blob: bd0228e8049db0b5183df7236b47b24cfec37561 [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Makoto Onuki7d1911f2017-06-09 12:30:09 -070019import static android.content.ContentProvider.maybeAddUserId;
20
Tor Norbye7b9c9122013-05-30 16:48:33 -070021import android.annotation.AnyRes;
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -070022import android.annotation.BroadcastBehavior;
Tor Norbyed9273d62013-05-30 15:59:53 -070023import android.annotation.IntDef;
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060024import android.annotation.NonNull;
25import android.annotation.Nullable;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070026import android.annotation.SdkConstant;
27import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050028import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070029import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050030import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060031import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.content.pm.PackageManager;
33import android.content.pm.ResolveInfo;
34import android.content.res.Resources;
35import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080036import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070037import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060038import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039import android.os.Bundle;
40import android.os.IBinder;
41import android.os.Parcel;
42import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000043import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050044import android.os.ResultReceiver;
45import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070046import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010047import android.os.UserHandle;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070048import android.provider.ContactsContract.QuickContact;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070049import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070050import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050051import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070052import android.provider.OpenableColumns;
Jason Monk2f68e8a2016-02-23 17:57:28 -050053import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054import android.util.AttributeSet;
55import android.util.Log;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070056
Dianne Hackborn2269d1572010-02-24 19:54:22 -080057import com.android.internal.util.XmlUtils;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070058
Jason Monk2f68e8a2016-02-23 17:57:28 -050059import org.xmlpull.v1.XmlPullParser;
60import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070061import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070062
63import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080064import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070065import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070066import java.lang.annotation.Retention;
67import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070068import java.net.URISyntaxException;
69import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080070import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070071import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080072import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070073import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070074import java.util.Set;
75
76/**
77 * An intent is an abstract description of an operation to be performed. It
78 * can be used with {@link Context#startActivity(Intent) startActivity} to
79 * launch an {@link android.app.Activity},
80 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
81 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
82 * and {@link android.content.Context#startService} or
83 * {@link android.content.Context#bindService} to communicate with a
84 * background {@link android.app.Service}.
85 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070086 * <p>An Intent provides a facility for performing late runtime binding between the code in
87 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070088 * can be thought of as the glue between activities. It is basically a passive data structure
89 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070090 *
91 * <div class="special reference">
92 * <h3>Developer Guides</h3>
93 * <p>For information about how to create and resolve intents, read the
94 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
95 * developer guide.</p>
96 * </div>
97 *
98 * <a name="IntentStructure"></a>
99 * <h3>Intent Structure</h3>
100 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700101 *
102 * <ul>
103 * <li> <p><b>action</b> -- The general action to be performed, such as
104 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
105 * etc.</p>
106 * </li>
107 * <li> <p><b>data</b> -- The data to operate on, such as a person record
108 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
109 * </li>
110 * </ul>
111 *
112 *
113 * <p>Some examples of action/data pairs are:</p>
114 *
115 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700116 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700117 * information about the person whose identifier is "1".</p>
118 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700119 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700120 * the phone dialer with the person filled in.</p>
121 * </li>
122 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
123 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700124 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * a particular URI.</p>
126 * </li>
127 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
128 * the phone dialer with the given number filled in.</p>
129 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700130 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700131 * information about the person whose identifier is "1".</p>
132 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700133 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700134 * a list of people, which the user can browse through. This example is a
135 * typical top-level entry into the Contacts application, showing you the
136 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700137 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700138 * being used to start an activity to display that person.</p>
139 * </li>
140 * </ul>
141 *
142 * <p>In addition to these primary attributes, there are a number of secondary
143 * attributes that you can also include with an intent:</p>
144 *
145 * <ul>
146 * <li> <p><b>category</b> -- Gives additional information about the action
147 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
148 * appear in the Launcher as a top-level application, while
149 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
150 * of alternative actions the user can perform on a piece of data.</p>
151 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
152 * intent data. Normally the type is inferred from the data itself.
153 * By setting this attribute, you disable that evaluation and force
154 * an explicit type.</p>
155 * <li> <p><b>component</b> -- Specifies an explicit name of a component
156 * class to use for the intent. Normally this is determined by looking
157 * at the other information in the intent (the action, data/type, and
158 * categories) and matching that with a component that can handle it.
159 * If this attribute is set then none of the evaluation is performed,
160 * and this component is used exactly as is. By specifying this attribute,
161 * all of the other Intent attributes become optional.</p>
162 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
163 * This can be used to provide extended information to the component.
164 * For example, if we have a action to send an e-mail message, we could
165 * also include extra pieces of data here to supply a subject, body,
166 * etc.</p>
167 * </ul>
168 *
169 * <p>Here are some examples of other operations you can specify as intents
170 * using these additional parameters:</p>
171 *
172 * <ul>
173 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
174 * Launch the home screen.</p>
175 * </li>
176 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
177 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
178 * vnd.android.cursor.item/phone}</i></b>
179 * -- Display the list of people's phone numbers, allowing the user to
180 * browse through them and pick one and return it to the parent activity.</p>
181 * </li>
182 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
183 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
184 * -- Display all pickers for data that can be opened with
185 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
186 * allowing the user to pick one of them and then some data inside of it
187 * and returning the resulting URI to the caller. This can be used,
188 * for example, in an e-mail application to allow the user to pick some
189 * data to include as an attachment.</p>
190 * </li>
191 * </ul>
192 *
193 * <p>There are a variety of standard Intent action and category constants
194 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700195 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700196 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700197 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700198 *
199 * <p>Put together, the set of actions, data types, categories, and extra data
200 * defines a language for the system allowing for the expression of phrases
201 * such as "call john smith's cell". As applications are added to the system,
202 * they can extend this language by adding new actions, types, and categories, or
203 * they can modify the behavior of existing phrases by supplying their own
204 * activities that handle them.</p>
205 *
206 * <a name="IntentResolution"></a>
207 * <h3>Intent Resolution</h3>
208 *
209 * <p>There are two primary forms of intents you will use.
210 *
211 * <ul>
212 * <li> <p><b>Explicit Intents</b> have specified a component (via
213 * {@link #setComponent} or {@link #setClass}), which provides the exact
214 * class to be run. Often these will not include any other information,
215 * simply being a way for an application to launch various internal
216 * activities it has as the user interacts with the application.
217 *
218 * <li> <p><b>Implicit Intents</b> have not specified a component;
219 * instead, they must include enough information for the system to
220 * determine which of the available components is best to run for that
221 * intent.
222 * </ul>
223 *
224 * <p>When using implicit intents, given such an arbitrary intent we need to
225 * know what to do with it. This is handled by the process of <em>Intent
226 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
227 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
228 * more activities/receivers) that can handle it.</p>
229 *
230 * <p>The intent resolution mechanism basically revolves around matching an
231 * Intent against all of the &lt;intent-filter&gt; descriptions in the
232 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
233 * objects explicitly registered with {@link Context#registerReceiver}.) More
234 * details on this can be found in the documentation on the {@link
235 * IntentFilter} class.</p>
236 *
237 * <p>There are three pieces of information in the Intent that are used for
238 * resolution: the action, type, and category. Using this information, a query
239 * is done on the {@link PackageManager} for a component that can handle the
240 * intent. The appropriate component is determined based on the intent
241 * information supplied in the <code>AndroidManifest.xml</code> file as
242 * follows:</p>
243 *
244 * <ul>
245 * <li> <p>The <b>action</b>, if given, must be listed by the component as
246 * one it handles.</p>
247 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
248 * already supplied in the Intent. Like the action, if a type is
249 * included in the intent (either explicitly or implicitly in its
250 * data), then this must be listed by the component as one it handles.</p>
251 * <li> For data that is not a <code>content:</code> URI and where no explicit
252 * type is included in the Intent, instead the <b>scheme</b> of the
253 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
254 * considered. Again like the action, if we are matching a scheme it
255 * must be listed by the component as one it can handle.
256 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
257 * by the activity as categories it handles. That is, if you include
258 * the categories {@link #CATEGORY_LAUNCHER} and
259 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
260 * with an intent that lists <em>both</em> of those categories.
261 * Activities will very often need to support the
262 * {@link #CATEGORY_DEFAULT} so that they can be found by
263 * {@link Context#startActivity Context.startActivity()}.</p>
264 * </ul>
265 *
266 * <p>For example, consider the Note Pad sample application that
267 * allows user to browse through a list of notes data and view details about
268 * individual items. Text in italics indicate places were you would replace a
269 * name with one specific to your own package.</p>
270 *
271 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
272 * package="<i>com.android.notepad</i>"&gt;
273 * &lt;application android:icon="@drawable/app_notes"
274 * android:label="@string/app_name"&gt;
275 *
276 * &lt;provider class=".NotePadProvider"
277 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
278 *
279 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
280 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700281 * &lt;action android:name="android.intent.action.MAIN" /&gt;
282 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700283 * &lt;/intent-filter&gt;
284 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700285 * &lt;action android:name="android.intent.action.VIEW" /&gt;
286 * &lt;action android:name="android.intent.action.EDIT" /&gt;
287 * &lt;action android:name="android.intent.action.PICK" /&gt;
288 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
289 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700290 * &lt;/intent-filter&gt;
291 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700292 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
293 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 * &lt;/activity&gt;
297 *
298 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
299 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700300 * &lt;action android:name="android.intent.action.VIEW" /&gt;
301 * &lt;action android:name="android.intent.action.EDIT" /&gt;
302 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
303 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700304 * &lt;/intent-filter&gt;
305 *
306 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700307 * &lt;action android:name="android.intent.action.INSERT" /&gt;
308 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
309 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700310 * &lt;/intent-filter&gt;
311 *
312 * &lt;/activity&gt;
313 *
314 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
315 * android:theme="@android:style/Theme.Dialog"&gt;
316 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700317 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
318 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
319 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
320 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
321 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700322 * &lt;/intent-filter&gt;
323 * &lt;/activity&gt;
324 *
325 * &lt;/application&gt;
326 * &lt;/manifest&gt;</pre>
327 *
328 * <p>The first activity,
329 * <code>com.android.notepad.NotesList</code>, serves as our main
330 * entry into the app. It can do three things as described by its three intent
331 * templates:
332 * <ol>
333 * <li><pre>
334 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700335 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
336 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700337 * &lt;/intent-filter&gt;</pre>
338 * <p>This provides a top-level entry into the NotePad application: the standard
339 * MAIN action is a main entry point (not requiring any other information in
340 * the Intent), and the LAUNCHER category says that this entry point should be
341 * listed in the application launcher.</p>
342 * <li><pre>
343 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700344 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
345 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
346 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
347 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700348 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700349 * &lt;/intent-filter&gt;</pre>
350 * <p>This declares the things that the activity can do on a directory of
351 * notes. The type being supported is given with the &lt;type&gt; tag, where
352 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
353 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
354 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
355 * The activity allows the user to view or edit the directory of data (via
356 * the VIEW and EDIT actions), or to pick a particular note and return it
357 * to the caller (via the PICK action). Note also the DEFAULT category
358 * supplied here: this is <em>required</em> for the
359 * {@link Context#startActivity Context.startActivity} method to resolve your
360 * activity when its component name is not explicitly specified.</p>
361 * <li><pre>
362 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700363 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
364 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
365 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700366 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700367 * <p>This filter describes the ability to return to the caller a note selected by
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700368 * the user without needing to know where it came from. The data type
369 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
370 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
371 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
372 * The GET_CONTENT action is similar to the PICK action, where the activity
373 * will return to its caller a piece of data selected by the user. Here,
374 * however, the caller specifies the type of data they desire instead of
375 * the type of data the user will be picking from.</p>
376 * </ol>
377 *
378 * <p>Given these capabilities, the following intents will resolve to the
379 * NotesList activity:</p>
380 *
381 * <ul>
382 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
383 * activities that can be used as top-level entry points into an
384 * application.</p>
385 * <li> <p><b>{ action=android.app.action.MAIN,
386 * category=android.app.category.LAUNCHER }</b> is the actual intent
387 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700388 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700389 * data=content://com.google.provider.NotePad/notes }</b>
390 * displays a list of all the notes under
391 * "content://com.google.provider.NotePad/notes", which
392 * the user can browse through and see the details on.</p>
393 * <li> <p><b>{ action=android.app.action.PICK
394 * data=content://com.google.provider.NotePad/notes }</b>
395 * provides a list of the notes under
396 * "content://com.google.provider.NotePad/notes", from which
397 * the user can pick a note whose data URL is returned back to the caller.</p>
398 * <li> <p><b>{ action=android.app.action.GET_CONTENT
399 * type=vnd.android.cursor.item/vnd.google.note }</b>
400 * is similar to the pick action, but allows the caller to specify the
401 * kind of data they want back so that the system can find the appropriate
402 * activity to pick something of that data type.</p>
403 * </ul>
404 *
405 * <p>The second activity,
406 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
407 * note entry and allows them to edit it. It can do two things as described
408 * by its two intent templates:
409 * <ol>
410 * <li><pre>
411 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700412 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
413 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
414 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
415 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700416 * &lt;/intent-filter&gt;</pre>
417 * <p>The first, primary, purpose of this activity is to let the user interact
418 * with a single note, as decribed by the MIME type
419 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
420 * either VIEW a note or allow the user to EDIT it. Again we support the
421 * DEFAULT category to allow the activity to be launched without explicitly
422 * specifying its component.</p>
423 * <li><pre>
424 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700425 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
426 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
427 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700428 * &lt;/intent-filter&gt;</pre>
429 * <p>The secondary use of this activity is to insert a new note entry into
430 * an existing directory of notes. This is used when the user creates a new
431 * note: the INSERT action is executed on the directory of notes, causing
432 * this activity to run and have the user create the new note data which
433 * it then adds to the content provider.</p>
434 * </ol>
435 *
436 * <p>Given these capabilities, the following intents will resolve to the
437 * NoteEditor activity:</p>
438 *
439 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700440 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700441 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
442 * shows the user the content of note <var>{ID}</var>.</p>
443 * <li> <p><b>{ action=android.app.action.EDIT
444 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
445 * allows the user to edit the content of note <var>{ID}</var>.</p>
446 * <li> <p><b>{ action=android.app.action.INSERT
447 * data=content://com.google.provider.NotePad/notes }</b>
448 * creates a new, empty note in the notes list at
449 * "content://com.google.provider.NotePad/notes"
450 * and allows the user to edit it. If they keep their changes, the URI
451 * of the newly created note is returned to the caller.</p>
452 * </ul>
453 *
454 * <p>The last activity,
455 * <code>com.android.notepad.TitleEditor</code>, allows the user to
456 * edit the title of a note. This could be implemented as a class that the
457 * application directly invokes (by explicitly setting its component in
458 * the Intent), but here we show a way you can publish alternative
459 * operations on existing data:</p>
460 *
461 * <pre>
462 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700463 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
464 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
465 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
466 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
467 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700468 * &lt;/intent-filter&gt;</pre>
469 *
470 * <p>In the single intent template here, we
471 * have created our own private action called
472 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
473 * edit the title of a note. It must be invoked on a specific note
474 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
475 * view and edit actions, but here displays and edits the title contained
476 * in the note data.
477 *
478 * <p>In addition to supporting the default category as usual, our title editor
479 * also supports two other standard categories: ALTERNATIVE and
480 * SELECTED_ALTERNATIVE. Implementing
481 * these categories allows others to find the special action it provides
482 * without directly knowing about it, through the
483 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
484 * more often to build dynamic menu items with
485 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
486 * template here was also supply an explicit name for the template
487 * (via <code>android:label="@string/resolve_title"</code>) to better control
488 * what the user sees when presented with this activity as an alternative
489 * action to the data they are viewing.
490 *
491 * <p>Given these capabilities, the following intent will resolve to the
492 * TitleEditor activity:</p>
493 *
494 * <ul>
495 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
496 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
497 * displays and allows the user to edit the title associated
498 * with note <var>{ID}</var>.</p>
499 * </ul>
500 *
501 * <h3>Standard Activity Actions</h3>
502 *
503 * <p>These are the current standard actions that Intent defines for launching
504 * activities (usually through {@link Context#startActivity}. The most
505 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
506 * {@link #ACTION_EDIT}.
507 *
508 * <ul>
509 * <li> {@link #ACTION_MAIN}
510 * <li> {@link #ACTION_VIEW}
511 * <li> {@link #ACTION_ATTACH_DATA}
512 * <li> {@link #ACTION_EDIT}
513 * <li> {@link #ACTION_PICK}
514 * <li> {@link #ACTION_CHOOSER}
515 * <li> {@link #ACTION_GET_CONTENT}
516 * <li> {@link #ACTION_DIAL}
517 * <li> {@link #ACTION_CALL}
518 * <li> {@link #ACTION_SEND}
519 * <li> {@link #ACTION_SENDTO}
520 * <li> {@link #ACTION_ANSWER}
521 * <li> {@link #ACTION_INSERT}
522 * <li> {@link #ACTION_DELETE}
523 * <li> {@link #ACTION_RUN}
524 * <li> {@link #ACTION_SYNC}
525 * <li> {@link #ACTION_PICK_ACTIVITY}
526 * <li> {@link #ACTION_SEARCH}
527 * <li> {@link #ACTION_WEB_SEARCH}
528 * <li> {@link #ACTION_FACTORY_TEST}
529 * </ul>
530 *
531 * <h3>Standard Broadcast Actions</h3>
532 *
533 * <p>These are the current standard actions that Intent defines for receiving
534 * broadcasts (usually through {@link Context#registerReceiver} or a
535 * &lt;receiver&gt; tag in a manifest).
536 *
537 * <ul>
538 * <li> {@link #ACTION_TIME_TICK}
539 * <li> {@link #ACTION_TIME_CHANGED}
540 * <li> {@link #ACTION_TIMEZONE_CHANGED}
541 * <li> {@link #ACTION_BOOT_COMPLETED}
542 * <li> {@link #ACTION_PACKAGE_ADDED}
543 * <li> {@link #ACTION_PACKAGE_CHANGED}
544 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800545 * <li> {@link #ACTION_PACKAGE_RESTARTED}
546 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000547 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
548 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * <li> {@link #ACTION_UID_REMOVED}
550 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700551 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700552 * <li> {@link #ACTION_POWER_DISCONNECTED}
553 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700554 * </ul>
555 *
556 * <h3>Standard Categories</h3>
557 *
558 * <p>These are the current standard categories that can be used to further
559 * clarify an Intent via {@link #addCategory}.
560 *
561 * <ul>
562 * <li> {@link #CATEGORY_DEFAULT}
563 * <li> {@link #CATEGORY_BROWSABLE}
564 * <li> {@link #CATEGORY_TAB}
565 * <li> {@link #CATEGORY_ALTERNATIVE}
566 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
567 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800568 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700569 * <li> {@link #CATEGORY_HOME}
570 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400572 * <li> {@link #CATEGORY_CAR_DOCK}
573 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500574 * <li> {@link #CATEGORY_LE_DESK_DOCK}
575 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200576 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700577 * <li> {@link #CATEGORY_APP_MARKET}
Zak Cohendb6ca492017-01-26 14:09:00 -0800578 * <li> {@link #CATEGORY_VR_HOME}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700579 * </ul>
580 *
581 * <h3>Standard Extra Data</h3>
582 *
583 * <p>These are the current standard fields that can be used as extra data via
584 * {@link #putExtra}.
585 *
586 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800587 * <li> {@link #EXTRA_ALARM_COUNT}
588 * <li> {@link #EXTRA_BCC}
589 * <li> {@link #EXTRA_CC}
590 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
591 * <li> {@link #EXTRA_DATA_REMOVED}
592 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500593 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
594 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_DOCK_STATE_CAR}
596 * <li> {@link #EXTRA_DOCK_STATE_DESK}
597 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
598 * <li> {@link #EXTRA_DONT_KILL_APP}
599 * <li> {@link #EXTRA_EMAIL}
600 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700601 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800602 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700603 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800604 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700605 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800606 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
607 * <li> {@link #EXTRA_REPLACING}
608 * <li> {@link #EXTRA_SHORTCUT_ICON}
609 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
610 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700611 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800612 * <li> {@link #EXTRA_SHORTCUT_NAME}
613 * <li> {@link #EXTRA_SUBJECT}
614 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700615 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800616 * <li> {@link #EXTRA_TITLE}
617 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 * </ul>
619 *
620 * <h3>Flags</h3>
621 *
622 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800623 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
624 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700625 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800626public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700627 private static final String ATTR_ACTION = "action";
628 private static final String TAG_CATEGORIES = "categories";
629 private static final String ATTR_CATEGORY = "category";
630 private static final String TAG_EXTRA = "extra";
631 private static final String ATTR_TYPE = "type";
632 private static final String ATTR_COMPONENT = "component";
633 private static final String ATTR_DATA = "data";
634 private static final String ATTR_FLAGS = "flags";
635
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700636 // ---------------------------------------------------------------------
637 // ---------------------------------------------------------------------
638 // Standard intent activity actions (see action variable).
639
640 /**
641 * Activity Action: Start as a main entry point, does not expect to
642 * receive data.
643 * <p>Input: nothing
644 * <p>Output: nothing
645 */
646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
647 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700649 /**
650 * Activity Action: Display the data to the user. This is the most common
651 * action performed on data -- it is the generic action you can use on
652 * a piece of data to get the most reasonable thing to occur. For example,
653 * when used on a contacts entry it will view the entry; when used on a
654 * mailto: URI it will bring up a compose window filled with the information
655 * supplied by the URI; when used with a tel: URI it will invoke the
656 * dialer.
657 * <p>Input: {@link #getData} is URI from which to retrieve data.
658 * <p>Output: nothing.
659 */
660 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
661 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800662
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700663 /**
Dianne Hackborna320f012017-04-07 13:57:48 -0700664 * Extra that can be included on activity intents coming from the storage UI
665 * when it launches sub-activities to manage various types of storage. For example,
666 * it may use {@link #ACTION_VIEW} with a "image/*" MIME type to have an app show
667 * the images on the device, and in that case also include this extra to tell the
668 * app it is coming from the storage UI so should help the user manage storage of
669 * this type.
670 */
671 public static final String EXTRA_FROM_STORAGE = "android.intent.extra.FROM_STORAGE";
672
673 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700674 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
675 * performed on a piece of data.
676 */
677 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800678
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700679 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900680 * Activity Action: Quick view the data. Launches a quick viewer for
681 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900682 * <p>Activities handling this intent action should handle the vast majority of
683 * MIME types rather than only specific ones.
Garfield Tance1d0e92017-03-23 10:52:48 -0700684 * <p>Quick viewers must render the quick view image locally, and must not send
685 * file content outside current device.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900686 * <p>Input: {@link #getData} is a mandatory content URI of the item to
687 * preview. {@link #getClipData} contains an optional list of content URIs
688 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
689 * optional index of the URI in the clip data to show first.
Garfield Tance1d0e92017-03-23 10:52:48 -0700690 * {@link #EXTRA_QUICK_VIEW_FEATURES} is an optional extra indicating the features
691 * that can be shown in the quick view UI.
Steve McKayc78bcb82015-07-31 14:35:22 -0700692 * <p>Output: nothing.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900693 * @see #EXTRA_INDEX
Garfield Tance1d0e92017-03-23 10:52:48 -0700694 * @see #EXTRA_QUICK_VIEW_FEATURES
Steve McKayc78bcb82015-07-31 14:35:22 -0700695 */
696 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
697 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
698
699 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700700 * Used to indicate that some piece of data should be attached to some other
701 * place. For example, image data could be attached to a contact. It is up
702 * to the recipient to decide where the data should be attached; the intent
703 * does not specify the ultimate destination.
704 * <p>Input: {@link #getData} is URI of data to be attached.
705 * <p>Output: nothing.
706 */
707 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
708 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800709
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700710 /**
711 * Activity Action: Provide explicit editable access to the given data.
712 * <p>Input: {@link #getData} is URI of data to be edited.
713 * <p>Output: nothing.
714 */
715 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
716 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800717
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700718 /**
719 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
720 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
721 * The extras can contain type specific data to pass through to the editing/creating
722 * activity.
723 * <p>Output: The URI of the item that was picked. This must be a content:
724 * URI so that any receiver can access it.
725 */
726 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
727 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800728
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700729 /**
730 * Activity Action: Pick an item from the data, returning what was selected.
731 * <p>Input: {@link #getData} is URI containing a directory of data
732 * (vnd.android.cursor.dir/*) from which to pick an item.
733 * <p>Output: The URI of the item that was picked.
734 */
735 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
736 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800737
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700738 /**
739 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800740 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800741 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
742 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700743 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
744 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800745 * (value: ShortcutIconResource).</p>
746 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800747 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700748 * @see #EXTRA_SHORTCUT_INTENT
749 * @see #EXTRA_SHORTCUT_NAME
750 * @see #EXTRA_SHORTCUT_ICON
751 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
752 * @see android.content.Intent.ShortcutIconResource
753 */
754 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
755 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
756
757 /**
758 * The name of the extra used to define the Intent of a shortcut.
759 *
760 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800761 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700762 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800763 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700764 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
765 /**
766 * The name of the extra used to define the name of a shortcut.
767 *
768 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800769 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700770 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800771 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700772 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
773 /**
774 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
775 *
776 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800777 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700778 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800779 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700780 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
781 /**
782 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
783 *
784 * @see #ACTION_CREATE_SHORTCUT
785 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800786 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700787 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800788 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700789 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
790 "android.intent.extra.shortcut.ICON_RESOURCE";
791
792 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500793 * An activity that provides a user interface for adjusting application preferences.
794 * Optional but recommended settings for all applications which have settings.
795 */
796 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
797 public static final String ACTION_APPLICATION_PREFERENCES
798 = "android.intent.action.APPLICATION_PREFERENCES";
799
800 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700801 * Activity Action: Launch an activity showing the app information.
802 * For applications which install other applications (such as app stores), it is recommended
803 * to handle this action for providing the app information to the user.
804 *
805 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
806 * to be displayed.
807 * <p>Output: Nothing.
808 */
809 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
810 public static final String ACTION_SHOW_APP_INFO
811 = "android.intent.action.SHOW_APP_INFO";
812
813 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800814 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700815 *
816 * @see Intent#ACTION_CREATE_SHORTCUT
817 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800818 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
819 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700820 */
821 public static class ShortcutIconResource implements Parcelable {
822 /**
823 * The package name of the application containing the icon.
824 */
825 public String packageName;
826
827 /**
828 * The resource name of the icon, including package, name and type.
829 */
830 public String resourceName;
831
832 /**
833 * Creates a new ShortcutIconResource for the specified context and resource
834 * identifier.
835 *
836 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700837 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700838 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700839 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700840 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700841 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700842 ShortcutIconResource icon = new ShortcutIconResource();
843 icon.packageName = context.getPackageName();
844 icon.resourceName = context.getResources().getResourceName(resourceId);
845 return icon;
846 }
847
848 /**
849 * Used to read a ShortcutIconResource from a Parcel.
850 */
851 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
852 new Parcelable.Creator<ShortcutIconResource>() {
853
854 public ShortcutIconResource createFromParcel(Parcel source) {
855 ShortcutIconResource icon = new ShortcutIconResource();
856 icon.packageName = source.readString();
857 icon.resourceName = source.readString();
858 return icon;
859 }
860
861 public ShortcutIconResource[] newArray(int size) {
862 return new ShortcutIconResource[size];
863 }
864 };
865
866 /**
867 * No special parcel contents.
868 */
869 public int describeContents() {
870 return 0;
871 }
872
873 public void writeToParcel(Parcel dest, int flags) {
874 dest.writeString(packageName);
875 dest.writeString(resourceName);
876 }
877
878 @Override
879 public String toString() {
880 return resourceName;
881 }
882 }
883
884 /**
885 * Activity Action: Display an activity chooser, allowing the user to pick
886 * what they want to before proceeding. This can be used as an alternative
887 * to the standard activity picker that is displayed by the system when
888 * you try to start an activity with multiple possible matches, with these
889 * differences in behavior:
890 * <ul>
891 * <li>You can specify the title that will appear in the activity chooser.
892 * <li>The user does not have the option to make one of the matching
893 * activities a preferred activity, and all possible activities will
894 * always be shown even if one of them is currently marked as the
895 * preferred activity.
896 * </ul>
897 * <p>
898 * This action should be used when the user will naturally expect to
899 * select an activity in order to proceed. An example if when not to use
900 * it is when the user clicks on a "mailto:" link. They would naturally
901 * expect to go directly to their mail app, so startActivity() should be
902 * called directly: it will
903 * either launch the current preferred app, or put up a dialog allowing the
904 * user to pick an app to use and optionally marking that as preferred.
905 * <p>
906 * In contrast, if the user is selecting a menu item to send a picture
907 * they are viewing to someone else, there are many different things they
908 * may want to do at this point: send it through e-mail, upload it to a
909 * web service, etc. In this case the CHOOSER action should be used, to
910 * always present to the user a list of the things they can do, with a
911 * nice title given by the caller such as "Send this photo with:".
912 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700913 * If you need to grant URI permissions through a chooser, you must specify
914 * the permissions to be granted on the ACTION_CHOOSER Intent
915 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
916 * {@link #setClipData} to specify the URIs to be granted as well as
917 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
918 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
919 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700920 * As a convenience, an Intent of this form can be created with the
921 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700922 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700923 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700924 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
925 * and can optionally have a {@link #EXTRA_TITLE} field containing the
926 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700927 * <p>
928 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700929 */
930 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
931 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
932
933 /**
934 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
935 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700936 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
937 * target intent, also optionally supplying a title. If the target
938 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
939 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
940 * set in the returned chooser intent, with its ClipData set appropriately:
941 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500942 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700943 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700944 * @param target The Intent that the user will be selecting an activity
945 * to perform.
946 * @param title Optional title that will be displayed in the chooser.
947 * @return Return a new Intent object that you can hand to
948 * {@link Context#startActivity(Intent) Context.startActivity()} and
949 * related methods.
950 */
951 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700952 return createChooser(target, title, null);
953 }
954
955 /**
956 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
957 *
958 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
959 * target intent, also optionally supplying a title. If the target
960 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
961 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
962 * set in the returned chooser intent, with its ClipData set appropriately:
963 * either a direct reflection of {@link #getClipData()} if that is non-null,
964 * or a new ClipData built from {@link #getData()}.</p>
965 *
966 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
967 * when the user makes a choice. This can be useful if the calling application wants
968 * to remember the last chosen target and surface it as a more prominent or one-touch
969 * affordance elsewhere in the UI for next time.</p>
970 *
971 * @param target The Intent that the user will be selecting an activity
972 * to perform.
973 * @param title Optional title that will be displayed in the chooser.
974 * @param sender Optional IntentSender to be called when a choice is made.
975 * @return Return a new Intent object that you can hand to
976 * {@link Context#startActivity(Intent) Context.startActivity()} and
977 * related methods.
978 */
979 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700980 Intent intent = new Intent(ACTION_CHOOSER);
981 intent.putExtra(EXTRA_INTENT, target);
982 if (title != null) {
983 intent.putExtra(EXTRA_TITLE, title);
984 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700985
Adam Powell0b3c1122014-10-09 12:50:14 -0700986 if (sender != null) {
987 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
988 }
989
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700990 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700991 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
992 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
993 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700994 if (permFlags != 0) {
995 ClipData targetClipData = target.getClipData();
996 if (targetClipData == null && target.getData() != null) {
997 ClipData.Item item = new ClipData.Item(target.getData());
998 String[] mimeTypes;
999 if (target.getType() != null) {
1000 mimeTypes = new String[] { target.getType() };
1001 } else {
1002 mimeTypes = new String[] { };
1003 }
1004 targetClipData = new ClipData(null, mimeTypes, item);
1005 }
1006 if (targetClipData != null) {
1007 intent.setClipData(targetClipData);
1008 intent.addFlags(permFlags);
1009 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001010 }
Dianne Hackborne302a162012-05-15 14:58:32 -07001011
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001012 return intent;
1013 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001014
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001015 /**
1016 * Activity Action: Allow the user to select a particular kind of data and
1017 * return it. This is different than {@link #ACTION_PICK} in that here we
1018 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001019 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001020 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001021 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001022 * etc.
1023 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001024 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001025 * of data, such as a person contact, you set the MIME type to the kind of
1026 * data you want and launch it with {@link Context#startActivity(Intent)}.
1027 * The system will then launch the best application to select that kind
1028 * of data for you.
1029 * <p>
1030 * You may also be interested in any of a set of types of content the user
1031 * can pick. For example, an e-mail application that wants to allow the
1032 * user to add an attachment to an e-mail message can use this action to
1033 * bring up a list of all of the types of content the user can attach.
1034 * <p>
1035 * In this case, you should wrap the GET_CONTENT intent with a chooser
1036 * (through {@link #createChooser}), which will give the proper interface
1037 * for the user to pick how to send your data and allow you to specify
1038 * a prompt indicating what they are doing. You will usually specify a
1039 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1040 * broad range of content types the user can select from.
1041 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001042 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001043 * only pick from data that can be represented as a stream. This is
1044 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1045 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001046 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001047 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001048 * is locally available on the device. For example, if this extra is set
1049 * to true then an image picker should not show any pictures that are available
1050 * from a remote server but not already on the local device (thus requiring
1051 * they be downloaded when opened).
1052 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001053 * If the caller can handle multiple returned items (the user performing
1054 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1055 * to indicate this.
1056 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001057 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1058 * that no URI is supplied in the intent, as there are no constraints on
1059 * where the returned data originally comes from. You may also include the
1060 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001061 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001062 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1063 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001064 * <p>
1065 * Output: The URI of the item that was picked. This must be a content:
1066 * URI so that any receiver can access it.
1067 */
1068 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1069 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1070 /**
1071 * Activity Action: Dial a number as specified by the data. This shows a
1072 * UI with the number being dialed, allowing the user to explicitly
1073 * initiate the call.
1074 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1075 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1076 * number.
1077 * <p>Output: nothing.
1078 */
1079 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1080 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1081 /**
1082 * Activity Action: Perform a call to someone specified by the data.
1083 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1084 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1085 * number.
1086 * <p>Output: nothing.
1087 *
1088 * <p>Note: there will be restrictions on which applications can initiate a
1089 * call; most applications should use the {@link #ACTION_DIAL}.
1090 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1091 * numbers. Applications can <strong>dial</strong> emergency numbers using
1092 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001093 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001094 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001095 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001096 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001097 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001098 */
1099 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1100 public static final String ACTION_CALL = "android.intent.action.CALL";
1101 /**
1102 * Activity Action: Perform a call to an emergency number specified by the
1103 * data.
1104 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1105 * tel: URI of an explicit phone number.
1106 * <p>Output: nothing.
1107 * @hide
1108 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001109 @SystemApi
1110 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001111 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1112 /**
1113 * Activity action: Perform a call to any number (emergency or not)
1114 * specified by the data.
1115 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1116 * tel: URI of an explicit phone number.
1117 * <p>Output: nothing.
1118 * @hide
1119 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001120 @SystemApi
1121 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001122 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
fionaxu77a744c2017-03-17 14:35:39 -07001123
Santos Cordon15a13782015-03-31 18:32:31 -07001124 /**
fionaxuadfe7002017-02-17 17:20:46 -08001125 * Activity Action: Main entry point for carrier setup apps.
1126 * <p>Carrier apps that provide an implementation for this action may be invoked to configure
1127 * carrier service and typically require
1128 * {@link android.telephony.TelephonyManager#hasCarrierPrivileges() carrier privileges} to
1129 * fulfill their duties.
1130 */
1131 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1132 public static final String ACTION_CARRIER_SETUP = "android.intent.action.CARRIER_SETUP";
1133 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001134 * Activity Action: Send a message to someone specified by the data.
1135 * <p>Input: {@link #getData} is URI describing the target.
1136 * <p>Output: nothing.
1137 */
1138 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1139 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1140 /**
1141 * Activity Action: Deliver some data to someone else. Who the data is
1142 * being delivered to is not specified; it is up to the receiver of this
1143 * action to ask the user where the data should be sent.
1144 * <p>
1145 * When launching a SEND intent, you should usually wrap it in a chooser
1146 * (through {@link #createChooser}), which will give the proper interface
1147 * for the user to pick how to send your data and allow you to specify
1148 * a prompt indicating what they are doing.
1149 * <p>
1150 * Input: {@link #getType} is the MIME type of the data being sent.
1151 * get*Extra can have either a {@link #EXTRA_TEXT}
1152 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1153 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1154 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1155 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001156 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1157 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1158 * your text with HTML formatting.
1159 * <p>
1160 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1161 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1162 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1163 * content: URIs and other advanced features of {@link ClipData}. If
1164 * using this approach, you still must supply the same data through the
1165 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1166 * for compatibility with old applications. If you don't set a ClipData,
1167 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001168 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001169 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1170 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1171 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1172 * be openable only as asset typed files using
1173 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1174 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001175 * Optional standard extras, which may be interpreted by some recipients as
1176 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1177 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1178 * <p>
1179 * Output: nothing.
1180 */
1181 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1182 public static final String ACTION_SEND = "android.intent.action.SEND";
1183 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001184 * Activity Action: Deliver multiple data to someone else.
1185 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001186 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001187 * <p>
1188 * Input: {@link #getType} is the MIME type of the data being sent.
1189 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001190 * #EXTRA_STREAM} field, containing the data to be sent. If using
1191 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1192 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001193 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001194 * Multiple types are supported, and receivers should handle mixed types
1195 * whenever possible. The right way for the receiver to check them is to
1196 * use the content resolver on each URI. The intent sender should try to
1197 * put the most concrete mime type in the intent type, but it can fall
1198 * back to {@literal <type>/*} or {@literal *}/* as needed.
1199 * <p>
1200 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1201 * be image/jpg, but if you are sending image/jpg and image/png, then the
1202 * intent's type should be image/*.
1203 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001204 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1205 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1206 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1207 * content: URIs and other advanced features of {@link ClipData}. If
1208 * using this approach, you still must supply the same data through the
1209 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1210 * for compatibility with old applications. If you don't set a ClipData,
1211 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1212 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001213 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1214 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1215 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1216 * be openable only as asset typed files using
1217 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1218 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001219 * Optional standard extras, which may be interpreted by some recipients as
1220 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1221 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1222 * <p>
1223 * Output: nothing.
1224 */
1225 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1226 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1227 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001228 * Activity Action: Handle an incoming phone call.
1229 * <p>Input: nothing.
1230 * <p>Output: nothing.
1231 */
1232 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1233 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1234 /**
1235 * Activity Action: Insert an empty item into the given container.
1236 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1237 * in which to place the data.
1238 * <p>Output: URI of the new data that was created.
1239 */
1240 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1241 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1242 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001243 * Activity Action: Create a new item in the given container, initializing it
1244 * from the current contents of the clipboard.
1245 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1246 * in which to place the data.
1247 * <p>Output: URI of the new data that was created.
1248 */
1249 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1250 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1251 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001252 * Activity Action: Delete the given data from its container.
1253 * <p>Input: {@link #getData} is URI of data to be deleted.
1254 * <p>Output: nothing.
1255 */
1256 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1257 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1258 /**
1259 * Activity Action: Run the data, whatever that means.
1260 * <p>Input: ? (Note: this is currently specific to the test harness.)
1261 * <p>Output: nothing.
1262 */
1263 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1264 public static final String ACTION_RUN = "android.intent.action.RUN";
1265 /**
1266 * Activity Action: Perform a data synchronization.
1267 * <p>Input: ?
1268 * <p>Output: ?
1269 */
1270 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1271 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1272 /**
1273 * Activity Action: Pick an activity given an intent, returning the class
1274 * selected.
1275 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1276 * used with {@link PackageManager#queryIntentActivities} to determine the
1277 * set of activities from which to pick.
1278 * <p>Output: Class name of the activity that was selected.
1279 */
1280 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1281 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1282 /**
1283 * Activity Action: Perform a search.
1284 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1285 * is the text to search for. If empty, simply
1286 * enter your search results Activity with the search UI activated.
1287 * <p>Output: nothing.
1288 */
1289 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1290 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1291 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001292 * Activity Action: Start the platform-defined tutorial
1293 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1294 * is the text to search for. If empty, simply
1295 * enter your search results Activity with the search UI activated.
1296 * <p>Output: nothing.
1297 */
1298 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1299 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1300 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001301 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001302 * <p>
1303 * Input: {@link android.app.SearchManager#QUERY
1304 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1305 * a url starts with http or https, the site will be opened. If it is plain
1306 * text, Google search will be applied.
1307 * <p>
1308 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001309 */
1310 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1311 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001312
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001313 /**
Jim Miller07994402012-05-02 14:22:27 -07001314 * Activity Action: Perform assist action.
1315 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001316 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1317 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001318 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1319 * information.
Jim Miller07994402012-05-02 14:22:27 -07001320 * Output: nothing.
1321 */
1322 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1323 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001324
1325 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001326 * Activity Action: Perform voice assist action.
1327 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001328 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1329 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001330 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001331 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001332 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001333 */
Amith Yamasani16452032017-03-03 10:15:57 -08001334 @SystemApi
Bjorn Bringertbc086862013-03-01 12:59:24 +00001335 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1336 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1337
1338 /**
Adam Skory7140a252013-09-11 12:04:58 +01001339 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1340 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001341 */
1342 public static final String EXTRA_ASSIST_PACKAGE
1343 = "android.intent.extra.ASSIST_PACKAGE";
1344
1345 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001346 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1347 * application package at the time the assist was invoked.
1348 */
1349 public static final String EXTRA_ASSIST_UID
1350 = "android.intent.extra.ASSIST_UID";
1351
1352 /**
Adam Skory7140a252013-09-11 12:04:58 +01001353 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1354 * information supplied by the current foreground app at the time of the assist request.
1355 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001356 */
1357 public static final String EXTRA_ASSIST_CONTEXT
1358 = "android.intent.extra.ASSIST_CONTEXT";
1359
Jim Miller07994402012-05-02 14:22:27 -07001360 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001361 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1362 * keyboard as the primary input device for assistance.
1363 */
1364 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1365 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1366
1367 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001368 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1369 * that was used to invoke the assist.
1370 */
1371 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1372 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1373
1374 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001375 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001376 * <p>Input: Nothing.
1377 * <p>Output: nothing.
1378 */
1379 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1380 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1381 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001382 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001383 * <p>Input: Nothing.
1384 * <p>Output: Nothing.
1385 */
1386 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1387 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1388
1389 /**
1390 * Activity Action: Show activity for reporting a bug.
1391 * <p>Input: Nothing.
1392 * <p>Output: Nothing.
1393 */
1394 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1395 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1396
1397 /**
1398 * Activity Action: Main entry point for factory tests. Only used when
1399 * the device is booting in factory test node. The implementing package
1400 * must be installed in the system image.
1401 * <p>Input: nothing
1402 * <p>Output: nothing
1403 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06001404 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001405 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1406
1407 /**
1408 * Activity Action: The user pressed the "call" button to go to the dialer
1409 * or other appropriate UI for placing a call.
1410 * <p>Input: Nothing.
1411 * <p>Output: Nothing.
1412 */
1413 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1414 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1415
1416 /**
1417 * Activity Action: Start Voice Command.
1418 * <p>Input: Nothing.
1419 * <p>Output: Nothing.
1420 */
1421 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1422 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001423
1424 /**
1425 * Activity Action: Start action associated with long pressing on the
1426 * search key.
1427 * <p>Input: Nothing.
1428 * <p>Output: Nothing.
1429 */
1430 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1431 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001432
Jacek Surazski86b6c532009-05-13 14:38:28 +02001433 /**
1434 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1435 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001436 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001437 * <p>Input: No data is specified. The bug report is passed in using
1438 * an {@link #EXTRA_BUG_REPORT} field.
1439 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001440 *
1441 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001442 */
1443 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1444 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001445
1446 /**
1447 * Activity Action: Show power usage information to the user.
1448 * <p>Input: Nothing.
1449 * <p>Output: Nothing.
1450 */
1451 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1452 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001453
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001454 /**
Russell Brenner4cd32e52017-02-24 11:11:47 -08001455 * Activity Action: Setup wizard action provided for OTA provisioning to determine if it needs
1456 * to run.
1457 * <p>Input: Nothing.
1458 * <p>Output: Nothing.
1459 * @deprecated As of {@link android.os.Build.VERSION_CODES#M}, setup wizard can be identified
1460 * using {@link #ACTION_MAIN} and {@link #CATEGORY_SETUP_WIZARD}
1461 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001462 * @removed
Russell Brenner4cd32e52017-02-24 11:11:47 -08001463 */
1464 @Deprecated
1465 @SystemApi
1466 public static final String ACTION_DEVICE_INITIALIZATION_WIZARD =
1467 "android.intent.action.DEVICE_INITIALIZATION_WIZARD";
1468
1469 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001470 * Activity Action: Setup wizard to launch after a platform update. This
1471 * activity should have a string meta-data field associated with it,
1472 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1473 * the platform for setup. The activity will be launched only if
1474 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1475 * same value.
1476 * <p>Input: Nothing.
1477 * <p>Output: Nothing.
1478 * @hide
1479 */
Russell Brenner4cd32e52017-02-24 11:11:47 -08001480 @SystemApi
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001481 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1482 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001483
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001484 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001485 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1486 * <p>Input: Nothing.
1487 * <p>Output: Nothing.
1488 * @hide
1489 */
1490 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1491 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001492 "com.android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001493
1494 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001495 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1496 * <p>Input: Nothing.
1497 * <p>Output: Nothing.
1498 * @hide
1499 */
1500 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1501 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001502 "com.android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001503
1504 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001505 * Activity Action: Show settings for managing network data usage of a
1506 * specific application. Applications should define an activity that offers
1507 * options to control data usage.
1508 */
1509 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1510 public static final String ACTION_MANAGE_NETWORK_USAGE =
1511 "android.intent.action.MANAGE_NETWORK_USAGE";
1512
1513 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001514 * Activity Action: Launch application installer.
1515 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001516 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001517 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1518 * you can also use "package:<package-name>" to install an application for the
1519 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001520 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1521 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1522 * <p>
1523 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1524 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001525 * <p>
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001526 * <strong>Note:</strong>If your app is targeting API level higher than 25 you
Svet Ganov86877e42015-05-28 08:19:48 -07001527 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1528 * in order to launch the application installer.
1529 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001530 *
1531 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1532 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1533 * @see #EXTRA_RETURN_RESULT
1534 */
1535 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1536 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1537
1538 /**
Todd Kennedyd0084f72017-07-28 13:56:14 -07001539 * Activity Action: Activity to handle split installation failures.
1540 * <p>Splits may be installed dynamically. This happens when an Activity is launched,
1541 * but the split that contains the application isn't installed. When a split is
1542 * installed in this manner, the containing package usually doesn't know this is
1543 * happening. However, if an error occurs during installation, the containing
1544 * package can define a single activity handling this action to deal with such
1545 * failures.
1546 * <p>The activity handling this action must be in the base package.
1547 * <p>
1548 * Input: {@link #EXTRA_INTENT} the original intent that started split installation.
1549 * {@link #EXTRA_SPLIT_NAME} the name of the split that failed to be installed.
1550 */
1551 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1552 public static final String ACTION_INSTALL_FAILURE = "android.intent.action.INSTALL_FAILURE";
1553
1554 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001555 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001556 * @removed
Todd Kennedyd46a1602017-04-03 15:22:38 -07001557 * @deprecated Do not use. This will go away.
1558 * Replace with {@link #ACTION_INSTALL_INSTANT_APP_PACKAGE}.
1559 */
1560 @SystemApi
1561 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1562 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1563 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1564 /**
1565 * Activity Action: Launch instant application installer.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001566 * <p class="note">
1567 * This is a protected intent that can only be sent by the system.
1568 * </p>
1569 *
1570 * @hide
1571 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001572 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001573 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001574 public static final String ACTION_INSTALL_INSTANT_APP_PACKAGE
1575 = "android.intent.action.INSTALL_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001576
1577 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001578 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001579 * @removed
Todd Kennedyd46a1602017-04-03 15:22:38 -07001580 * @deprecated Do not use. This will go away.
1581 * Replace with {@link #ACTION_RESOLVE_INSTANT_APP_PACKAGE}.
1582 */
1583 @SystemApi
1584 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1585 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1586 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1587 /**
1588 * Service Action: Resolve instant application.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001589 * <p>
1590 * The system will have a persistent connection to this service.
1591 * This is a protected intent that can only be sent by the system.
1592 * </p>
1593 *
1594 * @hide
1595 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001596 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001597 @SdkConstant(SdkConstantType.SERVICE_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001598 public static final String ACTION_RESOLVE_INSTANT_APP_PACKAGE
1599 = "android.intent.action.RESOLVE_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001600
1601 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001602 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001603 * @removed
Todd Kennedyd46a1602017-04-03 15:22:38 -07001604 * @deprecated Do not use. This will go away.
1605 * Replace with {@link #ACTION_INSTANT_APP_RESOLVER_SETTINGS}.
1606 */
1607 @SystemApi
1608 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1609 public static final String ACTION_EPHEMERAL_RESOLVER_SETTINGS
1610 = "android.intent.action.EPHEMERAL_RESOLVER_SETTINGS";
1611 /**
1612 * Activity Action: Launch instant app settings.
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001613 *
1614 * <p class="note">
1615 * This is a protected intent that can only be sent by the system.
1616 * </p>
1617 *
1618 * @hide
1619 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001620 @SystemApi
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001621 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001622 public static final String ACTION_INSTANT_APP_RESOLVER_SETTINGS
1623 = "android.intent.action.INSTANT_APP_RESOLVER_SETTINGS";
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001624
1625 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001626 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1627 * package. Specifies the installer package name; this package will receive the
1628 * {@link #ACTION_APP_ERROR} intent.
1629 */
1630 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1631 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1632
1633 /**
1634 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1635 * package. Specifies that the application being installed should not be
1636 * treated as coming from an unknown source, but as coming from the app
1637 * invoking the Intent. For this to work you must start the installer with
1638 * startActivityForResult().
1639 */
1640 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1641 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1642
1643 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001644 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1645 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001646 * data field originated from.
1647 */
rich cannings706e8ba2012-08-20 13:20:14 -07001648 public static final String EXTRA_ORIGINATING_URI
1649 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001650
1651 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001652 * This extra can be used with any Intent used to launch an activity, supplying information
1653 * about who is launching that activity. This field contains a {@link android.net.Uri}
1654 * object, typically an http: or https: URI of the web site that the referral came from;
1655 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1656 * a native application that it came from.
1657 *
1658 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1659 * instead of directly retrieving the extra. It is also valid for applications to
1660 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1661 * a string, not a Uri; the field here, if supplied, will always take precedence,
1662 * however.</p>
1663 *
1664 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001665 */
1666 public static final String EXTRA_REFERRER
1667 = "android.intent.extra.REFERRER";
1668
1669 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001670 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1671 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1672 * not be created, in particular when Intent extras are supplied through the
1673 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1674 * schemes.
1675 *
1676 * @see #EXTRA_REFERRER
1677 */
1678 public static final String EXTRA_REFERRER_NAME
1679 = "android.intent.extra.REFERRER_NAME";
1680
1681 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001682 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001683 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001684 * Currently only a system app that hosts the provider authority "downloads" or holds the
1685 * permission {@link android.Manifest.permission.MANAGE_DOCUMENTS} can use this.
Ben Gruver37d83a32012-09-27 13:02:06 -07001686 * @hide
1687 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001688 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001689 public static final String EXTRA_ORIGINATING_UID
1690 = "android.intent.extra.ORIGINATING_UID";
1691
1692 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001693 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1694 * package. Tells the installer UI to skip the confirmation with the user
1695 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001696 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1697 * will no longer show an interstitial message about updating existing
1698 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001699 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001700 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001701 public static final String EXTRA_ALLOW_REPLACE
1702 = "android.intent.extra.ALLOW_REPLACE";
1703
1704 /**
1705 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1706 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1707 * return to the application the result code of the install/uninstall. The returned result
1708 * code will be {@link android.app.Activity#RESULT_OK} on success or
1709 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1710 */
1711 public static final String EXTRA_RETURN_RESULT
1712 = "android.intent.extra.RETURN_RESULT";
1713
1714 /**
1715 * Package manager install result code. @hide because result codes are not
1716 * yet ready to be exposed.
1717 */
1718 public static final String EXTRA_INSTALL_RESULT
1719 = "android.intent.extra.INSTALL_RESULT";
1720
1721 /**
1722 * Activity Action: Launch application uninstaller.
1723 * <p>
1724 * Input: The data must be a package: URI whose scheme specific part is
1725 * the package name of the current installed package to be uninstalled.
1726 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1727 * <p>
1728 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1729 * succeeded.
1730 */
1731 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1732 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1733
1734 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001735 * Specify whether the package should be uninstalled for all users.
1736 * @hide because these should not be part of normal application flow.
1737 */
1738 public static final String EXTRA_UNINSTALL_ALL_USERS
1739 = "android.intent.extra.UNINSTALL_ALL_USERS";
1740
1741 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001742 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1743 * describing the last run version of the platform that was setup.
1744 * @hide
1745 */
1746 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1747
Svet Ganov3695b8a2015-03-24 16:30:25 -07001748 /**
1749 * Activity action: Launch UI to manage the permissions of an app.
1750 * <p>
1751 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1752 * will be managed by the launched UI.
1753 * </p>
1754 * <p>
1755 * Output: Nothing.
1756 * </p>
1757 *
1758 * @see #EXTRA_PACKAGE_NAME
1759 *
1760 * @hide
1761 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001762 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001763 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1764 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1765 "android.intent.action.MANAGE_APP_PERMISSIONS";
1766
1767 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001768 * Activity action: Launch UI to manage permissions.
1769 * <p>
1770 * Input: Nothing.
1771 * </p>
1772 * <p>
1773 * Output: Nothing.
1774 * </p>
1775 *
1776 * @hide
1777 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001778 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001779 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1780 public static final String ACTION_MANAGE_PERMISSIONS =
1781 "android.intent.action.MANAGE_PERMISSIONS";
1782
1783 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001784 * Activity action: Launch UI to review permissions for an app.
1785 * The system uses this intent if permission review for apps not
1786 * supporting the new runtime permissions model is enabled. In
1787 * this mode a permission review is required before any of the
1788 * app components can run.
1789 * <p>
1790 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1791 * permissions will be reviewed (mandatory).
1792 * </p>
1793 * <p>
1794 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1795 * be fired after the permission review (optional).
1796 * </p>
1797 * <p>
1798 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1799 * be invoked after the permission review (optional).
1800 * </p>
1801 * <p>
1802 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1803 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1804 * </p>
1805 * <p>
1806 * Output: Nothing.
1807 * </p>
1808 *
1809 * @see #EXTRA_PACKAGE_NAME
1810 * @see #EXTRA_INTENT
1811 * @see #EXTRA_REMOTE_CALLBACK
1812 * @see #EXTRA_RESULT_NEEDED
1813 *
1814 * @hide
1815 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001816 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001817 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1818 public static final String ACTION_REVIEW_PERMISSIONS =
1819 "android.intent.action.REVIEW_PERMISSIONS";
1820
1821 /**
1822 * Intent extra: A callback for reporting remote result as a bundle.
1823 * <p>
1824 * Type: IRemoteCallback
1825 * </p>
1826 *
1827 * @hide
1828 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001829 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001830 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1831
1832 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001833 * Intent extra: An app package name.
1834 * <p>
1835 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001836 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001837 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001838 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001839 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1840
1841 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001842 * Intent extra: An app split name.
1843 * <p>
1844 * Type: String
1845 * </p>
Todd Kennedye5195dd2016-10-19 15:29:19 -07001846 */
Todd Kennedye5195dd2016-10-19 15:29:19 -07001847 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1848
1849 /**
Jeff Sharkey1a749422017-04-28 14:19:50 -06001850 * Intent extra: A {@link ComponentName} value.
1851 * <p>
1852 * Type: String
1853 * </p>
1854 */
1855 public static final String EXTRA_COMPONENT_NAME = "android.intent.extra.COMPONENT_NAME";
1856
1857 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001858 * Intent extra: An extra for specifying whether a result is needed.
1859 * <p>
1860 * Type: boolean
1861 * </p>
1862 *
1863 * @hide
1864 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001865 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001866 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1867
1868 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001869 * Activity action: Launch UI to manage which apps have a given permission.
1870 * <p>
1871 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1872 * to which will be managed by the launched UI.
1873 * </p>
1874 * <p>
1875 * Output: Nothing.
1876 * </p>
1877 *
1878 * @see #EXTRA_PERMISSION_NAME
1879 *
1880 * @hide
1881 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001882 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001883 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1884 public static final String ACTION_MANAGE_PERMISSION_APPS =
1885 "android.intent.action.MANAGE_PERMISSION_APPS";
1886
1887 /**
1888 * Intent extra: The name of a permission.
1889 * <p>
1890 * Type: String
1891 * </p>
1892 *
1893 * @hide
1894 */
1895 @SystemApi
1896 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1897
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001898 // ---------------------------------------------------------------------
1899 // ---------------------------------------------------------------------
1900 // Standard intent broadcast actions (see action variable).
1901
1902 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001903 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1904 * <p>
1905 * For historical reasons, the name of this broadcast action refers to the power
1906 * state of the screen but it is actually sent in response to changes in the
1907 * overall interactive state of the device.
1908 * </p><p>
1909 * This broadcast is sent when the device becomes non-interactive which may have
1910 * nothing to do with the screen turning off. To determine the
1911 * actual state of the screen, use {@link android.view.Display#getState}.
1912 * </p><p>
1913 * See {@link android.os.PowerManager#isInteractive} for details.
1914 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001915 * You <em>cannot</em> receive this through components declared in
1916 * manifests, only by explicitly registering for it with
1917 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1918 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001919 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001920 * <p class="note">This is a protected intent that can only be sent
1921 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001922 */
1923 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1924 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001925
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001926 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001927 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1928 * <p>
1929 * For historical reasons, the name of this broadcast action refers to the power
1930 * state of the screen but it is actually sent in response to changes in the
1931 * overall interactive state of the device.
1932 * </p><p>
1933 * This broadcast is sent when the device becomes interactive which may have
1934 * nothing to do with the screen turning on. To determine the
1935 * actual state of the screen, use {@link android.view.Display#getState}.
1936 * </p><p>
1937 * See {@link android.os.PowerManager#isInteractive} for details.
1938 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001939 * You <em>cannot</em> receive this through components declared in
1940 * manifests, only by explicitly registering for it with
1941 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1942 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001943 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001944 * <p class="note">This is a protected intent that can only be sent
1945 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001946 */
1947 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1948 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001949
1950 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001951 * Broadcast Action: Sent after the system stops dreaming.
1952 *
1953 * <p class="note">This is a protected intent that can only be sent by the system.
1954 * It is only sent to registered receivers.</p>
1955 */
1956 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1957 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1958
1959 /**
1960 * Broadcast Action: Sent after the system starts dreaming.
1961 *
1962 * <p class="note">This is a protected intent that can only be sent by the system.
1963 * It is only sent to registered receivers.</p>
1964 */
1965 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1966 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1967
1968 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001969 * 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 -07001970 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001971 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001972 * <p class="note">This is a protected intent that can only be sent
1973 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001974 */
1975 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001976 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001977
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001978 /**
1979 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001980 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001981 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001982 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1983 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001984 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001985 * <p class="note">This is a protected intent that can only be sent
1986 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001987 */
1988 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1989 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1990 /**
1991 * Broadcast Action: The time was set.
1992 */
1993 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1994 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1995 /**
1996 * Broadcast Action: The date has changed.
1997 */
1998 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1999 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
2000 /**
2001 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
2002 * <ul>
2003 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
2004 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002005 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002006 * <p class="note">This is a protected intent that can only be sent
2007 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002008 */
2009 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2010 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
2011 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07002012 * Clear DNS Cache Action: This is broadcast when networks have changed and old
2013 * DNS entries should be tossed.
2014 * @hide
2015 */
2016 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2017 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
2018 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002019 * Alarm Changed Action: This is broadcast when the AlarmClock
2020 * application's alarm is set or unset. It is used by the
2021 * AlarmClock application and the StatusBar service.
2022 * @hide
2023 */
2024 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2025 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002026
2027 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002028 * Broadcast Action: This is broadcast once, after the user has finished
2029 * booting, but while still in the "locked" state. It can be used to perform
2030 * application-specific initialization, such as installing alarms. You must
2031 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
2032 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002033 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002034 * This broadcast is sent immediately at boot by all devices (regardless of
2035 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
2036 * higher. Upon receipt of this broadcast, the user is still locked and only
2037 * device-protected storage can be accessed safely. If you want to access
2038 * credential-protected storage, you need to wait for the user to be
2039 * unlocked (typically by entering their lock pattern or PIN for the first
2040 * time), after which the {@link #ACTION_USER_UNLOCKED} and
2041 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
2042 * <p>
2043 * To receive this broadcast, your receiver component must be marked as
2044 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002045 * <p class="note">
2046 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002047 *
2048 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002049 */
2050 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2051 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2052
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002053 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002054 * Broadcast Action: This is broadcast once, after the user has finished
2055 * booting. It can be used to perform application-specific initialization,
2056 * such as installing alarms. You must hold the
2057 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2058 * order to receive this broadcast.
2059 * <p>
2060 * This broadcast is sent at boot by all devices (both with and without
2061 * direct boot support). Upon receipt of this broadcast, the user is
2062 * unlocked and both device-protected and credential-protected storage can
2063 * accessed safely.
2064 * <p>
2065 * If you need to run while the user is still locked (before they've entered
2066 * their lock pattern or PIN for the first time), you can listen for the
2067 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2068 * <p class="note">
2069 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002070 */
2071 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002072 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002073 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002074
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002075 /**
2076 * Broadcast Action: This is broadcast when a user action should request a
2077 * temporary system dialog to dismiss. Some examples of temporary system
2078 * dialogs are the notification window-shade and the recent tasks dialog.
2079 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002080 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002081 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2082 /**
2083 * Broadcast Action: Trigger the download and eventual installation
2084 * of a package.
2085 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002086 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002087 * <p class="note">This is a protected intent that can only be sent
2088 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002089 *
2090 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002091 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002092 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002093 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2094 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2095 /**
Christopher Tate94b91db2017-04-19 15:49:17 -07002096 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002097 * device. The data contains the name of the package. Note that the
2098 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002099 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002100 * <ul>
Christopher Tate94b91db2017-04-19 15:49:17 -07002101 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2102 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002103 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2104 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002105 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002106 * <p class="note">This is a protected intent that can only be sent
2107 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002108 */
2109 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2110 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2111 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002112 * Broadcast Action: A new version of an application package has been
2113 * installed, replacing an existing version that was previously installed.
2114 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002115 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002116 * <ul>
2117 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2118 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002119 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002120 * <p class="note">This is a protected intent that can only be sent
2121 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002122 */
2123 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2124 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2125 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002126 * Broadcast Action: A new version of your application has been installed
2127 * over an existing one. This is only sent to the application that was
2128 * replaced. It does not contain any additional data; to receive it, just
2129 * use an intent filter for this action.
2130 *
2131 * <p class="note">This is a protected intent that can only be sent
2132 * by the system.
2133 */
2134 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2135 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2136 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002137 * Broadcast Action: An existing application package has been removed from
2138 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002139 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002140 * <ul>
2141 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2142 * to the package.
2143 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2144 * application -- data and code -- is being removed.
2145 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2146 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2147 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002148 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002149 * <p class="note">This is a protected intent that can only be sent
2150 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002151 */
2152 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2153 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2154 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002155 * Broadcast Action: An existing application package has been completely
2156 * removed from the device. The data contains the name of the package.
2157 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2158 * {@link #EXTRA_DATA_REMOVED} is true and
2159 * {@link #EXTRA_REPLACING} is false of that broadcast.
2160 *
2161 * <ul>
2162 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2163 * to the package.
2164 * </ul>
2165 *
2166 * <p class="note">This is a protected intent that can only be sent
2167 * by the system.
2168 */
2169 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2170 public static final String ACTION_PACKAGE_FULLY_REMOVED
2171 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2172 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002173 * Broadcast Action: An existing application package has been changed (for
2174 * example, a component has been enabled or disabled). The data contains
2175 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002176 * <ul>
2177 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002178 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002179 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002180 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2181 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002182 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002183 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002184 * <p class="note">This is a protected intent that can only be sent
2185 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002186 */
2187 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2188 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2189 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002190 * @hide
2191 * Broadcast Action: Ask system services if there is any reason to
2192 * restart the given package. The data contains the name of the
2193 * package.
2194 * <ul>
2195 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2196 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2197 * </ul>
2198 *
2199 * <p class="note">This is a protected intent that can only be sent
2200 * by the system.
2201 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002202 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002203 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2204 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2205 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002206 * Broadcast Action: The user has restarted a package, and all of its
2207 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002208 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002209 * be removed. Note that the restarted package does <em>not</em>
2210 * receive this broadcast.
2211 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002212 * <ul>
2213 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2214 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002215 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002216 * <p class="note">This is a protected intent that can only be sent
2217 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002218 */
2219 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2220 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2221 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002222 * Broadcast Action: The user has cleared the data of a package. This should
2223 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002224 * its persistent data is erased and this broadcast sent.
2225 * Note that the cleared package does <em>not</em>
2226 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002227 * <ul>
2228 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2229 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002230 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002231 * <p class="note">This is a protected intent that can only be sent
2232 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002233 */
2234 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2235 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2236 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002237 * Broadcast Action: Packages have been suspended.
2238 * <p>Includes the following extras:
2239 * <ul>
2240 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2241 * </ul>
2242 *
2243 * <p class="note">This is a protected intent that can only be sent
2244 * by the system. It is only sent to registered receivers.
2245 */
2246 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2247 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2248 /**
2249 * Broadcast Action: Packages have been unsuspended.
2250 * <p>Includes the following extras:
2251 * <ul>
2252 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2253 * </ul>
2254 *
2255 * <p class="note">This is a protected intent that can only be sent
2256 * by the system. It is only sent to registered receivers.
2257 */
2258 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2259 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2260 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002261 * Broadcast Action: A user ID has been removed from the system. The user
2262 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002263 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002264 * <p class="note">This is a protected intent that can only be sent
2265 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002266 */
2267 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2268 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002269
2270 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002271 * Broadcast Action: Sent to the installer package of an application when
2272 * that application is first launched (that is the first time it is moved
2273 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002274 *
2275 * <p class="note">This is a protected intent that can only be sent
2276 * by the system.
2277 */
2278 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2279 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2280
2281 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002282 * Broadcast Action: Sent to the system package verifier when a package
2283 * needs to be verified. The data contains the package URI.
2284 * <p class="note">
2285 * This is a protected intent that can only be sent by the system.
2286 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002287 */
2288 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2289 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2290
2291 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002292 * Broadcast Action: Sent to the system package verifier when a package is
2293 * verified. The data contains the package URI.
2294 * <p class="note">
2295 * This is a protected intent that can only be sent by the system.
2296 */
2297 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2298 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2299
2300 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002301 * Broadcast Action: Sent to the system intent filter verifier when an
2302 * intent filter needs to be verified. The data contains the filter data
2303 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002304 * <p class="note">
2305 * This is a protected intent that can only be sent by the system.
2306 * </p>
2307 *
2308 * @hide
2309 */
2310 @SystemApi
2311 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2312 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2313
2314 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002315 * Broadcast Action: Resources for a set of packages (which were
2316 * previously unavailable) are currently
2317 * available since the media on which they exist is available.
2318 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2319 * list of packages whose availability changed.
2320 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2321 * list of uids of packages whose availability changed.
2322 * Note that the
2323 * packages in this list do <em>not</em> receive this broadcast.
2324 * The specified set of packages are now available on the system.
2325 * <p>Includes the following extras:
2326 * <ul>
2327 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2328 * whose resources(were previously unavailable) are currently available.
2329 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2330 * packages whose resources(were previously unavailable)
2331 * are currently available.
2332 * </ul>
2333 *
2334 * <p class="note">This is a protected intent that can only be sent
2335 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002336 */
2337 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002338 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2339 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002340
2341 /**
2342 * Broadcast Action: Resources for a set of packages are currently
2343 * unavailable since the media on which they exist is unavailable.
2344 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2345 * list of packages whose availability changed.
2346 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2347 * list of uids of packages whose availability changed.
2348 * The specified set of packages can no longer be
2349 * launched and are practically unavailable on the system.
2350 * <p>Inclues the following extras:
2351 * <ul>
2352 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2353 * whose resources are no longer available.
2354 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2355 * whose resources are no longer available.
2356 * </ul>
2357 *
2358 * <p class="note">This is a protected intent that can only be sent
2359 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002360 */
2361 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002362 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002363 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002364
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002365 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002366 * Broadcast Action: preferred activities have changed *explicitly*.
2367 *
2368 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2369 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2370 * be sent.
2371 *
2372 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2373 *
2374 * @hide
2375 */
2376 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2377 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2378 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2379
2380
2381 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002382 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002383 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002384 * This should <em>only</em> be used to determine when the wallpaper
2385 * has changed to show the new wallpaper to the user. You should certainly
2386 * never, in response to this, change the wallpaper or other attributes of
2387 * it such as the suggested size. That would be crazy, right? You'd cause
2388 * all kinds of loops, especially if other apps are doing similar things,
2389 * right? Of course. So please don't do this.
2390 *
2391 * @deprecated Modern applications should use
2392 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2393 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2394 * shown behind their UI, rather than watching for this broadcast and
2395 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002396 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002397 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002398 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2399 /**
2400 * Broadcast Action: The current device {@link android.content.res.Configuration}
2401 * (orientation, locale, etc) has changed. When such a change happens, the
2402 * UIs (view hierarchy) will need to be rebuilt based on this new
2403 * information; for the most part, applications don't need to worry about
2404 * this, because the system will take care of stopping and restarting the
2405 * application to make sure it sees the new changes. Some system code that
2406 * can not be restarted will need to watch for this action and handle it
2407 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002408 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002409 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002410 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002411 * in manifests, only by explicitly registering for it with
2412 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2413 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002414 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002415 * <p class="note">This is a protected intent that can only be sent
2416 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002417 *
2418 * @see android.content.res.Configuration
2419 */
2420 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2421 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2422 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002423 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002424 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002425 * <p class="note">This is a protected intent that can only be sent
2426 * by the system.
2427 */
2428 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2429 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2430 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002431 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2432 * charging state, level, and other information about the battery.
2433 * See {@link android.os.BatteryManager} for documentation on the
2434 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002435 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002436 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002437 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002438 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002439 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002440 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2441 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2442 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2443 * broadcasts that are sent and can be received through manifest
2444 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002445 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002446 * <p class="note">This is a protected intent that can only be sent
2447 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002448 */
2449 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2450 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2451 /**
2452 * Broadcast Action: Indicates low battery condition on the device.
2453 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002454 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002455 * <p class="note">This is a protected intent that can only be sent
2456 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002457 */
2458 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2459 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2460 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002461 * Broadcast Action: Indicates the battery is now okay after being low.
2462 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2463 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002464 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002465 * <p class="note">This is a protected intent that can only be sent
2466 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002467 */
2468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2469 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2470 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002471 * Broadcast Action: External power has been connected to the device.
2472 * This is intended for applications that wish to register specifically to this notification.
2473 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2474 * stay active to receive this notification. This action can be used to implement actions
2475 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002476 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002477 * <p class="note">This is a protected intent that can only be sent
2478 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002479 */
2480 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002481 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002482 /**
2483 * Broadcast Action: External power has been removed from the device.
2484 * This is intended for applications that wish to register specifically to this notification.
2485 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2486 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002487 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002488 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002489 * <p class="note">This is a protected intent that can only be sent
2490 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002491 */
2492 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002493 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002494 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002495 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002496 * Broadcast Action: Device is shutting down.
2497 * This is broadcast when the device is being shut down (completely turned
2498 * off, not sleeping). Once the broadcast is complete, the final shutdown
2499 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002500 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002501 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002502 * <p class="note">This is a protected intent that can only be sent
2503 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002504 * <p>May include the following extras:
2505 * <ul>
2506 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2507 * shutdown is only for userspace processes. If not set, assumed to be false.
2508 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002509 */
2510 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002511 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002512 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002513 * Activity Action: Start this activity to request system shutdown.
2514 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002515 * to request confirmation from the user before shutting down. The optional boolean
2516 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2517 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002518 *
2519 * <p class="note">This is a protected intent that can only be sent
2520 * by the system.
2521 *
2522 * {@hide}
2523 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002524 public static final String ACTION_REQUEST_SHUTDOWN
2525 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002526 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002527 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002528 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002529 * <p class="note">
2530 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002531 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002532 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2533 * or above, this broadcast will no longer be delivered to any
2534 * {@link BroadcastReceiver} defined in your manifest. Instead,
2535 * apps are strongly encouraged to use the improved
2536 * {@link Context#getCacheDir()} behavior so the system can
2537 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002538 */
2539 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002540 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002541 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2542 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002543 * Broadcast Action: Indicates low storage space condition on the device no
2544 * longer exists
2545 * <p class="note">
2546 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002547 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002548 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2549 * or above, this broadcast will no longer be delivered to any
2550 * {@link BroadcastReceiver} defined in your manifest. Instead,
2551 * apps are strongly encouraged to use the improved
2552 * {@link Context#getCacheDir()} behavior so the system can
2553 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002554 */
2555 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002556 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002557 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2558 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002559 * Broadcast Action: A sticky broadcast that indicates a storage space full
2560 * condition on the device. This is intended for activities that want to be
2561 * able to fill the data partition completely, leaving only enough free
2562 * space to prevent system-wide SQLite failures.
2563 * <p class="note">
2564 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002565 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002566 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2567 * or above, this broadcast will no longer be delivered to any
2568 * {@link BroadcastReceiver} defined in your manifest. Instead,
2569 * apps are strongly encouraged to use the improved
2570 * {@link Context#getCacheDir()} behavior so the system can
2571 * automatically free up storage when needed.
2572 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002573 */
2574 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002575 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002576 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2577 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002578 * Broadcast Action: Indicates storage space full condition on the device no
2579 * longer exists.
2580 * <p class="note">
2581 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002582 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002583 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2584 * or above, this broadcast will no longer be delivered to any
2585 * {@link BroadcastReceiver} defined in your manifest. Instead,
2586 * apps are strongly encouraged to use the improved
2587 * {@link Context#getCacheDir()} behavior so the system can
2588 * automatically free up storage when needed.
2589 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002590 */
2591 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002592 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002593 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2594 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002595 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2596 * and package management should be started.
2597 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2598 * notification.
2599 */
2600 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2601 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2602 /**
2603 * Broadcast Action: The device has entered USB Mass Storage mode.
2604 * This is used mainly for the USB Settings panel.
2605 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2606 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002607 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002608 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002609 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002610 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002611 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2612
2613 /**
2614 * Broadcast Action: The device has exited USB Mass Storage mode.
2615 * This is used mainly for the USB Settings panel.
2616 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2617 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002618 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002619 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002620 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002621 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002622 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2623
2624 /**
2625 * Broadcast Action: External media has been removed.
2626 * The path to the mount point for the removed media is contained in the Intent.mData field.
2627 */
2628 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2629 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2630
2631 /**
2632 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002633 * 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 -07002634 */
2635 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2636 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2637
2638 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002639 * Broadcast Action: External media is present, and being disk-checked
2640 * 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 -08002641 */
2642 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2643 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2644
2645 /**
2646 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2647 * 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 -08002648 */
2649 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2650 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2651
2652 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002653 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002654 * 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 -07002655 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2656 * media was mounted read only.
2657 */
2658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2659 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2660
2661 /**
2662 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002663 * 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 -07002664 */
2665 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2666 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2667
2668 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002669 * Broadcast Action: External media is no longer being shared via USB mass storage.
2670 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2671 *
2672 * @hide
2673 */
2674 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2675
2676 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002677 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2678 * The path to the mount point for the removed media is contained in the Intent.mData field.
2679 */
2680 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2681 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2682
2683 /**
2684 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002685 * 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 -07002686 */
2687 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2688 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2689
2690 /**
2691 * Broadcast Action: User has expressed the desire to remove the external storage media.
2692 * Applications should close all files they have open within the mount point when they receive this intent.
2693 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2694 */
2695 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2696 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2697
2698 /**
2699 * Broadcast Action: The media scanner has started scanning a directory.
2700 * The path to the directory being scanned is contained in the Intent.mData field.
2701 */
2702 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2703 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2704
2705 /**
2706 * Broadcast Action: The media scanner has finished scanning a directory.
2707 * The path to the scanned directory is contained in the Intent.mData field.
2708 */
2709 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2710 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2711
2712 /**
2713 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2714 * The path to the file is contained in the Intent.mData field.
2715 */
2716 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2717 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2718
2719 /**
2720 * Broadcast Action: The "Media Button" was pressed. Includes a single
2721 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2722 * caused the broadcast.
2723 */
2724 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2725 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2726
2727 /**
2728 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2729 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2730 * caused the broadcast.
2731 */
2732 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2733 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2734
2735 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2736 // location; they are not general-purpose actions.
2737
2738 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002739 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002740 */
2741 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2742 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2743 "android.intent.action.GTALK_CONNECTED";
2744
2745 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002746 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002747 */
2748 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2749 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2750 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002751
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002752 /**
2753 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002754 */
2755 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2756 public static final String ACTION_INPUT_METHOD_CHANGED =
2757 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002758
2759 /**
2760 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2761 * more radios have been turned off or on. The intent will have the following extra value:</p>
2762 * <ul>
2763 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2764 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2765 * turned off</li>
2766 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002767 *
Peng Xua35b5532016-01-20 00:05:45 -08002768 * <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 -07002769 */
2770 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2771 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2772
2773 /**
2774 * Broadcast Action: Some content providers have parts of their namespace
2775 * where they publish new events or items that the user may be especially
2776 * interested in. For these things, they may broadcast this action when the
2777 * set of interesting items change.
2778 *
2779 * For example, GmailProvider sends this notification when the set of unread
2780 * mail in the inbox changes.
2781 *
2782 * <p>The data of the intent identifies which part of which provider
2783 * changed. When queried through the content resolver, the data URI will
2784 * return the data set in question.
2785 *
2786 * <p>The intent will have the following extra values:
2787 * <ul>
2788 * <li><em>count</em> - The number of items in the data set. This is the
2789 * same as the number of items in the cursor returned by querying the
2790 * data URI. </li>
2791 * </ul>
2792 *
2793 * This intent will be sent at boot (if the count is non-zero) and when the
2794 * data set changes. It is possible for the data set to change without the
2795 * count changing (for example, if a new unread message arrives in the same
2796 * sync operation in which a message is archived). The phone should still
2797 * ring/vibrate/etc as normal in this case.
2798 */
2799 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2800 public static final String ACTION_PROVIDER_CHANGED =
2801 "android.intent.action.PROVIDER_CHANGED";
2802
2803 /**
2804 * Broadcast Action: Wired Headset plugged in or unplugged.
2805 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002806 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2807 * and documentation.
2808 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002809 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002810 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002811 */
2812 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002813 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002814
2815 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002816 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2817 * <ul>
2818 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2819 * </ul>
2820 *
2821 * <p class="note">This is a protected intent that can only be sent
2822 * by the system.
2823 *
2824 * @hide
2825 */
2826 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2827 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2828 = "android.intent.action.ADVANCED_SETTINGS";
2829
2830 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002831 * Broadcast Action: Sent after application restrictions are changed.
2832 *
2833 * <p class="note">This is a protected intent that can only be sent
2834 * by the system.</p>
2835 */
2836 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2837 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2838 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2839
2840 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002841 * Broadcast Action: An outgoing call is about to be placed.
2842 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002843 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002844 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002845 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002846 * the phone number originally intended to be dialed.</li>
2847 * </ul>
2848 * <p>Once the broadcast is finished, the resultData is used as the actual
2849 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002850 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002851 * outgoing call in turn: for example, a parental control application
2852 * might verify that the user is authorized to place the call at that
2853 * time, then a number-rewriting application might add an area code if
2854 * one was not specified.</p>
2855 * <p>For consistency, any receiver whose purpose is to prohibit phone
2856 * calls should have a priority of 0, to ensure it will see the final
2857 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002858 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002859 * should have a positive priority.
2860 * Negative priorities are reserved for the system for this broadcast;
2861 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002862 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2863 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002864 * <p>Emergency calls cannot be intercepted using this mechanism, and
2865 * other calls cannot be modified to call emergency numbers using this
2866 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002867 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2868 * call to use their own service instead. Those apps should first prevent
2869 * the call from being placed by setting resultData to <code>null</code>
2870 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002871 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002872 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2873 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002874 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002875 * <p class="note">This is a protected intent that can only be sent
2876 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002877 */
2878 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2879 public static final String ACTION_NEW_OUTGOING_CALL =
2880 "android.intent.action.NEW_OUTGOING_CALL";
2881
2882 /**
2883 * Broadcast Action: Have the device reboot. This is only for use by
2884 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002885 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002886 * <p class="note">This is a protected intent that can only be sent
2887 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002888 */
2889 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2890 public static final String ACTION_REBOOT =
2891 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002892
Wei Huang97ecc9c2009-05-11 17:44:20 -07002893 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002894 * Broadcast Action: A sticky broadcast for changes in the physical
2895 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002896 *
2897 * <p>The intent will have the following extra values:
2898 * <ul>
2899 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002900 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002901 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002902 * <p>This is intended for monitoring the current physical dock state.
2903 * See {@link android.app.UiModeManager} for the normal API dealing with
2904 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002905 */
2906 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2907 public static final String ACTION_DOCK_EVENT =
2908 "android.intent.action.DOCK_EVENT";
2909
2910 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002911 * Broadcast Action: A broadcast when idle maintenance can be started.
2912 * This means that the user is not interacting with the device and is
2913 * not expected to do so soon. Typical use of the idle maintenance is
2914 * to perform somehow expensive tasks that can be postponed at a moment
2915 * when they will not degrade user experience.
2916 * <p>
2917 * <p class="note">In order to keep the device responsive in case of an
2918 * unexpected user interaction, implementations of a maintenance task
2919 * should be interruptible. In such a scenario a broadcast with action
2920 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2921 * should not do the maintenance work in
2922 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2923 * maintenance service by {@link Context#startService(Intent)}. Also
2924 * you should hold a wake lock while your maintenance service is running
2925 * to prevent the device going to sleep.
2926 * </p>
2927 * <p>
2928 * <p class="note">This is a protected intent that can only be sent by
2929 * the system.
2930 * </p>
2931 *
2932 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002933 *
2934 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002935 */
2936 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2937 public static final String ACTION_IDLE_MAINTENANCE_START =
2938 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2939
2940 /**
2941 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2942 * This means that the user was not interacting with the device as a result
2943 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2944 * was sent and now the user started interacting with the device. Typical
2945 * use of the idle maintenance is to perform somehow expensive tasks that
2946 * can be postponed at a moment when they will not degrade user experience.
2947 * <p>
2948 * <p class="note">In order to keep the device responsive in case of an
2949 * unexpected user interaction, implementations of a maintenance task
2950 * should be interruptible. Hence, on receiving a broadcast with this
2951 * action, the maintenance task should be interrupted as soon as possible.
2952 * In other words, you should not do the maintenance work in
2953 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2954 * maintenance service that was started on receiving of
2955 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2956 * lock you acquired when your maintenance service started.
2957 * </p>
2958 * <p class="note">This is a protected intent that can only be sent
2959 * by the system.
2960 *
2961 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002962 *
2963 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002964 */
2965 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2966 public static final String ACTION_IDLE_MAINTENANCE_END =
2967 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2968
2969 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002970 * Broadcast Action: a remote intent is to be broadcasted.
2971 *
2972 * A remote intent is used for remote RPC between devices. The remote intent
2973 * is serialized and sent from one device to another device. The receiving
2974 * device parses the remote intent and broadcasts it. Note that anyone can
2975 * broadcast a remote intent. However, if the intent receiver of the remote intent
2976 * does not trust intent broadcasts from arbitrary intent senders, it should require
2977 * the sender to hold certain permissions so only trusted sender's broadcast will be
2978 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002979 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002980 */
2981 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002982 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002983
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002984 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002985 * Broadcast Action: This is broadcast once when the user is booting after a
2986 * system update. It can be used to perform cleanup or upgrades after a
2987 * system update.
2988 * <p>
2989 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2990 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2991 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2992 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002993 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002994 * @hide
2995 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08002996 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002997 public static final String ACTION_PRE_BOOT_COMPLETED =
2998 "android.intent.action.PRE_BOOT_COMPLETED";
2999
Amith Yamasani13593602012-03-22 16:16:17 -07003000 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003001 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003002 * on restricted users. The broadcast intent contains an extra
3003 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
3004 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
3005 * String[] depending on the restriction type.<p/>
3006 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07003007 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
3008 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
3009 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003010 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
3011 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003012 * @see RestrictionEntry
3013 */
3014 public static final String ACTION_GET_RESTRICTION_ENTRIES =
3015 "android.intent.action.GET_RESTRICTION_ENTRIES";
3016
3017 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003018 * Sent the first time a user is starting, to allow system apps to
3019 * perform one time initialization. (This will not be seen by third
3020 * party applications because a newly initialized user does not have any
3021 * third party applications installed for it.) This is sent early in
3022 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003023 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3024 * broadcast, since it is part of a visible user interaction; be as quick
3025 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003026 */
3027 public static final String ACTION_USER_INITIALIZE =
3028 "android.intent.action.USER_INITIALIZE";
3029
3030 /**
3031 * Sent when a user switch is happening, causing the process's user to be
3032 * brought to the foreground. This is only sent to receivers registered
3033 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3034 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003035 * foreground. This is sent as a foreground
3036 * broadcast, since it is part of a visible user interaction; be as quick
3037 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003038 */
3039 public static final String ACTION_USER_FOREGROUND =
3040 "android.intent.action.USER_FOREGROUND";
3041
3042 /**
3043 * Sent when a user switch is happening, causing the process's user to be
3044 * sent to the background. This is only sent to receivers registered
3045 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3046 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003047 * background. This is sent as a foreground
3048 * broadcast, since it is part of a visible user interaction; be as quick
3049 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003050 */
3051 public static final String ACTION_USER_BACKGROUND =
3052 "android.intent.action.USER_BACKGROUND";
3053
3054 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003055 * Broadcast sent to the system when a user is added. Carries an extra
3056 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3057 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003058 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003059 * @hide
3060 */
3061 public static final String ACTION_USER_ADDED =
3062 "android.intent.action.USER_ADDED";
3063
3064 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003065 * Broadcast sent by the system when a user is started. Carries an extra
3066 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003067 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003068 * that has been started. This is sent as a foreground
3069 * broadcast, since it is part of a visible user interaction; be as quick
3070 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003071 * @hide
3072 */
3073 public static final String ACTION_USER_STARTED =
3074 "android.intent.action.USER_STARTED";
3075
3076 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003077 * Broadcast sent when a user is in the process of starting. Carries an extra
3078 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3079 * sent to registered receivers, not manifest receivers. It is sent to all
3080 * users (including the one that is being started). You must hold
3081 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3082 * this broadcast. This is sent as a background broadcast, since
3083 * its result is not part of the primary UX flow; to safely keep track of
3084 * started/stopped state of a user you can use this in conjunction with
3085 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3086 * other user state broadcasts since those are foreground broadcasts so can
3087 * execute in a different order.
3088 * @hide
3089 */
3090 public static final String ACTION_USER_STARTING =
3091 "android.intent.action.USER_STARTING";
3092
3093 /**
3094 * Broadcast sent when a user is going to be stopped. Carries an extra
3095 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3096 * sent to registered receivers, not manifest receivers. It is sent to all
3097 * users (including the one that is being stopped). You must hold
3098 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3099 * this broadcast. The user will not stop until all receivers have
3100 * handled the broadcast. This is sent as a background broadcast, since
3101 * its result is not part of the primary UX flow; to safely keep track of
3102 * started/stopped state of a user you can use this in conjunction with
3103 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3104 * other user state broadcasts since those are foreground broadcasts so can
3105 * execute in a different order.
3106 * @hide
3107 */
3108 public static final String ACTION_USER_STOPPING =
3109 "android.intent.action.USER_STOPPING";
3110
3111 /**
3112 * Broadcast sent to the system when a user is stopped. Carries an extra
3113 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3114 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3115 * specific package. This is only sent to registered receivers, not manifest
3116 * receivers. It is sent to all running users <em>except</em> the one that
3117 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003118 * @hide
3119 */
3120 public static final String ACTION_USER_STOPPED =
3121 "android.intent.action.USER_STOPPED";
3122
3123 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003124 * 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 -07003125 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003126 * one that has been removed. The user will not be completely removed until all receivers have
3127 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003128 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003129 * @hide
3130 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003131 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003132 public static final String ACTION_USER_REMOVED =
3133 "android.intent.action.USER_REMOVED";
3134
3135 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003136 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003137 * the userHandle of the user to become the current one. This is only sent to
3138 * registered receivers, not manifest receivers. It is sent to all running users.
3139 * You must hold
3140 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003141 * @hide
3142 */
3143 public static final String ACTION_USER_SWITCHED =
3144 "android.intent.action.USER_SWITCHED";
3145
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003146 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003147 * Broadcast Action: Sent when the credential-encrypted private storage has
3148 * become unlocked for the target user. This is only sent to registered
3149 * receivers, not manifest receivers.
3150 */
3151 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3152 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3153
3154 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003155 * Broadcast sent to the system when a user's information changes. Carries an extra
3156 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003157 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003158 * @hide
3159 */
3160 public static final String ACTION_USER_INFO_CHANGED =
3161 "android.intent.action.USER_INFO_CHANGED";
3162
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003163 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003164 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3165 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003166 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3167 * that need to display merged content across both primary and managed profiles need to
3168 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003169 * not manifest receivers.
3170 */
3171 public static final String ACTION_MANAGED_PROFILE_ADDED =
3172 "android.intent.action.MANAGED_PROFILE_ADDED";
3173
3174 /**
3175 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003176 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3177 * Only applications (for example Launchers) that need to display merged content across both
3178 * primary and managed profiles need to worry about this broadcast. This is only sent to
3179 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003180 */
3181 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3182 "android.intent.action.MANAGED_PROFILE_REMOVED";
3183
3184 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003185 * Broadcast sent to the primary user when the credential-encrypted private storage for
3186 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3187 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3188 * Launchers) that need to display merged content across both primary and managed profiles
3189 * need to worry about this broadcast. This is only sent to registered receivers,
3190 * not manifest receivers.
3191 */
3192 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3193 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3194
3195 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003196 * Broadcast sent to the primary user when an associated managed profile has become available.
3197 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003198 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3199 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3200 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003201 */
Rubin Xue95057a2016-04-01 16:49:25 +01003202 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3203 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3204
3205 /**
3206 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3207 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3208 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3209 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3210 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3211 */
3212 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3213 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003214
3215 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003216 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3217 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3218 * the device was locked or unlocked.
3219 *
3220 * This is only sent to registered receivers.
3221 *
3222 * @hide
3223 */
3224 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3225 "android.intent.action.DEVICE_LOCKED_CHANGED";
3226
3227 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003228 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3229 */
3230 public static final String ACTION_QUICK_CLOCK =
3231 "android.intent.action.QUICK_CLOCK";
3232
Michael Wright0087a142013-02-05 16:29:39 -08003233 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003234 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003235 * @hide
3236 */
3237 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003238 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003239
Justin Kohd378ad72013-04-01 12:18:26 -07003240 /**
3241 * Broadcast Action: A global button was pressed. Includes a single
3242 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3243 * caused the broadcast.
3244 * @hide
3245 */
Sujith Ramakrishnan48e19c82017-04-24 15:57:58 -07003246 @SystemApi
Justin Kohd378ad72013-04-01 12:18:26 -07003247 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3248
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003249 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003250 * Broadcast Action: Sent when media resource is granted.
3251 * <p>
3252 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3253 * granted.
3254 * </p>
3255 * <p class="note">
3256 * This is a protected intent that can only be sent by the system.
3257 * </p>
3258 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003259 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003260 * </p>
3261 *
3262 * @hide
3263 */
3264 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3265 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3266
3267 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003268 * Broadcast Action: An overlay package has changed. The data contains the
3269 * name of the overlay package which has changed. This is broadcast on all
3270 * changes to the OverlayInfo returned by {@link
3271 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3272 * most common change is a state change that will change whether the
3273 * overlay is enabled or not.
3274 * @hide
3275 */
3276 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3277
3278 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003279 * Activity Action: Allow the user to select and return one or more existing
3280 * documents. When invoked, the system will display the various
3281 * {@link DocumentsProvider} instances installed on the device, letting the
3282 * user interactively navigate through them. These documents include local
3283 * media, such as photos and video, and documents provided by installed
3284 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003285 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003286 * Each document is represented as a {@code content://} URI backed by a
3287 * {@link DocumentsProvider}, which can be opened as a stream with
3288 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3289 * {@link android.provider.DocumentsContract.Document} metadata.
3290 * <p>
3291 * All selected documents are returned to the calling application with
3292 * persistable read and write permission grants. If you want to maintain
3293 * access to the documents across device reboots, you need to explicitly
3294 * take the persistable permissions using
3295 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3296 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003297 * Callers must indicate the acceptable document MIME types through
3298 * {@link #setType(String)}. For example, to select photos, use
3299 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3300 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3301 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003302 * <p>
3303 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003304 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3305 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003306 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003307 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3308 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003309 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003310 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003311 * Callers can set a document URI through
3312 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3313 * location of documents navigator. System will do its best to launch the
3314 * navigator in the specified document if it's a folder, or the folder that
3315 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003316 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003317 * Output: The URI of the item that was picked, returned in
3318 * {@link #getData()}. This must be a {@code content://} URI so that any
3319 * receiver can access it. If multiple documents were selected, they are
3320 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003321 *
3322 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003323 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003324 * @see #ACTION_CREATE_DOCUMENT
3325 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003326 */
3327 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3328 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3329
3330 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003331 * Activity Action: Allow the user to create a new document. When invoked,
3332 * the system will display the various {@link DocumentsProvider} instances
3333 * installed on the device, letting the user navigate through them. The
3334 * returned document may be a newly created document with no content, or it
3335 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003336 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003337 * Each document is represented as a {@code content://} URI backed by a
3338 * {@link DocumentsProvider}, which can be opened as a stream with
3339 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3340 * {@link android.provider.DocumentsContract.Document} metadata.
3341 * <p>
3342 * Callers must indicate the concrete MIME type of the document being
3343 * created by setting {@link #setType(String)}. This MIME type cannot be
3344 * changed after the document is created.
3345 * <p>
3346 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3347 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003348 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003349 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3350 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003351 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003352 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003353 * Callers can set a document URI through
3354 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3355 * location of documents navigator. System will do its best to launch the
3356 * navigator in the specified document if it's a folder, or the folder that
3357 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003358 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003359 * Output: The URI of the item that was created. This must be a
3360 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003361 *
3362 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003363 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003364 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003365 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003366 */
3367 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3368 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3369
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003370 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003371 * Activity Action: Allow the user to pick a directory subtree. When
3372 * invoked, the system will display the various {@link DocumentsProvider}
3373 * instances installed on the device, letting the user navigate through
3374 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003375 * <p>
3376 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003377 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3378 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3379 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003380 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003381 * Callers can set a document URI through
3382 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3383 * location of documents navigator. System will do its best to launch the
3384 * navigator in the specified document if it's a folder, or the folder that
3385 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003386 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003387 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003388 *
3389 * @see DocumentsContract
3390 */
3391 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003392 public static final String
3393 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003394
Felipe Lemec7b1f892016-01-15 15:02:31 -08003395 /**
Peng Xua35b5532016-01-20 00:05:45 -08003396 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3397 * exisiting sensor being disconnected.
3398 *
3399 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3400 *
3401 * {@hide}
3402 */
3403 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3404 public static final String
3405 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3406
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003407 /**
Sam Line707f832017-04-13 17:00:55 -07003408 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003409 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003410 * @removed
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003411 */
3412 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003413 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003414 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3415
Christopher Tate6597e342015-02-17 12:15:25 -08003416 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003417 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3418 * is about to be performed.
3419 * @hide
3420 */
3421 @SystemApi
3422 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3423 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3424 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3425
3426 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003427 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3428 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3429 *
3430 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3431 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003432 * @hide
3433 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003434 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003435 public static final String EXTRA_FORCE_MASTER_CLEAR =
3436 "android.intent.extra.FORCE_MASTER_CLEAR";
3437
3438 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003439 * A broadcast action to trigger a factory reset.
3440 *
3441 * <p> The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission.
3442 *
3443 * <p>Not for use by third-party applications.
3444 *
3445 * @see #EXTRA_FORCE_MASTER_CLEAR
3446 *
3447 * {@hide}
3448 */
3449 @SystemApi
3450 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3451 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3452
3453 /**
3454 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3455 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3456 *
3457 * <p>Not for use by third-party applications.
3458 *
3459 * @hide
3460 */
3461 @SystemApi
3462 public static final String EXTRA_FORCE_FACTORY_RESET =
3463 "android.intent.extra.FORCE_FACTORY_RESET";
3464
3465 /**
Michal Karpinski6135a262017-08-11 10:45:58 +01003466 * Broadcast action: report that a settings element is being restored from backup. The intent
3467 * contains four extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3468 * EXTRA_SETTING_NEW_VALUE is the value being restored, EXTRA_SETTING_PREVIOUS_VALUE
3469 * is the value of that settings entry prior to the restore operation, and
3470 * EXTRA_SETTING_RESTORED_FROM_SDK_INT is the version of the SDK that the setting has been
3471 * restored from (corresponds to {@link android.os.Build.VERSION#SDK_INT}). The first three
3472 * values are represented as strings, the fourth one as int.
Christopher Tate6597e342015-02-17 12:15:25 -08003473 *
3474 * <p>This broadcast is sent only for settings provider entries known to require special handling
3475 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3476 * the provider's backup agent implementation.
3477 *
3478 * @see #EXTRA_SETTING_NAME
3479 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3480 * @see #EXTRA_SETTING_NEW_VALUE
Michal Karpinski6135a262017-08-11 10:45:58 +01003481 * @see #EXTRA_SETTING_RESTORED_FROM_SDK_INT
Christopher Tate6597e342015-02-17 12:15:25 -08003482 * {@hide}
3483 */
3484 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3485
3486 /** {@hide} */
3487 public static final String EXTRA_SETTING_NAME = "setting_name";
3488 /** {@hide} */
3489 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3490 /** {@hide} */
3491 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
Michal Karpinski6135a262017-08-11 10:45:58 +01003492 /** {@hide} */
3493 public static final String EXTRA_SETTING_RESTORED_FROM_SDK_INT = "restored_from_sdk_int";
Christopher Tate6597e342015-02-17 12:15:25 -08003494
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003495 /**
3496 * Activity Action: Process a piece of text.
3497 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3498 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3499 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3500 */
3501 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3502 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003503
3504 /**
3505 * Broadcast Action: The sim card state has changed.
3506 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3507 * because TelephonyIntents is an internal class.
3508 * @hide
3509 */
3510 @SystemApi
3511 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3512 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3513
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003514 /**
fionaxu90fee272017-03-31 12:45:12 -07003515 * Broadcast Action: indicate that the phone service state has changed.
3516 * The intent will have the following extra values:</p>
3517 * <p>
3518 * @see #EXTRA_VOICE_REG_STATE
3519 * @see #EXTRA_DATA_REG_STATE
3520 * @see #EXTRA_VOICE_ROAMING_TYPE
3521 * @see #EXTRA_DATA_ROAMING_TYPE
3522 * @see #EXTRA_OPERATOR_ALPHA_LONG
3523 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3524 * @see #EXTRA_OPERATOR_NUMERIC
3525 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3526 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3527 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3528 * @see #EXTRA_MANUAL
3529 * @see #EXTRA_VOICE_RADIO_TECH
3530 * @see #EXTRA_DATA_RADIO_TECH
3531 * @see #EXTRA_CSS_INDICATOR
3532 * @see #EXTRA_NETWORK_ID
3533 * @see #EXTRA_SYSTEM_ID
3534 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3535 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3536 * @see #EXTRA_EMERGENCY_ONLY
3537 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3538 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3539 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3540 *
3541 * <p class="note">
3542 * Requires the READ_PHONE_STATE permission.
3543 *
3544 * <p class="note">This is a protected intent that can only be sent by the system.
3545 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003546 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003547 */
3548 @Deprecated
3549 @SystemApi
3550 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3551 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3552
3553 /**
3554 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3555 * state.
3556 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3557 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3558 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3559 * @see android.telephony.ServiceState#STATE_POWER_OFF
3560 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003561 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003562 */
3563 @Deprecated
3564 @SystemApi
3565 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3566
3567 /**
3568 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3569 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3570 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3571 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3572 * @see android.telephony.ServiceState#STATE_POWER_OFF
3573 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003574 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003575 */
3576 @Deprecated
3577 @SystemApi
3578 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3579
3580 /**
3581 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3582 * type.
3583 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003584 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003585 */
3586 @Deprecated
3587 @SystemApi
3588 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3589
3590 /**
3591 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3592 * type.
3593 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003594 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003595 */
3596 @Deprecated
3597 @SystemApi
3598 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3599
3600 /**
3601 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3602 * registered voice operator name in long alphanumeric format.
3603 * {@code null} if the operator name is not known or unregistered.
3604 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003605 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003606 */
3607 @Deprecated
3608 @SystemApi
3609 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3610
3611 /**
3612 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3613 * registered voice operator name in short alphanumeric format.
3614 * {@code null} if the operator name is not known or unregistered.
3615 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003616 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003617 */
3618 @Deprecated
3619 @SystemApi
3620 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3621
3622 /**
3623 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3624 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3625 * network.
3626 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003627 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003628 */
3629 @Deprecated
3630 @SystemApi
3631 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3632
3633 /**
3634 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3635 * registered data operator name in long alphanumeric format.
3636 * {@code null} if the operator name is not known or unregistered.
3637 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003638 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003639 */
3640 @Deprecated
3641 @SystemApi
3642 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3643
3644 /**
3645 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3646 * registered data operator name in short alphanumeric format.
3647 * {@code null} if the operator name is not known or unregistered.
3648 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003649 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003650 */
3651 @Deprecated
3652 @SystemApi
3653 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3654
3655 /**
3656 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3657 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3658 * data operator.
3659 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003660 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003661 */
3662 @Deprecated
3663 @SystemApi
3664 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3665
3666 /**
3667 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3668 * network selection mode is manual.
3669 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3670 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003671 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003672 */
3673 @Deprecated
3674 @SystemApi
3675 public static final String EXTRA_MANUAL = "manual";
3676
3677 /**
3678 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3679 * radio technology.
3680 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003681 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003682 */
3683 @Deprecated
3684 @SystemApi
3685 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3686
3687 /**
3688 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3689 * radio technology.
3690 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003691 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003692 */
3693 @Deprecated
3694 @SystemApi
3695 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3696
3697 /**
3698 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3699 * support on CDMA network.
3700 * Will be {@code true} if support, {@code false} otherwise.
3701 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003702 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003703 */
3704 @Deprecated
3705 @SystemApi
3706 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3707
3708 /**
3709 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3710 * id. {@code Integer.MAX_VALUE} if unknown.
3711 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003712 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003713 */
3714 @Deprecated
3715 @SystemApi
3716 public static final String EXTRA_NETWORK_ID = "networkId";
3717
3718 /**
3719 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3720 * {@code Integer.MAX_VALUE} if unknown.
3721 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003722 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003723 */
3724 @Deprecated
3725 @SystemApi
3726 public static final String EXTRA_SYSTEM_ID = "systemId";
3727
3728 /**
3729 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3730 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3731 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003732 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003733 */
3734 @Deprecated
3735 @SystemApi
3736 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3737
3738 /**
3739 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3740 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3741 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003742 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003743 */
3744 @Deprecated
3745 @SystemApi
3746 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3747
3748 /**
3749 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3750 * only mode.
3751 * {@code true} if in emergency only mode, {@code false} otherwise.
3752 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003753 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003754 */
3755 @Deprecated
3756 @SystemApi
3757 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3758
3759 /**
3760 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3761 * registration state is roaming.
3762 * {@code true} if registration indicates roaming, {@code false} otherwise
3763 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003764 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003765 */
3766 @Deprecated
3767 @SystemApi
3768 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
3769 "isDataRoamingFromRegistration";
3770
3771 /**
3772 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
3773 * aggregation is in use.
3774 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
3775 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003776 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003777 */
3778 @Deprecated
3779 @SystemApi
3780 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
3781
3782 /**
3783 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
3784 * is reduced from the rsrp threshold while calculating signal strength level.
3785 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003786 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003787 */
3788 @Deprecated
3789 @SystemApi
3790 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
3791
3792 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003793 * The name of the extra used to define the text to be processed, as a
3794 * CharSequence. Note that this may be a styled CharSequence, so you must use
3795 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003796 */
3797 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3798 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003799 * 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 +00003800 */
3801 public static final String EXTRA_PROCESS_TEXT_READONLY =
3802 "android.intent.extra.PROCESS_TEXT_READONLY";
3803
Bryce Leebc58f592015-09-25 16:43:01 -07003804 /**
3805 * Broadcast action: reports when a new thermal event has been reached. When the device
3806 * is reaching its maximum temperatue, the thermal level reported
3807 * {@hide}
3808 */
3809 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3810 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3811
3812 /** {@hide} */
3813 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3814
3815 /**
3816 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003817 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003818 * {@hide}
3819 */
3820 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3821
3822 /**
3823 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003824 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003825 * {@hide}
3826 */
3827 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3828
3829 /**
3830 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003831 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003832 * {@hide}
3833 */
3834 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3835
3836
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003837 // ---------------------------------------------------------------------
3838 // ---------------------------------------------------------------------
3839 // Standard intent categories (see addCategory()).
3840
3841 /**
3842 * Set if the activity should be an option for the default action
3843 * (center press) to perform on a piece of data. Setting this will
3844 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003845 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003846 * Intent when initiating an action -- it is for use in intent filters
3847 * specified in packages.
3848 */
3849 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3850 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3851 /**
3852 * Activities that can be safely invoked from a browser must support this
3853 * category. For example, if the user is viewing a web page or an e-mail
3854 * and clicks on a link in the text, the Intent generated execute that
3855 * link will require the BROWSABLE category, so that only activities
3856 * supporting this category will be considered as possible actions. By
3857 * supporting this category, you are promising that there is nothing
3858 * damaging (without user intervention) that can happen by invoking any
3859 * matching Intent.
3860 */
3861 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3862 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3863 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003864 * Categories for activities that can participate in voice interaction.
3865 * An activity that supports this category must be prepared to run with
3866 * no UI shown at all (though in some case it may have a UI shown), and
3867 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3868 */
3869 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3870 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3871 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003872 * Set if the activity should be considered as an alternative action to
3873 * the data the user is currently viewing. See also
3874 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3875 * applies to the selection in a list of items.
3876 *
3877 * <p>Supporting this category means that you would like your activity to be
3878 * displayed in the set of alternative things the user can do, usually as
3879 * part of the current activity's options menu. You will usually want to
3880 * include a specific label in the &lt;intent-filter&gt; of this action
3881 * describing to the user what it does.
3882 *
3883 * <p>The action of IntentFilter with this category is important in that it
3884 * describes the specific action the target will perform. This generally
3885 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3886 * a specific name such as "com.android.camera.action.CROP. Only one
3887 * alternative of any particular action will be shown to the user, so using
3888 * a specific action like this makes sure that your alternative will be
3889 * displayed while also allowing other applications to provide their own
3890 * overrides of that particular action.
3891 */
3892 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3893 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3894 /**
3895 * Set if the activity should be considered as an alternative selection
3896 * action to the data the user has currently selected. This is like
3897 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3898 * of items from which the user can select, giving them alternatives to the
3899 * default action that will be performed on it.
3900 */
3901 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3902 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3903 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003904 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003905 */
3906 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3907 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3908 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003909 * Should be displayed in the top-level launcher.
3910 */
3911 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3912 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3913 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003914 * Indicates an activity optimized for Leanback mode, and that should
3915 * be displayed in the Leanback launcher.
3916 */
3917 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3918 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3919 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003920 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3921 * @hide
3922 */
3923 @SystemApi
3924 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3925 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003926 * Provides information about the package it is in; typically used if
3927 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3928 * a front-door to the user without having to be shown in the all apps list.
3929 */
3930 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3931 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3932 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003933 * This is the home activity, that is the first activity that is displayed
3934 * when the device boots.
3935 */
3936 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3937 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3938 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003939 * This is the home activity that is displayed when the device is finished setting up and ready
3940 * for use.
3941 * @hide
3942 */
3943 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3944 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3945 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003946 * This is the setup wizard activity, that is the first activity that is displayed
3947 * when the user sets up the device for the first time.
3948 * @hide
3949 */
3950 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3951 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3952 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003953 * This activity is a preference panel.
3954 */
3955 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3956 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3957 /**
3958 * This activity is a development preference panel.
3959 */
3960 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3961 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3962 /**
3963 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003964 */
3965 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3966 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3967 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003968 * This activity allows the user to browse and download new applications.
3969 */
3970 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3971 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3972 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003973 * This activity may be exercised by the monkey or other automated test tools.
3974 */
3975 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3976 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3977 /**
3978 * To be used as a test (not part of the normal user experience).
3979 */
3980 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3981 /**
3982 * To be used as a unit test (run through the Test Harness).
3983 */
3984 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3985 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003986 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003987 * experience).
3988 */
3989 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003990
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003991 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003992 * Used to indicate that an intent only wants URIs that can be opened with
3993 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3994 * must support at least the columns defined in {@link OpenableColumns} when
3995 * queried.
3996 *
3997 * @see #ACTION_GET_CONTENT
3998 * @see #ACTION_OPEN_DOCUMENT
3999 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004000 */
4001 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4002 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
4003
4004 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09004005 * Used to indicate that an intent filter can accept files which are not necessarily
4006 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
4007 * at least streamable via
4008 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
4009 * using one of the stream types exposed via
4010 * {@link ContentResolver#getStreamTypes(Uri, String)}.
4011 *
4012 * @see #ACTION_SEND
4013 * @see #ACTION_SEND_MULTIPLE
4014 */
4015 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4016 public static final String CATEGORY_TYPED_OPENABLE =
4017 "android.intent.category.TYPED_OPENABLE";
4018
4019 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004020 * To be used as code under test for framework instrumentation tests.
4021 */
4022 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
4023 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04004024 /**
4025 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004026 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4027 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004028 */
4029 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4030 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
4031 /**
4032 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004033 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4034 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004035 */
4036 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4037 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004038 /**
4039 * An activity to run when device is inserted into a analog (low end) dock.
4040 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4041 * information, see {@link android.app.UiModeManager}.
4042 */
4043 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4044 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
4045
4046 /**
4047 * An activity to run when device is inserted into a digital (high end) dock.
4048 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4049 * information, see {@link android.app.UiModeManager}.
4050 */
4051 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4052 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004053
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004054 /**
4055 * Used to indicate that the activity can be used in a car environment.
4056 */
4057 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4058 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4059
Zak Cohendb6ca492017-01-26 14:09:00 -08004060 /**
4061 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4062 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4063 * information, see {@link android.app.UiModeManager}.
4064 */
4065 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4066 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004067 // ---------------------------------------------------------------------
4068 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004069 // Application launch intent categories (see addCategory()).
4070
4071 /**
4072 * Used with {@link #ACTION_MAIN} to launch the browser application.
4073 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004074 * <p>NOTE: This should not be used as the primary key of an Intent,
4075 * since it will not result in the app launching with the correct
4076 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004077 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004078 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004079 */
4080 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4081 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4082
4083 /**
4084 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4085 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004086 * <p>NOTE: This should not be used as the primary key of an Intent,
4087 * since it will not result in the app launching with the correct
4088 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004089 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004090 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004091 */
4092 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4093 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4094
4095 /**
4096 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4097 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004098 * <p>NOTE: This should not be used as the primary key of an Intent,
4099 * since it will not result in the app launching with the correct
4100 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004101 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004102 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004103 */
4104 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4105 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4106
4107 /**
4108 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4109 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004110 * <p>NOTE: This should not be used as the primary key of an Intent,
4111 * since it will not result in the app launching with the correct
4112 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004113 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004114 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004115 */
4116 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4117 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4118
4119 /**
4120 * Used with {@link #ACTION_MAIN} to launch the email application.
4121 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004122 * <p>NOTE: This should not be used as the primary key of an Intent,
4123 * since it will not result in the app launching with the correct
4124 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004125 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004126 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004127 */
4128 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4129 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4130
4131 /**
4132 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4133 * The activity should be able to view and manipulate image and video files
4134 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004135 * <p>NOTE: This should not be used as the primary key of an Intent,
4136 * since it will not result in the app launching with the correct
4137 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004138 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004139 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004140 */
4141 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4142 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4143
4144 /**
4145 * Used with {@link #ACTION_MAIN} to launch the maps application.
4146 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004147 * <p>NOTE: This should not be used as the primary key of an Intent,
4148 * since it will not result in the app launching with the correct
4149 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004150 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004151 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004152 */
4153 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4154 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4155
4156 /**
4157 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4158 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004159 * <p>NOTE: This should not be used as the primary key of an Intent,
4160 * since it will not result in the app launching with the correct
4161 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004162 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004163 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004164 */
4165 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4166 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4167
4168 /**
4169 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004170 * The activity should be able to play, browse, or manipulate music files
4171 * stored on the device.
4172 * <p>NOTE: This should not be used as the primary key of an Intent,
4173 * since it will not result in the app launching with the correct
4174 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004175 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004176 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004177 */
4178 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4179 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4180
4181 // ---------------------------------------------------------------------
4182 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004183 // Standard extra data keys.
4184
4185 /**
4186 * The initial data to place in a newly created record. Use with
4187 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4188 * fields as would be given to the underlying ContentProvider.insert()
4189 * call.
4190 */
4191 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4192
4193 /**
4194 * A constant CharSequence that is associated with the Intent, used with
4195 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4196 * this may be a styled CharSequence, so you must use
4197 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4198 * retrieve it.
4199 */
4200 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4201
4202 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004203 * A constant String that is associated with the Intent, used with
4204 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4205 * as HTML formatted text. Note that you <em>must</em> also supply
4206 * {@link #EXTRA_TEXT}.
4207 */
4208 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4209
4210 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004211 * A content: URI holding a stream of data associated with the Intent,
4212 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004213 */
4214 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4215
4216 /**
4217 * A String[] holding e-mail addresses that should be delivered to.
4218 */
4219 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4220
4221 /**
4222 * A String[] holding e-mail addresses that should be carbon copied.
4223 */
4224 public static final String EXTRA_CC = "android.intent.extra.CC";
4225
4226 /**
4227 * A String[] holding e-mail addresses that should be blind carbon copied.
4228 */
4229 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4230
4231 /**
4232 * A constant string holding the desired subject line of a message.
4233 */
4234 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4235
4236 /**
4237 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004238 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004239 */
4240 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4241
4242 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004243 * An int representing the user id to be used.
4244 *
4245 * @hide
4246 */
4247 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4248
4249 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004250 * An int representing the task id to be retrieved. This is used when a launch from recents is
4251 * intercepted by another action such as credentials confirmation to remember which task should
4252 * be resumed when complete.
4253 *
4254 * @hide
4255 */
4256 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4257
4258 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004259 * An Intent[] describing additional, alternate choices you would like shown with
4260 * {@link #ACTION_CHOOSER}.
4261 *
4262 * <p>An app may be capable of providing several different payload types to complete a
4263 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4264 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4265 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4266 * photo data or a hosted link where the photos can be viewed.</p>
4267 *
4268 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4269 * first/primary/preferred intent in the set. Additional intents specified in
4270 * this extra are ordered; by default intents that appear earlier in the array will be
4271 * preferred over intents that appear later in the array as matches for the same
4272 * target component. To alter this preference, a calling app may also supply
4273 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4274 */
4275 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4276
4277 /**
Adam Powell52c39212016-04-07 15:14:18 -07004278 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4279 * and omitted from a list of components presented to the user.
4280 *
4281 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4282 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4283 * from your own package or other apps from your organization if the idea of sending to those
4284 * targets would be redundant with other app functionality. Filtered components will not
4285 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4286 */
4287 public static final String EXTRA_EXCLUDE_COMPONENTS
4288 = "android.intent.extra.EXCLUDE_COMPONENTS";
4289
4290 /**
4291 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4292 * describing additional high-priority deep-link targets for the chooser to present to the user.
4293 *
4294 * <p>Targets provided in this way will be presented inline with all other targets provided
4295 * by services from other apps. They will be prioritized before other service targets, but
4296 * after those targets provided by sources that the user has manually pinned to the front.</p>
4297 *
4298 * @see #ACTION_CHOOSER
4299 */
4300 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4301
4302 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004303 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4304 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4305 *
4306 * <p>An app preparing an action for another app to complete may wish to allow the user to
4307 * disambiguate between several options for completing the action based on the chosen target
4308 * or otherwise refine the action before it is invoked.
4309 * </p>
4310 *
4311 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4312 * <ul>
4313 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4314 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4315 * chosen target beyond the first</li>
4316 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4317 * should fill in and send once the disambiguation is complete</li>
4318 * </ul>
4319 */
4320 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4321 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4322
4323 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004324 * An {@code ArrayList} of {@code String} annotations describing content for
4325 * {@link #ACTION_CHOOSER}.
4326 *
4327 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4328 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4329 *
4330 * <p>Annotations should describe the major components or topics of the content. It is up to
4331 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4332 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004333 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4334 * character. Performance on customized annotations can suffer, if they are rarely used for
4335 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4336 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004337 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004338 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004339 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004340 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004341 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004342 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004343 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004344 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004345 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004346 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4347 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4348 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4349 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4350 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004351 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004352 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4353 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004354 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004355 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004356 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004357 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004358 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004359 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004360 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004361 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004362 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004363 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004364 * Christmas and Thanksgiving.</li>
4365 * </ul>
4366 */
4367 public static final String EXTRA_CONTENT_ANNOTATIONS
4368 = "android.intent.extra.CONTENT_ANNOTATIONS";
4369
4370 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004371 * A {@link ResultReceiver} used to return data back to the sender.
4372 *
4373 * <p>Used to complete an app-specific
4374 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4375 *
4376 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4377 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4378 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4379 * when the user selects a target component from the chooser. It is up to the recipient
4380 * to send a result to this ResultReceiver to signal that disambiguation is complete
4381 * and that the chooser should invoke the user's choice.</p>
4382 *
4383 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4384 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4385 * to match and fill in the final Intent or ChooserTarget before starting it.
4386 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4387 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4388 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4389 *
4390 * <p>The result code passed to the ResultReceiver should be
4391 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4392 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4393 * the chooser should finish without starting a target.</p>
4394 */
4395 public static final String EXTRA_RESULT_RECEIVER
4396 = "android.intent.extra.RESULT_RECEIVER";
4397
4398 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004399 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004400 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004401 */
4402 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4403
4404 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004405 * A Parcelable[] of {@link Intent} or
4406 * {@link android.content.pm.LabeledIntent} objects as set with
4407 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4408 * a the front of the list of choices, when shown to the user with a
4409 * {@link #ACTION_CHOOSER}.
4410 */
4411 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4412
4413 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004414 * A {@link IntentSender} to start after ephemeral installation success.
4415 * @hide
4416 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004417 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4418
4419 /**
4420 * A {@link IntentSender} to start after ephemeral installation failure.
4421 * @hide
4422 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004423 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4424
4425 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004426 * The host name that triggered an ephemeral resolution.
4427 * @hide
4428 */
4429 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4430
4431 /**
4432 * An opaque token to track ephemeral resolution.
4433 * @hide
4434 */
4435 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4436
4437 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004438 * The version code of the app to install components from.
4439 * @hide
4440 */
4441 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4442
4443 /**
Chad Brubaker06068612017-04-06 09:43:47 -07004444 * The app that triggered the ephemeral installation.
4445 * @hide
4446 */
4447 public static final String EXTRA_CALLING_PACKAGE
4448 = "android.intent.extra.CALLING_PACKAGE";
4449
4450 /**
4451 * Optional calling app provided bundle containing additional launch information the
4452 * installer may use.
4453 * @hide
4454 */
4455 public static final String EXTRA_VERIFICATION_BUNDLE
4456 = "android.intent.extra.VERIFICATION_BUNDLE";
4457
4458 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004459 * A Bundle forming a mapping of potential target package names to different extras Bundles
4460 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4461 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4462 * be currently installed on the device.
4463 *
4464 * <p>An application may choose to provide alternate extras for the case where a user
4465 * selects an activity from a predetermined set of target packages. If the activity
4466 * the user selects from the chooser belongs to a package with its package name as
4467 * a key in this bundle, the corresponding extras for that package will be merged with
4468 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4469 * extra has the same key as an extra already present in the intent it will overwrite
4470 * the extra from the intent.</p>
4471 *
4472 * <p><em>Examples:</em>
4473 * <ul>
4474 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4475 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4476 * parameters for that target.</li>
4477 * <li>An application may offer additional metadata for known targets of a given intent
4478 * to pass along information only relevant to that target such as account or content
4479 * identifiers already known to that application.</li>
4480 * </ul></p>
4481 */
4482 public static final String EXTRA_REPLACEMENT_EXTRAS =
4483 "android.intent.extra.REPLACEMENT_EXTRAS";
4484
4485 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004486 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4487 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4488 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4489 * {@link ComponentName} of the chosen component.
4490 *
4491 * <p>In some situations this callback may never come, for example if the user abandons
4492 * the chooser, switches to another task or any number of other reasons. Apps should not
4493 * be written assuming that this callback will always occur.</p>
4494 */
4495 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4496 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4497
4498 /**
4499 * The {@link ComponentName} chosen by the user to complete an action.
4500 *
4501 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4502 */
4503 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4504
4505 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004506 * A {@link android.view.KeyEvent} object containing the event that
4507 * triggered the creation of the Intent it is in.
4508 */
4509 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4510
4511 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004512 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4513 * before shutting down.
4514 *
4515 * {@hide}
4516 */
4517 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4518
4519 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004520 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4521 * requested by the user.
4522 *
4523 * {@hide}
4524 */
4525 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4526 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4527
4528 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004529 * 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 -07004530 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4531 * of restarting the application.
4532 */
4533 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4534
4535 /**
4536 * A String holding the phone number originally entered in
4537 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4538 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4539 */
4540 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004541
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004542 /**
4543 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4544 * intents to supply the uid the package had been assigned. Also an optional
4545 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4546 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4547 * purpose.
4548 */
4549 public static final String EXTRA_UID = "android.intent.extra.UID";
4550
4551 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004552 * @hide String array of package names.
4553 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004554 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004555 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4556
4557 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004558 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4559 * intents to indicate whether this represents a full uninstall (removing
4560 * both the code and its data) or a partial uninstall (leaving its data,
4561 * implying that this is an update).
4562 */
4563 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004564
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004565 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004566 * @hide
4567 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4568 * intents to indicate that at this point the package has been removed for
4569 * all users on the device.
4570 */
4571 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4572 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4573
4574 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004575 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4576 * intents to indicate that this is a replacement of the package, so this
4577 * broadcast will immediately be followed by an add broadcast for a
4578 * different version of the same package.
4579 */
4580 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004581
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004582 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004583 * Used as an int extra field in {@link android.app.AlarmManager} intents
4584 * to tell the application being invoked how many pending alarms are being
4585 * delievered with the intent. For one-shot alarms this will always be 1.
4586 * For recurring alarms, this might be greater than 1 if the device was
4587 * asleep or powered off at the time an earlier alarm would have been
4588 * delivered.
4589 */
4590 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004591
Jacek Surazski86b6c532009-05-13 14:38:28 +02004592 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004593 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4594 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004595 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4596 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004597 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4598 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4599 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004600 */
4601 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4602
4603 /**
4604 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4605 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004606 */
4607 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4608
4609 /**
4610 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4611 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004612 */
4613 public static final int EXTRA_DOCK_STATE_DESK = 1;
4614
4615 /**
4616 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4617 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004618 */
4619 public static final int EXTRA_DOCK_STATE_CAR = 2;
4620
4621 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004622 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4623 * to represent that the phone is in a analog (low end) dock.
4624 */
4625 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4626
4627 /**
4628 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4629 * to represent that the phone is in a digital (high end) dock.
4630 */
4631 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4632
4633 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004634 * Boolean that can be supplied as meta-data with a dock activity, to
4635 * indicate that the dock should take over the home key when it is active.
4636 */
4637 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004638
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004639 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004640 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4641 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004642 */
4643 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4644
4645 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004646 * Used in the extra field in the remote intent. It's astring token passed with the
4647 * remote intent.
4648 */
4649 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4650 "android.intent.extra.remote_intent_token";
4651
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004652 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004653 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004654 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004655 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004656 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004657 "android.intent.extra.changed_component_name";
4658
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004659 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004660 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004661 * and contains a string array of all of the components that have changed. If
4662 * the state of the overall package has changed, then it will contain an entry
4663 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004664 */
4665 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4666 "android.intent.extra.changed_component_name_list";
4667
4668 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004669 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004670 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004671 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4672 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4673 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004674 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004675 */
4676 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4677 "android.intent.extra.changed_package_list";
4678
4679 /**
4680 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004681 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4682 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004683 * and contains an integer array of uids of all of the components
4684 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004685 */
4686 public static final String EXTRA_CHANGED_UID_LIST =
4687 "android.intent.extra.changed_uid_list";
4688
4689 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004690 * @hide
4691 * Magic extra system code can use when binding, to give a label for
4692 * who it is that has bound to a service. This is an integer giving
4693 * a framework string resource that can be displayed to the user.
4694 */
4695 public static final String EXTRA_CLIENT_LABEL =
4696 "android.intent.extra.client_label";
4697
4698 /**
4699 * @hide
4700 * Magic extra system code can use when binding, to give a PendingIntent object
4701 * that can be launched for the user to disable the system's use of this
4702 * service.
4703 */
4704 public static final String EXTRA_CLIENT_INTENT =
4705 "android.intent.extra.client_intent";
4706
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004707 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004708 * Extra used to indicate that an intent should only return data that is on
4709 * the local device. This is a boolean extra; the default is false. If true,
4710 * an implementation should only allow the user to select data that is
4711 * already on the device, not requiring it be downloaded from a remote
4712 * service when opened.
4713 *
4714 * @see #ACTION_GET_CONTENT
4715 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004716 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004717 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004718 */
4719 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004720 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004721
Amith Yamasani13593602012-03-22 16:16:17 -07004722 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004723 * Extra used to indicate that an intent can allow the user to select and
4724 * return multiple items. This is a boolean extra; the default is false. If
4725 * true, an implementation is allowed to present the user with a UI where
4726 * they can pick multiple items that are all returned to the caller. When
4727 * this happens, they should be returned as the {@link #getClipData()} part
4728 * of the result Intent.
4729 *
4730 * @see #ACTION_GET_CONTENT
4731 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004732 */
4733 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004734 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004735
4736 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004737 * The integer userHandle carried with broadcast intents related to addition, removal and
4738 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4739 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4740 *
Amith Yamasani13593602012-03-22 16:16:17 -07004741 * @hide
4742 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004743 public static final String EXTRA_USER_HANDLE =
4744 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004745
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004746 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004747 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4748 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4749 */
4750 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004751 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004752
4753 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004754 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004755 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4756 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004757 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004758 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4759
4760 /**
4761 * Extra sent in the intent to the BroadcastReceiver that handles
4762 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4763 * the restrictions as key/value pairs.
4764 */
4765 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4766 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004767
Amith Yamasani86118ba2013-03-28 14:33:16 -07004768 /**
4769 * Extra used in the response from a BroadcastReceiver that handles
4770 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4771 */
4772 public static final String EXTRA_RESTRICTIONS_INTENT =
4773 "android.intent.extra.restrictions_intent";
4774
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004775 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004776 * Extra used to communicate a set of acceptable MIME types. The type of the
4777 * extra is {@code String[]}. Values may be a combination of concrete MIME
4778 * types (such as "image/png") and/or partial MIME types (such as
4779 * "audio/*").
4780 *
4781 * @see #ACTION_GET_CONTENT
4782 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004783 */
4784 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4785
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004786 /**
4787 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4788 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004789 * When this is true, hardware devices can use this information to determine that
4790 * they shouldn't do a complete shutdown of their device since this is not a
4791 * complete shutdown down to the kernel, but only user space restarting.
4792 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004793 */
4794 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4795 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4796
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004797 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004798 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4799 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4800 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4801 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004802 *
4803 * @hide for internal use only.
4804 */
4805 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4806 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004807 /** @hide */
4808 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4809 /** @hide */
4810 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4811 /** @hide */
4812 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004813
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004814 /** {@hide} */
4815 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4816
qingxi240c2bb2017-04-12 17:31:18 -07004817 /**
4818 * {@hide}
4819 * This extra will be send together with {@link #ACTION_FACTORY_RESET}
4820 */
Rubin Xue8490f12015-06-25 12:17:48 +01004821 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4822
Santos Cordon15a13782015-03-31 18:32:31 -07004823 /**
qingxi240c2bb2017-04-12 17:31:18 -07004824 * {@hide}
4825 * This extra will be set to true when the user choose to wipe the data on eSIM during factory
4826 * reset for the device with eSIM. This extra will be sent together with
4827 * {@link #ACTION_FACTORY_RESET}
4828 */
4829 public static final String EXTRA_WIPE_ESIMS = "com.android.internal.intent.extra.WIPE_ESIMS";
4830
4831 /**
Santos Cordon15a13782015-03-31 18:32:31 -07004832 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4833 * activation request.
4834 * TODO: Add information about the structure and response data used with the pending intent.
4835 * @hide
4836 */
4837 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4838 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4839
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004840 /**
4841 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004842 *
4843 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07004844 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004845 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004846 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4847
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004848 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004849 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
4850 * such as opening in other apps, sharing, opening, editing, printing, deleting,
4851 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004852 *
4853 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07004854 * @see #ACTION_QUICK_VIEW
4855 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004856 */
Garfield Tance1d0e92017-03-23 10:52:48 -07004857 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004858 public static final String EXTRA_QUICK_VIEW_ADVANCED =
4859 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004860
4861 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07004862 * An optional extra of {@code String[]} indicating which quick view features should be made
4863 * available to the user in the quick view UI while handing a
4864 * {@link Intent#ACTION_QUICK_VIEW} intent.
4865 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
4866 * Quick viewer can implement features not listed below.
4867 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
4868 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DOWNLOAD},
4869 * {@link QuickViewConstants#FEATURE_SEND}, {@link QuickViewConstants#FEATURE_PRINT}.
4870 * <p>
4871 * Requirements:
4872 * <li>Quick viewer shouldn't show a feature if the feature is absent in
4873 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
4874 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
4875 * internal policies.
4876 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
4877 * requirement that the feature be shown. Quick viewer may, according to its own policies,
4878 * disable or hide features.
4879 *
4880 * @see #ACTION_QUICK_VIEW
4881 */
4882 public static final String EXTRA_QUICK_VIEW_FEATURES =
4883 "android.intent.extra.QUICK_VIEW_FEATURES";
4884
4885 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004886 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004887 * When a profile goes into quiet mode, all apps in the profile are killed and the
4888 * profile user is stopped. Widgets originating from the profile are masked, and app
4889 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004890 */
4891 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004892
4893 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004894 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004895 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004896 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4897 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004898 *
4899 * @hide
4900 */
4901 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4902 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4903
4904 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004905 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4906 * whether to show the chooser or not when there is only one application available
4907 * to choose from.
4908 *
4909 * @hide
4910 */
4911 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4912 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4913
4914 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004915 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004916 * to represent that a video codec is allowed to use.
4917 *
4918 * @hide
4919 */
4920 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4921
4922 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004923 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004924 * to represent that a audio codec is allowed to use.
4925 *
4926 * @hide
4927 */
4928 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4929
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004930 // ---------------------------------------------------------------------
4931 // ---------------------------------------------------------------------
4932 // Intent flags (see mFlags variable).
4933
Tor Norbyed9273d62013-05-30 15:59:53 -07004934 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06004935 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07004936 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4937 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004938 @Retention(RetentionPolicy.SOURCE)
4939 public @interface GrantUriMode {}
4940
Jeff Sharkey846318a2014-04-04 12:12:41 -07004941 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06004942 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07004943 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4944 @Retention(RetentionPolicy.SOURCE)
4945 public @interface AccessUriMode {}
4946
4947 /**
4948 * Test if given mode flags specify an access mode, which must be at least
4949 * read and/or write.
4950 *
4951 * @hide
4952 */
4953 public static boolean isAccessUriMode(int modeFlags) {
4954 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4955 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4956 }
4957
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06004958 /** @hide */
4959 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
4960 FLAG_GRANT_READ_URI_PERMISSION,
4961 FLAG_GRANT_WRITE_URI_PERMISSION,
4962 FLAG_FROM_BACKGROUND,
4963 FLAG_DEBUG_LOG_RESOLUTION,
4964 FLAG_EXCLUDE_STOPPED_PACKAGES,
4965 FLAG_INCLUDE_STOPPED_PACKAGES,
4966 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
4967 FLAG_GRANT_PREFIX_URI_PERMISSION,
4968 FLAG_DEBUG_TRIAGED_MISSING,
4969 FLAG_IGNORE_EPHEMERAL,
4970 FLAG_ACTIVITY_NO_HISTORY,
4971 FLAG_ACTIVITY_SINGLE_TOP,
4972 FLAG_ACTIVITY_NEW_TASK,
4973 FLAG_ACTIVITY_MULTIPLE_TASK,
4974 FLAG_ACTIVITY_CLEAR_TOP,
4975 FLAG_ACTIVITY_FORWARD_RESULT,
4976 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
4977 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
4978 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
4979 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
4980 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
4981 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
4982 FLAG_ACTIVITY_NEW_DOCUMENT,
4983 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
4984 FLAG_ACTIVITY_NO_USER_ACTION,
4985 FLAG_ACTIVITY_REORDER_TO_FRONT,
4986 FLAG_ACTIVITY_NO_ANIMATION,
4987 FLAG_ACTIVITY_CLEAR_TASK,
4988 FLAG_ACTIVITY_TASK_ON_HOME,
4989 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
4990 FLAG_ACTIVITY_LAUNCH_ADJACENT,
4991 FLAG_RECEIVER_REGISTERED_ONLY,
4992 FLAG_RECEIVER_REPLACE_PENDING,
4993 FLAG_RECEIVER_FOREGROUND,
4994 FLAG_RECEIVER_NO_ABORT,
4995 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
4996 FLAG_RECEIVER_BOOT_UPGRADE,
4997 FLAG_RECEIVER_INCLUDE_BACKGROUND,
4998 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
4999 FLAG_RECEIVER_FROM_SHELL,
5000 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5001 })
5002 @Retention(RetentionPolicy.SOURCE)
5003 public @interface Flags {}
5004
5005 /** @hide */
5006 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5007 FLAG_FROM_BACKGROUND,
5008 FLAG_DEBUG_LOG_RESOLUTION,
5009 FLAG_EXCLUDE_STOPPED_PACKAGES,
5010 FLAG_INCLUDE_STOPPED_PACKAGES,
5011 FLAG_DEBUG_TRIAGED_MISSING,
5012 FLAG_IGNORE_EPHEMERAL,
5013 FLAG_ACTIVITY_NO_HISTORY,
5014 FLAG_ACTIVITY_SINGLE_TOP,
5015 FLAG_ACTIVITY_NEW_TASK,
5016 FLAG_ACTIVITY_MULTIPLE_TASK,
5017 FLAG_ACTIVITY_CLEAR_TOP,
5018 FLAG_ACTIVITY_FORWARD_RESULT,
5019 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5020 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5021 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5022 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5023 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5024 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5025 FLAG_ACTIVITY_NEW_DOCUMENT,
5026 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5027 FLAG_ACTIVITY_NO_USER_ACTION,
5028 FLAG_ACTIVITY_REORDER_TO_FRONT,
5029 FLAG_ACTIVITY_NO_ANIMATION,
5030 FLAG_ACTIVITY_CLEAR_TASK,
5031 FLAG_ACTIVITY_TASK_ON_HOME,
5032 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5033 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5034 FLAG_RECEIVER_REGISTERED_ONLY,
5035 FLAG_RECEIVER_REPLACE_PENDING,
5036 FLAG_RECEIVER_FOREGROUND,
5037 FLAG_RECEIVER_NO_ABORT,
5038 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5039 FLAG_RECEIVER_BOOT_UPGRADE,
5040 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5041 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5042 FLAG_RECEIVER_FROM_SHELL,
5043 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5044 })
5045 @Retention(RetentionPolicy.SOURCE)
5046 public @interface MutableFlags {}
5047
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005048 /**
5049 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005050 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005051 * specified in its ClipData. When applying to an Intent's ClipData,
5052 * all URIs as well as recursive traversals through data or other ClipData
5053 * in Intent items will be granted; only the grant flags of the top-level
5054 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005055 */
5056 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5057 /**
5058 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005059 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005060 * specified in its ClipData. When applying to an Intent's ClipData,
5061 * all URIs as well as recursive traversals through data or other ClipData
5062 * in Intent items will be granted; only the grant flags of the top-level
5063 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005064 */
5065 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5066 /**
5067 * Can be set by the caller to indicate that this Intent is coming from
5068 * a background operation, not from direct user interaction.
5069 */
5070 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5071 /**
5072 * A flag you can enable for debugging: when set, log messages will be
5073 * printed during the resolution of this intent to show you what has
5074 * been found to create the final resolved list.
5075 */
5076 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005077 /**
5078 * If set, this intent will not match any components in packages that
5079 * are currently stopped. If this is not set, then the default behavior
5080 * is to include such applications in the result.
5081 */
5082 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5083 /**
5084 * If set, this intent will always match any components in packages that
5085 * are currently stopped. This is the default behavior when
5086 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5087 * flags are set, this one wins (it allows overriding of exclude for
5088 * places where the framework may automatically set the exclude flag).
5089 */
5090 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005091
5092 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005093 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005094 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005095 * persisted across device reboots until explicitly revoked with
5096 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5097 * grant for possible persisting; the receiving application must call
5098 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5099 * actually persist.
5100 *
5101 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5102 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5103 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005104 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005105 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005106 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005107
5108 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005109 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5110 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5111 * applies to any URI that is a prefix match against the original granted
5112 * URI. (Without this flag, the URI must match exactly for access to be
5113 * granted.) Another URI is considered a prefix match only when scheme,
5114 * authority, and all path segments defined by the prefix are an exact
5115 * match.
5116 */
5117 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5118
5119 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005120 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005121 * homework and verified that they correctly handle packages and components
5122 * that come and go over time. In particular:
5123 * <ul>
5124 * <li>Apps installed on external storage, which will appear to be
5125 * uninstalled while the the device is ejected.
5126 * <li>Apps with encryption unaware components, which will appear to not
5127 * exist while the device is locked.
5128 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005129 *
5130 * @hide
5131 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005132 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005133
5134 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005135 * Internal flag used to indicate ephemeral applications should not be
5136 * considered when resolving the intent.
5137 *
5138 * @hide
5139 */
5140 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5141
5142 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005143 * If set, the new activity is not kept in the history stack. As soon as
5144 * the user navigates away from it, the activity is finished. This may also
5145 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5146 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005147 *
5148 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5149 * is never invoked when the current activity starts a new activity which
5150 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005151 */
5152 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5153 /**
5154 * If set, the activity will not be launched if it is already running
5155 * at the top of the history stack.
5156 */
5157 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5158 /**
5159 * If set, this activity will become the start of a new task on this
5160 * history stack. A task (from the activity that started it to the
5161 * next task activity) defines an atomic group of activities that the
5162 * user can move to. Tasks can be moved to the foreground and background;
5163 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005164 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005165 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5166 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005167 *
5168 * <p>This flag is generally used by activities that want
5169 * to present a "launcher" style behavior: they give the user a list of
5170 * separate things that can be done, which otherwise run completely
5171 * independently of the activity launching them.
5172 *
5173 * <p>When using this flag, if a task is already running for the activity
5174 * you are now starting, then a new activity will not be started; instead,
5175 * the current task will simply be brought to the front of the screen with
5176 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5177 * to disable this behavior.
5178 *
5179 * <p>This flag can not be used when the caller is requesting a result from
5180 * the activity being launched.
5181 */
5182 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5183 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005184 * This flag is used to create a new task and launch an activity into it.
5185 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5186 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5187 * search through existing tasks for ones matching this Intent. Only if no such
5188 * task is found would a new task be created. When paired with
5189 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5190 * the search for a matching task and unconditionally start a new task.
5191 *
5192 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5193 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005194 * top-level application launcher.</strong> Used in conjunction with
5195 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5196 * behavior of bringing an existing task to the foreground. When set,
5197 * a new task is <em>always</em> started to host the Activity for the
5198 * Intent, regardless of whether there is already an existing task running
5199 * the same thing.
5200 *
5201 * <p><strong>Because the default system does not include graphical task management,
5202 * you should not use this flag unless you provide some way for a user to
5203 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005204 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005205 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5206 * creating new document tasks.
5207 *
5208 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005209 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005210 *
Scott Main7aee61f2011-02-08 11:25:01 -08005211 * <p>See
5212 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5213 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005214 *
5215 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5216 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005217 */
5218 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5219 /**
5220 * If set, and the activity being launched is already running in the
5221 * current task, then instead of launching a new instance of that activity,
5222 * all of the other activities on top of it will be closed and this Intent
5223 * will be delivered to the (now on top) old activity as a new Intent.
5224 *
5225 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5226 * If D calls startActivity() with an Intent that resolves to the component
5227 * of activity B, then C and D will be finished and B receive the given
5228 * Intent, resulting in the stack now being: A, B.
5229 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005230 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005231 * either receive the new intent you are starting here in its
5232 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005233 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005234 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5235 * the same intent, then it will be finished and re-created; for all other
5236 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5237 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005238 *
5239 * <p>This launch mode can also be used to good effect in conjunction with
5240 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5241 * of a task, it will bring any currently running instance of that task
5242 * to the foreground, and then clear it to its root state. This is
5243 * especially useful, for example, when launching an activity from the
5244 * notification manager.
5245 *
Scott Main7aee61f2011-02-08 11:25:01 -08005246 * <p>See
5247 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5248 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005249 */
5250 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5251 /**
5252 * If set and this intent is being used to launch a new activity from an
5253 * existing one, then the reply target of the existing activity will be
5254 * transfered to the new activity. This way the new activity can call
5255 * {@link android.app.Activity#setResult} and have that result sent back to
5256 * the reply target of the original activity.
5257 */
5258 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5259 /**
5260 * If set and this intent is being used to launch a new activity from an
5261 * existing one, the current activity will not be counted as the top
5262 * activity for deciding whether the new intent should be delivered to
5263 * the top instead of starting a new one. The previous activity will
5264 * be used as the top, with the assumption being that the current activity
5265 * will finish itself immediately.
5266 */
5267 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5268 /**
5269 * If set, the new activity is not kept in the list of recently launched
5270 * activities.
5271 */
5272 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5273 /**
5274 * This flag is not normally set by application code, but set for you by
5275 * the system as described in the
5276 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5277 * launchMode} documentation for the singleTask mode.
5278 */
5279 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5280 /**
5281 * If set, and this activity is either being started in a new task or
5282 * bringing to the top an existing task, then it will be launched as
5283 * the front door of the task. This will result in the application of
5284 * any affinities needed to have that task in the proper state (either
5285 * moving activities to or from it), or simply resetting that task to
5286 * its initial state if needed.
5287 */
5288 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5289 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005290 * This flag is not normally set by application code, but set for you by
5291 * the system if this activity is being launched from history
5292 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005293 */
5294 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005295 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005296 * @deprecated As of API 21 this performs identically to
5297 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005298 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005299 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005300 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005301 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005302 * This flag is used to open a document into a new task rooted at the activity launched
5303 * by this Intent. Through the use of this flag, or its equivalent attribute,
5304 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005305 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005306 *
Craig Mautner026596b2014-05-21 15:35:44 -07005307 * <p>The use of the activity attribute form of this,
5308 * {@link android.R.attr#documentLaunchMode}, is
5309 * preferred over the Intent flag described here. The attribute form allows the
5310 * Activity to specify multiple document behavior for all launchers of the Activity
5311 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005312 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005313 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5314 * it is kept after the activity is finished is different than the use of
5315 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5316 * this flag is being used to create a new recents entry, then by default that entry
5317 * will be removed once the activity is finished. You can modify this behavior with
5318 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5319 *
Craig Mautner026596b2014-05-21 15:35:44 -07005320 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5321 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5322 * equivalent of the Activity manifest specifying {@link
5323 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5324 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5325 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005326 *
Craig Mautner026596b2014-05-21 15:35:44 -07005327 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005328 *
Craig Mautner026596b2014-05-21 15:35:44 -07005329 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005330 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5331 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005332 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005333 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005334 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005335 * callback from occurring on the current frontmost activity before it is
5336 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005337 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005338 * <p>Typically, an activity can rely on that callback to indicate that an
5339 * explicit user action has caused their activity to be moved out of the
5340 * foreground. The callback marks an appropriate point in the activity's
5341 * lifecycle for it to dismiss any notifications that it intends to display
5342 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005343 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005344 * <p>If an activity is ever started via any non-user-driven events such as
5345 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5346 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005347 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005348 */
5349 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005350 /**
5351 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5352 * this flag will cause the launched activity to be brought to the front of its
5353 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005354 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005355 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5356 * If D calls startActivity() with an Intent that resolves to the component
5357 * of activity B, then B will be brought to the front of the history stack,
5358 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005359 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005360 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005361 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005362 */
5363 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005364 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005365 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5366 * this flag will prevent the system from applying an activity transition
5367 * animation to go to the next activity state. This doesn't mean an
5368 * animation will never run -- if another activity change happens that doesn't
5369 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005370 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005371 * when you are going to do a series of activity operations but the
5372 * animation seen by the user shouldn't be driven by the first activity
5373 * change but rather a later one.
5374 */
5375 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5376 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005377 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5378 * this flag will cause any existing task that would be associated with the
5379 * activity to be cleared before the activity is started. That is, the activity
5380 * becomes the new root of an otherwise empty task, and any old activities
5381 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5382 */
5383 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5384 /**
5385 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5386 * this flag will cause a newly launching task to be placed on top of the current
5387 * home activity task (if there is one). That is, pressing back from the task
5388 * will always return the user to home even if that was not the last activity they
5389 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5390 */
5391 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5392 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005393 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5394 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005395 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005396 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005397 * this flag. When set and the task's activity is finished, the recents
5398 * entry will remain in the interface for the user to re-launch it, like a
5399 * recents entry for a top-level application.
5400 * <p>
5401 * The receiving activity can override this request with
5402 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5403 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005404 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005405 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005406 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005407
5408 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005409 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5410 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005411 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5412 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005413 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005414 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005415
5416 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005417 * If set, when sending a broadcast only registered receivers will be
5418 * called -- no BroadcastReceiver components will be launched.
5419 */
5420 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005421 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005422 * If set, when sending a broadcast the new broadcast will replace
5423 * any existing pending broadcast that matches it. Matching is defined
5424 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5425 * true for the intents of the two broadcasts. When a match is found,
5426 * the new broadcast (and receivers associated with it) will replace the
5427 * existing one in the pending broadcast list, remaining at the same
5428 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005429 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005430 * <p>This flag is most typically used with sticky broadcasts, which
5431 * only care about delivering the most recent values of the broadcast
5432 * to their receivers.
5433 */
5434 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5435 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005436 * If set, when sending a broadcast the recipient is allowed to run at
5437 * foreground priority, with a shorter timeout interval. During normal
5438 * broadcasts the receivers are not automatically hoisted out of the
5439 * background priority class.
5440 */
5441 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5442 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005443 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5444 * They can still propagate results through to later receivers, but they can not prevent
5445 * later receivers from seeing the broadcast.
5446 */
5447 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5448 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005449 * If set, when sending a broadcast <i>before boot has completed</i> only
5450 * registered receivers will be called -- no BroadcastReceiver components
5451 * will be launched. Sticky intent state will be recorded properly even
5452 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5453 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005454 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005455 * <p>This flag is only for use by system sevices as a convenience to
5456 * avoid having to implement a more complex mechanism around detection
5457 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005458 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005459 * @hide
5460 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005461 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005462 /**
5463 * Set when this broadcast is for a boot upgrade, a special mode that
5464 * allows the broadcast to be sent before the system is ready and launches
5465 * the app process with no providers running in it.
5466 * @hide
5467 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005468 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005469 /**
5470 * If set, the broadcast will always go to manifest receivers in background (cached
5471 * or not running) apps, regardless of whether that would be done by default. By
5472 * default they will only receive broadcasts if the broadcast has specified an
5473 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005474 *
5475 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5476 * the broadcast code there must also be changed to match.
5477 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005478 * @hide
5479 */
5480 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5481 /**
5482 * If set, the broadcast will never go to manifest receivers in background (cached
5483 * or not running) apps, regardless of whether that would be done by default. By
5484 * default they will receive broadcasts if the broadcast has specified an
5485 * explicit component or package name.
5486 * @hide
5487 */
5488 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005489 /**
5490 * If set, this broadcast is being sent from the shell.
5491 * @hide
5492 */
5493 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005494
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005495 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005496 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5497 * will not receive broadcasts.
5498 *
5499 * <em>This flag has no effect when used by an Instant App.</em>
5500 */
5501 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5502
5503 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005504 * @hide Flags that can't be changed with PendingIntent.
5505 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005506 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5507 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5508 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005509
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005510 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005511 // ---------------------------------------------------------------------
5512 // toUri() and parseUri() options.
5513
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005514 /** @hide */
5515 @IntDef(flag = true, prefix = { "URI_" }, value = {
5516 URI_ALLOW_UNSAFE,
5517 URI_ANDROID_APP_SCHEME,
5518 URI_INTENT_SCHEME,
5519 })
5520 @Retention(RetentionPolicy.SOURCE)
5521 public @interface UriFlags {}
5522
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005523 /**
5524 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5525 * always has the "intent:" scheme. This syntax can be used when you want
5526 * to later disambiguate between URIs that are intended to describe an
5527 * Intent vs. all others that should be treated as raw URIs. When used
5528 * with {@link #parseUri}, any other scheme will result in a generic
5529 * VIEW action for that raw URI.
5530 */
5531 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005532
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005533 /**
5534 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5535 * always has the "android-app:" scheme. This is a variation of
5536 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5537 * http/https URI being delivered to a specific package name. The format
5538 * is:
5539 *
5540 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005541 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005542 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005543 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5544 * you must also include a scheme; including a path also requires both a host and a scheme.
5545 * The final #Intent; fragment can be used without a scheme, host, or path.
5546 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005547 * used with intents that have a {@link #setSelector}, since the base intent
5548 * will always have an explicit package name.</p>
5549 *
5550 * <p>Some examples of how this scheme maps to Intent objects:</p>
5551 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5552 * <colgroup align="left" />
5553 * <colgroup align="left" />
5554 * <thead>
5555 * <tr><th>URI</th> <th>Intent</th></tr>
5556 * </thead>
5557 *
5558 * <tbody>
5559 * <tr><td><code>android-app://com.example.app</code></td>
5560 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5561 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5562 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5563 * </table></td>
5564 * </tr>
5565 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5566 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5567 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5568 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5569 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5570 * </table></td>
5571 * </tr>
5572 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5573 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5574 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5575 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5576 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5577 * </table></td>
5578 * </tr>
5579 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5580 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5581 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5582 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5583 * </table></td>
5584 * </tr>
5585 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5586 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5587 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5588 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5589 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5590 * </table></td>
5591 * </tr>
5592 * <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>
5593 * <td><table border="" style="margin:0" >
5594 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5595 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5596 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5597 * </table></td>
5598 * </tr>
5599 * </tbody>
5600 * </table>
5601 */
5602 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5603
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005604 /**
5605 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5606 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5607 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5608 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5609 * generated Intent can not cause unexpected data access to happen.
5610 *
5611 * <p>If you do not trust the source of the URI being parsed, you should still do further
5612 * processing to protect yourself from it. In particular, when using it to start an
5613 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5614 * that can handle it.</p>
5615 */
5616 public static final int URI_ALLOW_UNSAFE = 1<<2;
5617
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005618 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005619
5620 private String mAction;
5621 private Uri mData;
5622 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005623 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005624 private ComponentName mComponent;
5625 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005626 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005627 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005628 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005629 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005630 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005631 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005632 /** Token to track instant app launches. Local only; do not copy cross-process. */
5633 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005634
5635 // ---------------------------------------------------------------------
5636
Makoto Onuki97f82f22017-05-31 16:20:21 -07005637 private static final int COPY_MODE_ALL = 0;
5638 private static final int COPY_MODE_FILTER = 1;
5639 private static final int COPY_MODE_HISTORY = 2;
5640
5641 /** @hide */
5642 @IntDef(value = {COPY_MODE_ALL, COPY_MODE_FILTER, COPY_MODE_HISTORY})
5643 @Retention(RetentionPolicy.SOURCE)
5644 public @interface CopyMode {}
5645
5646
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005647 /**
5648 * Create an empty intent.
5649 */
5650 public Intent() {
5651 }
5652
5653 /**
5654 * Copy constructor.
5655 */
5656 public Intent(Intent o) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005657 this(o, COPY_MODE_ALL);
5658 }
5659
5660 private Intent(Intent o, @CopyMode int copyMode) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005661 this.mAction = o.mAction;
5662 this.mData = o.mData;
5663 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005664 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005665 this.mComponent = o.mComponent;
Makoto Onuki97f82f22017-05-31 16:20:21 -07005666
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005667 if (o.mCategories != null) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005668 this.mCategories = new ArraySet<>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005669 }
Makoto Onuki97f82f22017-05-31 16:20:21 -07005670
5671 if (copyMode != COPY_MODE_FILTER) {
5672 this.mFlags = o.mFlags;
5673 this.mContentUserHint = o.mContentUserHint;
5674 this.mLaunchToken = o.mLaunchToken;
5675 if (o.mSourceBounds != null) {
5676 this.mSourceBounds = new Rect(o.mSourceBounds);
5677 }
5678 if (o.mSelector != null) {
5679 this.mSelector = new Intent(o.mSelector);
5680 }
5681
5682 if (copyMode != COPY_MODE_HISTORY) {
5683 if (o.mExtras != null) {
5684 this.mExtras = new Bundle(o.mExtras);
5685 }
5686 if (o.mClipData != null) {
5687 this.mClipData = new ClipData(o.mClipData);
5688 }
5689 } else {
5690 if (o.mExtras != null && !o.mExtras.maybeIsEmpty()) {
5691 this.mExtras = Bundle.STRIPPED;
5692 }
5693
5694 // Also set "stripped" clip data when we ever log mClipData in the (broadcast)
5695 // history.
5696 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005697 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005698 }
5699
5700 @Override
5701 public Object clone() {
5702 return new Intent(this);
5703 }
5704
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005705 /**
5706 * Make a clone of only the parts of the Intent that are relevant for
5707 * filter matching: the action, data, type, component, and categories.
5708 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005709 public @NonNull Intent cloneFilter() {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005710 return new Intent(this, COPY_MODE_FILTER);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005711 }
5712
5713 /**
5714 * Create an intent with a given action. All other fields (data, type,
5715 * class) are null. Note that the action <em>must</em> be in a
5716 * namespace because Intents are used globally in the system -- for
5717 * example the system VIEW action is android.intent.action.VIEW; an
5718 * application's custom action would be something like
5719 * com.google.app.myapp.CUSTOM_ACTION.
5720 *
5721 * @param action The Intent action, such as ACTION_VIEW.
5722 */
5723 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005724 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005725 }
5726
5727 /**
5728 * Create an intent with a given action and for a given data url. Note
5729 * that the action <em>must</em> be in a namespace because Intents are
5730 * used globally in the system -- for example the system VIEW action is
5731 * android.intent.action.VIEW; an application's custom action would be
5732 * something like com.google.app.myapp.CUSTOM_ACTION.
5733 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005734 * <p><em>Note: scheme and host name matching in the Android framework is
5735 * case-sensitive, unlike the formal RFC. As a result,
5736 * you should always ensure that you write your Uri with these elements
5737 * using lower case letters, and normalize any Uris you receive from
5738 * outside of Android to ensure the scheme and host is lower case.</em></p>
5739 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005740 * @param action The Intent action, such as ACTION_VIEW.
5741 * @param uri The Intent data URI.
5742 */
5743 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005744 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005745 mData = uri;
5746 }
5747
5748 /**
5749 * Create an intent for a specific component. All other fields (action, data,
5750 * type, class) are null, though they can be modified later with explicit
5751 * calls. This provides a convenient way to create an intent that is
5752 * intended to execute a hard-coded class name, rather than relying on the
5753 * system to find an appropriate class for you; see {@link #setComponent}
5754 * for more information on the repercussions of this.
5755 *
5756 * @param packageContext A Context of the application package implementing
5757 * this class.
5758 * @param cls The component class that is to be used for the intent.
5759 *
5760 * @see #setClass
5761 * @see #setComponent
5762 * @see #Intent(String, android.net.Uri , Context, Class)
5763 */
5764 public Intent(Context packageContext, Class<?> cls) {
5765 mComponent = new ComponentName(packageContext, cls);
5766 }
5767
5768 /**
5769 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005770 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005771 * construct the Intent and then calling {@link #setClass} to set its
5772 * class.
5773 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005774 * <p><em>Note: scheme and host name matching in the Android framework is
5775 * case-sensitive, unlike the formal RFC. As a result,
5776 * you should always ensure that you write your Uri with these elements
5777 * using lower case letters, and normalize any Uris you receive from
5778 * outside of Android to ensure the scheme and host is lower case.</em></p>
5779 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005780 * @param action The Intent action, such as ACTION_VIEW.
5781 * @param uri The Intent data URI.
5782 * @param packageContext A Context of the application package implementing
5783 * this class.
5784 * @param cls The component class that is to be used for the intent.
5785 *
5786 * @see #Intent(String, android.net.Uri)
5787 * @see #Intent(Context, Class)
5788 * @see #setClass
5789 * @see #setComponent
5790 */
5791 public Intent(String action, Uri uri,
5792 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005793 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005794 mData = uri;
5795 mComponent = new ComponentName(packageContext, cls);
5796 }
5797
5798 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005799 * Create an intent to launch the main (root) activity of a task. This
5800 * is the Intent that is started when the application's is launched from
5801 * Home. For anything else that wants to launch an application in the
5802 * same way, it is important that they use an Intent structured the same
5803 * way, and can use this function to ensure this is the case.
5804 *
5805 * <p>The returned Intent has the given Activity component as its explicit
5806 * component, {@link #ACTION_MAIN} as its action, and includes the
5807 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5808 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5809 * to do that through {@link #addFlags(int)} on the returned Intent.
5810 *
5811 * @param mainActivity The main activity component that this Intent will
5812 * launch.
5813 * @return Returns a newly created Intent that can be used to launch the
5814 * activity as a main application entry.
5815 *
5816 * @see #setClass
5817 * @see #setComponent
5818 */
5819 public static Intent makeMainActivity(ComponentName mainActivity) {
5820 Intent intent = new Intent(ACTION_MAIN);
5821 intent.setComponent(mainActivity);
5822 intent.addCategory(CATEGORY_LAUNCHER);
5823 return intent;
5824 }
5825
5826 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005827 * Make an Intent for the main activity of an application, without
5828 * specifying a specific activity to run but giving a selector to find
5829 * the activity. This results in a final Intent that is structured
5830 * the same as when the application is launched from
5831 * Home. For anything else that wants to launch an application in the
5832 * same way, it is important that they use an Intent structured the same
5833 * way, and can use this function to ensure this is the case.
5834 *
5835 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5836 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5837 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5838 * to do that through {@link #addFlags(int)} on the returned Intent.
5839 *
5840 * @param selectorAction The action name of the Intent's selector.
5841 * @param selectorCategory The name of a category to add to the Intent's
5842 * selector.
5843 * @return Returns a newly created Intent that can be used to launch the
5844 * activity as a main application entry.
5845 *
5846 * @see #setSelector(Intent)
5847 */
5848 public static Intent makeMainSelectorActivity(String selectorAction,
5849 String selectorCategory) {
5850 Intent intent = new Intent(ACTION_MAIN);
5851 intent.addCategory(CATEGORY_LAUNCHER);
5852 Intent selector = new Intent();
5853 selector.setAction(selectorAction);
5854 selector.addCategory(selectorCategory);
5855 intent.setSelector(selector);
5856 return intent;
5857 }
5858
5859 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005860 * Make an Intent that can be used to re-launch an application's task
5861 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5862 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5863 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5864 *
5865 * @param mainActivity The activity component that is the root of the
5866 * task; this is the activity that has been published in the application's
5867 * manifest as the main launcher icon.
5868 *
5869 * @return Returns a newly created Intent that can be used to relaunch the
5870 * activity's task in its root state.
5871 */
5872 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5873 Intent intent = makeMainActivity(mainActivity);
5874 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5875 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5876 return intent;
5877 }
5878
5879 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005880 * Call {@link #parseUri} with 0 flags.
5881 * @deprecated Use {@link #parseUri} instead.
5882 */
5883 @Deprecated
5884 public static Intent getIntent(String uri) throws URISyntaxException {
5885 return parseUri(uri, 0);
5886 }
Tom Taylord4a47292009-12-21 13:59:18 -08005887
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005888 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005889 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005890 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005891 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005892 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005893 *
5894 * <p>The URI given here must not be relative -- that is, it must include
5895 * the scheme and full path.
5896 *
5897 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005898 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005899 *
5900 * @return Intent The newly created Intent object.
5901 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005902 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5903 * it bad (as parsed by the Uri class) or the Intent data within the
5904 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005905 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005906 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005907 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005908 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005909 int i = 0;
5910 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005911 final boolean androidApp = uri.startsWith("android-app:");
5912
5913 // Validate intent scheme if requested.
5914 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5915 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005916 Intent intent = new Intent(ACTION_VIEW);
5917 try {
5918 intent.setData(Uri.parse(uri));
5919 } catch (IllegalArgumentException e) {
5920 throw new URISyntaxException(uri, e.getMessage());
5921 }
5922 return intent;
5923 }
5924 }
Tom Taylord4a47292009-12-21 13:59:18 -08005925
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005926 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005927 // simple case
5928 if (i == -1) {
5929 if (!androidApp) {
5930 return new Intent(ACTION_VIEW, Uri.parse(uri));
5931 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005932
5933 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005934 } else if (!uri.startsWith("#Intent;", i)) {
5935 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005936 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005937 } else {
5938 i = -1;
5939 }
5940 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005941
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005942 // new format
5943 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005944 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005945 boolean explicitAction = false;
5946 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005947
5948 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005949 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005950 String data;
5951 if (i >= 0) {
5952 data = uri.substring(0, i);
5953 i += 8; // length of "#Intent;"
5954 } else {
5955 data = uri;
5956 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005957
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005958 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005959 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005960 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005961 if (eq < 0) eq = i-1;
5962 int semi = uri.indexOf(';', i);
5963 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005964
5965 // action
5966 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005967 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005968 if (!inSelector) {
5969 explicitAction = true;
5970 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005971 }
5972
5973 // categories
5974 else if (uri.startsWith("category=", i)) {
5975 intent.addCategory(value);
5976 }
5977
5978 // type
5979 else if (uri.startsWith("type=", i)) {
5980 intent.mType = value;
5981 }
5982
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005983 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005984 else if (uri.startsWith("launchFlags=", i)) {
5985 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005986 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5987 intent.mFlags &= ~IMMUTABLE_FLAGS;
5988 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005989 }
5990
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005991 // package
5992 else if (uri.startsWith("package=", i)) {
5993 intent.mPackage = value;
5994 }
5995
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005996 // component
5997 else if (uri.startsWith("component=", i)) {
5998 intent.mComponent = ComponentName.unflattenFromString(value);
5999 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006000
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006001 // scheme
6002 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006003 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006004 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006005 } else {
6006 scheme = value;
6007 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006008 }
6009
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006010 // source bounds
6011 else if (uri.startsWith("sourceBounds=", i)) {
6012 intent.mSourceBounds = Rect.unflattenFromString(value);
6013 }
6014
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006015 // selector
6016 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
6017 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006018 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006019 }
6020
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006021 // extra
6022 else {
6023 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006024 // create Bundle if it doesn't already exist
6025 if (intent.mExtras == null) intent.mExtras = new Bundle();
6026 Bundle b = intent.mExtras;
6027 // add EXTRA
6028 if (uri.startsWith("S.", i)) b.putString(key, value);
6029 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
6030 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
6031 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
6032 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
6033 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
6034 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
6035 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
6036 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
6037 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
6038 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006039
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006040 // move to the next item
6041 i = semi + 1;
6042 }
6043
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006044 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006045 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006046 if (baseIntent.mPackage == null) {
6047 baseIntent.setSelector(intent);
6048 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006049 intent = baseIntent;
6050 }
6051
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006052 if (data != null) {
6053 if (data.startsWith("intent:")) {
6054 data = data.substring(7);
6055 if (scheme != null) {
6056 data = scheme + ':' + data;
6057 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006058 } else if (data.startsWith("android-app:")) {
6059 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
6060 // Correctly formed android-app, first part is package name.
6061 int end = data.indexOf('/', 14);
6062 if (end < 0) {
6063 // All we have is a package name.
6064 intent.mPackage = data.substring(14);
6065 if (!explicitAction) {
6066 intent.setAction(ACTION_MAIN);
6067 }
6068 data = "";
6069 } else {
6070 // Target the Intent at the given package name always.
6071 String authority = null;
6072 intent.mPackage = data.substring(14, end);
6073 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006074 if ((end+1) < data.length()) {
6075 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6076 // Found a scheme, remember it.
6077 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006078 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006079 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6080 // Found a authority, remember it.
6081 authority = data.substring(end+1, newEnd);
6082 end = newEnd;
6083 }
6084 } else {
6085 // All we have is a scheme.
6086 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006087 }
6088 }
6089 if (scheme == null) {
6090 // If there was no scheme, then this just targets the package.
6091 if (!explicitAction) {
6092 intent.setAction(ACTION_MAIN);
6093 }
6094 data = "";
6095 } else if (authority == null) {
6096 data = scheme + ":";
6097 } else {
6098 data = scheme + "://" + authority + data.substring(end);
6099 }
6100 }
6101 } else {
6102 data = "";
6103 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006104 }
Tom Taylord4a47292009-12-21 13:59:18 -08006105
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006106 if (data.length() > 0) {
6107 try {
6108 intent.mData = Uri.parse(data);
6109 } catch (IllegalArgumentException e) {
6110 throw new URISyntaxException(uri, e.getMessage());
6111 }
6112 }
6113 }
Tom Taylord4a47292009-12-21 13:59:18 -08006114
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006115 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006116
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006117 } catch (IndexOutOfBoundsException e) {
6118 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6119 }
6120 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006121
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006122 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006123 return getIntentOld(uri, 0);
6124 }
6125
6126 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006127 Intent intent;
6128
6129 int i = uri.lastIndexOf('#');
6130 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006131 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006132 final int intentFragmentStart = i;
6133 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006134
6135 i++;
6136
6137 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006138 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006139 i += 7;
6140 int j = uri.indexOf(')', i);
6141 action = uri.substring(i, j);
6142 i = j + 1;
6143 }
6144
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006145 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006146
6147 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006148 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006149 i += 11;
6150 int j = uri.indexOf(')', i);
6151 while (i < j) {
6152 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006153 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006154 if (i < sep) {
6155 intent.addCategory(uri.substring(i, sep));
6156 }
6157 i = sep + 1;
6158 }
6159 i = j + 1;
6160 }
6161
6162 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006163 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006164 i += 5;
6165 int j = uri.indexOf(')', i);
6166 intent.mType = uri.substring(i, j);
6167 i = j + 1;
6168 }
6169
6170 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006171 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006172 i += 12;
6173 int j = uri.indexOf(')', i);
6174 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006175 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6176 intent.mFlags &= ~IMMUTABLE_FLAGS;
6177 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006178 i = j + 1;
6179 }
6180
6181 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006182 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006183 i += 10;
6184 int j = uri.indexOf(')', i);
6185 int sep = uri.indexOf('!', i);
6186 if (sep >= 0 && sep < j) {
6187 String pkg = uri.substring(i, sep);
6188 String cls = uri.substring(sep + 1, j);
6189 intent.mComponent = new ComponentName(pkg, cls);
6190 }
6191 i = j + 1;
6192 }
6193
6194 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006195 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006196 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006197
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006198 final int closeParen = uri.indexOf(')', i);
6199 if (closeParen == -1) throw new URISyntaxException(uri,
6200 "EXTRA missing trailing ')'", i);
6201
6202 while (i < closeParen) {
6203 // fetch the key value
6204 int j = uri.indexOf('=', i);
6205 if (j <= i + 1 || i >= closeParen) {
6206 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6207 }
6208 char type = uri.charAt(i);
6209 i++;
6210 String key = uri.substring(i, j);
6211 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006212
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006213 // get type-value
6214 j = uri.indexOf('!', i);
6215 if (j == -1 || j >= closeParen) j = closeParen;
6216 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6217 String value = uri.substring(i, j);
6218 i = j;
6219
6220 // create Bundle if it doesn't already exist
6221 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006222
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006223 // add item to bundle
6224 try {
6225 switch (type) {
6226 case 'S':
6227 intent.mExtras.putString(key, Uri.decode(value));
6228 break;
6229 case 'B':
6230 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6231 break;
6232 case 'b':
6233 intent.mExtras.putByte(key, Byte.parseByte(value));
6234 break;
6235 case 'c':
6236 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6237 break;
6238 case 'd':
6239 intent.mExtras.putDouble(key, Double.parseDouble(value));
6240 break;
6241 case 'f':
6242 intent.mExtras.putFloat(key, Float.parseFloat(value));
6243 break;
6244 case 'i':
6245 intent.mExtras.putInt(key, Integer.parseInt(value));
6246 break;
6247 case 'l':
6248 intent.mExtras.putLong(key, Long.parseLong(value));
6249 break;
6250 case 's':
6251 intent.mExtras.putShort(key, Short.parseShort(value));
6252 break;
6253 default:
6254 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6255 }
6256 } catch (NumberFormatException e) {
6257 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6258 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006259
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006260 char ch = uri.charAt(i);
6261 if (ch == ')') break;
6262 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6263 i++;
6264 }
6265 }
6266
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006267 if (isIntentFragment) {
6268 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6269 } else {
6270 intent.mData = Uri.parse(uri);
6271 }
Tom Taylord4a47292009-12-21 13:59:18 -08006272
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006273 if (intent.mAction == null) {
6274 // By default, if no action is specified, then use VIEW.
6275 intent.mAction = ACTION_VIEW;
6276 }
6277
6278 } else {
6279 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6280 }
6281
6282 return intent;
6283 }
6284
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006285 /** @hide */
6286 public interface CommandOptionHandler {
6287 boolean handleOption(String opt, ShellCommand cmd);
6288 }
6289
6290 /** @hide */
6291 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6292 throws URISyntaxException {
6293 Intent intent = new Intent();
6294 Intent baseIntent = intent;
6295 boolean hasIntentInfo = false;
6296
6297 Uri data = null;
6298 String type = null;
6299
6300 String opt;
6301 while ((opt=cmd.getNextOption()) != null) {
6302 switch (opt) {
6303 case "-a":
6304 intent.setAction(cmd.getNextArgRequired());
6305 if (intent == baseIntent) {
6306 hasIntentInfo = true;
6307 }
6308 break;
6309 case "-d":
6310 data = Uri.parse(cmd.getNextArgRequired());
6311 if (intent == baseIntent) {
6312 hasIntentInfo = true;
6313 }
6314 break;
6315 case "-t":
6316 type = cmd.getNextArgRequired();
6317 if (intent == baseIntent) {
6318 hasIntentInfo = true;
6319 }
6320 break;
6321 case "-c":
6322 intent.addCategory(cmd.getNextArgRequired());
6323 if (intent == baseIntent) {
6324 hasIntentInfo = true;
6325 }
6326 break;
6327 case "-e":
6328 case "--es": {
6329 String key = cmd.getNextArgRequired();
6330 String value = cmd.getNextArgRequired();
6331 intent.putExtra(key, value);
6332 }
6333 break;
6334 case "--esn": {
6335 String key = cmd.getNextArgRequired();
6336 intent.putExtra(key, (String) null);
6337 }
6338 break;
6339 case "--ei": {
6340 String key = cmd.getNextArgRequired();
6341 String value = cmd.getNextArgRequired();
6342 intent.putExtra(key, Integer.decode(value));
6343 }
6344 break;
6345 case "--eu": {
6346 String key = cmd.getNextArgRequired();
6347 String value = cmd.getNextArgRequired();
6348 intent.putExtra(key, Uri.parse(value));
6349 }
6350 break;
6351 case "--ecn": {
6352 String key = cmd.getNextArgRequired();
6353 String value = cmd.getNextArgRequired();
6354 ComponentName cn = ComponentName.unflattenFromString(value);
6355 if (cn == null)
6356 throw new IllegalArgumentException("Bad component name: " + value);
6357 intent.putExtra(key, cn);
6358 }
6359 break;
6360 case "--eia": {
6361 String key = cmd.getNextArgRequired();
6362 String value = cmd.getNextArgRequired();
6363 String[] strings = value.split(",");
6364 int[] list = new int[strings.length];
6365 for (int i = 0; i < strings.length; i++) {
6366 list[i] = Integer.decode(strings[i]);
6367 }
6368 intent.putExtra(key, list);
6369 }
6370 break;
6371 case "--eial": {
6372 String key = cmd.getNextArgRequired();
6373 String value = cmd.getNextArgRequired();
6374 String[] strings = value.split(",");
6375 ArrayList<Integer> list = new ArrayList<>(strings.length);
6376 for (int i = 0; i < strings.length; i++) {
6377 list.add(Integer.decode(strings[i]));
6378 }
6379 intent.putExtra(key, list);
6380 }
6381 break;
6382 case "--el": {
6383 String key = cmd.getNextArgRequired();
6384 String value = cmd.getNextArgRequired();
6385 intent.putExtra(key, Long.valueOf(value));
6386 }
6387 break;
6388 case "--ela": {
6389 String key = cmd.getNextArgRequired();
6390 String value = cmd.getNextArgRequired();
6391 String[] strings = value.split(",");
6392 long[] list = new long[strings.length];
6393 for (int i = 0; i < strings.length; i++) {
6394 list[i] = Long.valueOf(strings[i]);
6395 }
6396 intent.putExtra(key, list);
6397 hasIntentInfo = true;
6398 }
6399 break;
6400 case "--elal": {
6401 String key = cmd.getNextArgRequired();
6402 String value = cmd.getNextArgRequired();
6403 String[] strings = value.split(",");
6404 ArrayList<Long> list = new ArrayList<>(strings.length);
6405 for (int i = 0; i < strings.length; i++) {
6406 list.add(Long.valueOf(strings[i]));
6407 }
6408 intent.putExtra(key, list);
6409 hasIntentInfo = true;
6410 }
6411 break;
6412 case "--ef": {
6413 String key = cmd.getNextArgRequired();
6414 String value = cmd.getNextArgRequired();
6415 intent.putExtra(key, Float.valueOf(value));
6416 hasIntentInfo = true;
6417 }
6418 break;
6419 case "--efa": {
6420 String key = cmd.getNextArgRequired();
6421 String value = cmd.getNextArgRequired();
6422 String[] strings = value.split(",");
6423 float[] list = new float[strings.length];
6424 for (int i = 0; i < strings.length; i++) {
6425 list[i] = Float.valueOf(strings[i]);
6426 }
6427 intent.putExtra(key, list);
6428 hasIntentInfo = true;
6429 }
6430 break;
6431 case "--efal": {
6432 String key = cmd.getNextArgRequired();
6433 String value = cmd.getNextArgRequired();
6434 String[] strings = value.split(",");
6435 ArrayList<Float> list = new ArrayList<>(strings.length);
6436 for (int i = 0; i < strings.length; i++) {
6437 list.add(Float.valueOf(strings[i]));
6438 }
6439 intent.putExtra(key, list);
6440 hasIntentInfo = true;
6441 }
6442 break;
6443 case "--esa": {
6444 String key = cmd.getNextArgRequired();
6445 String value = cmd.getNextArgRequired();
6446 // Split on commas unless they are preceeded by an escape.
6447 // The escape character must be escaped for the string and
6448 // again for the regex, thus four escape characters become one.
6449 String[] strings = value.split("(?<!\\\\),");
6450 intent.putExtra(key, strings);
6451 hasIntentInfo = true;
6452 }
6453 break;
6454 case "--esal": {
6455 String key = cmd.getNextArgRequired();
6456 String value = cmd.getNextArgRequired();
6457 // Split on commas unless they are preceeded by an escape.
6458 // The escape character must be escaped for the string and
6459 // again for the regex, thus four escape characters become one.
6460 String[] strings = value.split("(?<!\\\\),");
6461 ArrayList<String> list = new ArrayList<>(strings.length);
6462 for (int i = 0; i < strings.length; i++) {
6463 list.add(strings[i]);
6464 }
6465 intent.putExtra(key, list);
6466 hasIntentInfo = true;
6467 }
6468 break;
6469 case "--ez": {
6470 String key = cmd.getNextArgRequired();
6471 String value = cmd.getNextArgRequired().toLowerCase();
6472 // Boolean.valueOf() results in false for anything that is not "true", which is
6473 // error-prone in shell commands
6474 boolean arg;
6475 if ("true".equals(value) || "t".equals(value)) {
6476 arg = true;
6477 } else if ("false".equals(value) || "f".equals(value)) {
6478 arg = false;
6479 } else {
6480 try {
6481 arg = Integer.decode(value) != 0;
6482 } catch (NumberFormatException ex) {
6483 throw new IllegalArgumentException("Invalid boolean value: " + value);
6484 }
6485 }
6486
6487 intent.putExtra(key, arg);
6488 }
6489 break;
6490 case "-n": {
6491 String str = cmd.getNextArgRequired();
6492 ComponentName cn = ComponentName.unflattenFromString(str);
6493 if (cn == null)
6494 throw new IllegalArgumentException("Bad component name: " + str);
6495 intent.setComponent(cn);
6496 if (intent == baseIntent) {
6497 hasIntentInfo = true;
6498 }
6499 }
6500 break;
6501 case "-p": {
6502 String str = cmd.getNextArgRequired();
6503 intent.setPackage(str);
6504 if (intent == baseIntent) {
6505 hasIntentInfo = true;
6506 }
6507 }
6508 break;
6509 case "-f":
6510 String str = cmd.getNextArgRequired();
6511 intent.setFlags(Integer.decode(str).intValue());
6512 break;
6513 case "--grant-read-uri-permission":
6514 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6515 break;
6516 case "--grant-write-uri-permission":
6517 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6518 break;
6519 case "--grant-persistable-uri-permission":
6520 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6521 break;
6522 case "--grant-prefix-uri-permission":
6523 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6524 break;
6525 case "--exclude-stopped-packages":
6526 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6527 break;
6528 case "--include-stopped-packages":
6529 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6530 break;
6531 case "--debug-log-resolution":
6532 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6533 break;
6534 case "--activity-brought-to-front":
6535 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6536 break;
6537 case "--activity-clear-top":
6538 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6539 break;
6540 case "--activity-clear-when-task-reset":
6541 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6542 break;
6543 case "--activity-exclude-from-recents":
6544 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6545 break;
6546 case "--activity-launched-from-history":
6547 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6548 break;
6549 case "--activity-multiple-task":
6550 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6551 break;
6552 case "--activity-no-animation":
6553 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6554 break;
6555 case "--activity-no-history":
6556 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6557 break;
6558 case "--activity-no-user-action":
6559 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6560 break;
6561 case "--activity-previous-is-top":
6562 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6563 break;
6564 case "--activity-reorder-to-front":
6565 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6566 break;
6567 case "--activity-reset-task-if-needed":
6568 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6569 break;
6570 case "--activity-single-top":
6571 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6572 break;
6573 case "--activity-clear-task":
6574 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6575 break;
6576 case "--activity-task-on-home":
6577 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6578 break;
6579 case "--receiver-registered-only":
6580 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6581 break;
6582 case "--receiver-replace-pending":
6583 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6584 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006585 case "--receiver-foreground":
6586 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6587 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006588 case "--receiver-no-abort":
6589 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6590 break;
6591 case "--receiver-include-background":
6592 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6593 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006594 case "--selector":
6595 intent.setDataAndType(data, type);
6596 intent = new Intent();
6597 break;
6598 default:
6599 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6600 // Okay, caller handled this option.
6601 } else {
6602 throw new IllegalArgumentException("Unknown option: " + opt);
6603 }
6604 break;
6605 }
6606 }
6607 intent.setDataAndType(data, type);
6608
6609 final boolean hasSelector = intent != baseIntent;
6610 if (hasSelector) {
6611 // A selector was specified; fix up.
6612 baseIntent.setSelector(intent);
6613 intent = baseIntent;
6614 }
6615
6616 String arg = cmd.getNextArg();
6617 baseIntent = null;
6618 if (arg == null) {
6619 if (hasSelector) {
6620 // If a selector has been specified, and no arguments
6621 // have been supplied for the main Intent, then we can
6622 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6623 // need to have a component name specified yet, the
6624 // selector will take care of that.
6625 baseIntent = new Intent(Intent.ACTION_MAIN);
6626 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6627 }
6628 } else if (arg.indexOf(':') >= 0) {
6629 // The argument is a URI. Fully parse it, and use that result
6630 // to fill in any data not specified so far.
6631 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6632 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6633 } else if (arg.indexOf('/') >= 0) {
6634 // The argument is a component name. Build an Intent to launch
6635 // it.
6636 baseIntent = new Intent(Intent.ACTION_MAIN);
6637 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6638 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6639 } else {
6640 // Assume the argument is a package name.
6641 baseIntent = new Intent(Intent.ACTION_MAIN);
6642 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6643 baseIntent.setPackage(arg);
6644 }
6645 if (baseIntent != null) {
6646 Bundle extras = intent.getExtras();
6647 intent.replaceExtras((Bundle)null);
6648 Bundle uriExtras = baseIntent.getExtras();
6649 baseIntent.replaceExtras((Bundle)null);
6650 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6651 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6652 for (String c : cats) {
6653 baseIntent.removeCategory(c);
6654 }
6655 }
6656 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6657 if (extras == null) {
6658 extras = uriExtras;
6659 } else if (uriExtras != null) {
6660 uriExtras.putAll(extras);
6661 extras = uriExtras;
6662 }
6663 intent.replaceExtras(extras);
6664 hasIntentInfo = true;
6665 }
6666
6667 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6668 return intent;
6669 }
6670
6671 /** @hide */
6672 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6673 final String[] lines = new String[] {
6674 "<INTENT> specifications include these flags and arguments:",
6675 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6676 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6677 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6678 " [--esn <EXTRA_KEY> ...]",
6679 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6680 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6681 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6682 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6683 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6684 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6685 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6686 " (mutiple extras passed as Integer[])",
6687 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6688 " (mutiple extras passed as List<Integer>)",
6689 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6690 " (mutiple extras passed as Long[])",
6691 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6692 " (mutiple extras passed as List<Long>)",
6693 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6694 " (mutiple extras passed as Float[])",
6695 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6696 " (mutiple extras passed as List<Float>)",
6697 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6698 " (mutiple extras passed as String[]; to embed a comma into a string,",
6699 " escape it using \"\\,\")",
6700 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6701 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6702 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006703 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006704 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6705 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6706 " [--debug-log-resolution] [--exclude-stopped-packages]",
6707 " [--include-stopped-packages]",
6708 " [--activity-brought-to-front] [--activity-clear-top]",
6709 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6710 " [--activity-launched-from-history] [--activity-multiple-task]",
6711 " [--activity-no-animation] [--activity-no-history]",
6712 " [--activity-no-user-action] [--activity-previous-is-top]",
6713 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6714 " [--activity-single-top] [--activity-clear-task]",
6715 " [--activity-task-on-home]",
6716 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08006717 " [--receiver-foreground] [--receiver-no-abort]",
6718 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006719 " [--selector]",
6720 " [<URI> | <PACKAGE> | <COMPONENT>]"
6721 };
6722 for (String line : lines) {
6723 pw.print(prefix);
6724 pw.println(line);
6725 }
6726 }
6727
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006728 /**
6729 * Retrieve the general action to be performed, such as
6730 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6731 * the information in the intent should be interpreted -- most importantly,
6732 * what to do with the data returned by {@link #getData}.
6733 *
6734 * @return The action of this intent or null if none is specified.
6735 *
6736 * @see #setAction
6737 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006738 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006739 return mAction;
6740 }
6741
6742 /**
6743 * Retrieve data this intent is operating on. This URI specifies the name
6744 * of the data; often it uses the content: scheme, specifying data in a
6745 * content provider. Other schemes may be handled by specific activities,
6746 * such as http: by the web browser.
6747 *
6748 * @return The URI of the data this intent is targeting or null.
6749 *
6750 * @see #getScheme
6751 * @see #setData
6752 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006753 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006754 return mData;
6755 }
6756
6757 /**
6758 * The same as {@link #getData()}, but returns the URI as an encoded
6759 * String.
6760 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006761 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006762 return mData != null ? mData.toString() : null;
6763 }
6764
6765 /**
6766 * Return the scheme portion of the intent's data. If the data is null or
6767 * does not include a scheme, null is returned. Otherwise, the scheme
6768 * prefix without the final ':' is returned, i.e. "http".
6769 *
6770 * <p>This is the same as calling getData().getScheme() (and checking for
6771 * null data).
6772 *
6773 * @return The scheme of this intent.
6774 *
6775 * @see #getData
6776 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006777 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006778 return mData != null ? mData.getScheme() : null;
6779 }
6780
6781 /**
6782 * Retrieve any explicit MIME type included in the intent. This is usually
6783 * null, as the type is determined by the intent data.
6784 *
6785 * @return If a type was manually set, it is returned; else null is
6786 * returned.
6787 *
6788 * @see #resolveType(ContentResolver)
6789 * @see #setType
6790 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006791 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006792 return mType;
6793 }
6794
6795 /**
6796 * Return the MIME data type of this intent. If the type field is
6797 * explicitly set, that is simply returned. Otherwise, if the data is set,
6798 * the type of that data is returned. If neither fields are set, a null is
6799 * returned.
6800 *
6801 * @return The MIME type of this intent.
6802 *
6803 * @see #getType
6804 * @see #resolveType(ContentResolver)
6805 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006806 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006807 return resolveType(context.getContentResolver());
6808 }
6809
6810 /**
6811 * Return the MIME data type of this intent. If the type field is
6812 * explicitly set, that is simply returned. Otherwise, if the data is set,
6813 * the type of that data is returned. If neither fields are set, a null is
6814 * returned.
6815 *
6816 * @param resolver A ContentResolver that can be used to determine the MIME
6817 * type of the intent's data.
6818 *
6819 * @return The MIME type of this intent.
6820 *
6821 * @see #getType
6822 * @see #resolveType(Context)
6823 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006824 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006825 if (mType != null) {
6826 return mType;
6827 }
6828 if (mData != null) {
6829 if ("content".equals(mData.getScheme())) {
6830 return resolver.getType(mData);
6831 }
6832 }
6833 return null;
6834 }
6835
6836 /**
6837 * Return the MIME data type of this intent, only if it will be needed for
6838 * intent resolution. This is not generally useful for application code;
6839 * it is used by the frameworks for communicating with back-end system
6840 * services.
6841 *
6842 * @param resolver A ContentResolver that can be used to determine the MIME
6843 * type of the intent's data.
6844 *
6845 * @return The MIME type of this intent, or null if it is unknown or not
6846 * needed.
6847 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006848 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006849 if (mComponent != null) {
6850 return mType;
6851 }
6852 return resolveType(resolver);
6853 }
6854
6855 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006856 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006857 *
6858 * @param category The category to check.
6859 *
6860 * @return boolean True if the intent contains the category, else false.
6861 *
6862 * @see #getCategories
6863 * @see #addCategory
6864 */
6865 public boolean hasCategory(String category) {
6866 return mCategories != null && mCategories.contains(category);
6867 }
6868
6869 /**
6870 * Return the set of all categories in the intent. If there are no categories,
6871 * returns NULL.
6872 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006873 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006874 *
6875 * @see #hasCategory
6876 * @see #addCategory
6877 */
6878 public Set<String> getCategories() {
6879 return mCategories;
6880 }
6881
6882 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006883 * Return the specific selector associated with this Intent. If there is
6884 * none, returns null. See {@link #setSelector} for more information.
6885 *
6886 * @see #setSelector
6887 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006888 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006889 return mSelector;
6890 }
6891
6892 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006893 * Return the {@link ClipData} associated with this Intent. If there is
6894 * none, returns null. See {@link #setClipData} for more information.
6895 *
John Spurlock125d1332013-11-25 11:58:37 -05006896 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006897 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006898 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006899 return mClipData;
6900 }
6901
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006902 /** @hide */
6903 public int getContentUserHint() {
6904 return mContentUserHint;
6905 }
6906
Todd Kennedyb3b431302017-03-20 16:05:48 -07006907 /** @hide */
6908 public String getLaunchToken() {
6909 return mLaunchToken;
6910 }
6911
6912 /** @hide */
6913 public void setLaunchToken(String launchToken) {
6914 mLaunchToken = launchToken;
6915 }
6916
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006917 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006918 * Sets the ClassLoader that will be used when unmarshalling
6919 * any Parcelable values from the extras of this Intent.
6920 *
6921 * @param loader a ClassLoader, or null to use the default loader
6922 * at the time of unmarshalling.
6923 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006924 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006925 if (mExtras != null) {
6926 mExtras.setClassLoader(loader);
6927 }
6928 }
6929
6930 /**
6931 * Returns true if an extra value is associated with the given name.
6932 * @param name the extra's name
6933 * @return true if the given extra is present.
6934 */
6935 public boolean hasExtra(String name) {
6936 return mExtras != null && mExtras.containsKey(name);
6937 }
6938
6939 /**
6940 * Returns true if the Intent's extras contain a parcelled file descriptor.
6941 * @return true if the Intent contains a parcelled file descriptor.
6942 */
6943 public boolean hasFileDescriptors() {
6944 return mExtras != null && mExtras.hasFileDescriptors();
6945 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006946
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006947 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006948 public void setAllowFds(boolean allowFds) {
6949 if (mExtras != null) {
6950 mExtras.setAllowFds(allowFds);
6951 }
6952 }
6953
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006954 /** {@hide} */
6955 public void setDefusable(boolean defusable) {
6956 if (mExtras != null) {
6957 mExtras.setDefusable(defusable);
6958 }
6959 }
6960
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006961 /**
6962 * Retrieve extended data from the intent.
6963 *
6964 * @param name The name of the desired item.
6965 *
6966 * @return the value of an item that previously added with putExtra()
6967 * or null if none was found.
6968 *
6969 * @deprecated
6970 * @hide
6971 */
6972 @Deprecated
6973 public Object getExtra(String name) {
6974 return getExtra(name, null);
6975 }
6976
6977 /**
6978 * Retrieve extended data from the intent.
6979 *
6980 * @param name The name of the desired item.
6981 * @param defaultValue the value to be returned if no value of the desired
6982 * type is stored with the given name.
6983 *
6984 * @return the value of an item that previously added with putExtra()
6985 * or the default value if none was found.
6986 *
6987 * @see #putExtra(String, boolean)
6988 */
6989 public boolean getBooleanExtra(String name, boolean defaultValue) {
6990 return mExtras == null ? defaultValue :
6991 mExtras.getBoolean(name, defaultValue);
6992 }
6993
6994 /**
6995 * Retrieve extended data from the intent.
6996 *
6997 * @param name The name of the desired item.
6998 * @param defaultValue the value to be returned if no value of the desired
6999 * type is stored with the given name.
7000 *
7001 * @return the value of an item that previously added with putExtra()
7002 * or the default value if none was found.
7003 *
7004 * @see #putExtra(String, byte)
7005 */
7006 public byte getByteExtra(String name, byte defaultValue) {
7007 return mExtras == null ? defaultValue :
7008 mExtras.getByte(name, defaultValue);
7009 }
7010
7011 /**
7012 * Retrieve extended data from the intent.
7013 *
7014 * @param name The name of the desired item.
7015 * @param defaultValue the value to be returned if no value of the desired
7016 * type is stored with the given name.
7017 *
7018 * @return the value of an item that previously added with putExtra()
7019 * or the default value if none was found.
7020 *
7021 * @see #putExtra(String, short)
7022 */
7023 public short getShortExtra(String name, short defaultValue) {
7024 return mExtras == null ? defaultValue :
7025 mExtras.getShort(name, defaultValue);
7026 }
7027
7028 /**
7029 * Retrieve extended data from the intent.
7030 *
7031 * @param name The name of the desired item.
7032 * @param defaultValue the value to be returned if no value of the desired
7033 * type is stored with the given name.
7034 *
7035 * @return the value of an item that previously added with putExtra()
7036 * or the default value if none was found.
7037 *
7038 * @see #putExtra(String, char)
7039 */
7040 public char getCharExtra(String name, char defaultValue) {
7041 return mExtras == null ? defaultValue :
7042 mExtras.getChar(name, defaultValue);
7043 }
7044
7045 /**
7046 * Retrieve extended data from the intent.
7047 *
7048 * @param name The name of the desired item.
7049 * @param defaultValue the value to be returned if no value of the desired
7050 * type is stored with the given name.
7051 *
7052 * @return the value of an item that previously added with putExtra()
7053 * or the default value if none was found.
7054 *
7055 * @see #putExtra(String, int)
7056 */
7057 public int getIntExtra(String name, int defaultValue) {
7058 return mExtras == null ? defaultValue :
7059 mExtras.getInt(name, defaultValue);
7060 }
7061
7062 /**
7063 * Retrieve extended data from the intent.
7064 *
7065 * @param name The name of the desired item.
7066 * @param defaultValue the value to be returned if no value of the desired
7067 * type is stored with the given name.
7068 *
7069 * @return the value of an item that previously added with putExtra()
7070 * or the default value if none was found.
7071 *
7072 * @see #putExtra(String, long)
7073 */
7074 public long getLongExtra(String name, long defaultValue) {
7075 return mExtras == null ? defaultValue :
7076 mExtras.getLong(name, defaultValue);
7077 }
7078
7079 /**
7080 * Retrieve extended data from the intent.
7081 *
7082 * @param name The name of the desired item.
7083 * @param defaultValue the value to be returned if no value of the desired
7084 * type is stored with the given name.
7085 *
7086 * @return the value of an item that previously added with putExtra(),
7087 * or the default value if no such item is present
7088 *
7089 * @see #putExtra(String, float)
7090 */
7091 public float getFloatExtra(String name, float defaultValue) {
7092 return mExtras == null ? defaultValue :
7093 mExtras.getFloat(name, defaultValue);
7094 }
7095
7096 /**
7097 * Retrieve extended data from the intent.
7098 *
7099 * @param name The name of the desired item.
7100 * @param defaultValue the value to be returned if no value of the desired
7101 * type is stored with the given name.
7102 *
7103 * @return the value of an item that previously added with putExtra()
7104 * or the default value if none was found.
7105 *
7106 * @see #putExtra(String, double)
7107 */
7108 public double getDoubleExtra(String name, double defaultValue) {
7109 return mExtras == null ? defaultValue :
7110 mExtras.getDouble(name, defaultValue);
7111 }
7112
7113 /**
7114 * Retrieve extended data from the intent.
7115 *
7116 * @param name The name of the desired item.
7117 *
7118 * @return the value of an item that previously added with putExtra()
7119 * or null if no String value was found.
7120 *
7121 * @see #putExtra(String, String)
7122 */
7123 public String getStringExtra(String name) {
7124 return mExtras == null ? null : mExtras.getString(name);
7125 }
7126
7127 /**
7128 * Retrieve extended data from the intent.
7129 *
7130 * @param name The name of the desired item.
7131 *
7132 * @return the value of an item that previously added with putExtra()
7133 * or null if no CharSequence value was found.
7134 *
7135 * @see #putExtra(String, CharSequence)
7136 */
7137 public CharSequence getCharSequenceExtra(String name) {
7138 return mExtras == null ? null : mExtras.getCharSequence(name);
7139 }
7140
7141 /**
7142 * Retrieve extended data from the intent.
7143 *
7144 * @param name The name of the desired item.
7145 *
7146 * @return the value of an item that previously added with putExtra()
7147 * or null if no Parcelable value was found.
7148 *
7149 * @see #putExtra(String, Parcelable)
7150 */
7151 public <T extends Parcelable> T getParcelableExtra(String name) {
7152 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7153 }
7154
7155 /**
7156 * Retrieve extended data from the intent.
7157 *
7158 * @param name The name of the desired item.
7159 *
7160 * @return the value of an item that previously added with putExtra()
7161 * or null if no Parcelable[] value was found.
7162 *
7163 * @see #putExtra(String, Parcelable[])
7164 */
7165 public Parcelable[] getParcelableArrayExtra(String name) {
7166 return mExtras == null ? null : mExtras.getParcelableArray(name);
7167 }
7168
7169 /**
7170 * Retrieve extended data from the intent.
7171 *
7172 * @param name The name of the desired item.
7173 *
7174 * @return the value of an item that previously added with putExtra()
7175 * or null if no ArrayList<Parcelable> value was found.
7176 *
7177 * @see #putParcelableArrayListExtra(String, ArrayList)
7178 */
7179 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
7180 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7181 }
7182
7183 /**
7184 * Retrieve extended data from the intent.
7185 *
7186 * @param name The name of the desired item.
7187 *
7188 * @return the value of an item that previously added with putExtra()
7189 * or null if no Serializable value was found.
7190 *
7191 * @see #putExtra(String, Serializable)
7192 */
7193 public Serializable getSerializableExtra(String name) {
7194 return mExtras == null ? null : mExtras.getSerializable(name);
7195 }
7196
7197 /**
7198 * Retrieve extended data from the intent.
7199 *
7200 * @param name The name of the desired item.
7201 *
7202 * @return the value of an item that previously added with putExtra()
7203 * or null if no ArrayList<Integer> value was found.
7204 *
7205 * @see #putIntegerArrayListExtra(String, ArrayList)
7206 */
7207 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
7208 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7209 }
7210
7211 /**
7212 * Retrieve extended data from the intent.
7213 *
7214 * @param name The name of the desired item.
7215 *
7216 * @return the value of an item that previously added with putExtra()
7217 * or null if no ArrayList<String> value was found.
7218 *
7219 * @see #putStringArrayListExtra(String, ArrayList)
7220 */
7221 public ArrayList<String> getStringArrayListExtra(String name) {
7222 return mExtras == null ? null : mExtras.getStringArrayList(name);
7223 }
7224
7225 /**
7226 * Retrieve extended data from the intent.
7227 *
7228 * @param name The name of the desired item.
7229 *
7230 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007231 * or null if no ArrayList<CharSequence> value was found.
7232 *
7233 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7234 */
7235 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
7236 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7237 }
7238
7239 /**
7240 * Retrieve extended data from the intent.
7241 *
7242 * @param name The name of the desired item.
7243 *
7244 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007245 * or null if no boolean array value was found.
7246 *
7247 * @see #putExtra(String, boolean[])
7248 */
7249 public boolean[] getBooleanArrayExtra(String name) {
7250 return mExtras == null ? null : mExtras.getBooleanArray(name);
7251 }
7252
7253 /**
7254 * Retrieve extended data from the intent.
7255 *
7256 * @param name The name of the desired item.
7257 *
7258 * @return the value of an item that previously added with putExtra()
7259 * or null if no byte array value was found.
7260 *
7261 * @see #putExtra(String, byte[])
7262 */
7263 public byte[] getByteArrayExtra(String name) {
7264 return mExtras == null ? null : mExtras.getByteArray(name);
7265 }
7266
7267 /**
7268 * Retrieve extended data from the intent.
7269 *
7270 * @param name The name of the desired item.
7271 *
7272 * @return the value of an item that previously added with putExtra()
7273 * or null if no short array value was found.
7274 *
7275 * @see #putExtra(String, short[])
7276 */
7277 public short[] getShortArrayExtra(String name) {
7278 return mExtras == null ? null : mExtras.getShortArray(name);
7279 }
7280
7281 /**
7282 * Retrieve extended data from the intent.
7283 *
7284 * @param name The name of the desired item.
7285 *
7286 * @return the value of an item that previously added with putExtra()
7287 * or null if no char array value was found.
7288 *
7289 * @see #putExtra(String, char[])
7290 */
7291 public char[] getCharArrayExtra(String name) {
7292 return mExtras == null ? null : mExtras.getCharArray(name);
7293 }
7294
7295 /**
7296 * Retrieve extended data from the intent.
7297 *
7298 * @param name The name of the desired item.
7299 *
7300 * @return the value of an item that previously added with putExtra()
7301 * or null if no int array value was found.
7302 *
7303 * @see #putExtra(String, int[])
7304 */
7305 public int[] getIntArrayExtra(String name) {
7306 return mExtras == null ? null : mExtras.getIntArray(name);
7307 }
7308
7309 /**
7310 * Retrieve extended data from the intent.
7311 *
7312 * @param name The name of the desired item.
7313 *
7314 * @return the value of an item that previously added with putExtra()
7315 * or null if no long array value was found.
7316 *
7317 * @see #putExtra(String, long[])
7318 */
7319 public long[] getLongArrayExtra(String name) {
7320 return mExtras == null ? null : mExtras.getLongArray(name);
7321 }
7322
7323 /**
7324 * Retrieve extended data from the intent.
7325 *
7326 * @param name The name of the desired item.
7327 *
7328 * @return the value of an item that previously added with putExtra()
7329 * or null if no float array value was found.
7330 *
7331 * @see #putExtra(String, float[])
7332 */
7333 public float[] getFloatArrayExtra(String name) {
7334 return mExtras == null ? null : mExtras.getFloatArray(name);
7335 }
7336
7337 /**
7338 * Retrieve extended data from the intent.
7339 *
7340 * @param name The name of the desired item.
7341 *
7342 * @return the value of an item that previously added with putExtra()
7343 * or null if no double array value was found.
7344 *
7345 * @see #putExtra(String, double[])
7346 */
7347 public double[] getDoubleArrayExtra(String name) {
7348 return mExtras == null ? null : mExtras.getDoubleArray(name);
7349 }
7350
7351 /**
7352 * Retrieve extended data from the intent.
7353 *
7354 * @param name The name of the desired item.
7355 *
7356 * @return the value of an item that previously added with putExtra()
7357 * or null if no String array value was found.
7358 *
7359 * @see #putExtra(String, String[])
7360 */
7361 public String[] getStringArrayExtra(String name) {
7362 return mExtras == null ? null : mExtras.getStringArray(name);
7363 }
7364
7365 /**
7366 * Retrieve extended data from the intent.
7367 *
7368 * @param name The name of the desired item.
7369 *
7370 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007371 * or null if no CharSequence array value was found.
7372 *
7373 * @see #putExtra(String, CharSequence[])
7374 */
7375 public CharSequence[] getCharSequenceArrayExtra(String name) {
7376 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7377 }
7378
7379 /**
7380 * Retrieve extended data from the intent.
7381 *
7382 * @param name The name of the desired item.
7383 *
7384 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007385 * or null if no Bundle value was found.
7386 *
7387 * @see #putExtra(String, Bundle)
7388 */
7389 public Bundle getBundleExtra(String name) {
7390 return mExtras == null ? null : mExtras.getBundle(name);
7391 }
7392
7393 /**
7394 * Retrieve extended data from the intent.
7395 *
7396 * @param name The name of the desired item.
7397 *
7398 * @return the value of an item that previously added with putExtra()
7399 * or null if no IBinder value was found.
7400 *
7401 * @see #putExtra(String, IBinder)
7402 *
7403 * @deprecated
7404 * @hide
7405 */
7406 @Deprecated
7407 public IBinder getIBinderExtra(String name) {
7408 return mExtras == null ? null : mExtras.getIBinder(name);
7409 }
7410
7411 /**
7412 * Retrieve extended data from the intent.
7413 *
7414 * @param name The name of the desired item.
7415 * @param defaultValue The default value to return in case no item is
7416 * associated with the key 'name'
7417 *
7418 * @return the value of an item that previously added with putExtra()
7419 * or defaultValue if none was found.
7420 *
7421 * @see #putExtra
7422 *
7423 * @deprecated
7424 * @hide
7425 */
7426 @Deprecated
7427 public Object getExtra(String name, Object defaultValue) {
7428 Object result = defaultValue;
7429 if (mExtras != null) {
7430 Object result2 = mExtras.get(name);
7431 if (result2 != null) {
7432 result = result2;
7433 }
7434 }
7435
7436 return result;
7437 }
7438
7439 /**
7440 * Retrieves a map of extended data from the intent.
7441 *
7442 * @return the map of all extras previously added with putExtra(),
7443 * or null if none have been added.
7444 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007445 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007446 return (mExtras != null)
7447 ? new Bundle(mExtras)
7448 : null;
7449 }
7450
7451 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007452 * Filter extras to only basic types.
7453 * @hide
7454 */
7455 public void removeUnsafeExtras() {
7456 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007457 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007458 }
7459 }
7460
7461 /**
Makoto Onuki97f82f22017-05-31 16:20:21 -07007462 * @return Whether {@link #maybeStripForHistory} will return an lightened intent or
7463 * return itself as-is.
7464 * @hide
7465 */
7466 public boolean canStripForHistory() {
7467 return ((mExtras != null) && mExtras.isParcelled()) || (mClipData != null);
7468 }
7469
7470 /**
7471 * Call it when the system needs to keep an intent for logging purposes to remove fields
7472 * that are not needed for logging.
7473 * @hide
7474 */
7475 public Intent maybeStripForHistory() {
7476 // TODO Scan and remove possibly heavy instances like Bitmaps from unparcelled extras?
7477
7478 if (!canStripForHistory()) {
7479 return this;
7480 }
7481 return new Intent(this, COPY_MODE_HISTORY);
7482 }
7483
7484 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007485 * Retrieve any special flags associated with this intent. You will
7486 * normally just set them with {@link #setFlags} and let the system
7487 * take the appropriate action with them.
7488 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007489 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007490 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007491 * @see #addFlags
7492 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007493 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007494 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007495 return mFlags;
7496 }
7497
Dianne Hackborne7f97212011-02-24 14:40:20 -08007498 /** @hide */
7499 public boolean isExcludingStopped() {
7500 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7501 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7502 }
7503
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007504 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007505 * Retrieve the application package name this Intent is limited to. When
7506 * resolving an Intent, if non-null this limits the resolution to only
7507 * components in the given application package.
7508 *
7509 * @return The name of the application package for the Intent.
7510 *
7511 * @see #resolveActivity
7512 * @see #setPackage
7513 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007514 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007515 return mPackage;
7516 }
7517
7518 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007519 * Retrieve the concrete component associated with the intent. When receiving
7520 * an intent, this is the component that was found to best handle it (that is,
7521 * yourself) and will always be non-null; in all other cases it will be
7522 * null unless explicitly set.
7523 *
7524 * @return The name of the application component to handle the intent.
7525 *
7526 * @see #resolveActivity
7527 * @see #setComponent
7528 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007529 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007530 return mComponent;
7531 }
7532
7533 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007534 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7535 * used as a hint to the receiver for animations and the like. Null means that there
7536 * is no source bounds.
7537 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007538 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007539 return mSourceBounds;
7540 }
7541
7542 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007543 * Return the Activity component that should be used to handle this intent.
7544 * The appropriate component is determined based on the information in the
7545 * intent, evaluated as follows:
7546 *
7547 * <p>If {@link #getComponent} returns an explicit class, that is returned
7548 * without any further consideration.
7549 *
7550 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7551 * category to be considered.
7552 *
7553 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7554 * action.
7555 *
7556 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7557 * this type.
7558 *
7559 * <p>If {@link #addCategory} has added any categories, the activity must
7560 * handle ALL of the categories specified.
7561 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007562 * <p>If {@link #getPackage} is non-NULL, only activity components in
7563 * that application package will be considered.
7564 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007565 * <p>If there are no activities that satisfy all of these conditions, a
7566 * null string is returned.
7567 *
7568 * <p>If multiple activities are found to satisfy the intent, the one with
7569 * the highest priority will be used. If there are multiple activities
7570 * with the same priority, the system will either pick the best activity
7571 * based on user preference, or resolve to a system class that will allow
7572 * the user to pick an activity and forward from there.
7573 *
7574 * <p>This method is implemented simply by calling
7575 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7576 * true.</p>
7577 * <p> This API is called for you as part of starting an activity from an
7578 * intent. You do not normally need to call it yourself.</p>
7579 *
7580 * @param pm The package manager with which to resolve the Intent.
7581 *
7582 * @return Name of the component implementing an activity that can
7583 * display the intent.
7584 *
7585 * @see #setComponent
7586 * @see #getComponent
7587 * @see #resolveActivityInfo
7588 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007589 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007590 if (mComponent != null) {
7591 return mComponent;
7592 }
7593
7594 ResolveInfo info = pm.resolveActivity(
7595 this, PackageManager.MATCH_DEFAULT_ONLY);
7596 if (info != null) {
7597 return new ComponentName(
7598 info.activityInfo.applicationInfo.packageName,
7599 info.activityInfo.name);
7600 }
7601
7602 return null;
7603 }
7604
7605 /**
7606 * Resolve the Intent into an {@link ActivityInfo}
7607 * describing the activity that should execute the intent. Resolution
7608 * follows the same rules as described for {@link #resolveActivity}, but
7609 * you get back the completely information about the resolved activity
7610 * instead of just its class name.
7611 *
7612 * @param pm The package manager with which to resolve the Intent.
7613 * @param flags Addition information to retrieve as per
7614 * {@link PackageManager#getActivityInfo(ComponentName, int)
7615 * PackageManager.getActivityInfo()}.
7616 *
7617 * @return PackageManager.ActivityInfo
7618 *
7619 * @see #resolveActivity
7620 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007621 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
7622 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007623 ActivityInfo ai = null;
7624 if (mComponent != null) {
7625 try {
7626 ai = pm.getActivityInfo(mComponent, flags);
7627 } catch (PackageManager.NameNotFoundException e) {
7628 // ignore
7629 }
7630 } else {
7631 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007632 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007633 if (info != null) {
7634 ai = info.activityInfo;
7635 }
7636 }
7637
7638 return ai;
7639 }
7640
7641 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007642 * Special function for use by the system to resolve service
7643 * intents to system apps. Throws an exception if there are
7644 * multiple potential matches to the Intent. Returns null if
7645 * there are no matches.
7646 * @hide
7647 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007648 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
7649 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07007650 if (mComponent != null) {
7651 return mComponent;
7652 }
7653
7654 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7655 if (results == null) {
7656 return null;
7657 }
7658 ComponentName comp = null;
7659 for (int i=0; i<results.size(); i++) {
7660 ResolveInfo ri = results.get(i);
7661 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7662 continue;
7663 }
7664 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7665 ri.serviceInfo.name);
7666 if (comp != null) {
7667 throw new IllegalStateException("Multiple system services handle " + this
7668 + ": " + comp + ", " + foundComp);
7669 }
7670 comp = foundComp;
7671 }
7672 return comp;
7673 }
7674
7675 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007676 * Set the general action to be performed.
7677 *
7678 * @param action An action name, such as ACTION_VIEW. Application-specific
7679 * actions should be prefixed with the vendor's package name.
7680 *
7681 * @return Returns the same Intent object, for chaining multiple calls
7682 * into a single statement.
7683 *
7684 * @see #getAction
7685 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007686 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007687 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007688 return this;
7689 }
7690
7691 /**
7692 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007693 * clears any type that was previously set by {@link #setType} or
7694 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007695 *
Nick Pellyccae4122012-01-09 14:12:58 -08007696 * <p><em>Note: scheme matching in the Android framework is
7697 * case-sensitive, unlike the formal RFC. As a result,
7698 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007699 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007700 * {@link #setDataAndNormalize}
7701 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007702 *
Nick Pellyccae4122012-01-09 14:12:58 -08007703 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007704 *
7705 * @return Returns the same Intent object, for chaining multiple calls
7706 * into a single statement.
7707 *
7708 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007709 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007710 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007711 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007712 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007713 mData = data;
7714 mType = null;
7715 return this;
7716 }
7717
7718 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007719 * Normalize and set the data this intent is operating on.
7720 *
7721 * <p>This method automatically clears any type that was
7722 * previously set (for example, by {@link #setType}).
7723 *
7724 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007725 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007726 * so really this is just a convenience method for
7727 * <pre>
7728 * setData(data.normalize())
7729 * </pre>
7730 *
7731 * @param data The Uri of the data this intent is now targeting.
7732 *
7733 * @return Returns the same Intent object, for chaining multiple calls
7734 * into a single statement.
7735 *
7736 * @see #getData
7737 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007738 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007739 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007740 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007741 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007742 }
7743
7744 /**
7745 * Set an explicit MIME data type.
7746 *
7747 * <p>This is used to create intents that only specify a type and not data,
7748 * for example to indicate the type of data to return.
7749 *
7750 * <p>This method automatically clears any data that was
7751 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007752 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007753 * <p><em>Note: MIME type matching in the Android framework is
7754 * case-sensitive, unlike formal RFC MIME types. As a result,
7755 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007756 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7757 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007758 *
7759 * @param type The MIME type of the data being handled by this intent.
7760 *
7761 * @return Returns the same Intent object, for chaining multiple calls
7762 * into a single statement.
7763 *
7764 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007765 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007766 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007767 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007768 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007769 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007770 mData = null;
7771 mType = type;
7772 return this;
7773 }
7774
7775 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007776 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007777 *
Nick Pellyccae4122012-01-09 14:12:58 -08007778 * <p>This is used to create intents that only specify a type and not data,
7779 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007780 *
Nick Pellyccae4122012-01-09 14:12:58 -08007781 * <p>This method automatically clears any data that was
7782 * previously set (for example by {@link #setData}).
7783 *
7784 * <p>The MIME type is normalized using
7785 * {@link #normalizeMimeType} before it is set,
7786 * so really this is just a convenience method for
7787 * <pre>
7788 * setType(Intent.normalizeMimeType(type))
7789 * </pre>
7790 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007791 * @param type The MIME type of the data being handled by this intent.
7792 *
7793 * @return Returns the same Intent object, for chaining multiple calls
7794 * into a single statement.
7795 *
Nick Pellyccae4122012-01-09 14:12:58 -08007796 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007797 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007798 * @see #normalizeMimeType
7799 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007800 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08007801 return setType(normalizeMimeType(type));
7802 }
7803
7804 /**
7805 * (Usually optional) Set the data for the intent along with an explicit
7806 * MIME data type. This method should very rarely be used -- it allows you
7807 * to override the MIME type that would ordinarily be inferred from the
7808 * data with your own type given here.
7809 *
7810 * <p><em>Note: MIME type and Uri scheme matching in the
7811 * Android framework is case-sensitive, unlike the formal RFC definitions.
7812 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007813 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007814 * {@link #setDataAndTypeAndNormalize}
7815 * to ensure that they are converted to lower case.</em>
7816 *
7817 * @param data The Uri of the data this intent is now targeting.
7818 * @param type The MIME type of the data being handled by this intent.
7819 *
7820 * @return Returns the same Intent object, for chaining multiple calls
7821 * into a single statement.
7822 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007823 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007824 * @see #setData
7825 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007826 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007827 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007828 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007829 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007830 mData = data;
7831 mType = type;
7832 return this;
7833 }
7834
7835 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007836 * (Usually optional) Normalize and set both the data Uri and an explicit
7837 * MIME data type. This method should very rarely be used -- it allows you
7838 * to override the MIME type that would ordinarily be inferred from the
7839 * data with your own type given here.
7840 *
7841 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007842 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007843 * before they are set, so really this is just a convenience method for
7844 * <pre>
7845 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7846 * </pre>
7847 *
7848 * @param data The Uri of the data this intent is now targeting.
7849 * @param type The MIME type of the data being handled by this intent.
7850 *
7851 * @return Returns the same Intent object, for chaining multiple calls
7852 * into a single statement.
7853 *
7854 * @see #setType
7855 * @see #setData
7856 * @see #setDataAndType
7857 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007858 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007859 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007860 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007861 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007862 }
7863
7864 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007865 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007866 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007867 * activities that provide <em>all</em> of the requested categories will be
7868 * used.
7869 *
7870 * @param category The desired category. This can be either one of the
7871 * predefined Intent categories, or a custom category in your own
7872 * namespace.
7873 *
7874 * @return Returns the same Intent object, for chaining multiple calls
7875 * into a single statement.
7876 *
7877 * @see #hasCategory
7878 * @see #removeCategory
7879 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007880 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007881 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007882 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007883 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007884 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007885 return this;
7886 }
7887
7888 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007889 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007890 *
7891 * @param category The category to remove.
7892 *
7893 * @see #addCategory
7894 */
7895 public void removeCategory(String category) {
7896 if (mCategories != null) {
7897 mCategories.remove(category);
7898 if (mCategories.size() == 0) {
7899 mCategories = null;
7900 }
7901 }
7902 }
7903
7904 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007905 * Set a selector for this Intent. This is a modification to the kinds of
7906 * things the Intent will match. If the selector is set, it will be used
7907 * when trying to find entities that can handle the Intent, instead of the
7908 * main contents of the Intent. This allows you build an Intent containing
7909 * a generic protocol while targeting it more specifically.
7910 *
7911 * <p>An example of where this may be used is with things like
7912 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7913 * Intent that will launch the Browser application. However, the correct
7914 * main entry point of an application is actually {@link #ACTION_MAIN}
7915 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7916 * used to specify the actual Activity to launch. If you launch the browser
7917 * with something different, undesired behavior may happen if the user has
7918 * previously or later launches it the normal way, since they do not match.
7919 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7920 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7921 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7922 *
7923 * <p>Setting a selector does not impact the behavior of
7924 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7925 * desired behavior of a selector -- it does not impact the base meaning
7926 * of the Intent, just what kinds of things will be matched against it
7927 * when determining who can handle it.</p>
7928 *
7929 * <p>You can not use both a selector and {@link #setPackage(String)} on
7930 * the same base Intent.</p>
7931 *
7932 * @param selector The desired selector Intent; set to null to not use
7933 * a special selector.
7934 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007935 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007936 if (selector == this) {
7937 throw new IllegalArgumentException(
7938 "Intent being set as a selector of itself");
7939 }
7940 if (selector != null && mPackage != null) {
7941 throw new IllegalArgumentException(
7942 "Can't set selector when package name is already set");
7943 }
7944 mSelector = selector;
7945 }
7946
7947 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007948 * Set a {@link ClipData} associated with this Intent. This replaces any
7949 * previously set ClipData.
7950 *
7951 * <p>The ClipData in an intent is not used for Intent matching or other
7952 * such operations. Semantically it is like extras, used to transmit
7953 * additional data with the Intent. The main feature of using this over
7954 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7955 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7956 * items included in the clip data. This is useful, in particular, if
7957 * you want to transmit an Intent containing multiple <code>content:</code>
7958 * URIs for which the recipient may not have global permission to access the
7959 * content provider.
7960 *
7961 * <p>If the ClipData contains items that are themselves Intents, any
7962 * grant flags in those Intents will be ignored. Only the top-level flags
7963 * of the main Intent are respected, and will be applied to all Uri or
7964 * Intent items in the clip (or sub-items of the clip).
7965 *
7966 * <p>The MIME type, label, and icon in the ClipData object are not
7967 * directly used by Intent. Applications should generally rely on the
7968 * MIME type of the Intent itself, not what it may find in the ClipData.
7969 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007970 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007971 *
7972 * @param clip The new clip to set. May be null to clear the current clip.
7973 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007974 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007975 mClipData = clip;
7976 }
7977
7978 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007979 * This is NOT a secure mechanism to identify the user who sent the intent.
7980 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7981 * who sent the intent.
7982 * @hide
7983 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007984 public void prepareToLeaveUser(int userId) {
7985 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7986 // We want mContentUserHint to refer to the original user, so don't do anything.
7987 if (mContentUserHint == UserHandle.USER_CURRENT) {
7988 mContentUserHint = userId;
7989 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007990 }
7991
7992 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007993 * Add extended data to the intent. The name must include a package
7994 * prefix, for example the app com.android.contacts would use names
7995 * like "com.android.contacts.ShowAll".
7996 *
7997 * @param name The name of the extra data, with package prefix.
7998 * @param value The boolean data value.
7999 *
8000 * @return Returns the same Intent object, for chaining multiple calls
8001 * into a single statement.
8002 *
8003 * @see #putExtras
8004 * @see #removeExtra
8005 * @see #getBooleanExtra(String, boolean)
8006 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008007 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008008 if (mExtras == null) {
8009 mExtras = new Bundle();
8010 }
8011 mExtras.putBoolean(name, value);
8012 return this;
8013 }
8014
8015 /**
8016 * Add extended data to the intent. The name must include a package
8017 * prefix, for example the app com.android.contacts would use names
8018 * like "com.android.contacts.ShowAll".
8019 *
8020 * @param name The name of the extra data, with package prefix.
8021 * @param value The byte data value.
8022 *
8023 * @return Returns the same Intent object, for chaining multiple calls
8024 * into a single statement.
8025 *
8026 * @see #putExtras
8027 * @see #removeExtra
8028 * @see #getByteExtra(String, byte)
8029 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008030 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008031 if (mExtras == null) {
8032 mExtras = new Bundle();
8033 }
8034 mExtras.putByte(name, value);
8035 return this;
8036 }
8037
8038 /**
8039 * Add extended data to the intent. The name must include a package
8040 * prefix, for example the app com.android.contacts would use names
8041 * like "com.android.contacts.ShowAll".
8042 *
8043 * @param name The name of the extra data, with package prefix.
8044 * @param value The char data value.
8045 *
8046 * @return Returns the same Intent object, for chaining multiple calls
8047 * into a single statement.
8048 *
8049 * @see #putExtras
8050 * @see #removeExtra
8051 * @see #getCharExtra(String, char)
8052 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008053 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008054 if (mExtras == null) {
8055 mExtras = new Bundle();
8056 }
8057 mExtras.putChar(name, value);
8058 return this;
8059 }
8060
8061 /**
8062 * Add extended data to the intent. The name must include a package
8063 * prefix, for example the app com.android.contacts would use names
8064 * like "com.android.contacts.ShowAll".
8065 *
8066 * @param name The name of the extra data, with package prefix.
8067 * @param value The short data value.
8068 *
8069 * @return Returns the same Intent object, for chaining multiple calls
8070 * into a single statement.
8071 *
8072 * @see #putExtras
8073 * @see #removeExtra
8074 * @see #getShortExtra(String, short)
8075 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008076 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008077 if (mExtras == null) {
8078 mExtras = new Bundle();
8079 }
8080 mExtras.putShort(name, value);
8081 return this;
8082 }
8083
8084 /**
8085 * Add extended data to the intent. The name must include a package
8086 * prefix, for example the app com.android.contacts would use names
8087 * like "com.android.contacts.ShowAll".
8088 *
8089 * @param name The name of the extra data, with package prefix.
8090 * @param value The integer data value.
8091 *
8092 * @return Returns the same Intent object, for chaining multiple calls
8093 * into a single statement.
8094 *
8095 * @see #putExtras
8096 * @see #removeExtra
8097 * @see #getIntExtra(String, int)
8098 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008099 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008100 if (mExtras == null) {
8101 mExtras = new Bundle();
8102 }
8103 mExtras.putInt(name, value);
8104 return this;
8105 }
8106
8107 /**
8108 * Add extended data to the intent. The name must include a package
8109 * prefix, for example the app com.android.contacts would use names
8110 * like "com.android.contacts.ShowAll".
8111 *
8112 * @param name The name of the extra data, with package prefix.
8113 * @param value The long data value.
8114 *
8115 * @return Returns the same Intent object, for chaining multiple calls
8116 * into a single statement.
8117 *
8118 * @see #putExtras
8119 * @see #removeExtra
8120 * @see #getLongExtra(String, long)
8121 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008122 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008123 if (mExtras == null) {
8124 mExtras = new Bundle();
8125 }
8126 mExtras.putLong(name, value);
8127 return this;
8128 }
8129
8130 /**
8131 * Add extended data to the intent. The name must include a package
8132 * prefix, for example the app com.android.contacts would use names
8133 * like "com.android.contacts.ShowAll".
8134 *
8135 * @param name The name of the extra data, with package prefix.
8136 * @param value The float data value.
8137 *
8138 * @return Returns the same Intent object, for chaining multiple calls
8139 * into a single statement.
8140 *
8141 * @see #putExtras
8142 * @see #removeExtra
8143 * @see #getFloatExtra(String, float)
8144 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008145 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008146 if (mExtras == null) {
8147 mExtras = new Bundle();
8148 }
8149 mExtras.putFloat(name, value);
8150 return this;
8151 }
8152
8153 /**
8154 * Add extended data to the intent. The name must include a package
8155 * prefix, for example the app com.android.contacts would use names
8156 * like "com.android.contacts.ShowAll".
8157 *
8158 * @param name The name of the extra data, with package prefix.
8159 * @param value The double data value.
8160 *
8161 * @return Returns the same Intent object, for chaining multiple calls
8162 * into a single statement.
8163 *
8164 * @see #putExtras
8165 * @see #removeExtra
8166 * @see #getDoubleExtra(String, double)
8167 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008168 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008169 if (mExtras == null) {
8170 mExtras = new Bundle();
8171 }
8172 mExtras.putDouble(name, value);
8173 return this;
8174 }
8175
8176 /**
8177 * Add extended data to the intent. The name must include a package
8178 * prefix, for example the app com.android.contacts would use names
8179 * like "com.android.contacts.ShowAll".
8180 *
8181 * @param name The name of the extra data, with package prefix.
8182 * @param value The String data value.
8183 *
8184 * @return Returns the same Intent object, for chaining multiple calls
8185 * into a single statement.
8186 *
8187 * @see #putExtras
8188 * @see #removeExtra
8189 * @see #getStringExtra(String)
8190 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008191 public @NonNull Intent putExtra(String name, String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008192 if (mExtras == null) {
8193 mExtras = new Bundle();
8194 }
8195 mExtras.putString(name, value);
8196 return this;
8197 }
8198
8199 /**
8200 * Add extended data to the intent. The name must include a package
8201 * prefix, for example the app com.android.contacts would use names
8202 * like "com.android.contacts.ShowAll".
8203 *
8204 * @param name The name of the extra data, with package prefix.
8205 * @param value The CharSequence data value.
8206 *
8207 * @return Returns the same Intent object, for chaining multiple calls
8208 * into a single statement.
8209 *
8210 * @see #putExtras
8211 * @see #removeExtra
8212 * @see #getCharSequenceExtra(String)
8213 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008214 public @NonNull Intent putExtra(String name, CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008215 if (mExtras == null) {
8216 mExtras = new Bundle();
8217 }
8218 mExtras.putCharSequence(name, value);
8219 return this;
8220 }
8221
8222 /**
8223 * Add extended data to the intent. The name must include a package
8224 * prefix, for example the app com.android.contacts would use names
8225 * like "com.android.contacts.ShowAll".
8226 *
8227 * @param name The name of the extra data, with package prefix.
8228 * @param value The Parcelable data value.
8229 *
8230 * @return Returns the same Intent object, for chaining multiple calls
8231 * into a single statement.
8232 *
8233 * @see #putExtras
8234 * @see #removeExtra
8235 * @see #getParcelableExtra(String)
8236 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008237 public @NonNull Intent putExtra(String name, Parcelable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008238 if (mExtras == null) {
8239 mExtras = new Bundle();
8240 }
8241 mExtras.putParcelable(name, value);
8242 return this;
8243 }
8244
8245 /**
8246 * Add extended data to the intent. The name must include a package
8247 * prefix, for example the app com.android.contacts would use names
8248 * like "com.android.contacts.ShowAll".
8249 *
8250 * @param name The name of the extra data, with package prefix.
8251 * @param value The Parcelable[] data value.
8252 *
8253 * @return Returns the same Intent object, for chaining multiple calls
8254 * into a single statement.
8255 *
8256 * @see #putExtras
8257 * @see #removeExtra
8258 * @see #getParcelableArrayExtra(String)
8259 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008260 public @NonNull Intent putExtra(String name, Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008261 if (mExtras == null) {
8262 mExtras = new Bundle();
8263 }
8264 mExtras.putParcelableArray(name, value);
8265 return this;
8266 }
8267
8268 /**
8269 * Add extended data to the intent. The name must include a package
8270 * prefix, for example the app com.android.contacts would use names
8271 * like "com.android.contacts.ShowAll".
8272 *
8273 * @param name The name of the extra data, with package prefix.
8274 * @param value The ArrayList<Parcelable> data value.
8275 *
8276 * @return Returns the same Intent object, for chaining multiple calls
8277 * into a single statement.
8278 *
8279 * @see #putExtras
8280 * @see #removeExtra
8281 * @see #getParcelableArrayListExtra(String)
8282 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008283 public @NonNull Intent putParcelableArrayListExtra(String name,
8284 ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008285 if (mExtras == null) {
8286 mExtras = new Bundle();
8287 }
8288 mExtras.putParcelableArrayList(name, value);
8289 return this;
8290 }
8291
8292 /**
8293 * Add extended data to the intent. The name must include a package
8294 * prefix, for example the app com.android.contacts would use names
8295 * like "com.android.contacts.ShowAll".
8296 *
8297 * @param name The name of the extra data, with package prefix.
8298 * @param value The ArrayList<Integer> data value.
8299 *
8300 * @return Returns the same Intent object, for chaining multiple calls
8301 * into a single statement.
8302 *
8303 * @see #putExtras
8304 * @see #removeExtra
8305 * @see #getIntegerArrayListExtra(String)
8306 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008307 public @NonNull Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008308 if (mExtras == null) {
8309 mExtras = new Bundle();
8310 }
8311 mExtras.putIntegerArrayList(name, value);
8312 return this;
8313 }
8314
8315 /**
8316 * Add extended data to the intent. The name must include a package
8317 * prefix, for example the app com.android.contacts would use names
8318 * like "com.android.contacts.ShowAll".
8319 *
8320 * @param name The name of the extra data, with package prefix.
8321 * @param value The ArrayList<String> data value.
8322 *
8323 * @return Returns the same Intent object, for chaining multiple calls
8324 * into a single statement.
8325 *
8326 * @see #putExtras
8327 * @see #removeExtra
8328 * @see #getStringArrayListExtra(String)
8329 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008330 public @NonNull Intent putStringArrayListExtra(String name, ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008331 if (mExtras == null) {
8332 mExtras = new Bundle();
8333 }
8334 mExtras.putStringArrayList(name, value);
8335 return this;
8336 }
8337
8338 /**
8339 * Add extended data to the intent. The name must include a package
8340 * prefix, for example the app com.android.contacts would use names
8341 * like "com.android.contacts.ShowAll".
8342 *
8343 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008344 * @param value The ArrayList<CharSequence> data value.
8345 *
8346 * @return Returns the same Intent object, for chaining multiple calls
8347 * into a single statement.
8348 *
8349 * @see #putExtras
8350 * @see #removeExtra
8351 * @see #getCharSequenceArrayListExtra(String)
8352 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008353 public @NonNull Intent putCharSequenceArrayListExtra(String name,
8354 ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008355 if (mExtras == null) {
8356 mExtras = new Bundle();
8357 }
8358 mExtras.putCharSequenceArrayList(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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008368 * @param value The Serializable 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 #getSerializableExtra(String)
8376 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008377 public @NonNull Intent putExtra(String name, Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008378 if (mExtras == null) {
8379 mExtras = new Bundle();
8380 }
8381 mExtras.putSerializable(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 boolean array 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 #getBooleanArrayExtra(String)
8399 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008400 public @NonNull Intent putExtra(String name, boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008401 if (mExtras == null) {
8402 mExtras = new Bundle();
8403 }
8404 mExtras.putBooleanArray(name, value);
8405 return this;
8406 }
8407
8408 /**
8409 * Add extended data to the intent. The name must include a package
8410 * prefix, for example the app com.android.contacts would use names
8411 * like "com.android.contacts.ShowAll".
8412 *
8413 * @param name The name of the extra data, with package prefix.
8414 * @param value The byte array data value.
8415 *
8416 * @return Returns the same Intent object, for chaining multiple calls
8417 * into a single statement.
8418 *
8419 * @see #putExtras
8420 * @see #removeExtra
8421 * @see #getByteArrayExtra(String)
8422 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008423 public @NonNull Intent putExtra(String name, byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008424 if (mExtras == null) {
8425 mExtras = new Bundle();
8426 }
8427 mExtras.putByteArray(name, value);
8428 return this;
8429 }
8430
8431 /**
8432 * Add extended data to the intent. The name must include a package
8433 * prefix, for example the app com.android.contacts would use names
8434 * like "com.android.contacts.ShowAll".
8435 *
8436 * @param name The name of the extra data, with package prefix.
8437 * @param value The short array data value.
8438 *
8439 * @return Returns the same Intent object, for chaining multiple calls
8440 * into a single statement.
8441 *
8442 * @see #putExtras
8443 * @see #removeExtra
8444 * @see #getShortArrayExtra(String)
8445 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008446 public @NonNull Intent putExtra(String name, short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008447 if (mExtras == null) {
8448 mExtras = new Bundle();
8449 }
8450 mExtras.putShortArray(name, value);
8451 return this;
8452 }
8453
8454 /**
8455 * Add extended data to the intent. The name must include a package
8456 * prefix, for example the app com.android.contacts would use names
8457 * like "com.android.contacts.ShowAll".
8458 *
8459 * @param name The name of the extra data, with package prefix.
8460 * @param value The char array data value.
8461 *
8462 * @return Returns the same Intent object, for chaining multiple calls
8463 * into a single statement.
8464 *
8465 * @see #putExtras
8466 * @see #removeExtra
8467 * @see #getCharArrayExtra(String)
8468 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008469 public @NonNull Intent putExtra(String name, char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008470 if (mExtras == null) {
8471 mExtras = new Bundle();
8472 }
8473 mExtras.putCharArray(name, value);
8474 return this;
8475 }
8476
8477 /**
8478 * Add extended data to the intent. The name must include a package
8479 * prefix, for example the app com.android.contacts would use names
8480 * like "com.android.contacts.ShowAll".
8481 *
8482 * @param name The name of the extra data, with package prefix.
8483 * @param value The int array data value.
8484 *
8485 * @return Returns the same Intent object, for chaining multiple calls
8486 * into a single statement.
8487 *
8488 * @see #putExtras
8489 * @see #removeExtra
8490 * @see #getIntArrayExtra(String)
8491 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008492 public @NonNull Intent putExtra(String name, int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008493 if (mExtras == null) {
8494 mExtras = new Bundle();
8495 }
8496 mExtras.putIntArray(name, value);
8497 return this;
8498 }
8499
8500 /**
8501 * Add extended data to the intent. The name must include a package
8502 * prefix, for example the app com.android.contacts would use names
8503 * like "com.android.contacts.ShowAll".
8504 *
8505 * @param name The name of the extra data, with package prefix.
8506 * @param value The byte array data value.
8507 *
8508 * @return Returns the same Intent object, for chaining multiple calls
8509 * into a single statement.
8510 *
8511 * @see #putExtras
8512 * @see #removeExtra
8513 * @see #getLongArrayExtra(String)
8514 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008515 public @NonNull Intent putExtra(String name, long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008516 if (mExtras == null) {
8517 mExtras = new Bundle();
8518 }
8519 mExtras.putLongArray(name, value);
8520 return this;
8521 }
8522
8523 /**
8524 * Add extended data to the intent. The name must include a package
8525 * prefix, for example the app com.android.contacts would use names
8526 * like "com.android.contacts.ShowAll".
8527 *
8528 * @param name The name of the extra data, with package prefix.
8529 * @param value The float array data value.
8530 *
8531 * @return Returns the same Intent object, for chaining multiple calls
8532 * into a single statement.
8533 *
8534 * @see #putExtras
8535 * @see #removeExtra
8536 * @see #getFloatArrayExtra(String)
8537 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008538 public @NonNull Intent putExtra(String name, float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008539 if (mExtras == null) {
8540 mExtras = new Bundle();
8541 }
8542 mExtras.putFloatArray(name, value);
8543 return this;
8544 }
8545
8546 /**
8547 * Add extended data to the intent. The name must include a package
8548 * prefix, for example the app com.android.contacts would use names
8549 * like "com.android.contacts.ShowAll".
8550 *
8551 * @param name The name of the extra data, with package prefix.
8552 * @param value The double array data value.
8553 *
8554 * @return Returns the same Intent object, for chaining multiple calls
8555 * into a single statement.
8556 *
8557 * @see #putExtras
8558 * @see #removeExtra
8559 * @see #getDoubleArrayExtra(String)
8560 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008561 public @NonNull Intent putExtra(String name, double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008562 if (mExtras == null) {
8563 mExtras = new Bundle();
8564 }
8565 mExtras.putDoubleArray(name, value);
8566 return this;
8567 }
8568
8569 /**
8570 * Add extended data to the intent. The name must include a package
8571 * prefix, for example the app com.android.contacts would use names
8572 * like "com.android.contacts.ShowAll".
8573 *
8574 * @param name The name of the extra data, with package prefix.
8575 * @param value The String array data value.
8576 *
8577 * @return Returns the same Intent object, for chaining multiple calls
8578 * into a single statement.
8579 *
8580 * @see #putExtras
8581 * @see #removeExtra
8582 * @see #getStringArrayExtra(String)
8583 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008584 public @NonNull Intent putExtra(String name, String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008585 if (mExtras == null) {
8586 mExtras = new Bundle();
8587 }
8588 mExtras.putStringArray(name, value);
8589 return this;
8590 }
8591
8592 /**
8593 * Add extended data to the intent. The name must include a package
8594 * prefix, for example the app com.android.contacts would use names
8595 * like "com.android.contacts.ShowAll".
8596 *
8597 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008598 * @param value The CharSequence array data value.
8599 *
8600 * @return Returns the same Intent object, for chaining multiple calls
8601 * into a single statement.
8602 *
8603 * @see #putExtras
8604 * @see #removeExtra
8605 * @see #getCharSequenceArrayExtra(String)
8606 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008607 public @NonNull Intent putExtra(String name, CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008608 if (mExtras == null) {
8609 mExtras = new Bundle();
8610 }
8611 mExtras.putCharSequenceArray(name, value);
8612 return this;
8613 }
8614
8615 /**
8616 * Add extended data to the intent. The name must include a package
8617 * prefix, for example the app com.android.contacts would use names
8618 * like "com.android.contacts.ShowAll".
8619 *
8620 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008621 * @param value The Bundle data value.
8622 *
8623 * @return Returns the same Intent object, for chaining multiple calls
8624 * into a single statement.
8625 *
8626 * @see #putExtras
8627 * @see #removeExtra
8628 * @see #getBundleExtra(String)
8629 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008630 public @NonNull Intent putExtra(String name, Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008631 if (mExtras == null) {
8632 mExtras = new Bundle();
8633 }
8634 mExtras.putBundle(name, value);
8635 return this;
8636 }
8637
8638 /**
8639 * Add extended data to the intent. The name must include a package
8640 * prefix, for example the app com.android.contacts would use names
8641 * like "com.android.contacts.ShowAll".
8642 *
8643 * @param name The name of the extra data, with package prefix.
8644 * @param value The IBinder data value.
8645 *
8646 * @return Returns the same Intent object, for chaining multiple calls
8647 * into a single statement.
8648 *
8649 * @see #putExtras
8650 * @see #removeExtra
8651 * @see #getIBinderExtra(String)
8652 *
8653 * @deprecated
8654 * @hide
8655 */
8656 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008657 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008658 if (mExtras == null) {
8659 mExtras = new Bundle();
8660 }
8661 mExtras.putIBinder(name, value);
8662 return this;
8663 }
8664
8665 /**
8666 * Copy all extras in 'src' in to this intent.
8667 *
8668 * @param src Contains the extras to copy.
8669 *
8670 * @see #putExtra
8671 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008672 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008673 if (src.mExtras != null) {
8674 if (mExtras == null) {
8675 mExtras = new Bundle(src.mExtras);
8676 } else {
8677 mExtras.putAll(src.mExtras);
8678 }
8679 }
8680 return this;
8681 }
8682
8683 /**
8684 * Add a set of extended data to the intent. The keys must include a package
8685 * prefix, for example the app com.android.contacts would use names
8686 * like "com.android.contacts.ShowAll".
8687 *
8688 * @param extras The Bundle of extras to add to this intent.
8689 *
8690 * @see #putExtra
8691 * @see #removeExtra
8692 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008693 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008694 if (mExtras == null) {
8695 mExtras = new Bundle();
8696 }
8697 mExtras.putAll(extras);
8698 return this;
8699 }
8700
8701 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008702 * Completely replace the extras in the Intent with the extras in the
8703 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008704 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008705 * @param src The exact extras contained in this Intent are copied
8706 * into the target intent, replacing any that were previously there.
8707 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008708 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008709 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8710 return this;
8711 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008712
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008713 /**
8714 * Completely replace the extras in the Intent with the given Bundle of
8715 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008716 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008717 * @param extras The new set of extras in the Intent, or null to erase
8718 * all extras.
8719 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008720 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008721 mExtras = extras != null ? new Bundle(extras) : null;
8722 return this;
8723 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008724
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008725 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008726 * Remove extended data from the intent.
8727 *
8728 * @see #putExtra
8729 */
8730 public void removeExtra(String name) {
8731 if (mExtras != null) {
8732 mExtras.remove(name);
8733 if (mExtras.size() == 0) {
8734 mExtras = null;
8735 }
8736 }
8737 }
8738
8739 /**
8740 * Set special flags controlling how this intent is handled. Most values
8741 * here depend on the type of component being executed by the Intent,
8742 * specifically the FLAG_ACTIVITY_* flags are all for use with
8743 * {@link Context#startActivity Context.startActivity()} and the
8744 * FLAG_RECEIVER_* flags are all for use with
8745 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8746 *
Scott Main7aee61f2011-02-08 11:25:01 -08008747 * <p>See the
8748 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8749 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008750 * the behavior of your application.
8751 *
8752 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008753 * @return Returns the same Intent object, for chaining multiple calls
8754 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008755 * @see #getFlags
8756 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008757 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008758 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008759 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008760 mFlags = flags;
8761 return this;
8762 }
8763
8764 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008765 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008766 *
8767 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008768 * @return Returns the same Intent object, for chaining multiple calls into
8769 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008770 * @see #setFlags
8771 * @see #getFlags
8772 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008773 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008774 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008775 mFlags |= flags;
8776 return this;
8777 }
8778
8779 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008780 * Remove these flags from the intent.
8781 *
8782 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008783 * @see #setFlags
8784 * @see #getFlags
8785 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008786 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008787 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008788 mFlags &= ~flags;
8789 }
8790
8791 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008792 * (Usually optional) Set an explicit application package name that limits
8793 * the components this Intent will resolve to. If left to the default
8794 * value of null, all components in all applications will considered.
8795 * If non-null, the Intent can only match the components in the given
8796 * application package.
8797 *
8798 * @param packageName The name of the application package to handle the
8799 * intent, or null to allow any application package.
8800 *
8801 * @return Returns the same Intent object, for chaining multiple calls
8802 * into a single statement.
8803 *
8804 * @see #getPackage
8805 * @see #resolveActivity
8806 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008807 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008808 if (packageName != null && mSelector != null) {
8809 throw new IllegalArgumentException(
8810 "Can't set package name when selector is already set");
8811 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008812 mPackage = packageName;
8813 return this;
8814 }
8815
8816 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008817 * (Usually optional) Explicitly set the component to handle the intent.
8818 * If left with the default value of null, the system will determine the
8819 * appropriate class to use based on the other fields (action, data,
8820 * type, categories) in the Intent. If this class is defined, the
8821 * specified class will always be used regardless of the other fields. You
8822 * should only set this value when you know you absolutely want a specific
8823 * class to be used; otherwise it is better to let the system find the
8824 * appropriate class so that you will respect the installed applications
8825 * and user preferences.
8826 *
8827 * @param component The name of the application component to handle the
8828 * intent, or null to let the system find one for you.
8829 *
8830 * @return Returns the same Intent object, for chaining multiple calls
8831 * into a single statement.
8832 *
8833 * @see #setClass
8834 * @see #setClassName(Context, String)
8835 * @see #setClassName(String, String)
8836 * @see #getComponent
8837 * @see #resolveActivity
8838 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008839 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008840 mComponent = component;
8841 return this;
8842 }
8843
8844 /**
8845 * Convenience for calling {@link #setComponent} with an
8846 * explicit class name.
8847 *
8848 * @param packageContext A Context of the application package implementing
8849 * this class.
8850 * @param className The name of a class inside of the application package
8851 * that will be used as the component for this Intent.
8852 *
8853 * @return Returns the same Intent object, for chaining multiple calls
8854 * into a single statement.
8855 *
8856 * @see #setComponent
8857 * @see #setClass
8858 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008859 public @NonNull Intent setClassName(@NonNull Context packageContext,
8860 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008861 mComponent = new ComponentName(packageContext, className);
8862 return this;
8863 }
8864
8865 /**
8866 * Convenience for calling {@link #setComponent} with an
8867 * explicit application package name and class name.
8868 *
8869 * @param packageName The name of the package implementing the desired
8870 * component.
8871 * @param className The name of a class inside of the application package
8872 * that will be used as the component for this Intent.
8873 *
8874 * @return Returns the same Intent object, for chaining multiple calls
8875 * into a single statement.
8876 *
8877 * @see #setComponent
8878 * @see #setClass
8879 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008880 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008881 mComponent = new ComponentName(packageName, className);
8882 return this;
8883 }
8884
8885 /**
8886 * Convenience for calling {@link #setComponent(ComponentName)} with the
8887 * name returned by a {@link Class} object.
8888 *
8889 * @param packageContext A Context of the application package implementing
8890 * this class.
8891 * @param cls The class name to set, equivalent to
8892 * <code>setClassName(context, cls.getName())</code>.
8893 *
8894 * @return Returns the same Intent object, for chaining multiple calls
8895 * into a single statement.
8896 *
8897 * @see #setComponent
8898 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008899 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008900 mComponent = new ComponentName(packageContext, cls);
8901 return this;
8902 }
8903
8904 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008905 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8906 * used as a hint to the receiver for animations and the like. Null means that there
8907 * is no source bounds.
8908 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008909 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008910 if (r != null) {
8911 mSourceBounds = new Rect(r);
8912 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008913 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008914 }
8915 }
8916
Tor Norbyed9273d62013-05-30 15:59:53 -07008917 /** @hide */
8918 @IntDef(flag = true,
8919 value = {
8920 FILL_IN_ACTION,
8921 FILL_IN_DATA,
8922 FILL_IN_CATEGORIES,
8923 FILL_IN_COMPONENT,
8924 FILL_IN_PACKAGE,
8925 FILL_IN_SOURCE_BOUNDS,
8926 FILL_IN_SELECTOR,
8927 FILL_IN_CLIP_DATA
8928 })
8929 @Retention(RetentionPolicy.SOURCE)
8930 public @interface FillInFlags {}
8931
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008932 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008933 * Use with {@link #fillIn} to allow the current action value to be
8934 * overwritten, even if it is already set.
8935 */
8936 public static final int FILL_IN_ACTION = 1<<0;
8937
8938 /**
8939 * Use with {@link #fillIn} to allow the current data or type value
8940 * overwritten, even if it is already set.
8941 */
8942 public static final int FILL_IN_DATA = 1<<1;
8943
8944 /**
8945 * Use with {@link #fillIn} to allow the current categories to be
8946 * overwritten, even if they are already set.
8947 */
8948 public static final int FILL_IN_CATEGORIES = 1<<2;
8949
8950 /**
8951 * Use with {@link #fillIn} to allow the current component value to be
8952 * overwritten, even if it is already set.
8953 */
8954 public static final int FILL_IN_COMPONENT = 1<<3;
8955
8956 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008957 * Use with {@link #fillIn} to allow the current package value to be
8958 * overwritten, even if it is already set.
8959 */
8960 public static final int FILL_IN_PACKAGE = 1<<4;
8961
8962 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008963 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008964 * overwritten, even if it is already set.
8965 */
8966 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8967
8968 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008969 * Use with {@link #fillIn} to allow the current selector to be
8970 * overwritten, even if it is already set.
8971 */
8972 public static final int FILL_IN_SELECTOR = 1<<6;
8973
8974 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008975 * Use with {@link #fillIn} to allow the current ClipData to be
8976 * overwritten, even if it is already set.
8977 */
8978 public static final int FILL_IN_CLIP_DATA = 1<<7;
8979
8980 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008981 * Copy the contents of <var>other</var> in to this object, but only
8982 * where fields are not defined by this object. For purposes of a field
8983 * being defined, the following pieces of data in the Intent are
8984 * considered to be separate fields:
8985 *
8986 * <ul>
8987 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008988 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008989 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8990 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008991 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008992 * <li> component, as set by {@link #setComponent(ComponentName)} or
8993 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008994 * <li> source bounds, as set by {@link #setSourceBounds}.
8995 * <li> selector, as set by {@link #setSelector(Intent)}.
8996 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008997 * <li> each top-level name in the associated extras.
8998 * </ul>
8999 *
9000 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009001 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009002 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
9003 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
9004 * the restriction where the corresponding field will not be replaced if
9005 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009006 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009007 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
9008 * is explicitly specified. The selector will only be copied if
9009 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07009010 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009011 * <p>For example, consider Intent A with {data="foo", categories="bar"}
9012 * and Intent B with {action="gotit", data-type="some/thing",
9013 * categories="one","two"}.
9014 *
9015 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
9016 * containing: {action="gotit", data-type="some/thing",
9017 * categories="bar"}.
9018 *
9019 * @param other Another Intent whose values are to be used to fill in
9020 * the current one.
9021 * @param flags Options to control which fields can be filled in.
9022 *
9023 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009024 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07009025 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08009026 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07009027 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009028 */
Tor Norbyed9273d62013-05-30 15:59:53 -07009029 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009030 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009031 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009032 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009033 if (other.mAction != null
9034 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009035 mAction = other.mAction;
9036 changes |= FILL_IN_ACTION;
9037 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009038 if ((other.mData != null || other.mType != null)
9039 && ((mData == null && mType == null)
9040 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009041 mData = other.mData;
9042 mType = other.mType;
9043 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009044 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009045 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009046 if (other.mCategories != null
9047 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009048 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009049 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009050 }
9051 changes |= FILL_IN_CATEGORIES;
9052 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009053 if (other.mPackage != null
9054 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009055 // Only do this if mSelector is not set.
9056 if (mSelector == null) {
9057 mPackage = other.mPackage;
9058 changes |= FILL_IN_PACKAGE;
9059 }
9060 }
9061 // Selector is special: it can only be set if explicitly allowed,
9062 // for the same reason as the component name.
9063 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
9064 if (mPackage == null) {
9065 mSelector = new Intent(other.mSelector);
9066 mPackage = null;
9067 changes |= FILL_IN_SELECTOR;
9068 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009069 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009070 if (other.mClipData != null
9071 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
9072 mClipData = other.mClipData;
9073 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009074 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009075 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009076 // Component is special: it can -only- be set if explicitly allowed,
9077 // since otherwise the sender could force the intent somewhere the
9078 // originator didn't intend.
9079 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009080 mComponent = other.mComponent;
9081 changes |= FILL_IN_COMPONENT;
9082 }
9083 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009084 if (other.mSourceBounds != null
9085 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
9086 mSourceBounds = new Rect(other.mSourceBounds);
9087 changes |= FILL_IN_SOURCE_BOUNDS;
9088 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009089 if (mExtras == null) {
9090 if (other.mExtras != null) {
9091 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009092 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009093 }
9094 } else if (other.mExtras != null) {
9095 try {
9096 Bundle newb = new Bundle(other.mExtras);
9097 newb.putAll(mExtras);
9098 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009099 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009100 } catch (RuntimeException e) {
9101 // Modifying the extras can cause us to unparcel the contents
9102 // of the bundle, and if we do this in the system process that
9103 // may fail. We really should handle this (i.e., the Bundle
9104 // impl shouldn't be on top of a plain map), but for now just
9105 // ignore it and keep the original contents. :(
9106 Log.w("Intent", "Failure filling in extras", e);
9107 }
9108 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009109 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9110 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9111 mContentUserHint = other.mContentUserHint;
9112 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009113 return changes;
9114 }
9115
9116 /**
9117 * Wrapper class holding an Intent and implementing comparisons on it for
9118 * the purpose of filtering. The class implements its
9119 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9120 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9121 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9122 * on the wrapped Intent.
9123 */
9124 public static final class FilterComparison {
9125 private final Intent mIntent;
9126 private final int mHashCode;
9127
9128 public FilterComparison(Intent intent) {
9129 mIntent = intent;
9130 mHashCode = intent.filterHashCode();
9131 }
9132
9133 /**
9134 * Return the Intent that this FilterComparison represents.
9135 * @return Returns the Intent held by the FilterComparison. Do
9136 * not modify!
9137 */
9138 public Intent getIntent() {
9139 return mIntent;
9140 }
9141
9142 @Override
9143 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009144 if (obj instanceof FilterComparison) {
9145 Intent other = ((FilterComparison)obj).mIntent;
9146 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009147 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009148 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009149 }
9150
9151 @Override
9152 public int hashCode() {
9153 return mHashCode;
9154 }
9155 }
9156
9157 /**
9158 * Determine if two intents are the same for the purposes of intent
9159 * resolution (filtering). That is, if their action, data, type,
9160 * class, and categories are the same. This does <em>not</em> compare
9161 * any extra data included in the intents.
9162 *
9163 * @param other The other Intent to compare against.
9164 *
9165 * @return Returns true if action, data, type, class, and categories
9166 * are the same.
9167 */
9168 public boolean filterEquals(Intent other) {
9169 if (other == null) {
9170 return false;
9171 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009172 if (!Objects.equals(this.mAction, other.mAction)) return false;
9173 if (!Objects.equals(this.mData, other.mData)) return false;
9174 if (!Objects.equals(this.mType, other.mType)) return false;
9175 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9176 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9177 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009178
9179 return true;
9180 }
9181
9182 /**
9183 * Generate hash code that matches semantics of filterEquals().
9184 *
9185 * @return Returns the hash value of the action, data, type, class, and
9186 * categories.
9187 *
9188 * @see #filterEquals
9189 */
9190 public int filterHashCode() {
9191 int code = 0;
9192 if (mAction != null) {
9193 code += mAction.hashCode();
9194 }
9195 if (mData != null) {
9196 code += mData.hashCode();
9197 }
9198 if (mType != null) {
9199 code += mType.hashCode();
9200 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009201 if (mPackage != null) {
9202 code += mPackage.hashCode();
9203 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009204 if (mComponent != null) {
9205 code += mComponent.hashCode();
9206 }
9207 if (mCategories != null) {
9208 code += mCategories.hashCode();
9209 }
9210 return code;
9211 }
9212
9213 @Override
9214 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009215 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009216
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009217 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009218 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009219 b.append(" }");
9220
9221 return b.toString();
9222 }
9223
9224 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009225 public String toInsecureString() {
9226 StringBuilder b = new StringBuilder(128);
9227
9228 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009229 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009230 b.append(" }");
9231
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009232 return b.toString();
9233 }
Romain Guy4969af72009-06-17 10:53:19 -07009234
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009235 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009236 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009237 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009238
9239 b.append("Intent { ");
9240 toShortString(b, false, true, true, true);
9241 b.append(" }");
9242
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009243 return b.toString();
9244 }
9245
9246 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009247 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9248 StringBuilder b = new StringBuilder(128);
9249 toShortString(b, secure, comp, extras, clip);
9250 return b.toString();
9251 }
9252
9253 /** @hide */
9254 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9255 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009256 boolean first = true;
9257 if (mAction != null) {
9258 b.append("act=").append(mAction);
9259 first = false;
9260 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009261 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009262 if (!first) {
9263 b.append(' ');
9264 }
9265 first = false;
9266 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009267 for (int i=0; i<mCategories.size(); i++) {
9268 if (i > 0) b.append(',');
9269 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009270 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009271 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009272 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009273 if (mData != null) {
9274 if (!first) {
9275 b.append(' ');
9276 }
9277 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009278 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009279 if (secure) {
9280 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009281 } else {
9282 b.append(mData);
9283 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009284 }
9285 if (mType != null) {
9286 if (!first) {
9287 b.append(' ');
9288 }
9289 first = false;
9290 b.append("typ=").append(mType);
9291 }
9292 if (mFlags != 0) {
9293 if (!first) {
9294 b.append(' ');
9295 }
9296 first = false;
9297 b.append("flg=0x").append(Integer.toHexString(mFlags));
9298 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009299 if (mPackage != null) {
9300 if (!first) {
9301 b.append(' ');
9302 }
9303 first = false;
9304 b.append("pkg=").append(mPackage);
9305 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009306 if (comp && mComponent != null) {
9307 if (!first) {
9308 b.append(' ');
9309 }
9310 first = false;
9311 b.append("cmp=").append(mComponent.flattenToShortString());
9312 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009313 if (mSourceBounds != null) {
9314 if (!first) {
9315 b.append(' ');
9316 }
9317 first = false;
9318 b.append("bnds=").append(mSourceBounds.toShortString());
9319 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009320 if (mClipData != null) {
9321 if (!first) {
9322 b.append(' ');
9323 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009324 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009325 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009326 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009327 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009328 if (mClipData.getDescription() != null) {
9329 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9330 } else {
9331 first = true;
9332 }
9333 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009334 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009335 first = false;
9336 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009337 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009338 if (extras && mExtras != null) {
9339 if (!first) {
9340 b.append(' ');
9341 }
9342 first = false;
9343 b.append("(has extras)");
9344 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009345 if (mContentUserHint != UserHandle.USER_CURRENT) {
9346 if (!first) {
9347 b.append(' ');
9348 }
9349 first = false;
9350 b.append("u=").append(mContentUserHint);
9351 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009352 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009353 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009354 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009355 b.append("}");
9356 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009357 }
9358
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009359 /**
9360 * Call {@link #toUri} with 0 flags.
9361 * @deprecated Use {@link #toUri} instead.
9362 */
9363 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009364 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009365 return toUri(0);
9366 }
9367
9368 /**
9369 * Convert this Intent into a String holding a URI representation of it.
9370 * The returned URI string has been properly URI encoded, so it can be
9371 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9372 * Intent's data as the base URI, with an additional fragment describing
9373 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009374 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009375 * <p>You can convert the returned string back to an Intent with
9376 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009377 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009378 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009379 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009380 * @return Returns a URI encoding URI string describing the entire contents
9381 * of the Intent.
9382 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009383 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009384 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009385 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9386 if (mPackage == null) {
9387 throw new IllegalArgumentException(
9388 "Intent must include an explicit package name to build an android-app: "
9389 + this);
9390 }
9391 uri.append("android-app://");
9392 uri.append(mPackage);
9393 String scheme = null;
9394 if (mData != null) {
9395 scheme = mData.getScheme();
9396 if (scheme != null) {
9397 uri.append('/');
9398 uri.append(scheme);
9399 String authority = mData.getEncodedAuthority();
9400 if (authority != null) {
9401 uri.append('/');
9402 uri.append(authority);
9403 String path = mData.getEncodedPath();
9404 if (path != null) {
9405 uri.append(path);
9406 }
9407 String queryParams = mData.getEncodedQuery();
9408 if (queryParams != null) {
9409 uri.append('?');
9410 uri.append(queryParams);
9411 }
9412 String fragment = mData.getEncodedFragment();
9413 if (fragment != null) {
9414 uri.append('#');
9415 uri.append(fragment);
9416 }
9417 }
9418 }
9419 }
9420 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9421 mPackage, flags);
9422 return uri.toString();
9423 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009424 String scheme = null;
9425 if (mData != null) {
9426 String data = mData.toString();
9427 if ((flags&URI_INTENT_SCHEME) != 0) {
9428 final int N = data.length();
9429 for (int i=0; i<N; i++) {
9430 char c = data.charAt(i);
9431 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
9432 || c == '.' || c == '-') {
9433 continue;
9434 }
9435 if (c == ':' && i > 0) {
9436 // Valid scheme.
9437 scheme = data.substring(0, i);
9438 uri.append("intent:");
9439 data = data.substring(i+1);
9440 break;
9441 }
Tom Taylord4a47292009-12-21 13:59:18 -08009442
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009443 // No scheme.
9444 break;
9445 }
9446 }
9447 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009448
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009449 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9450 uri.append("intent:");
9451 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009452
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009453 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009454
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009455 return uri.toString();
9456 }
9457
9458 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9459 String defPackage, int flags) {
9460 StringBuilder frag = new StringBuilder(128);
9461
9462 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009463 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009464 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009465 // Note that for now we are not going to try to handle the
9466 // data part; not clear how to represent this as a URI, and
9467 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009468 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9469 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009470 }
9471
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009472 if (frag.length() > 0) {
9473 uri.append("#Intent;");
9474 uri.append(frag);
9475 uri.append("end");
9476 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009477 }
9478
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009479 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9480 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009481 if (scheme != null) {
9482 uri.append("scheme=").append(scheme).append(';');
9483 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009484 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009485 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009486 }
9487 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009488 for (int i=0; i<mCategories.size(); i++) {
9489 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009490 }
9491 }
9492 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009493 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009494 }
9495 if (mFlags != 0) {
9496 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9497 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009498 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009499 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9500 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009501 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009502 uri.append("component=").append(Uri.encode(
9503 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009504 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009505 if (mSourceBounds != null) {
9506 uri.append("sourceBounds=")
9507 .append(Uri.encode(mSourceBounds.flattenToString()))
9508 .append(';');
9509 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009510 if (mExtras != null) {
9511 for (String key : mExtras.keySet()) {
9512 final Object value = mExtras.get(key);
9513 char entryType =
9514 value instanceof String ? 'S' :
9515 value instanceof Boolean ? 'B' :
9516 value instanceof Byte ? 'b' :
9517 value instanceof Character ? 'c' :
9518 value instanceof Double ? 'd' :
9519 value instanceof Float ? 'f' :
9520 value instanceof Integer ? 'i' :
9521 value instanceof Long ? 'l' :
9522 value instanceof Short ? 's' :
9523 '\0';
9524
9525 if (entryType != '\0') {
9526 uri.append(entryType);
9527 uri.append('.');
9528 uri.append(Uri.encode(key));
9529 uri.append('=');
9530 uri.append(Uri.encode(value.toString()));
9531 uri.append(';');
9532 }
9533 }
9534 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009535 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009536
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009537 public int describeContents() {
9538 return (mExtras != null) ? mExtras.describeContents() : 0;
9539 }
9540
9541 public void writeToParcel(Parcel out, int flags) {
9542 out.writeString(mAction);
9543 Uri.writeToParcel(out, mData);
9544 out.writeString(mType);
9545 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009546 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009547 ComponentName.writeToParcel(mComponent, out);
9548
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009549 if (mSourceBounds != null) {
9550 out.writeInt(1);
9551 mSourceBounds.writeToParcel(out, flags);
9552 } else {
9553 out.writeInt(0);
9554 }
9555
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009556 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009557 final int N = mCategories.size();
9558 out.writeInt(N);
9559 for (int i=0; i<N; i++) {
9560 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009561 }
9562 } else {
9563 out.writeInt(0);
9564 }
9565
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009566 if (mSelector != null) {
9567 out.writeInt(1);
9568 mSelector.writeToParcel(out, flags);
9569 } else {
9570 out.writeInt(0);
9571 }
9572
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009573 if (mClipData != null) {
9574 out.writeInt(1);
9575 mClipData.writeToParcel(out, flags);
9576 } else {
9577 out.writeInt(0);
9578 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009579 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009580 out.writeBundle(mExtras);
9581 }
9582
9583 public static final Parcelable.Creator<Intent> CREATOR
9584 = new Parcelable.Creator<Intent>() {
9585 public Intent createFromParcel(Parcel in) {
9586 return new Intent(in);
9587 }
9588 public Intent[] newArray(int size) {
9589 return new Intent[size];
9590 }
9591 };
9592
Dianne Hackborneb034652009-09-07 00:49:58 -07009593 /** @hide */
9594 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009595 readFromParcel(in);
9596 }
9597
9598 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009599 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009600 mData = Uri.CREATOR.createFromParcel(in);
9601 mType = in.readString();
9602 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009603 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009604 mComponent = ComponentName.readFromParcel(in);
9605
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009606 if (in.readInt() != 0) {
9607 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9608 }
9609
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009610 int N = in.readInt();
9611 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009612 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009613 int i;
9614 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009615 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009616 }
9617 } else {
9618 mCategories = null;
9619 }
9620
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009621 if (in.readInt() != 0) {
9622 mSelector = new Intent(in);
9623 }
9624
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009625 if (in.readInt() != 0) {
9626 mClipData = new ClipData(in);
9627 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009628 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009629 mExtras = in.readBundle();
9630 }
9631
9632 /**
9633 * Parses the "intent" element (and its children) from XML and instantiates
9634 * an Intent object. The given XML parser should be located at the tag
9635 * where parsing should start (often named "intent"), from which the
9636 * basic action, data, type, and package and class name will be
9637 * retrieved. The function will then parse in to any child elements,
9638 * looking for <category android:name="xxx"> tags to add categories and
9639 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9640 * to the intent.
9641 *
9642 * @param resources The Resources to use when inflating resources.
9643 * @param parser The XML parser pointing at an "intent" tag.
9644 * @param attrs The AttributeSet interface for retrieving extended
9645 * attribute data at the current <var>parser</var> location.
9646 * @return An Intent object matching the XML data.
9647 * @throws XmlPullParserException If there was an XML parsing error.
9648 * @throws IOException If there was an I/O error.
9649 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009650 public static @NonNull Intent parseIntent(@NonNull Resources resources,
9651 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009652 throws XmlPullParserException, IOException {
9653 Intent intent = new Intent();
9654
9655 TypedArray sa = resources.obtainAttributes(attrs,
9656 com.android.internal.R.styleable.Intent);
9657
9658 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9659
9660 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9661 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9662 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9663
9664 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9665 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9666 if (packageName != null && className != null) {
9667 intent.setComponent(new ComponentName(packageName, className));
9668 }
9669
9670 sa.recycle();
9671
9672 int outerDepth = parser.getDepth();
9673 int type;
9674 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9675 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9676 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9677 continue;
9678 }
9679
9680 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009681 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009682 sa = resources.obtainAttributes(attrs,
9683 com.android.internal.R.styleable.IntentCategory);
9684 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9685 sa.recycle();
9686
9687 if (cat != null) {
9688 intent.addCategory(cat);
9689 }
9690 XmlUtils.skipCurrentTag(parser);
9691
Craig Mautner21d24a22014-04-23 11:45:37 -07009692 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009693 if (intent.mExtras == null) {
9694 intent.mExtras = new Bundle();
9695 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009696 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009697 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009698
9699 } else {
9700 XmlUtils.skipCurrentTag(parser);
9701 }
9702 }
9703
9704 return intent;
9705 }
Nick Pellyccae4122012-01-09 14:12:58 -08009706
Craig Mautner21d24a22014-04-23 11:45:37 -07009707 /** @hide */
9708 public void saveToXml(XmlSerializer out) throws IOException {
9709 if (mAction != null) {
9710 out.attribute(null, ATTR_ACTION, mAction);
9711 }
9712 if (mData != null) {
9713 out.attribute(null, ATTR_DATA, mData.toString());
9714 }
9715 if (mType != null) {
9716 out.attribute(null, ATTR_TYPE, mType);
9717 }
9718 if (mComponent != null) {
9719 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9720 }
9721 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9722
9723 if (mCategories != null) {
9724 out.startTag(null, TAG_CATEGORIES);
9725 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9726 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9727 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009728 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009729 }
9730 }
9731
9732 /** @hide */
9733 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9734 XmlPullParserException {
9735 Intent intent = new Intent();
9736 final int outerDepth = in.getDepth();
9737
9738 int attrCount = in.getAttributeCount();
9739 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9740 final String attrName = in.getAttributeName(attrNdx);
9741 final String attrValue = in.getAttributeValue(attrNdx);
9742 if (ATTR_ACTION.equals(attrName)) {
9743 intent.setAction(attrValue);
9744 } else if (ATTR_DATA.equals(attrName)) {
9745 intent.setData(Uri.parse(attrValue));
9746 } else if (ATTR_TYPE.equals(attrName)) {
9747 intent.setType(attrValue);
9748 } else if (ATTR_COMPONENT.equals(attrName)) {
9749 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9750 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009751 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009752 } else {
9753 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9754 }
9755 }
9756
9757 int event;
9758 String name;
9759 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9760 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9761 if (event == XmlPullParser.START_TAG) {
9762 name = in.getName();
9763 if (TAG_CATEGORIES.equals(name)) {
9764 attrCount = in.getAttributeCount();
9765 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9766 intent.addCategory(in.getAttributeValue(attrNdx));
9767 }
9768 } else {
9769 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9770 XmlUtils.skipCurrentTag(in);
9771 }
9772 }
9773 }
9774
9775 return intent;
9776 }
9777
Nick Pellyccae4122012-01-09 14:12:58 -08009778 /**
9779 * Normalize a MIME data type.
9780 *
9781 * <p>A normalized MIME type has white-space trimmed,
9782 * content-type parameters removed, and is lower-case.
9783 * This aligns the type with Android best practices for
9784 * intent filtering.
9785 *
9786 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9787 * "text/x-vCard" becomes "text/x-vcard".
9788 *
9789 * <p>All MIME types received from outside Android (such as user input,
9790 * or external sources like Bluetooth, NFC, or the Internet) should
9791 * be normalized before they are used to create an Intent.
9792 *
9793 * @param type MIME data type to normalize
9794 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009795 * @see #setType
9796 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009797 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009798 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08009799 if (type == null) {
9800 return null;
9801 }
9802
Elliott Hughescb64d432013-08-02 10:00:44 -07009803 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009804
9805 final int semicolonIndex = type.indexOf(';');
9806 if (semicolonIndex != -1) {
9807 type = type.substring(0, semicolonIndex);
9808 }
9809 return type;
9810 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009811
9812 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009813 * Prepare this {@link Intent} to leave an app process.
9814 *
9815 * @hide
9816 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009817 public void prepareToLeaveProcess(Context context) {
9818 final boolean leavingPackage = (mComponent == null)
9819 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9820 prepareToLeaveProcess(leavingPackage);
9821 }
9822
9823 /**
9824 * Prepare this {@link Intent} to leave an app process.
9825 *
9826 * @hide
9827 */
9828 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009829 setAllowFds(false);
9830
9831 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009832 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009833 }
9834 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009835 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009836 }
9837
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -07009838 if (mExtras != null && !mExtras.isParcelled()) {
9839 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
9840 if (intent instanceof Intent) {
9841 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
9842 }
9843 }
9844
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009845 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9846 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009847 switch (mAction) {
9848 case ACTION_MEDIA_REMOVED:
9849 case ACTION_MEDIA_UNMOUNTED:
9850 case ACTION_MEDIA_CHECKING:
9851 case ACTION_MEDIA_NOFS:
9852 case ACTION_MEDIA_MOUNTED:
9853 case ACTION_MEDIA_SHARED:
9854 case ACTION_MEDIA_UNSHARED:
9855 case ACTION_MEDIA_BAD_REMOVAL:
9856 case ACTION_MEDIA_UNMOUNTABLE:
9857 case ACTION_MEDIA_EJECT:
9858 case ACTION_MEDIA_SCANNER_STARTED:
9859 case ACTION_MEDIA_SCANNER_FINISHED:
9860 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009861 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9862 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009863 // Ignore legacy actions
9864 break;
9865 default:
9866 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009867 }
9868 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009869
9870 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
9871 && leavingPackage) {
9872 switch (mAction) {
9873 case ACTION_PROVIDER_CHANGED:
Makoto Onuki7d1911f2017-06-09 12:30:09 -07009874 case QuickContact.ACTION_QUICK_CONTACT:
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009875 // Ignore actions that don't need to grant
9876 break;
9877 default:
9878 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
9879 }
9880 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009881 }
9882
9883 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009884 * @hide
9885 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009886 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009887 // We just entered destination process, so we should be able to read all
9888 // parcelables inside.
9889 setDefusable(true);
9890
9891 if (mSelector != null) {
9892 mSelector.prepareToEnterProcess();
9893 }
9894 if (mClipData != null) {
9895 mClipData.prepareToEnterProcess();
9896 }
9897
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009898 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009899 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9900 fixUris(mContentUserHint);
9901 mContentUserHint = UserHandle.USER_CURRENT;
9902 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009903 }
9904 }
9905
9906 /**
9907 * @hide
9908 */
9909 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009910 Uri data = getData();
9911 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009912 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009913 }
9914 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009915 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009916 }
9917 String action = getAction();
9918 if (ACTION_SEND.equals(action)) {
9919 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9920 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009921 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009922 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009923 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009924 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9925 if (streams != null) {
9926 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9927 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009928 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009929 }
9930 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9931 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009932 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9933 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9934 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9935 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9936 if (output != null) {
9937 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9938 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009939 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009940 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009941
9942 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009943 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009944 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9945 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009946 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009947 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009948 * @hide
9949 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009950 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009951 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009952 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009953
9954 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009955 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009956
9957 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009958 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009959 // Inspect contained intents to see if we need to migrate extras. We
9960 // don't promote ClipData to the parent, since ChooserActivity will
9961 // already start the picked item as the caller, and we can't combine
9962 // the flags in a safe way.
9963
9964 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009965 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009966 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9967 if (intent != null) {
9968 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009969 }
9970 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009971 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009972 try {
9973 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9974 if (intents != null) {
9975 for (int i = 0; i < intents.length; i++) {
9976 final Intent intent = (Intent) intents[i];
9977 if (intent != null) {
9978 migrated |= intent.migrateExtraStreamToClipData();
9979 }
9980 }
9981 }
9982 } catch (ClassCastException e) {
9983 }
9984 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009985
9986 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009987 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009988 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9989 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9990 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9991 if (stream != null || text != null || htmlText != null) {
9992 final ClipData clipData = new ClipData(
9993 null, new String[] { getType() },
9994 new ClipData.Item(text, htmlText, null, stream));
9995 setClipData(clipData);
9996 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009997 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009998 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009999 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010000 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010001
10002 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010003 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010004 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10005 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
10006 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
10007 int num = -1;
10008 if (streams != null) {
10009 num = streams.size();
10010 }
10011 if (texts != null) {
10012 if (num >= 0 && num != texts.size()) {
10013 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010014 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010015 }
10016 num = texts.size();
10017 }
10018 if (htmlTexts != null) {
10019 if (num >= 0 && num != htmlTexts.size()) {
10020 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010021 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010022 }
10023 num = htmlTexts.size();
10024 }
10025 if (num > 0) {
10026 final ClipData clipData = new ClipData(
10027 null, new String[] { getType() },
10028 makeClipItem(streams, texts, htmlTexts, 0));
10029
10030 for (int i = 1; i < num; i++) {
10031 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
10032 }
10033
10034 setClipData(clipData);
10035 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010036 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010037 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010038 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010039 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010040 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10041 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10042 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10043 final Uri output;
10044 try {
10045 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10046 } catch (ClassCastException e) {
10047 return false;
10048 }
10049 if (output != null) {
10050 setClipData(ClipData.newRawUri("", output));
10051 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
10052 return true;
10053 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010054 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010055
10056 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010057 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010058
10059 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
10060 ArrayList<String> htmlTexts, int which) {
10061 Uri uri = streams != null ? streams.get(which) : null;
10062 CharSequence text = texts != null ? texts.get(which) : null;
10063 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
10064 return new ClipData.Item(text, htmlText, null, uri);
10065 }
Craig Mautnerd00f4742014-03-12 14:17:26 -070010066
10067 /** @hide */
10068 public boolean isDocument() {
10069 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
10070 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010071}