blob: dd729a36875dcb0aa93fbe377c3715ed85e5fdd4 [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;
Yi Jin129fc6c2017-09-28 15:48:38 -070056import android.util.proto.ProtoOutputStream;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070057
Dianne Hackborn2269d1572010-02-24 19:54:22 -080058import com.android.internal.util.XmlUtils;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070059
Jason Monk2f68e8a2016-02-23 17:57:28 -050060import org.xmlpull.v1.XmlPullParser;
61import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070062import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070063
64import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080065import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070067import java.lang.annotation.Retention;
68import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070069import java.net.URISyntaxException;
70import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080071import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070072import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080073import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070074import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070075import java.util.Set;
76
77/**
78 * An intent is an abstract description of an operation to be performed. It
79 * can be used with {@link Context#startActivity(Intent) startActivity} to
80 * launch an {@link android.app.Activity},
81 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
82 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
83 * and {@link android.content.Context#startService} or
84 * {@link android.content.Context#bindService} to communicate with a
85 * background {@link android.app.Service}.
86 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070087 * <p>An Intent provides a facility for performing late runtime binding between the code in
88 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070089 * can be thought of as the glue between activities. It is basically a passive data structure
90 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070091 *
92 * <div class="special reference">
93 * <h3>Developer Guides</h3>
94 * <p>For information about how to create and resolve intents, read the
95 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
96 * developer guide.</p>
97 * </div>
98 *
99 * <a name="IntentStructure"></a>
100 * <h3>Intent Structure</h3>
101 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700102 *
103 * <ul>
104 * <li> <p><b>action</b> -- The general action to be performed, such as
105 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
106 * etc.</p>
107 * </li>
108 * <li> <p><b>data</b> -- The data to operate on, such as a person record
109 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
110 * </li>
111 * </ul>
112 *
113 *
114 * <p>Some examples of action/data pairs are:</p>
115 *
116 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700117 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700118 * information about the person whose identifier is "1".</p>
119 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700120 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700121 * the phone dialer with the person filled in.</p>
122 * </li>
123 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
124 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700125 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700126 * a particular URI.</p>
127 * </li>
128 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
129 * the phone dialer with the given number filled in.</p>
130 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700131 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700132 * information about the person whose identifier is "1".</p>
133 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700134 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700135 * a list of people, which the user can browse through. This example is a
136 * typical top-level entry into the Contacts application, showing you the
137 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700138 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700139 * being used to start an activity to display that person.</p>
140 * </li>
141 * </ul>
142 *
143 * <p>In addition to these primary attributes, there are a number of secondary
144 * attributes that you can also include with an intent:</p>
145 *
146 * <ul>
147 * <li> <p><b>category</b> -- Gives additional information about the action
148 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
149 * appear in the Launcher as a top-level application, while
150 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
151 * of alternative actions the user can perform on a piece of data.</p>
152 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
153 * intent data. Normally the type is inferred from the data itself.
154 * By setting this attribute, you disable that evaluation and force
155 * an explicit type.</p>
156 * <li> <p><b>component</b> -- Specifies an explicit name of a component
157 * class to use for the intent. Normally this is determined by looking
158 * at the other information in the intent (the action, data/type, and
159 * categories) and matching that with a component that can handle it.
160 * If this attribute is set then none of the evaluation is performed,
161 * and this component is used exactly as is. By specifying this attribute,
162 * all of the other Intent attributes become optional.</p>
163 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
164 * This can be used to provide extended information to the component.
165 * For example, if we have a action to send an e-mail message, we could
166 * also include extra pieces of data here to supply a subject, body,
167 * etc.</p>
168 * </ul>
169 *
170 * <p>Here are some examples of other operations you can specify as intents
171 * using these additional parameters:</p>
172 *
173 * <ul>
174 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
175 * Launch the home screen.</p>
176 * </li>
177 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
178 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
179 * vnd.android.cursor.item/phone}</i></b>
180 * -- Display the list of people's phone numbers, allowing the user to
181 * browse through them and pick one and return it to the parent activity.</p>
182 * </li>
183 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
184 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
185 * -- Display all pickers for data that can be opened with
186 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
187 * allowing the user to pick one of them and then some data inside of it
188 * and returning the resulting URI to the caller. This can be used,
189 * for example, in an e-mail application to allow the user to pick some
190 * data to include as an attachment.</p>
191 * </li>
192 * </ul>
193 *
194 * <p>There are a variety of standard Intent action and category constants
195 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700196 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700197 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700198 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700199 *
200 * <p>Put together, the set of actions, data types, categories, and extra data
201 * defines a language for the system allowing for the expression of phrases
202 * such as "call john smith's cell". As applications are added to the system,
203 * they can extend this language by adding new actions, types, and categories, or
204 * they can modify the behavior of existing phrases by supplying their own
205 * activities that handle them.</p>
206 *
207 * <a name="IntentResolution"></a>
208 * <h3>Intent Resolution</h3>
209 *
210 * <p>There are two primary forms of intents you will use.
211 *
212 * <ul>
213 * <li> <p><b>Explicit Intents</b> have specified a component (via
214 * {@link #setComponent} or {@link #setClass}), which provides the exact
215 * class to be run. Often these will not include any other information,
216 * simply being a way for an application to launch various internal
217 * activities it has as the user interacts with the application.
218 *
219 * <li> <p><b>Implicit Intents</b> have not specified a component;
220 * instead, they must include enough information for the system to
221 * determine which of the available components is best to run for that
222 * intent.
223 * </ul>
224 *
225 * <p>When using implicit intents, given such an arbitrary intent we need to
226 * know what to do with it. This is handled by the process of <em>Intent
227 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
228 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
229 * more activities/receivers) that can handle it.</p>
230 *
231 * <p>The intent resolution mechanism basically revolves around matching an
232 * Intent against all of the &lt;intent-filter&gt; descriptions in the
233 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
234 * objects explicitly registered with {@link Context#registerReceiver}.) More
235 * details on this can be found in the documentation on the {@link
236 * IntentFilter} class.</p>
237 *
238 * <p>There are three pieces of information in the Intent that are used for
239 * resolution: the action, type, and category. Using this information, a query
240 * is done on the {@link PackageManager} for a component that can handle the
241 * intent. The appropriate component is determined based on the intent
242 * information supplied in the <code>AndroidManifest.xml</code> file as
243 * follows:</p>
244 *
245 * <ul>
246 * <li> <p>The <b>action</b>, if given, must be listed by the component as
247 * one it handles.</p>
248 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
249 * already supplied in the Intent. Like the action, if a type is
250 * included in the intent (either explicitly or implicitly in its
251 * data), then this must be listed by the component as one it handles.</p>
252 * <li> For data that is not a <code>content:</code> URI and where no explicit
253 * type is included in the Intent, instead the <b>scheme</b> of the
254 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
255 * considered. Again like the action, if we are matching a scheme it
256 * must be listed by the component as one it can handle.
257 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
258 * by the activity as categories it handles. That is, if you include
259 * the categories {@link #CATEGORY_LAUNCHER} and
260 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
261 * with an intent that lists <em>both</em> of those categories.
262 * Activities will very often need to support the
263 * {@link #CATEGORY_DEFAULT} so that they can be found by
264 * {@link Context#startActivity Context.startActivity()}.</p>
265 * </ul>
266 *
267 * <p>For example, consider the Note Pad sample application that
268 * allows user to browse through a list of notes data and view details about
269 * individual items. Text in italics indicate places were you would replace a
270 * name with one specific to your own package.</p>
271 *
272 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
273 * package="<i>com.android.notepad</i>"&gt;
274 * &lt;application android:icon="@drawable/app_notes"
275 * android:label="@string/app_name"&gt;
276 *
277 * &lt;provider class=".NotePadProvider"
278 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
279 *
280 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
281 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700282 * &lt;action android:name="android.intent.action.MAIN" /&gt;
283 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700286 * &lt;action android:name="android.intent.action.VIEW" /&gt;
287 * &lt;action android:name="android.intent.action.EDIT" /&gt;
288 * &lt;action android:name="android.intent.action.PICK" /&gt;
289 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
290 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700291 * &lt;/intent-filter&gt;
292 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700293 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
294 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
295 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700296 * &lt;/intent-filter&gt;
297 * &lt;/activity&gt;
298 *
299 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
300 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700301 * &lt;action android:name="android.intent.action.VIEW" /&gt;
302 * &lt;action android:name="android.intent.action.EDIT" /&gt;
303 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
304 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700305 * &lt;/intent-filter&gt;
306 *
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="android.intent.action.INSERT" /&gt;
309 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
310 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700311 * &lt;/intent-filter&gt;
312 *
313 * &lt;/activity&gt;
314 *
315 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
316 * android:theme="@android:style/Theme.Dialog"&gt;
317 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700318 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
319 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
320 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
321 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
322 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700323 * &lt;/intent-filter&gt;
324 * &lt;/activity&gt;
325 *
326 * &lt;/application&gt;
327 * &lt;/manifest&gt;</pre>
328 *
329 * <p>The first activity,
330 * <code>com.android.notepad.NotesList</code>, serves as our main
331 * entry into the app. It can do three things as described by its three intent
332 * templates:
333 * <ol>
334 * <li><pre>
335 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700336 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
337 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700338 * &lt;/intent-filter&gt;</pre>
339 * <p>This provides a top-level entry into the NotePad application: the standard
340 * MAIN action is a main entry point (not requiring any other information in
341 * the Intent), and the LAUNCHER category says that this entry point should be
342 * listed in the application launcher.</p>
343 * <li><pre>
344 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700345 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
346 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
347 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
348 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700349 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700350 * &lt;/intent-filter&gt;</pre>
351 * <p>This declares the things that the activity can do on a directory of
352 * notes. The type being supported is given with the &lt;type&gt; tag, where
353 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
354 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
355 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
356 * The activity allows the user to view or edit the directory of data (via
357 * the VIEW and EDIT actions), or to pick a particular note and return it
358 * to the caller (via the PICK action). Note also the DEFAULT category
359 * supplied here: this is <em>required</em> for the
360 * {@link Context#startActivity Context.startActivity} method to resolve your
361 * activity when its component name is not explicitly specified.</p>
362 * <li><pre>
363 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700364 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
365 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
366 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700367 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700368 * <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 -0700369 * the user without needing to know where it came from. The data type
370 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
371 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
372 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
373 * The GET_CONTENT action is similar to the PICK action, where the activity
374 * will return to its caller a piece of data selected by the user. Here,
375 * however, the caller specifies the type of data they desire instead of
376 * the type of data the user will be picking from.</p>
377 * </ol>
378 *
379 * <p>Given these capabilities, the following intents will resolve to the
380 * NotesList activity:</p>
381 *
382 * <ul>
383 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
384 * activities that can be used as top-level entry points into an
385 * application.</p>
386 * <li> <p><b>{ action=android.app.action.MAIN,
387 * category=android.app.category.LAUNCHER }</b> is the actual intent
388 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700389 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700390 * data=content://com.google.provider.NotePad/notes }</b>
391 * displays a list of all the notes under
392 * "content://com.google.provider.NotePad/notes", which
393 * the user can browse through and see the details on.</p>
394 * <li> <p><b>{ action=android.app.action.PICK
395 * data=content://com.google.provider.NotePad/notes }</b>
396 * provides a list of the notes under
397 * "content://com.google.provider.NotePad/notes", from which
398 * the user can pick a note whose data URL is returned back to the caller.</p>
399 * <li> <p><b>{ action=android.app.action.GET_CONTENT
400 * type=vnd.android.cursor.item/vnd.google.note }</b>
401 * is similar to the pick action, but allows the caller to specify the
402 * kind of data they want back so that the system can find the appropriate
403 * activity to pick something of that data type.</p>
404 * </ul>
405 *
406 * <p>The second activity,
407 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
408 * note entry and allows them to edit it. It can do two things as described
409 * by its two intent templates:
410 * <ol>
411 * <li><pre>
412 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700413 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
414 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
415 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
416 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700417 * &lt;/intent-filter&gt;</pre>
418 * <p>The first, primary, purpose of this activity is to let the user interact
419 * with a single note, as decribed by the MIME type
420 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
421 * either VIEW a note or allow the user to EDIT it. Again we support the
422 * DEFAULT category to allow the activity to be launched without explicitly
423 * specifying its component.</p>
424 * <li><pre>
425 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700426 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
427 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
428 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700429 * &lt;/intent-filter&gt;</pre>
430 * <p>The secondary use of this activity is to insert a new note entry into
431 * an existing directory of notes. This is used when the user creates a new
432 * note: the INSERT action is executed on the directory of notes, causing
433 * this activity to run and have the user create the new note data which
434 * it then adds to the content provider.</p>
435 * </ol>
436 *
437 * <p>Given these capabilities, the following intents will resolve to the
438 * NoteEditor activity:</p>
439 *
440 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700441 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700442 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
443 * shows the user the content of note <var>{ID}</var>.</p>
444 * <li> <p><b>{ action=android.app.action.EDIT
445 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
446 * allows the user to edit the content of note <var>{ID}</var>.</p>
447 * <li> <p><b>{ action=android.app.action.INSERT
448 * data=content://com.google.provider.NotePad/notes }</b>
449 * creates a new, empty note in the notes list at
450 * "content://com.google.provider.NotePad/notes"
451 * and allows the user to edit it. If they keep their changes, the URI
452 * of the newly created note is returned to the caller.</p>
453 * </ul>
454 *
455 * <p>The last activity,
456 * <code>com.android.notepad.TitleEditor</code>, allows the user to
457 * edit the title of a note. This could be implemented as a class that the
458 * application directly invokes (by explicitly setting its component in
459 * the Intent), but here we show a way you can publish alternative
460 * operations on existing data:</p>
461 *
462 * <pre>
463 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700464 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
465 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
466 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
467 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
468 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700469 * &lt;/intent-filter&gt;</pre>
470 *
471 * <p>In the single intent template here, we
472 * have created our own private action called
473 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
474 * edit the title of a note. It must be invoked on a specific note
475 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
476 * view and edit actions, but here displays and edits the title contained
477 * in the note data.
478 *
479 * <p>In addition to supporting the default category as usual, our title editor
480 * also supports two other standard categories: ALTERNATIVE and
481 * SELECTED_ALTERNATIVE. Implementing
482 * these categories allows others to find the special action it provides
483 * without directly knowing about it, through the
484 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
485 * more often to build dynamic menu items with
486 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
487 * template here was also supply an explicit name for the template
488 * (via <code>android:label="@string/resolve_title"</code>) to better control
489 * what the user sees when presented with this activity as an alternative
490 * action to the data they are viewing.
491 *
492 * <p>Given these capabilities, the following intent will resolve to the
493 * TitleEditor activity:</p>
494 *
495 * <ul>
496 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
497 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
498 * displays and allows the user to edit the title associated
499 * with note <var>{ID}</var>.</p>
500 * </ul>
501 *
502 * <h3>Standard Activity Actions</h3>
503 *
504 * <p>These are the current standard actions that Intent defines for launching
505 * activities (usually through {@link Context#startActivity}. The most
506 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
507 * {@link #ACTION_EDIT}.
508 *
509 * <ul>
510 * <li> {@link #ACTION_MAIN}
511 * <li> {@link #ACTION_VIEW}
512 * <li> {@link #ACTION_ATTACH_DATA}
513 * <li> {@link #ACTION_EDIT}
514 * <li> {@link #ACTION_PICK}
515 * <li> {@link #ACTION_CHOOSER}
516 * <li> {@link #ACTION_GET_CONTENT}
517 * <li> {@link #ACTION_DIAL}
518 * <li> {@link #ACTION_CALL}
519 * <li> {@link #ACTION_SEND}
520 * <li> {@link #ACTION_SENDTO}
521 * <li> {@link #ACTION_ANSWER}
522 * <li> {@link #ACTION_INSERT}
523 * <li> {@link #ACTION_DELETE}
524 * <li> {@link #ACTION_RUN}
525 * <li> {@link #ACTION_SYNC}
526 * <li> {@link #ACTION_PICK_ACTIVITY}
527 * <li> {@link #ACTION_SEARCH}
528 * <li> {@link #ACTION_WEB_SEARCH}
529 * <li> {@link #ACTION_FACTORY_TEST}
530 * </ul>
531 *
532 * <h3>Standard Broadcast Actions</h3>
533 *
534 * <p>These are the current standard actions that Intent defines for receiving
535 * broadcasts (usually through {@link Context#registerReceiver} or a
536 * &lt;receiver&gt; tag in a manifest).
537 *
538 * <ul>
539 * <li> {@link #ACTION_TIME_TICK}
540 * <li> {@link #ACTION_TIME_CHANGED}
541 * <li> {@link #ACTION_TIMEZONE_CHANGED}
542 * <li> {@link #ACTION_BOOT_COMPLETED}
543 * <li> {@link #ACTION_PACKAGE_ADDED}
544 * <li> {@link #ACTION_PACKAGE_CHANGED}
545 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800546 * <li> {@link #ACTION_PACKAGE_RESTARTED}
547 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000548 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
549 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700550 * <li> {@link #ACTION_UID_REMOVED}
551 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700552 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700553 * <li> {@link #ACTION_POWER_DISCONNECTED}
554 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700555 * </ul>
556 *
557 * <h3>Standard Categories</h3>
558 *
559 * <p>These are the current standard categories that can be used to further
560 * clarify an Intent via {@link #addCategory}.
561 *
562 * <ul>
563 * <li> {@link #CATEGORY_DEFAULT}
564 * <li> {@link #CATEGORY_BROWSABLE}
565 * <li> {@link #CATEGORY_TAB}
566 * <li> {@link #CATEGORY_ALTERNATIVE}
567 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
568 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800569 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700570 * <li> {@link #CATEGORY_HOME}
571 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700572 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400573 * <li> {@link #CATEGORY_CAR_DOCK}
574 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500575 * <li> {@link #CATEGORY_LE_DESK_DOCK}
576 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200577 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700578 * <li> {@link #CATEGORY_APP_MARKET}
Zak Cohendb6ca492017-01-26 14:09:00 -0800579 * <li> {@link #CATEGORY_VR_HOME}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700580 * </ul>
581 *
582 * <h3>Standard Extra Data</h3>
583 *
584 * <p>These are the current standard fields that can be used as extra data via
585 * {@link #putExtra}.
586 *
587 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800588 * <li> {@link #EXTRA_ALARM_COUNT}
589 * <li> {@link #EXTRA_BCC}
590 * <li> {@link #EXTRA_CC}
591 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
592 * <li> {@link #EXTRA_DATA_REMOVED}
593 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500594 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
595 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800596 * <li> {@link #EXTRA_DOCK_STATE_CAR}
597 * <li> {@link #EXTRA_DOCK_STATE_DESK}
598 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
599 * <li> {@link #EXTRA_DONT_KILL_APP}
600 * <li> {@link #EXTRA_EMAIL}
601 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700602 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800603 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700604 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800605 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700606 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800607 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
608 * <li> {@link #EXTRA_REPLACING}
609 * <li> {@link #EXTRA_SHORTCUT_ICON}
610 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
611 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700612 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800613 * <li> {@link #EXTRA_SHORTCUT_NAME}
614 * <li> {@link #EXTRA_SUBJECT}
615 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700616 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800617 * <li> {@link #EXTRA_TITLE}
618 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700619 * </ul>
620 *
621 * <h3>Flags</h3>
622 *
623 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800624 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
625 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700626 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800627public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700628 private static final String ATTR_ACTION = "action";
629 private static final String TAG_CATEGORIES = "categories";
630 private static final String ATTR_CATEGORY = "category";
631 private static final String TAG_EXTRA = "extra";
632 private static final String ATTR_TYPE = "type";
633 private static final String ATTR_COMPONENT = "component";
634 private static final String ATTR_DATA = "data";
635 private static final String ATTR_FLAGS = "flags";
636
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700637 // ---------------------------------------------------------------------
638 // ---------------------------------------------------------------------
639 // Standard intent activity actions (see action variable).
640
641 /**
642 * Activity Action: Start as a main entry point, does not expect to
643 * receive data.
644 * <p>Input: nothing
645 * <p>Output: nothing
646 */
647 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
648 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700650 /**
651 * Activity Action: Display the data to the user. This is the most common
652 * action performed on data -- it is the generic action you can use on
653 * a piece of data to get the most reasonable thing to occur. For example,
654 * when used on a contacts entry it will view the entry; when used on a
655 * mailto: URI it will bring up a compose window filled with the information
656 * supplied by the URI; when used with a tel: URI it will invoke the
657 * dialer.
658 * <p>Input: {@link #getData} is URI from which to retrieve data.
659 * <p>Output: nothing.
660 */
661 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
662 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800663
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700664 /**
Dianne Hackborna320f012017-04-07 13:57:48 -0700665 * Extra that can be included on activity intents coming from the storage UI
666 * when it launches sub-activities to manage various types of storage. For example,
667 * it may use {@link #ACTION_VIEW} with a "image/*" MIME type to have an app show
668 * the images on the device, and in that case also include this extra to tell the
669 * app it is coming from the storage UI so should help the user manage storage of
670 * this type.
671 */
672 public static final String EXTRA_FROM_STORAGE = "android.intent.extra.FROM_STORAGE";
673
674 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700675 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
676 * performed on a piece of data.
677 */
678 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800679
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700680 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900681 * Activity Action: Quick view the data. Launches a quick viewer for
682 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900683 * <p>Activities handling this intent action should handle the vast majority of
684 * MIME types rather than only specific ones.
Garfield Tance1d0e92017-03-23 10:52:48 -0700685 * <p>Quick viewers must render the quick view image locally, and must not send
686 * file content outside current device.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900687 * <p>Input: {@link #getData} is a mandatory content URI of the item to
688 * preview. {@link #getClipData} contains an optional list of content URIs
689 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
690 * optional index of the URI in the clip data to show first.
Garfield Tance1d0e92017-03-23 10:52:48 -0700691 * {@link #EXTRA_QUICK_VIEW_FEATURES} is an optional extra indicating the features
692 * that can be shown in the quick view UI.
Steve McKayc78bcb82015-07-31 14:35:22 -0700693 * <p>Output: nothing.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900694 * @see #EXTRA_INDEX
Garfield Tance1d0e92017-03-23 10:52:48 -0700695 * @see #EXTRA_QUICK_VIEW_FEATURES
Steve McKayc78bcb82015-07-31 14:35:22 -0700696 */
697 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
698 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
699
700 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700701 * Used to indicate that some piece of data should be attached to some other
702 * place. For example, image data could be attached to a contact. It is up
703 * to the recipient to decide where the data should be attached; the intent
704 * does not specify the ultimate destination.
705 * <p>Input: {@link #getData} is URI of data to be attached.
706 * <p>Output: nothing.
707 */
708 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
709 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800710
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700711 /**
712 * Activity Action: Provide explicit editable access to the given data.
713 * <p>Input: {@link #getData} is URI of data to be edited.
714 * <p>Output: nothing.
715 */
716 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
717 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800718
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700719 /**
720 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
721 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
722 * The extras can contain type specific data to pass through to the editing/creating
723 * activity.
724 * <p>Output: The URI of the item that was picked. This must be a content:
725 * URI so that any receiver can access it.
726 */
727 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
728 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800729
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700730 /**
731 * Activity Action: Pick an item from the data, returning what was selected.
732 * <p>Input: {@link #getData} is URI containing a directory of data
733 * (vnd.android.cursor.dir/*) from which to pick an item.
734 * <p>Output: The URI of the item that was picked.
735 */
736 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
737 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800738
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700739 /**
740 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800741 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800742 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
743 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700744 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
745 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800746 * (value: ShortcutIconResource).</p>
747 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800748 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700749 * @see #EXTRA_SHORTCUT_INTENT
750 * @see #EXTRA_SHORTCUT_NAME
751 * @see #EXTRA_SHORTCUT_ICON
752 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
753 * @see android.content.Intent.ShortcutIconResource
754 */
755 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
756 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
757
758 /**
759 * The name of the extra used to define the Intent of a shortcut.
760 *
761 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800762 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700763 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800764 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700765 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
766 /**
767 * The name of the extra used to define the name of a shortcut.
768 *
769 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800770 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700771 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800772 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700773 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
774 /**
775 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
776 *
777 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800778 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700779 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800780 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700781 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
782 /**
783 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
784 *
785 * @see #ACTION_CREATE_SHORTCUT
786 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800787 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700788 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800789 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700790 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
791 "android.intent.extra.shortcut.ICON_RESOURCE";
792
793 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500794 * An activity that provides a user interface for adjusting application preferences.
795 * Optional but recommended settings for all applications which have settings.
796 */
797 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
798 public static final String ACTION_APPLICATION_PREFERENCES
799 = "android.intent.action.APPLICATION_PREFERENCES";
800
801 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700802 * Activity Action: Launch an activity showing the app information.
803 * For applications which install other applications (such as app stores), it is recommended
804 * to handle this action for providing the app information to the user.
805 *
806 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
807 * to be displayed.
808 * <p>Output: Nothing.
809 */
810 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
811 public static final String ACTION_SHOW_APP_INFO
812 = "android.intent.action.SHOW_APP_INFO";
813
814 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800815 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700816 *
817 * @see Intent#ACTION_CREATE_SHORTCUT
818 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800819 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
820 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700821 */
822 public static class ShortcutIconResource implements Parcelable {
823 /**
824 * The package name of the application containing the icon.
825 */
826 public String packageName;
827
828 /**
829 * The resource name of the icon, including package, name and type.
830 */
831 public String resourceName;
832
833 /**
834 * Creates a new ShortcutIconResource for the specified context and resource
835 * identifier.
836 *
837 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700838 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700839 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700840 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700841 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700842 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700843 ShortcutIconResource icon = new ShortcutIconResource();
844 icon.packageName = context.getPackageName();
845 icon.resourceName = context.getResources().getResourceName(resourceId);
846 return icon;
847 }
848
849 /**
850 * Used to read a ShortcutIconResource from a Parcel.
851 */
852 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
853 new Parcelable.Creator<ShortcutIconResource>() {
854
855 public ShortcutIconResource createFromParcel(Parcel source) {
856 ShortcutIconResource icon = new ShortcutIconResource();
857 icon.packageName = source.readString();
858 icon.resourceName = source.readString();
859 return icon;
860 }
861
862 public ShortcutIconResource[] newArray(int size) {
863 return new ShortcutIconResource[size];
864 }
865 };
866
867 /**
868 * No special parcel contents.
869 */
870 public int describeContents() {
871 return 0;
872 }
873
874 public void writeToParcel(Parcel dest, int flags) {
875 dest.writeString(packageName);
876 dest.writeString(resourceName);
877 }
878
879 @Override
880 public String toString() {
881 return resourceName;
882 }
883 }
884
885 /**
886 * Activity Action: Display an activity chooser, allowing the user to pick
887 * what they want to before proceeding. This can be used as an alternative
888 * to the standard activity picker that is displayed by the system when
889 * you try to start an activity with multiple possible matches, with these
890 * differences in behavior:
891 * <ul>
892 * <li>You can specify the title that will appear in the activity chooser.
893 * <li>The user does not have the option to make one of the matching
894 * activities a preferred activity, and all possible activities will
895 * always be shown even if one of them is currently marked as the
896 * preferred activity.
897 * </ul>
898 * <p>
899 * This action should be used when the user will naturally expect to
900 * select an activity in order to proceed. An example if when not to use
901 * it is when the user clicks on a "mailto:" link. They would naturally
902 * expect to go directly to their mail app, so startActivity() should be
903 * called directly: it will
904 * either launch the current preferred app, or put up a dialog allowing the
905 * user to pick an app to use and optionally marking that as preferred.
906 * <p>
907 * In contrast, if the user is selecting a menu item to send a picture
908 * they are viewing to someone else, there are many different things they
909 * may want to do at this point: send it through e-mail, upload it to a
910 * web service, etc. In this case the CHOOSER action should be used, to
911 * always present to the user a list of the things they can do, with a
912 * nice title given by the caller such as "Send this photo with:".
913 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700914 * If you need to grant URI permissions through a chooser, you must specify
915 * the permissions to be granted on the ACTION_CHOOSER Intent
916 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
917 * {@link #setClipData} to specify the URIs to be granted as well as
918 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
919 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
920 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700921 * As a convenience, an Intent of this form can be created with the
922 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700923 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700924 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700925 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
926 * and can optionally have a {@link #EXTRA_TITLE} field containing the
927 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700928 * <p>
929 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700930 */
931 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
932 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
933
934 /**
935 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
936 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700937 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
938 * target intent, also optionally supplying a title. If the target
939 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
940 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
941 * set in the returned chooser intent, with its ClipData set appropriately:
942 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500943 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700944 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700945 * @param target The Intent that the user will be selecting an activity
946 * to perform.
947 * @param title Optional title that will be displayed in the chooser.
948 * @return Return a new Intent object that you can hand to
949 * {@link Context#startActivity(Intent) Context.startActivity()} and
950 * related methods.
951 */
952 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700953 return createChooser(target, title, null);
954 }
955
956 /**
957 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
958 *
959 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
960 * target intent, also optionally supplying a title. If the target
961 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
962 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
963 * set in the returned chooser intent, with its ClipData set appropriately:
964 * either a direct reflection of {@link #getClipData()} if that is non-null,
965 * or a new ClipData built from {@link #getData()}.</p>
966 *
967 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
968 * when the user makes a choice. This can be useful if the calling application wants
969 * to remember the last chosen target and surface it as a more prominent or one-touch
970 * affordance elsewhere in the UI for next time.</p>
971 *
972 * @param target The Intent that the user will be selecting an activity
973 * to perform.
974 * @param title Optional title that will be displayed in the chooser.
975 * @param sender Optional IntentSender to be called when a choice is made.
976 * @return Return a new Intent object that you can hand to
977 * {@link Context#startActivity(Intent) Context.startActivity()} and
978 * related methods.
979 */
980 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700981 Intent intent = new Intent(ACTION_CHOOSER);
982 intent.putExtra(EXTRA_INTENT, target);
983 if (title != null) {
984 intent.putExtra(EXTRA_TITLE, title);
985 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700986
Adam Powell0b3c1122014-10-09 12:50:14 -0700987 if (sender != null) {
988 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
989 }
990
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700991 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700992 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
993 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
994 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700995 if (permFlags != 0) {
996 ClipData targetClipData = target.getClipData();
997 if (targetClipData == null && target.getData() != null) {
998 ClipData.Item item = new ClipData.Item(target.getData());
999 String[] mimeTypes;
1000 if (target.getType() != null) {
1001 mimeTypes = new String[] { target.getType() };
1002 } else {
1003 mimeTypes = new String[] { };
1004 }
1005 targetClipData = new ClipData(null, mimeTypes, item);
1006 }
1007 if (targetClipData != null) {
1008 intent.setClipData(targetClipData);
1009 intent.addFlags(permFlags);
1010 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001011 }
Dianne Hackborne302a162012-05-15 14:58:32 -07001012
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001013 return intent;
1014 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001015
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001016 /**
1017 * Activity Action: Allow the user to select a particular kind of data and
1018 * return it. This is different than {@link #ACTION_PICK} in that here we
1019 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001020 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001021 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001022 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001023 * etc.
1024 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001025 * 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 -07001026 * of data, such as a person contact, you set the MIME type to the kind of
1027 * data you want and launch it with {@link Context#startActivity(Intent)}.
1028 * The system will then launch the best application to select that kind
1029 * of data for you.
1030 * <p>
1031 * You may also be interested in any of a set of types of content the user
1032 * can pick. For example, an e-mail application that wants to allow the
1033 * user to add an attachment to an e-mail message can use this action to
1034 * bring up a list of all of the types of content the user can attach.
1035 * <p>
1036 * In this case, you should wrap the GET_CONTENT intent with a chooser
1037 * (through {@link #createChooser}), which will give the proper interface
1038 * for the user to pick how to send your data and allow you to specify
1039 * a prompt indicating what they are doing. You will usually specify a
1040 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1041 * broad range of content types the user can select from.
1042 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001043 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001044 * only pick from data that can be represented as a stream. This is
1045 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1046 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001047 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001048 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001049 * is locally available on the device. For example, if this extra is set
1050 * to true then an image picker should not show any pictures that are available
1051 * from a remote server but not already on the local device (thus requiring
1052 * they be downloaded when opened).
1053 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001054 * If the caller can handle multiple returned items (the user performing
1055 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1056 * to indicate this.
1057 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001058 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1059 * that no URI is supplied in the intent, as there are no constraints on
1060 * where the returned data originally comes from. You may also include the
1061 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001062 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001063 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1064 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001065 * <p>
1066 * Output: The URI of the item that was picked. This must be a content:
1067 * URI so that any receiver can access it.
1068 */
1069 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1070 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1071 /**
1072 * Activity Action: Dial a number as specified by the data. This shows a
1073 * UI with the number being dialed, allowing the user to explicitly
1074 * initiate the call.
1075 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1076 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1077 * number.
1078 * <p>Output: nothing.
1079 */
1080 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1081 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1082 /**
1083 * Activity Action: Perform a call to someone specified by the data.
1084 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1085 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1086 * number.
1087 * <p>Output: nothing.
1088 *
1089 * <p>Note: there will be restrictions on which applications can initiate a
1090 * call; most applications should use the {@link #ACTION_DIAL}.
1091 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1092 * numbers. Applications can <strong>dial</strong> emergency numbers using
1093 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001094 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001095 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001096 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001097 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001098 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001099 */
1100 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1101 public static final String ACTION_CALL = "android.intent.action.CALL";
1102 /**
1103 * Activity Action: Perform a call to an emergency number specified by the
1104 * data.
1105 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1106 * tel: URI of an explicit phone number.
1107 * <p>Output: nothing.
1108 * @hide
1109 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001110 @SystemApi
1111 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001112 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1113 /**
1114 * Activity action: Perform a call to any number (emergency or not)
1115 * specified by the data.
1116 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1117 * tel: URI of an explicit phone number.
1118 * <p>Output: nothing.
1119 * @hide
1120 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001121 @SystemApi
1122 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001123 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
fionaxu77a744c2017-03-17 14:35:39 -07001124
Santos Cordon15a13782015-03-31 18:32:31 -07001125 /**
fionaxuadfe7002017-02-17 17:20:46 -08001126 * Activity Action: Main entry point for carrier setup apps.
1127 * <p>Carrier apps that provide an implementation for this action may be invoked to configure
1128 * carrier service and typically require
1129 * {@link android.telephony.TelephonyManager#hasCarrierPrivileges() carrier privileges} to
1130 * fulfill their duties.
1131 */
1132 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1133 public static final String ACTION_CARRIER_SETUP = "android.intent.action.CARRIER_SETUP";
1134 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001135 * Activity Action: Send a message to someone specified by the data.
1136 * <p>Input: {@link #getData} is URI describing the target.
1137 * <p>Output: nothing.
1138 */
1139 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1140 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1141 /**
1142 * Activity Action: Deliver some data to someone else. Who the data is
1143 * being delivered to is not specified; it is up to the receiver of this
1144 * action to ask the user where the data should be sent.
1145 * <p>
1146 * When launching a SEND intent, you should usually wrap it in a chooser
1147 * (through {@link #createChooser}), which will give the proper interface
1148 * for the user to pick how to send your data and allow you to specify
1149 * a prompt indicating what they are doing.
1150 * <p>
1151 * Input: {@link #getType} is the MIME type of the data being sent.
1152 * get*Extra can have either a {@link #EXTRA_TEXT}
1153 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1154 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1155 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1156 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001157 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1158 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1159 * your text with HTML formatting.
1160 * <p>
1161 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1162 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1163 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1164 * content: URIs and other advanced features of {@link ClipData}. If
1165 * using this approach, you still must supply the same data through the
1166 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1167 * for compatibility with old applications. If you don't set a ClipData,
1168 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001169 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001170 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1171 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1172 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1173 * be openable only as asset typed files using
1174 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1175 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001176 * Optional standard extras, which may be interpreted by some recipients as
1177 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1178 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1179 * <p>
1180 * Output: nothing.
1181 */
1182 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1183 public static final String ACTION_SEND = "android.intent.action.SEND";
1184 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001185 * Activity Action: Deliver multiple data to someone else.
1186 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001187 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001188 * <p>
1189 * Input: {@link #getType} is the MIME type of the data being sent.
1190 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001191 * #EXTRA_STREAM} field, containing the data to be sent. If using
1192 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1193 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001194 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001195 * Multiple types are supported, and receivers should handle mixed types
1196 * whenever possible. The right way for the receiver to check them is to
1197 * use the content resolver on each URI. The intent sender should try to
1198 * put the most concrete mime type in the intent type, but it can fall
1199 * back to {@literal <type>/*} or {@literal *}/* as needed.
1200 * <p>
1201 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1202 * be image/jpg, but if you are sending image/jpg and image/png, then the
1203 * intent's type should be image/*.
1204 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001205 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1206 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1207 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1208 * content: URIs and other advanced features of {@link ClipData}. If
1209 * using this approach, you still must supply the same data through the
1210 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1211 * for compatibility with old applications. If you don't set a ClipData,
1212 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1213 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001214 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1215 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1216 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1217 * be openable only as asset typed files using
1218 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1219 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001220 * Optional standard extras, which may be interpreted by some recipients as
1221 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1222 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1223 * <p>
1224 * Output: nothing.
1225 */
1226 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1227 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1228 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001229 * Activity Action: Handle an incoming phone call.
1230 * <p>Input: nothing.
1231 * <p>Output: nothing.
1232 */
1233 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1234 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1235 /**
1236 * Activity Action: Insert an empty item into the given container.
1237 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1238 * in which to place the data.
1239 * <p>Output: URI of the new data that was created.
1240 */
1241 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1242 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1243 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001244 * Activity Action: Create a new item in the given container, initializing it
1245 * from the current contents of the clipboard.
1246 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1247 * in which to place the data.
1248 * <p>Output: URI of the new data that was created.
1249 */
1250 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1251 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1252 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001253 * Activity Action: Delete the given data from its container.
1254 * <p>Input: {@link #getData} is URI of data to be deleted.
1255 * <p>Output: nothing.
1256 */
1257 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1258 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1259 /**
1260 * Activity Action: Run the data, whatever that means.
1261 * <p>Input: ? (Note: this is currently specific to the test harness.)
1262 * <p>Output: nothing.
1263 */
1264 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1265 public static final String ACTION_RUN = "android.intent.action.RUN";
1266 /**
1267 * Activity Action: Perform a data synchronization.
1268 * <p>Input: ?
1269 * <p>Output: ?
1270 */
1271 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1272 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1273 /**
1274 * Activity Action: Pick an activity given an intent, returning the class
1275 * selected.
1276 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1277 * used with {@link PackageManager#queryIntentActivities} to determine the
1278 * set of activities from which to pick.
1279 * <p>Output: Class name of the activity that was selected.
1280 */
1281 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1282 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1283 /**
1284 * Activity Action: Perform a search.
1285 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1286 * is the text to search for. If empty, simply
1287 * enter your search results Activity with the search UI activated.
1288 * <p>Output: nothing.
1289 */
1290 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1291 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1292 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001293 * Activity Action: Start the platform-defined tutorial
1294 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1295 * is the text to search for. If empty, simply
1296 * enter your search results Activity with the search UI activated.
1297 * <p>Output: nothing.
1298 */
1299 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1300 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1301 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001302 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001303 * <p>
1304 * Input: {@link android.app.SearchManager#QUERY
1305 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1306 * a url starts with http or https, the site will be opened. If it is plain
1307 * text, Google search will be applied.
1308 * <p>
1309 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001310 */
1311 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1312 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001313
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001314 /**
Jim Miller07994402012-05-02 14:22:27 -07001315 * Activity Action: Perform assist action.
1316 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001317 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1318 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001319 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1320 * information.
Jim Miller07994402012-05-02 14:22:27 -07001321 * Output: nothing.
1322 */
1323 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1324 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001325
1326 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001327 * Activity Action: Perform voice assist action.
1328 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001329 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1330 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001331 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001332 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001333 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001334 */
Amith Yamasani16452032017-03-03 10:15:57 -08001335 @SystemApi
Bjorn Bringertbc086862013-03-01 12:59:24 +00001336 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1337 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1338
1339 /**
Adam Skory7140a252013-09-11 12:04:58 +01001340 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1341 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001342 */
1343 public static final String EXTRA_ASSIST_PACKAGE
1344 = "android.intent.extra.ASSIST_PACKAGE";
1345
1346 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001347 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1348 * application package at the time the assist was invoked.
1349 */
1350 public static final String EXTRA_ASSIST_UID
1351 = "android.intent.extra.ASSIST_UID";
1352
1353 /**
Adam Skory7140a252013-09-11 12:04:58 +01001354 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1355 * information supplied by the current foreground app at the time of the assist request.
1356 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001357 */
1358 public static final String EXTRA_ASSIST_CONTEXT
1359 = "android.intent.extra.ASSIST_CONTEXT";
1360
Jim Miller07994402012-05-02 14:22:27 -07001361 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001362 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1363 * keyboard as the primary input device for assistance.
1364 */
1365 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1366 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1367
1368 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001369 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1370 * that was used to invoke the assist.
1371 */
1372 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1373 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1374
1375 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001376 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001377 * <p>Input: Nothing.
1378 * <p>Output: nothing.
1379 */
1380 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1381 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1382 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001383 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001384 * <p>Input: Nothing.
1385 * <p>Output: Nothing.
1386 */
1387 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1388 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1389
1390 /**
1391 * Activity Action: Show activity for reporting a bug.
1392 * <p>Input: Nothing.
1393 * <p>Output: Nothing.
1394 */
1395 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1396 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1397
1398 /**
1399 * Activity Action: Main entry point for factory tests. Only used when
1400 * the device is booting in factory test node. The implementing package
1401 * must be installed in the system image.
1402 * <p>Input: nothing
1403 * <p>Output: nothing
1404 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06001405 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001406 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1407
1408 /**
1409 * Activity Action: The user pressed the "call" button to go to the dialer
1410 * or other appropriate UI for placing a call.
1411 * <p>Input: Nothing.
1412 * <p>Output: Nothing.
1413 */
1414 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1415 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1416
1417 /**
1418 * Activity Action: Start Voice Command.
1419 * <p>Input: Nothing.
1420 * <p>Output: Nothing.
1421 */
1422 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1423 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001424
1425 /**
1426 * Activity Action: Start action associated with long pressing on the
1427 * search key.
1428 * <p>Input: Nothing.
1429 * <p>Output: Nothing.
1430 */
1431 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1432 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001433
Jacek Surazski86b6c532009-05-13 14:38:28 +02001434 /**
1435 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1436 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001437 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001438 * <p>Input: No data is specified. The bug report is passed in using
1439 * an {@link #EXTRA_BUG_REPORT} field.
1440 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001441 *
1442 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001443 */
1444 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1445 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001446
1447 /**
1448 * Activity Action: Show power usage information to the user.
1449 * <p>Input: Nothing.
1450 * <p>Output: Nothing.
1451 */
1452 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1453 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001454
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001455 /**
Russell Brenner4cd32e52017-02-24 11:11:47 -08001456 * Activity Action: Setup wizard action provided for OTA provisioning to determine if it needs
1457 * to run.
1458 * <p>Input: Nothing.
1459 * <p>Output: Nothing.
1460 * @deprecated As of {@link android.os.Build.VERSION_CODES#M}, setup wizard can be identified
1461 * using {@link #ACTION_MAIN} and {@link #CATEGORY_SETUP_WIZARD}
1462 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001463 * @removed
Russell Brenner4cd32e52017-02-24 11:11:47 -08001464 */
1465 @Deprecated
1466 @SystemApi
1467 public static final String ACTION_DEVICE_INITIALIZATION_WIZARD =
1468 "android.intent.action.DEVICE_INITIALIZATION_WIZARD";
1469
1470 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001471 * Activity Action: Setup wizard to launch after a platform update. This
1472 * activity should have a string meta-data field associated with it,
1473 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1474 * the platform for setup. The activity will be launched only if
1475 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1476 * same value.
1477 * <p>Input: Nothing.
1478 * <p>Output: Nothing.
1479 * @hide
1480 */
Russell Brenner4cd32e52017-02-24 11:11:47 -08001481 @SystemApi
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001482 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1483 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001484
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001485 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001486 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1487 * <p>Input: Nothing.
1488 * <p>Output: Nothing.
1489 * @hide
1490 */
1491 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1492 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001493 "com.android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001494
1495 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001496 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1497 * <p>Input: Nothing.
1498 * <p>Output: Nothing.
1499 * @hide
1500 */
1501 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1502 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001503 "com.android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001504
1505 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001506 * Activity Action: Show settings for managing network data usage of a
1507 * specific application. Applications should define an activity that offers
1508 * options to control data usage.
1509 */
1510 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1511 public static final String ACTION_MANAGE_NETWORK_USAGE =
1512 "android.intent.action.MANAGE_NETWORK_USAGE";
1513
1514 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001515 * Activity Action: Launch application installer.
1516 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001517 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001518 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1519 * you can also use "package:<package-name>" to install an application for the
1520 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001521 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1522 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1523 * <p>
1524 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1525 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001526 * <p>
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001527 * <strong>Note:</strong>If your app is targeting API level higher than 25 you
Svet Ganov86877e42015-05-28 08:19:48 -07001528 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1529 * in order to launch the application installer.
1530 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001531 *
1532 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1533 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1534 * @see #EXTRA_RETURN_RESULT
1535 */
1536 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1537 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1538
1539 /**
Todd Kennedyd0084f72017-07-28 13:56:14 -07001540 * Activity Action: Activity to handle split installation failures.
1541 * <p>Splits may be installed dynamically. This happens when an Activity is launched,
1542 * but the split that contains the application isn't installed. When a split is
1543 * installed in this manner, the containing package usually doesn't know this is
1544 * happening. However, if an error occurs during installation, the containing
1545 * package can define a single activity handling this action to deal with such
1546 * failures.
1547 * <p>The activity handling this action must be in the base package.
1548 * <p>
1549 * Input: {@link #EXTRA_INTENT} the original intent that started split installation.
1550 * {@link #EXTRA_SPLIT_NAME} the name of the split that failed to be installed.
1551 */
1552 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1553 public static final String ACTION_INSTALL_FAILURE = "android.intent.action.INSTALL_FAILURE";
1554
1555 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001556 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001557 * @removed
Todd Kennedyd46a1602017-04-03 15:22:38 -07001558 * @deprecated Do not use. This will go away.
1559 * Replace with {@link #ACTION_INSTALL_INSTANT_APP_PACKAGE}.
1560 */
1561 @SystemApi
1562 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1563 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1564 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1565 /**
1566 * Activity Action: Launch instant application installer.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001567 * <p class="note">
1568 * This is a protected intent that can only be sent by the system.
1569 * </p>
1570 *
1571 * @hide
1572 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001573 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001574 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001575 public static final String ACTION_INSTALL_INSTANT_APP_PACKAGE
1576 = "android.intent.action.INSTALL_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001577
1578 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001579 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001580 * @removed
Todd Kennedyd46a1602017-04-03 15:22:38 -07001581 * @deprecated Do not use. This will go away.
1582 * Replace with {@link #ACTION_RESOLVE_INSTANT_APP_PACKAGE}.
1583 */
1584 @SystemApi
1585 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1586 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1587 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1588 /**
1589 * Service Action: Resolve instant application.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001590 * <p>
1591 * The system will have a persistent connection to this service.
1592 * This is a protected intent that can only be sent by the system.
1593 * </p>
1594 *
1595 * @hide
1596 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001597 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001598 @SdkConstant(SdkConstantType.SERVICE_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001599 public static final String ACTION_RESOLVE_INSTANT_APP_PACKAGE
1600 = "android.intent.action.RESOLVE_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001601
1602 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001603 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001604 * @removed
Todd Kennedyd46a1602017-04-03 15:22:38 -07001605 * @deprecated Do not use. This will go away.
1606 * Replace with {@link #ACTION_INSTANT_APP_RESOLVER_SETTINGS}.
1607 */
1608 @SystemApi
1609 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1610 public static final String ACTION_EPHEMERAL_RESOLVER_SETTINGS
1611 = "android.intent.action.EPHEMERAL_RESOLVER_SETTINGS";
1612 /**
1613 * Activity Action: Launch instant app settings.
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001614 *
1615 * <p class="note">
1616 * This is a protected intent that can only be sent by the system.
1617 * </p>
1618 *
1619 * @hide
1620 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001621 @SystemApi
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001622 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001623 public static final String ACTION_INSTANT_APP_RESOLVER_SETTINGS
1624 = "android.intent.action.INSTANT_APP_RESOLVER_SETTINGS";
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001625
1626 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001627 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1628 * package. Specifies the installer package name; this package will receive the
1629 * {@link #ACTION_APP_ERROR} intent.
1630 */
1631 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1632 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1633
1634 /**
1635 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1636 * package. Specifies that the application being installed should not be
1637 * treated as coming from an unknown source, but as coming from the app
1638 * invoking the Intent. For this to work you must start the installer with
1639 * startActivityForResult().
1640 */
1641 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1642 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1643
1644 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001645 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1646 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001647 * data field originated from.
1648 */
rich cannings706e8ba2012-08-20 13:20:14 -07001649 public static final String EXTRA_ORIGINATING_URI
1650 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001651
1652 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001653 * This extra can be used with any Intent used to launch an activity, supplying information
1654 * about who is launching that activity. This field contains a {@link android.net.Uri}
1655 * object, typically an http: or https: URI of the web site that the referral came from;
1656 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1657 * a native application that it came from.
1658 *
1659 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1660 * instead of directly retrieving the extra. It is also valid for applications to
1661 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1662 * a string, not a Uri; the field here, if supplied, will always take precedence,
1663 * however.</p>
1664 *
1665 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001666 */
1667 public static final String EXTRA_REFERRER
1668 = "android.intent.extra.REFERRER";
1669
1670 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001671 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1672 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1673 * not be created, in particular when Intent extras are supplied through the
1674 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1675 * schemes.
1676 *
1677 * @see #EXTRA_REFERRER
1678 */
1679 public static final String EXTRA_REFERRER_NAME
1680 = "android.intent.extra.REFERRER_NAME";
1681
1682 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001683 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001684 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001685 * Currently only a system app that hosts the provider authority "downloads" or holds the
1686 * permission {@link android.Manifest.permission.MANAGE_DOCUMENTS} can use this.
Ben Gruver37d83a32012-09-27 13:02:06 -07001687 * @hide
1688 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001689 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001690 public static final String EXTRA_ORIGINATING_UID
1691 = "android.intent.extra.ORIGINATING_UID";
1692
1693 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001694 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1695 * package. Tells the installer UI to skip the confirmation with the user
1696 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001697 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1698 * will no longer show an interstitial message about updating existing
1699 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001700 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001701 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001702 public static final String EXTRA_ALLOW_REPLACE
1703 = "android.intent.extra.ALLOW_REPLACE";
1704
1705 /**
1706 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1707 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1708 * return to the application the result code of the install/uninstall. The returned result
1709 * code will be {@link android.app.Activity#RESULT_OK} on success or
1710 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1711 */
1712 public static final String EXTRA_RETURN_RESULT
1713 = "android.intent.extra.RETURN_RESULT";
1714
1715 /**
1716 * Package manager install result code. @hide because result codes are not
1717 * yet ready to be exposed.
1718 */
1719 public static final String EXTRA_INSTALL_RESULT
1720 = "android.intent.extra.INSTALL_RESULT";
1721
1722 /**
1723 * Activity Action: Launch application uninstaller.
1724 * <p>
1725 * Input: The data must be a package: URI whose scheme specific part is
1726 * the package name of the current installed package to be uninstalled.
1727 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1728 * <p>
1729 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1730 * succeeded.
1731 */
1732 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1733 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1734
1735 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001736 * Specify whether the package should be uninstalled for all users.
1737 * @hide because these should not be part of normal application flow.
1738 */
1739 public static final String EXTRA_UNINSTALL_ALL_USERS
1740 = "android.intent.extra.UNINSTALL_ALL_USERS";
1741
1742 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001743 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1744 * describing the last run version of the platform that was setup.
1745 * @hide
1746 */
1747 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1748
Svet Ganov3695b8a2015-03-24 16:30:25 -07001749 /**
1750 * Activity action: Launch UI to manage the permissions of an app.
1751 * <p>
1752 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1753 * will be managed by the launched UI.
1754 * </p>
1755 * <p>
1756 * Output: Nothing.
1757 * </p>
1758 *
1759 * @see #EXTRA_PACKAGE_NAME
1760 *
1761 * @hide
1762 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001763 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001764 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1765 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1766 "android.intent.action.MANAGE_APP_PERMISSIONS";
1767
1768 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001769 * Activity action: Launch UI to manage permissions.
1770 * <p>
1771 * Input: Nothing.
1772 * </p>
1773 * <p>
1774 * Output: Nothing.
1775 * </p>
1776 *
1777 * @hide
1778 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001779 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001780 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1781 public static final String ACTION_MANAGE_PERMISSIONS =
1782 "android.intent.action.MANAGE_PERMISSIONS";
1783
1784 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001785 * Activity action: Launch UI to review permissions for an app.
1786 * The system uses this intent if permission review for apps not
1787 * supporting the new runtime permissions model is enabled. In
1788 * this mode a permission review is required before any of the
1789 * app components can run.
1790 * <p>
1791 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1792 * permissions will be reviewed (mandatory).
1793 * </p>
1794 * <p>
1795 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1796 * be fired after the permission review (optional).
1797 * </p>
1798 * <p>
1799 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1800 * be invoked after the permission review (optional).
1801 * </p>
1802 * <p>
1803 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1804 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1805 * </p>
1806 * <p>
1807 * Output: Nothing.
1808 * </p>
1809 *
1810 * @see #EXTRA_PACKAGE_NAME
1811 * @see #EXTRA_INTENT
1812 * @see #EXTRA_REMOTE_CALLBACK
1813 * @see #EXTRA_RESULT_NEEDED
1814 *
1815 * @hide
1816 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001817 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001818 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1819 public static final String ACTION_REVIEW_PERMISSIONS =
1820 "android.intent.action.REVIEW_PERMISSIONS";
1821
1822 /**
1823 * Intent extra: A callback for reporting remote result as a bundle.
1824 * <p>
1825 * Type: IRemoteCallback
1826 * </p>
1827 *
1828 * @hide
1829 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001830 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001831 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1832
1833 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001834 * Intent extra: An app package name.
1835 * <p>
1836 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001837 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001838 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001839 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001840 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1841
1842 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001843 * Intent extra: An app split name.
1844 * <p>
1845 * Type: String
1846 * </p>
Todd Kennedye5195dd2016-10-19 15:29:19 -07001847 */
Todd Kennedye5195dd2016-10-19 15:29:19 -07001848 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1849
1850 /**
Jeff Sharkey1a749422017-04-28 14:19:50 -06001851 * Intent extra: A {@link ComponentName} value.
1852 * <p>
1853 * Type: String
1854 * </p>
1855 */
1856 public static final String EXTRA_COMPONENT_NAME = "android.intent.extra.COMPONENT_NAME";
1857
1858 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001859 * Intent extra: An extra for specifying whether a result is needed.
1860 * <p>
1861 * Type: boolean
1862 * </p>
1863 *
1864 * @hide
1865 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001866 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001867 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1868
1869 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001870 * Activity action: Launch UI to manage which apps have a given permission.
1871 * <p>
1872 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1873 * to which will be managed by the launched UI.
1874 * </p>
1875 * <p>
1876 * Output: Nothing.
1877 * </p>
1878 *
1879 * @see #EXTRA_PERMISSION_NAME
1880 *
1881 * @hide
1882 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001883 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001884 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1885 public static final String ACTION_MANAGE_PERMISSION_APPS =
1886 "android.intent.action.MANAGE_PERMISSION_APPS";
1887
1888 /**
1889 * Intent extra: The name of a permission.
1890 * <p>
1891 * Type: String
1892 * </p>
1893 *
1894 * @hide
1895 */
1896 @SystemApi
1897 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1898
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001899 // ---------------------------------------------------------------------
1900 // ---------------------------------------------------------------------
1901 // Standard intent broadcast actions (see action variable).
1902
1903 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001904 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1905 * <p>
1906 * For historical reasons, the name of this broadcast action refers to the power
1907 * state of the screen but it is actually sent in response to changes in the
1908 * overall interactive state of the device.
1909 * </p><p>
1910 * This broadcast is sent when the device becomes non-interactive which may have
1911 * nothing to do with the screen turning off. To determine the
1912 * actual state of the screen, use {@link android.view.Display#getState}.
1913 * </p><p>
1914 * See {@link android.os.PowerManager#isInteractive} for details.
1915 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001916 * You <em>cannot</em> receive this through components declared in
1917 * manifests, only by explicitly registering for it with
1918 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1919 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001920 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001921 * <p class="note">This is a protected intent that can only be sent
1922 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001923 */
1924 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1925 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001926
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001927 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001928 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1929 * <p>
1930 * For historical reasons, the name of this broadcast action refers to the power
1931 * state of the screen but it is actually sent in response to changes in the
1932 * overall interactive state of the device.
1933 * </p><p>
1934 * This broadcast is sent when the device becomes interactive which may have
1935 * nothing to do with the screen turning on. To determine the
1936 * actual state of the screen, use {@link android.view.Display#getState}.
1937 * </p><p>
1938 * See {@link android.os.PowerManager#isInteractive} for details.
1939 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001940 * You <em>cannot</em> receive this through components declared in
1941 * manifests, only by explicitly registering for it with
1942 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1943 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001944 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001945 * <p class="note">This is a protected intent that can only be sent
1946 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001947 */
1948 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1949 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001950
1951 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001952 * Broadcast Action: Sent after the system stops dreaming.
1953 *
1954 * <p class="note">This is a protected intent that can only be sent by the system.
1955 * It is only sent to registered receivers.</p>
1956 */
1957 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1958 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1959
1960 /**
1961 * Broadcast Action: Sent after the system starts dreaming.
1962 *
1963 * <p class="note">This is a protected intent that can only be sent by the system.
1964 * It is only sent to registered receivers.</p>
1965 */
1966 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1967 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1968
1969 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001970 * 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 -07001971 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001972 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001973 * <p class="note">This is a protected intent that can only be sent
1974 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001975 */
1976 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001977 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001978
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001979 /**
1980 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001981 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001982 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001983 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1984 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001985 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001986 * <p class="note">This is a protected intent that can only be sent
1987 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001988 */
1989 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1990 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1991 /**
1992 * Broadcast Action: The time was set.
1993 */
1994 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1995 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1996 /**
1997 * Broadcast Action: The date has changed.
1998 */
1999 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2000 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
2001 /**
2002 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
2003 * <ul>
2004 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
2005 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002006 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002007 * <p class="note">This is a protected intent that can only be sent
2008 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002009 */
2010 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2011 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
2012 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07002013 * Clear DNS Cache Action: This is broadcast when networks have changed and old
2014 * DNS entries should be tossed.
2015 * @hide
2016 */
2017 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2018 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
2019 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002020 * Alarm Changed Action: This is broadcast when the AlarmClock
2021 * application's alarm is set or unset. It is used by the
2022 * AlarmClock application and the StatusBar service.
2023 * @hide
2024 */
2025 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2026 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002027
2028 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002029 * Broadcast Action: This is broadcast once, after the user has finished
2030 * booting, but while still in the "locked" state. It can be used to perform
2031 * application-specific initialization, such as installing alarms. You must
2032 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
2033 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002034 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002035 * This broadcast is sent immediately at boot by all devices (regardless of
2036 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
2037 * higher. Upon receipt of this broadcast, the user is still locked and only
2038 * device-protected storage can be accessed safely. If you want to access
2039 * credential-protected storage, you need to wait for the user to be
2040 * unlocked (typically by entering their lock pattern or PIN for the first
2041 * time), after which the {@link #ACTION_USER_UNLOCKED} and
2042 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
2043 * <p>
2044 * To receive this broadcast, your receiver component must be marked as
2045 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002046 * <p class="note">
2047 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002048 *
2049 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002050 */
2051 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2052 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2053
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002054 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002055 * Broadcast Action: This is broadcast once, after the user has finished
2056 * booting. It can be used to perform application-specific initialization,
2057 * such as installing alarms. You must hold the
2058 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2059 * order to receive this broadcast.
2060 * <p>
2061 * This broadcast is sent at boot by all devices (both with and without
2062 * direct boot support). Upon receipt of this broadcast, the user is
2063 * unlocked and both device-protected and credential-protected storage can
2064 * accessed safely.
2065 * <p>
2066 * If you need to run while the user is still locked (before they've entered
2067 * their lock pattern or PIN for the first time), you can listen for the
2068 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2069 * <p class="note">
2070 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002071 */
2072 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002073 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002074 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002075
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002076 /**
2077 * Broadcast Action: This is broadcast when a user action should request a
2078 * temporary system dialog to dismiss. Some examples of temporary system
2079 * dialogs are the notification window-shade and the recent tasks dialog.
2080 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002081 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002082 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2083 /**
2084 * Broadcast Action: Trigger the download and eventual installation
2085 * of a package.
2086 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002087 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002088 * <p class="note">This is a protected intent that can only be sent
2089 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002090 *
2091 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002092 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002093 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002094 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2095 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2096 /**
Christopher Tate94b91db2017-04-19 15:49:17 -07002097 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002098 * device. The data contains the name of the package. Note that the
2099 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002100 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002101 * <ul>
Christopher Tate94b91db2017-04-19 15:49:17 -07002102 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2103 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002104 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2105 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002106 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002107 * <p class="note">This is a protected intent that can only be sent
2108 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002109 */
2110 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2111 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2112 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002113 * Broadcast Action: A new version of an application package has been
2114 * installed, replacing an existing version that was previously installed.
2115 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002116 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002117 * <ul>
2118 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2119 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002120 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002121 * <p class="note">This is a protected intent that can only be sent
2122 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002123 */
2124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2125 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2126 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002127 * Broadcast Action: A new version of your application has been installed
2128 * over an existing one. This is only sent to the application that was
2129 * replaced. It does not contain any additional data; to receive it, just
2130 * use an intent filter for this action.
2131 *
2132 * <p class="note">This is a protected intent that can only be sent
2133 * by the system.
2134 */
2135 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2136 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2137 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002138 * Broadcast Action: An existing application package has been removed from
2139 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002140 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002141 * <ul>
2142 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2143 * to the package.
2144 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2145 * application -- data and code -- is being removed.
2146 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2147 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2148 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002149 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002150 * <p class="note">This is a protected intent that can only be sent
2151 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002152 */
2153 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2154 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2155 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002156 * Broadcast Action: An existing application package has been completely
2157 * removed from the device. The data contains the name of the package.
2158 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2159 * {@link #EXTRA_DATA_REMOVED} is true and
2160 * {@link #EXTRA_REPLACING} is false of that broadcast.
2161 *
2162 * <ul>
2163 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2164 * to the package.
2165 * </ul>
2166 *
2167 * <p class="note">This is a protected intent that can only be sent
2168 * by the system.
2169 */
2170 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2171 public static final String ACTION_PACKAGE_FULLY_REMOVED
2172 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2173 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002174 * Broadcast Action: An existing application package has been changed (for
2175 * example, a component has been enabled or disabled). The data contains
2176 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002177 * <ul>
2178 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002179 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002180 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002181 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2182 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002183 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002184 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002185 * <p class="note">This is a protected intent that can only be sent
2186 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002187 */
2188 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2189 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2190 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002191 * @hide
2192 * Broadcast Action: Ask system services if there is any reason to
2193 * restart the given package. The data contains the name of the
2194 * package.
2195 * <ul>
2196 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2197 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2198 * </ul>
2199 *
2200 * <p class="note">This is a protected intent that can only be sent
2201 * by the system.
2202 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002203 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002204 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2205 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2206 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002207 * Broadcast Action: The user has restarted a package, and all of its
2208 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002209 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002210 * be removed. Note that the restarted package does <em>not</em>
2211 * receive this broadcast.
2212 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002213 * <ul>
2214 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2215 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002216 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002217 * <p class="note">This is a protected intent that can only be sent
2218 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002219 */
2220 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2221 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2222 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002223 * Broadcast Action: The user has cleared the data of a package. This should
2224 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002225 * its persistent data is erased and this broadcast sent.
2226 * Note that the cleared package does <em>not</em>
2227 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002228 * <ul>
Svet Ganovf935a702017-08-22 12:15:58 -07002229 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package. If the
2230 * package whose data was cleared is an uninstalled instant app, then the UID
2231 * will be -1. The platform keeps some meta-data associated with instant apps
2232 * after they are uninstalled.
2233 * <li> {@link #EXTRA_PACKAGE_NAME} containing the package name only if the cleared
2234 * data was for an instant app.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002235 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002236 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002237 * <p class="note">This is a protected intent that can only be sent
2238 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002239 */
2240 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2241 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2242 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002243 * Broadcast Action: Packages have been suspended.
2244 * <p>Includes the following extras:
2245 * <ul>
2246 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2247 * </ul>
2248 *
2249 * <p class="note">This is a protected intent that can only be sent
2250 * by the system. It is only sent to registered receivers.
2251 */
2252 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2253 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2254 /**
2255 * Broadcast Action: Packages have been unsuspended.
2256 * <p>Includes the following extras:
2257 * <ul>
2258 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2259 * </ul>
2260 *
2261 * <p class="note">This is a protected intent that can only be sent
2262 * by the system. It is only sent to registered receivers.
2263 */
2264 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2265 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2266 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002267 * Broadcast Action: A user ID has been removed from the system. The user
2268 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002269 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002270 * <p class="note">This is a protected intent that can only be sent
2271 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002272 */
2273 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2274 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002275
2276 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002277 * Broadcast Action: Sent to the installer package of an application when
2278 * that application is first launched (that is the first time it is moved
2279 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002280 *
2281 * <p class="note">This is a protected intent that can only be sent
2282 * by the system.
2283 */
2284 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2285 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2286
2287 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002288 * Broadcast Action: Sent to the system package verifier when a package
2289 * needs to be verified. The data contains the package URI.
2290 * <p class="note">
2291 * This is a protected intent that can only be sent by the system.
2292 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002293 */
2294 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2295 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2296
2297 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002298 * Broadcast Action: Sent to the system package verifier when a package is
2299 * verified. The data contains the package URI.
2300 * <p class="note">
2301 * This is a protected intent that can only be sent by the system.
2302 */
2303 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2304 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2305
2306 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002307 * Broadcast Action: Sent to the system intent filter verifier when an
2308 * intent filter needs to be verified. The data contains the filter data
2309 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002310 * <p class="note">
2311 * This is a protected intent that can only be sent by the system.
2312 * </p>
2313 *
2314 * @hide
2315 */
2316 @SystemApi
2317 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2318 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2319
2320 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002321 * Broadcast Action: Resources for a set of packages (which were
2322 * previously unavailable) are currently
2323 * available since the media on which they exist is available.
2324 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2325 * list of packages whose availability changed.
2326 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2327 * list of uids of packages whose availability changed.
2328 * Note that the
2329 * packages in this list do <em>not</em> receive this broadcast.
2330 * The specified set of packages are now available on the system.
2331 * <p>Includes the following extras:
2332 * <ul>
2333 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2334 * whose resources(were previously unavailable) are currently available.
2335 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2336 * packages whose resources(were previously unavailable)
2337 * are currently available.
2338 * </ul>
2339 *
2340 * <p class="note">This is a protected intent that can only be sent
2341 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002342 */
2343 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002344 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2345 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002346
2347 /**
2348 * Broadcast Action: Resources for a set of packages are currently
2349 * unavailable since the media on which they exist is unavailable.
2350 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2351 * list of packages whose availability changed.
2352 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2353 * list of uids of packages whose availability changed.
2354 * The specified set of packages can no longer be
2355 * launched and are practically unavailable on the system.
2356 * <p>Inclues the following extras:
2357 * <ul>
2358 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2359 * whose resources are no longer available.
2360 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2361 * whose resources are no longer available.
2362 * </ul>
2363 *
2364 * <p class="note">This is a protected intent that can only be sent
2365 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002366 */
2367 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002368 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002369 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002370
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002371 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002372 * Broadcast Action: preferred activities have changed *explicitly*.
2373 *
2374 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2375 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2376 * be sent.
2377 *
2378 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2379 *
2380 * @hide
2381 */
2382 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2383 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2384 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2385
2386
2387 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002388 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002389 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002390 * This should <em>only</em> be used to determine when the wallpaper
2391 * has changed to show the new wallpaper to the user. You should certainly
2392 * never, in response to this, change the wallpaper or other attributes of
2393 * it such as the suggested size. That would be crazy, right? You'd cause
2394 * all kinds of loops, especially if other apps are doing similar things,
2395 * right? Of course. So please don't do this.
2396 *
2397 * @deprecated Modern applications should use
2398 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2399 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2400 * shown behind their UI, rather than watching for this broadcast and
2401 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002402 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002403 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002404 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2405 /**
2406 * Broadcast Action: The current device {@link android.content.res.Configuration}
2407 * (orientation, locale, etc) has changed. When such a change happens, the
2408 * UIs (view hierarchy) will need to be rebuilt based on this new
2409 * information; for the most part, applications don't need to worry about
2410 * this, because the system will take care of stopping and restarting the
2411 * application to make sure it sees the new changes. Some system code that
2412 * can not be restarted will need to watch for this action and handle it
2413 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002414 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002415 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002416 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002417 * in manifests, only by explicitly registering for it with
2418 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2419 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002420 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002421 * <p class="note">This is a protected intent that can only be sent
2422 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002423 *
2424 * @see android.content.res.Configuration
2425 */
2426 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2427 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2428 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002429 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002430 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002431 * <p class="note">This is a protected intent that can only be sent
2432 * by the system.
2433 */
2434 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2435 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2436 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002437 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2438 * charging state, level, and other information about the battery.
2439 * See {@link android.os.BatteryManager} for documentation on the
2440 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002441 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002442 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002443 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002444 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002445 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002446 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2447 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2448 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2449 * broadcasts that are sent and can be received through manifest
2450 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002451 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002452 * <p class="note">This is a protected intent that can only be sent
2453 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002454 */
2455 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2456 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2457 /**
2458 * Broadcast Action: Indicates low battery condition on the device.
2459 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002460 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002461 * <p class="note">This is a protected intent that can only be sent
2462 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002463 */
2464 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2465 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2466 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002467 * Broadcast Action: Indicates the battery is now okay after being low.
2468 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2469 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002470 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002471 * <p class="note">This is a protected intent that can only be sent
2472 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002473 */
2474 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2475 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2476 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002477 * Broadcast Action: External power has been connected to the device.
2478 * This is intended for applications that wish to register specifically to this notification.
2479 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2480 * stay active to receive this notification. This action can be used to implement actions
2481 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002482 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002483 * <p class="note">This is a protected intent that can only be sent
2484 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002485 */
2486 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002487 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002488 /**
2489 * Broadcast Action: External power has been removed from the device.
2490 * This is intended for applications that wish to register specifically to this notification.
2491 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2492 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002493 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002494 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002495 * <p class="note">This is a protected intent that can only be sent
2496 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002497 */
2498 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002499 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002500 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002501 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002502 * Broadcast Action: Device is shutting down.
2503 * This is broadcast when the device is being shut down (completely turned
2504 * off, not sleeping). Once the broadcast is complete, the final shutdown
2505 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002506 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002507 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002508 * <p class="note">This is a protected intent that can only be sent
2509 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002510 * <p>May include the following extras:
2511 * <ul>
2512 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2513 * shutdown is only for userspace processes. If not set, assumed to be false.
2514 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002515 */
2516 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002517 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002518 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002519 * Activity Action: Start this activity to request system shutdown.
2520 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002521 * to request confirmation from the user before shutting down. The optional boolean
2522 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2523 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002524 *
2525 * <p class="note">This is a protected intent that can only be sent
2526 * by the system.
2527 *
2528 * {@hide}
2529 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002530 public static final String ACTION_REQUEST_SHUTDOWN
2531 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002532 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002533 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002534 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002535 * <p class="note">
2536 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002537 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002538 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2539 * or above, this broadcast will no longer be delivered to any
2540 * {@link BroadcastReceiver} defined in your manifest. Instead,
2541 * apps are strongly encouraged to use the improved
2542 * {@link Context#getCacheDir()} behavior so the system can
2543 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002544 */
2545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002546 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002547 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2548 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002549 * Broadcast Action: Indicates low storage space condition on the device no
2550 * longer exists
2551 * <p class="note">
2552 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002553 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002554 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2555 * or above, this broadcast will no longer be delivered to any
2556 * {@link BroadcastReceiver} defined in your manifest. Instead,
2557 * apps are strongly encouraged to use the improved
2558 * {@link Context#getCacheDir()} behavior so the system can
2559 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002560 */
2561 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002562 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002563 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2564 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002565 * Broadcast Action: A sticky broadcast that indicates a storage space full
2566 * condition on the device. This is intended for activities that want to be
2567 * able to fill the data partition completely, leaving only enough free
2568 * space to prevent system-wide SQLite failures.
2569 * <p class="note">
2570 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002571 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002572 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2573 * or above, this broadcast will no longer be delivered to any
2574 * {@link BroadcastReceiver} defined in your manifest. Instead,
2575 * apps are strongly encouraged to use the improved
2576 * {@link Context#getCacheDir()} behavior so the system can
2577 * automatically free up storage when needed.
2578 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002579 */
2580 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002581 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002582 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2583 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002584 * Broadcast Action: Indicates storage space full condition on the device no
2585 * longer exists.
2586 * <p class="note">
2587 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002588 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002589 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2590 * or above, this broadcast will no longer be delivered to any
2591 * {@link BroadcastReceiver} defined in your manifest. Instead,
2592 * apps are strongly encouraged to use the improved
2593 * {@link Context#getCacheDir()} behavior so the system can
2594 * automatically free up storage when needed.
2595 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002596 */
2597 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002598 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002599 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2600 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002601 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2602 * and package management should be started.
2603 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2604 * notification.
2605 */
2606 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2607 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2608 /**
2609 * Broadcast Action: The device has entered USB Mass Storage mode.
2610 * This is used mainly for the USB Settings panel.
2611 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2612 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002613 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002614 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002615 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002616 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002617 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2618
2619 /**
2620 * Broadcast Action: The device has exited USB Mass Storage mode.
2621 * This is used mainly for the USB Settings panel.
2622 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2623 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002624 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002625 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002626 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002627 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002628 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2629
2630 /**
2631 * Broadcast Action: External media has been removed.
2632 * The path to the mount point for the removed media is contained in the Intent.mData field.
2633 */
2634 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2635 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2636
2637 /**
2638 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002639 * 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 -07002640 */
2641 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2642 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2643
2644 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002645 * Broadcast Action: External media is present, and being disk-checked
2646 * 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 -08002647 */
2648 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2649 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2650
2651 /**
2652 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2653 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002654 */
2655 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2656 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2657
2658 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002659 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002660 * 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 -07002661 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2662 * media was mounted read only.
2663 */
2664 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2665 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2666
2667 /**
2668 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002669 * 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 -07002670 */
2671 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2672 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2673
2674 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002675 * Broadcast Action: External media is no longer being shared via USB mass storage.
2676 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2677 *
2678 * @hide
2679 */
2680 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2681
2682 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002683 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2684 * The path to the mount point for the removed media is contained in the Intent.mData field.
2685 */
2686 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2687 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2688
2689 /**
2690 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002691 * 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 -07002692 */
2693 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2694 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2695
2696 /**
2697 * Broadcast Action: User has expressed the desire to remove the external storage media.
2698 * Applications should close all files they have open within the mount point when they receive this intent.
2699 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2700 */
2701 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2702 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2703
2704 /**
2705 * Broadcast Action: The media scanner has started scanning a directory.
2706 * The path to the directory being scanned is contained in the Intent.mData field.
2707 */
2708 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2709 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2710
2711 /**
2712 * Broadcast Action: The media scanner has finished scanning a directory.
2713 * The path to the scanned directory is contained in the Intent.mData field.
2714 */
2715 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2716 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2717
2718 /**
2719 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2720 * The path to the file is contained in the Intent.mData field.
2721 */
2722 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2723 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2724
2725 /**
2726 * Broadcast Action: The "Media Button" was pressed. Includes a single
2727 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2728 * caused the broadcast.
2729 */
2730 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2731 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2732
2733 /**
2734 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2735 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2736 * caused the broadcast.
2737 */
2738 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2739 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2740
2741 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2742 // location; they are not general-purpose actions.
2743
2744 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002745 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002746 */
2747 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2748 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2749 "android.intent.action.GTALK_CONNECTED";
2750
2751 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002752 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002753 */
2754 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2755 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2756 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002757
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002758 /**
2759 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002760 */
2761 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2762 public static final String ACTION_INPUT_METHOD_CHANGED =
2763 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002764
2765 /**
2766 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2767 * more radios have been turned off or on. The intent will have the following extra value:</p>
2768 * <ul>
2769 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2770 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2771 * turned off</li>
2772 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002773 *
Peng Xua35b5532016-01-20 00:05:45 -08002774 * <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 -07002775 */
2776 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2777 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2778
2779 /**
2780 * Broadcast Action: Some content providers have parts of their namespace
2781 * where they publish new events or items that the user may be especially
2782 * interested in. For these things, they may broadcast this action when the
2783 * set of interesting items change.
2784 *
2785 * For example, GmailProvider sends this notification when the set of unread
2786 * mail in the inbox changes.
2787 *
2788 * <p>The data of the intent identifies which part of which provider
2789 * changed. When queried through the content resolver, the data URI will
2790 * return the data set in question.
2791 *
2792 * <p>The intent will have the following extra values:
2793 * <ul>
2794 * <li><em>count</em> - The number of items in the data set. This is the
2795 * same as the number of items in the cursor returned by querying the
2796 * data URI. </li>
2797 * </ul>
2798 *
2799 * This intent will be sent at boot (if the count is non-zero) and when the
2800 * data set changes. It is possible for the data set to change without the
2801 * count changing (for example, if a new unread message arrives in the same
2802 * sync operation in which a message is archived). The phone should still
2803 * ring/vibrate/etc as normal in this case.
2804 */
2805 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2806 public static final String ACTION_PROVIDER_CHANGED =
2807 "android.intent.action.PROVIDER_CHANGED";
2808
2809 /**
2810 * Broadcast Action: Wired Headset plugged in or unplugged.
2811 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002812 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2813 * and documentation.
2814 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002815 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002816 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002817 */
2818 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002819 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002820
2821 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002822 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2823 * <ul>
2824 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2825 * </ul>
2826 *
2827 * <p class="note">This is a protected intent that can only be sent
2828 * by the system.
2829 *
2830 * @hide
2831 */
2832 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2833 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2834 = "android.intent.action.ADVANCED_SETTINGS";
2835
2836 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002837 * Broadcast Action: Sent after application restrictions are changed.
2838 *
2839 * <p class="note">This is a protected intent that can only be sent
2840 * by the system.</p>
2841 */
2842 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2843 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2844 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2845
2846 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002847 * Broadcast Action: An outgoing call is about to be placed.
2848 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002849 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002850 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002851 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002852 * the phone number originally intended to be dialed.</li>
2853 * </ul>
2854 * <p>Once the broadcast is finished, the resultData is used as the actual
2855 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002856 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002857 * outgoing call in turn: for example, a parental control application
2858 * might verify that the user is authorized to place the call at that
2859 * time, then a number-rewriting application might add an area code if
2860 * one was not specified.</p>
2861 * <p>For consistency, any receiver whose purpose is to prohibit phone
2862 * calls should have a priority of 0, to ensure it will see the final
2863 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002864 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002865 * should have a positive priority.
2866 * Negative priorities are reserved for the system for this broadcast;
2867 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002868 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2869 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002870 * <p>Emergency calls cannot be intercepted using this mechanism, and
2871 * other calls cannot be modified to call emergency numbers using this
2872 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002873 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2874 * call to use their own service instead. Those apps should first prevent
2875 * the call from being placed by setting resultData to <code>null</code>
2876 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002877 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002878 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2879 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002880 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002881 * <p class="note">This is a protected intent that can only be sent
2882 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002883 */
2884 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2885 public static final String ACTION_NEW_OUTGOING_CALL =
2886 "android.intent.action.NEW_OUTGOING_CALL";
2887
2888 /**
2889 * Broadcast Action: Have the device reboot. This is only for use by
2890 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002891 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002892 * <p class="note">This is a protected intent that can only be sent
2893 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002894 */
2895 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2896 public static final String ACTION_REBOOT =
2897 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002898
Wei Huang97ecc9c2009-05-11 17:44:20 -07002899 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002900 * Broadcast Action: A sticky broadcast for changes in the physical
2901 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002902 *
2903 * <p>The intent will have the following extra values:
2904 * <ul>
2905 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002906 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002907 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002908 * <p>This is intended for monitoring the current physical dock state.
2909 * See {@link android.app.UiModeManager} for the normal API dealing with
2910 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002911 */
2912 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2913 public static final String ACTION_DOCK_EVENT =
2914 "android.intent.action.DOCK_EVENT";
2915
2916 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002917 * Broadcast Action: A broadcast when idle maintenance can be started.
2918 * This means that the user is not interacting with the device and is
2919 * not expected to do so soon. Typical use of the idle maintenance is
2920 * to perform somehow expensive tasks that can be postponed at a moment
2921 * when they will not degrade user experience.
2922 * <p>
2923 * <p class="note">In order to keep the device responsive in case of an
2924 * unexpected user interaction, implementations of a maintenance task
2925 * should be interruptible. In such a scenario a broadcast with action
2926 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2927 * should not do the maintenance work in
2928 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2929 * maintenance service by {@link Context#startService(Intent)}. Also
2930 * you should hold a wake lock while your maintenance service is running
2931 * to prevent the device going to sleep.
2932 * </p>
2933 * <p>
2934 * <p class="note">This is a protected intent that can only be sent by
2935 * the system.
2936 * </p>
2937 *
2938 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002939 *
2940 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002941 */
2942 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2943 public static final String ACTION_IDLE_MAINTENANCE_START =
2944 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2945
2946 /**
2947 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2948 * This means that the user was not interacting with the device as a result
2949 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2950 * was sent and now the user started interacting with the device. Typical
2951 * use of the idle maintenance is to perform somehow expensive tasks that
2952 * can be postponed at a moment when they will not degrade user experience.
2953 * <p>
2954 * <p class="note">In order to keep the device responsive in case of an
2955 * unexpected user interaction, implementations of a maintenance task
2956 * should be interruptible. Hence, on receiving a broadcast with this
2957 * action, the maintenance task should be interrupted as soon as possible.
2958 * In other words, you should not do the maintenance work in
2959 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2960 * maintenance service that was started on receiving of
2961 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2962 * lock you acquired when your maintenance service started.
2963 * </p>
2964 * <p class="note">This is a protected intent that can only be sent
2965 * by the system.
2966 *
2967 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002968 *
2969 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002970 */
2971 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2972 public static final String ACTION_IDLE_MAINTENANCE_END =
2973 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2974
2975 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002976 * Broadcast Action: a remote intent is to be broadcasted.
2977 *
2978 * A remote intent is used for remote RPC between devices. The remote intent
2979 * is serialized and sent from one device to another device. The receiving
2980 * device parses the remote intent and broadcasts it. Note that anyone can
2981 * broadcast a remote intent. However, if the intent receiver of the remote intent
2982 * does not trust intent broadcasts from arbitrary intent senders, it should require
2983 * the sender to hold certain permissions so only trusted sender's broadcast will be
2984 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002985 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002986 */
2987 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002988 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002989
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002990 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002991 * Broadcast Action: This is broadcast once when the user is booting after a
2992 * system update. It can be used to perform cleanup or upgrades after a
2993 * system update.
2994 * <p>
2995 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2996 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2997 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2998 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002999 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003000 * @hide
3001 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003002 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003003 public static final String ACTION_PRE_BOOT_COMPLETED =
3004 "android.intent.action.PRE_BOOT_COMPLETED";
3005
Amith Yamasani13593602012-03-22 16:16:17 -07003006 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003007 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003008 * on restricted users. The broadcast intent contains an extra
3009 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
3010 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
3011 * String[] depending on the restriction type.<p/>
3012 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07003013 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
3014 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
3015 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003016 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
3017 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003018 * @see RestrictionEntry
3019 */
3020 public static final String ACTION_GET_RESTRICTION_ENTRIES =
3021 "android.intent.action.GET_RESTRICTION_ENTRIES";
3022
3023 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003024 * Sent the first time a user is starting, to allow system apps to
3025 * perform one time initialization. (This will not be seen by third
3026 * party applications because a newly initialized user does not have any
3027 * third party applications installed for it.) This is sent early in
3028 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003029 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3030 * broadcast, since it is part of a visible user interaction; be as quick
3031 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003032 */
3033 public static final String ACTION_USER_INITIALIZE =
3034 "android.intent.action.USER_INITIALIZE";
3035
3036 /**
3037 * Sent when a user switch is happening, causing the process's user to be
3038 * brought to the foreground. This is only sent to receivers registered
3039 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3040 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003041 * foreground. This is sent as a foreground
3042 * broadcast, since it is part of a visible user interaction; be as quick
3043 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003044 */
3045 public static final String ACTION_USER_FOREGROUND =
3046 "android.intent.action.USER_FOREGROUND";
3047
3048 /**
3049 * Sent when a user switch is happening, causing the process's user to be
3050 * sent to the background. This is only sent to receivers registered
3051 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3052 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003053 * background. This is sent as a foreground
3054 * broadcast, since it is part of a visible user interaction; be as quick
3055 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003056 */
3057 public static final String ACTION_USER_BACKGROUND =
3058 "android.intent.action.USER_BACKGROUND";
3059
3060 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003061 * Broadcast sent to the system when a user is added. Carries an extra
3062 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3063 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003064 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003065 * @hide
3066 */
3067 public static final String ACTION_USER_ADDED =
3068 "android.intent.action.USER_ADDED";
3069
3070 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003071 * Broadcast sent by the system when a user is started. Carries an extra
3072 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003073 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003074 * that has been started. This is sent as a foreground
3075 * broadcast, since it is part of a visible user interaction; be as quick
3076 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003077 * @hide
3078 */
3079 public static final String ACTION_USER_STARTED =
3080 "android.intent.action.USER_STARTED";
3081
3082 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003083 * Broadcast sent when a user is in the process of starting. Carries an extra
3084 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3085 * sent to registered receivers, not manifest receivers. It is sent to all
3086 * users (including the one that is being started). You must hold
3087 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3088 * this broadcast. This is sent as a background broadcast, since
3089 * its result is not part of the primary UX flow; to safely keep track of
3090 * started/stopped state of a user you can use this in conjunction with
3091 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3092 * other user state broadcasts since those are foreground broadcasts so can
3093 * execute in a different order.
3094 * @hide
3095 */
3096 public static final String ACTION_USER_STARTING =
3097 "android.intent.action.USER_STARTING";
3098
3099 /**
3100 * Broadcast sent when a user is going to be stopped. Carries an extra
3101 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3102 * sent to registered receivers, not manifest receivers. It is sent to all
3103 * users (including the one that is being stopped). You must hold
3104 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3105 * this broadcast. The user will not stop until all receivers have
3106 * handled the broadcast. This is sent as a background broadcast, since
3107 * its result is not part of the primary UX flow; to safely keep track of
3108 * started/stopped state of a user you can use this in conjunction with
3109 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3110 * other user state broadcasts since those are foreground broadcasts so can
3111 * execute in a different order.
3112 * @hide
3113 */
3114 public static final String ACTION_USER_STOPPING =
3115 "android.intent.action.USER_STOPPING";
3116
3117 /**
3118 * Broadcast sent to the system when a user is stopped. Carries an extra
3119 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3120 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3121 * specific package. This is only sent to registered receivers, not manifest
3122 * receivers. It is sent to all running users <em>except</em> the one that
3123 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003124 * @hide
3125 */
3126 public static final String ACTION_USER_STOPPED =
3127 "android.intent.action.USER_STOPPED";
3128
3129 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003130 * 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 -07003131 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003132 * one that has been removed. The user will not be completely removed until all receivers have
3133 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003134 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003135 * @hide
3136 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003137 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003138 public static final String ACTION_USER_REMOVED =
3139 "android.intent.action.USER_REMOVED";
3140
3141 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003142 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003143 * the userHandle of the user to become the current one. This is only sent to
3144 * registered receivers, not manifest receivers. It is sent to all running users.
3145 * You must hold
3146 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003147 * @hide
3148 */
3149 public static final String ACTION_USER_SWITCHED =
3150 "android.intent.action.USER_SWITCHED";
3151
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003152 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003153 * Broadcast Action: Sent when the credential-encrypted private storage has
3154 * become unlocked for the target user. This is only sent to registered
3155 * receivers, not manifest receivers.
3156 */
3157 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3158 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3159
3160 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003161 * Broadcast sent to the system when a user's information changes. Carries an extra
3162 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003163 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003164 * @hide
3165 */
3166 public static final String ACTION_USER_INFO_CHANGED =
3167 "android.intent.action.USER_INFO_CHANGED";
3168
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003169 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003170 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3171 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003172 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3173 * that need to display merged content across both primary and managed profiles need to
3174 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003175 * not manifest receivers.
3176 */
3177 public static final String ACTION_MANAGED_PROFILE_ADDED =
3178 "android.intent.action.MANAGED_PROFILE_ADDED";
3179
3180 /**
3181 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003182 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3183 * Only applications (for example Launchers) that need to display merged content across both
3184 * primary and managed profiles need to worry about this broadcast. This is only sent to
3185 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003186 */
3187 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3188 "android.intent.action.MANAGED_PROFILE_REMOVED";
3189
3190 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003191 * Broadcast sent to the primary user when the credential-encrypted private storage for
3192 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3193 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3194 * Launchers) that need to display merged content across both primary and managed profiles
3195 * need to worry about this broadcast. This is only sent to registered receivers,
3196 * not manifest receivers.
3197 */
3198 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3199 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3200
3201 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003202 * Broadcast sent to the primary user when an associated managed profile has become available.
3203 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003204 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3205 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3206 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003207 */
Rubin Xue95057a2016-04-01 16:49:25 +01003208 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3209 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3210
3211 /**
3212 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3213 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3214 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3215 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3216 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3217 */
3218 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3219 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003220
3221 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003222 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3223 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3224 * the device was locked or unlocked.
3225 *
3226 * This is only sent to registered receivers.
3227 *
3228 * @hide
3229 */
3230 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3231 "android.intent.action.DEVICE_LOCKED_CHANGED";
3232
3233 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003234 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3235 */
3236 public static final String ACTION_QUICK_CLOCK =
3237 "android.intent.action.QUICK_CLOCK";
3238
Michael Wright0087a142013-02-05 16:29:39 -08003239 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003240 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003241 * @hide
3242 */
3243 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003244 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003245
Justin Kohd378ad72013-04-01 12:18:26 -07003246 /**
3247 * Broadcast Action: A global button was pressed. Includes a single
3248 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3249 * caused the broadcast.
3250 * @hide
3251 */
Sujith Ramakrishnan48e19c82017-04-24 15:57:58 -07003252 @SystemApi
Justin Kohd378ad72013-04-01 12:18:26 -07003253 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3254
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003255 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003256 * Broadcast Action: Sent when media resource is granted.
3257 * <p>
3258 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3259 * granted.
3260 * </p>
3261 * <p class="note">
3262 * This is a protected intent that can only be sent by the system.
3263 * </p>
3264 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003265 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003266 * </p>
3267 *
3268 * @hide
3269 */
3270 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3271 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3272
3273 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003274 * Broadcast Action: An overlay package has changed. The data contains the
3275 * name of the overlay package which has changed. This is broadcast on all
3276 * changes to the OverlayInfo returned by {@link
3277 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3278 * most common change is a state change that will change whether the
3279 * overlay is enabled or not.
3280 * @hide
3281 */
3282 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3283
3284 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003285 * Activity Action: Allow the user to select and return one or more existing
3286 * documents. When invoked, the system will display the various
3287 * {@link DocumentsProvider} instances installed on the device, letting the
3288 * user interactively navigate through them. These documents include local
3289 * media, such as photos and video, and documents provided by installed
3290 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003291 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003292 * Each document is represented as a {@code content://} URI backed by a
3293 * {@link DocumentsProvider}, which can be opened as a stream with
3294 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3295 * {@link android.provider.DocumentsContract.Document} metadata.
3296 * <p>
3297 * All selected documents are returned to the calling application with
3298 * persistable read and write permission grants. If you want to maintain
3299 * access to the documents across device reboots, you need to explicitly
3300 * take the persistable permissions using
3301 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3302 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003303 * Callers must indicate the acceptable document MIME types through
3304 * {@link #setType(String)}. For example, to select photos, use
3305 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3306 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3307 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003308 * <p>
3309 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003310 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3311 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003312 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003313 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3314 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003315 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003316 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003317 * Callers can set a document URI through
3318 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3319 * location of documents navigator. System will do its best to launch the
3320 * navigator in the specified document if it's a folder, or the folder that
3321 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003322 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003323 * Output: The URI of the item that was picked, returned in
3324 * {@link #getData()}. This must be a {@code content://} URI so that any
3325 * receiver can access it. If multiple documents were selected, they are
3326 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003327 *
3328 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003329 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003330 * @see #ACTION_CREATE_DOCUMENT
3331 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003332 */
3333 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3334 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3335
3336 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003337 * Activity Action: Allow the user to create a new document. When invoked,
3338 * the system will display the various {@link DocumentsProvider} instances
3339 * installed on the device, letting the user navigate through them. The
3340 * returned document may be a newly created document with no content, or it
3341 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003342 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003343 * Each document is represented as a {@code content://} URI backed by a
3344 * {@link DocumentsProvider}, which can be opened as a stream with
3345 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3346 * {@link android.provider.DocumentsContract.Document} metadata.
3347 * <p>
3348 * Callers must indicate the concrete MIME type of the document being
3349 * created by setting {@link #setType(String)}. This MIME type cannot be
3350 * changed after the document is created.
3351 * <p>
3352 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3353 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003354 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003355 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3356 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003357 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003358 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003359 * Callers can set a document URI through
3360 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3361 * location of documents navigator. System will do its best to launch the
3362 * navigator in the specified document if it's a folder, or the folder that
3363 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003364 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003365 * Output: The URI of the item that was created. This must be a
3366 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003367 *
3368 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003369 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003370 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003371 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003372 */
3373 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3374 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3375
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003376 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003377 * Activity Action: Allow the user to pick a directory subtree. When
3378 * invoked, the system will display the various {@link DocumentsProvider}
3379 * instances installed on the device, letting the user navigate through
3380 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003381 * <p>
3382 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003383 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3384 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3385 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003386 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003387 * Callers can set a document URI through
3388 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3389 * location of documents navigator. System will do its best to launch the
3390 * navigator in the specified document if it's a folder, or the folder that
3391 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003392 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003393 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003394 *
3395 * @see DocumentsContract
3396 */
3397 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003398 public static final String
3399 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003400
Felipe Lemec7b1f892016-01-15 15:02:31 -08003401 /**
Peng Xua35b5532016-01-20 00:05:45 -08003402 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3403 * exisiting sensor being disconnected.
3404 *
3405 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3406 *
3407 * {@hide}
3408 */
3409 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3410 public static final String
3411 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3412
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003413 /**
Sam Line707f832017-04-13 17:00:55 -07003414 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003415 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003416 * @removed
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003417 */
3418 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003419 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003420 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3421
Christopher Tate6597e342015-02-17 12:15:25 -08003422 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003423 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3424 * is about to be performed.
3425 * @hide
3426 */
3427 @SystemApi
3428 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3429 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3430 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3431
3432 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003433 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3434 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3435 *
3436 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3437 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003438 * @hide
3439 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003440 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003441 public static final String EXTRA_FORCE_MASTER_CLEAR =
3442 "android.intent.extra.FORCE_MASTER_CLEAR";
3443
3444 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003445 * A broadcast action to trigger a factory reset.
3446 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003447 * <p>The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission. The
3448 * reason for the factory reset should be specified as {@link #EXTRA_REASON}.
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003449 *
3450 * <p>Not for use by third-party applications.
3451 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003452 * @see #EXTRA_FORCE_FACTORY_RESET
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003453 *
3454 * {@hide}
3455 */
3456 @SystemApi
3457 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3458 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3459
3460 /**
3461 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3462 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3463 *
3464 * <p>Not for use by third-party applications.
3465 *
3466 * @hide
3467 */
3468 @SystemApi
3469 public static final String EXTRA_FORCE_FACTORY_RESET =
3470 "android.intent.extra.FORCE_FACTORY_RESET";
3471
3472 /**
Michal Karpinski6135a262017-08-11 10:45:58 +01003473 * Broadcast action: report that a settings element is being restored from backup. The intent
3474 * contains four extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3475 * EXTRA_SETTING_NEW_VALUE is the value being restored, EXTRA_SETTING_PREVIOUS_VALUE
3476 * is the value of that settings entry prior to the restore operation, and
3477 * EXTRA_SETTING_RESTORED_FROM_SDK_INT is the version of the SDK that the setting has been
3478 * restored from (corresponds to {@link android.os.Build.VERSION#SDK_INT}). The first three
3479 * values are represented as strings, the fourth one as int.
Christopher Tate6597e342015-02-17 12:15:25 -08003480 *
3481 * <p>This broadcast is sent only for settings provider entries known to require special handling
3482 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3483 * the provider's backup agent implementation.
3484 *
3485 * @see #EXTRA_SETTING_NAME
3486 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3487 * @see #EXTRA_SETTING_NEW_VALUE
Michal Karpinski6135a262017-08-11 10:45:58 +01003488 * @see #EXTRA_SETTING_RESTORED_FROM_SDK_INT
Christopher Tate6597e342015-02-17 12:15:25 -08003489 * {@hide}
3490 */
3491 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3492
3493 /** {@hide} */
3494 public static final String EXTRA_SETTING_NAME = "setting_name";
3495 /** {@hide} */
3496 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3497 /** {@hide} */
3498 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
Michal Karpinski6135a262017-08-11 10:45:58 +01003499 /** {@hide} */
3500 public static final String EXTRA_SETTING_RESTORED_FROM_SDK_INT = "restored_from_sdk_int";
Christopher Tate6597e342015-02-17 12:15:25 -08003501
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003502 /**
3503 * Activity Action: Process a piece of text.
3504 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3505 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3506 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3507 */
3508 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3509 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003510
3511 /**
3512 * Broadcast Action: The sim card state has changed.
3513 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3514 * because TelephonyIntents is an internal class.
3515 * @hide
3516 */
3517 @SystemApi
3518 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3519 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3520
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003521 /**
fionaxu90fee272017-03-31 12:45:12 -07003522 * Broadcast Action: indicate that the phone service state has changed.
3523 * The intent will have the following extra values:</p>
3524 * <p>
3525 * @see #EXTRA_VOICE_REG_STATE
3526 * @see #EXTRA_DATA_REG_STATE
3527 * @see #EXTRA_VOICE_ROAMING_TYPE
3528 * @see #EXTRA_DATA_ROAMING_TYPE
3529 * @see #EXTRA_OPERATOR_ALPHA_LONG
3530 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3531 * @see #EXTRA_OPERATOR_NUMERIC
3532 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3533 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3534 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3535 * @see #EXTRA_MANUAL
3536 * @see #EXTRA_VOICE_RADIO_TECH
3537 * @see #EXTRA_DATA_RADIO_TECH
3538 * @see #EXTRA_CSS_INDICATOR
3539 * @see #EXTRA_NETWORK_ID
3540 * @see #EXTRA_SYSTEM_ID
3541 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3542 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3543 * @see #EXTRA_EMERGENCY_ONLY
3544 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3545 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3546 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3547 *
3548 * <p class="note">
3549 * Requires the READ_PHONE_STATE permission.
3550 *
3551 * <p class="note">This is a protected intent that can only be sent by the system.
3552 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003553 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003554 */
3555 @Deprecated
3556 @SystemApi
3557 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3558 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3559
3560 /**
3561 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3562 * state.
3563 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3564 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3565 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3566 * @see android.telephony.ServiceState#STATE_POWER_OFF
3567 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003568 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003569 */
3570 @Deprecated
3571 @SystemApi
3572 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3573
3574 /**
3575 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3576 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3577 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3578 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3579 * @see android.telephony.ServiceState#STATE_POWER_OFF
3580 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003581 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003582 */
3583 @Deprecated
3584 @SystemApi
3585 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3586
3587 /**
3588 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3589 * type.
3590 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003591 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003592 */
3593 @Deprecated
3594 @SystemApi
3595 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3596
3597 /**
3598 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3599 * type.
3600 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003601 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003602 */
3603 @Deprecated
3604 @SystemApi
3605 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3606
3607 /**
3608 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3609 * registered voice operator name in long alphanumeric format.
3610 * {@code null} if the operator name is not known or unregistered.
3611 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003612 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003613 */
3614 @Deprecated
3615 @SystemApi
3616 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3617
3618 /**
3619 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3620 * registered voice operator name in short alphanumeric format.
3621 * {@code null} if the operator name is not known or unregistered.
3622 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003623 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003624 */
3625 @Deprecated
3626 @SystemApi
3627 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3628
3629 /**
3630 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3631 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3632 * network.
3633 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003634 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003635 */
3636 @Deprecated
3637 @SystemApi
3638 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3639
3640 /**
3641 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3642 * registered data operator name in long alphanumeric format.
3643 * {@code null} if the operator name is not known or unregistered.
3644 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003645 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003646 */
3647 @Deprecated
3648 @SystemApi
3649 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3650
3651 /**
3652 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3653 * registered data operator name in short alphanumeric format.
3654 * {@code null} if the operator name is not known or unregistered.
3655 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003656 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003657 */
3658 @Deprecated
3659 @SystemApi
3660 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3661
3662 /**
3663 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3664 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3665 * data operator.
3666 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003667 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003668 */
3669 @Deprecated
3670 @SystemApi
3671 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3672
3673 /**
3674 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3675 * network selection mode is manual.
3676 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3677 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003678 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003679 */
3680 @Deprecated
3681 @SystemApi
3682 public static final String EXTRA_MANUAL = "manual";
3683
3684 /**
3685 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3686 * radio technology.
3687 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003688 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003689 */
3690 @Deprecated
3691 @SystemApi
3692 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3693
3694 /**
3695 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3696 * radio technology.
3697 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003698 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003699 */
3700 @Deprecated
3701 @SystemApi
3702 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3703
3704 /**
3705 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3706 * support on CDMA network.
3707 * Will be {@code true} if support, {@code false} otherwise.
3708 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003709 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003710 */
3711 @Deprecated
3712 @SystemApi
3713 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3714
3715 /**
3716 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3717 * id. {@code Integer.MAX_VALUE} if unknown.
3718 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003719 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003720 */
3721 @Deprecated
3722 @SystemApi
3723 public static final String EXTRA_NETWORK_ID = "networkId";
3724
3725 /**
3726 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3727 * {@code Integer.MAX_VALUE} if unknown.
3728 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003729 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003730 */
3731 @Deprecated
3732 @SystemApi
3733 public static final String EXTRA_SYSTEM_ID = "systemId";
3734
3735 /**
3736 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3737 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3738 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003739 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003740 */
3741 @Deprecated
3742 @SystemApi
3743 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3744
3745 /**
3746 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3747 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3748 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003749 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003750 */
3751 @Deprecated
3752 @SystemApi
3753 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3754
3755 /**
3756 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3757 * only mode.
3758 * {@code true} if in emergency only mode, {@code false} otherwise.
3759 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003760 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003761 */
3762 @Deprecated
3763 @SystemApi
3764 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3765
3766 /**
3767 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3768 * registration state is roaming.
3769 * {@code true} if registration indicates roaming, {@code false} otherwise
3770 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003771 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003772 */
3773 @Deprecated
3774 @SystemApi
3775 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
3776 "isDataRoamingFromRegistration";
3777
3778 /**
3779 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
3780 * aggregation is in use.
3781 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
3782 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003783 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003784 */
3785 @Deprecated
3786 @SystemApi
3787 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
3788
3789 /**
3790 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
3791 * is reduced from the rsrp threshold while calculating signal strength level.
3792 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003793 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003794 */
3795 @Deprecated
3796 @SystemApi
3797 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
3798
3799 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003800 * The name of the extra used to define the text to be processed, as a
3801 * CharSequence. Note that this may be a styled CharSequence, so you must use
3802 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003803 */
3804 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3805 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003806 * 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 +00003807 */
3808 public static final String EXTRA_PROCESS_TEXT_READONLY =
3809 "android.intent.extra.PROCESS_TEXT_READONLY";
3810
Bryce Leebc58f592015-09-25 16:43:01 -07003811 /**
3812 * Broadcast action: reports when a new thermal event has been reached. When the device
3813 * is reaching its maximum temperatue, the thermal level reported
3814 * {@hide}
3815 */
3816 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3817 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3818
3819 /** {@hide} */
3820 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3821
3822 /**
3823 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003824 * {@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_NORMAL = 0;
3828
3829 /**
3830 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003831 * the {@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_WARNING = 1;
3835
3836 /**
3837 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003838 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003839 * {@hide}
3840 */
3841 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3842
3843
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003844 // ---------------------------------------------------------------------
3845 // ---------------------------------------------------------------------
3846 // Standard intent categories (see addCategory()).
3847
3848 /**
3849 * Set if the activity should be an option for the default action
3850 * (center press) to perform on a piece of data. Setting this will
3851 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003852 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003853 * Intent when initiating an action -- it is for use in intent filters
3854 * specified in packages.
3855 */
3856 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3857 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3858 /**
3859 * Activities that can be safely invoked from a browser must support this
3860 * category. For example, if the user is viewing a web page or an e-mail
3861 * and clicks on a link in the text, the Intent generated execute that
3862 * link will require the BROWSABLE category, so that only activities
3863 * supporting this category will be considered as possible actions. By
3864 * supporting this category, you are promising that there is nothing
3865 * damaging (without user intervention) that can happen by invoking any
3866 * matching Intent.
3867 */
3868 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3869 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3870 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003871 * Categories for activities that can participate in voice interaction.
3872 * An activity that supports this category must be prepared to run with
3873 * no UI shown at all (though in some case it may have a UI shown), and
3874 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3875 */
3876 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3877 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3878 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003879 * Set if the activity should be considered as an alternative action to
3880 * the data the user is currently viewing. See also
3881 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3882 * applies to the selection in a list of items.
3883 *
3884 * <p>Supporting this category means that you would like your activity to be
3885 * displayed in the set of alternative things the user can do, usually as
3886 * part of the current activity's options menu. You will usually want to
3887 * include a specific label in the &lt;intent-filter&gt; of this action
3888 * describing to the user what it does.
3889 *
3890 * <p>The action of IntentFilter with this category is important in that it
3891 * describes the specific action the target will perform. This generally
3892 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3893 * a specific name such as "com.android.camera.action.CROP. Only one
3894 * alternative of any particular action will be shown to the user, so using
3895 * a specific action like this makes sure that your alternative will be
3896 * displayed while also allowing other applications to provide their own
3897 * overrides of that particular action.
3898 */
3899 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3900 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3901 /**
3902 * Set if the activity should be considered as an alternative selection
3903 * action to the data the user has currently selected. This is like
3904 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3905 * of items from which the user can select, giving them alternatives to the
3906 * default action that will be performed on it.
3907 */
3908 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3909 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3910 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003911 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003912 */
3913 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3914 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3915 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003916 * Should be displayed in the top-level launcher.
3917 */
3918 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3919 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3920 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003921 * Indicates an activity optimized for Leanback mode, and that should
3922 * be displayed in the Leanback launcher.
3923 */
3924 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3925 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3926 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003927 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3928 * @hide
3929 */
3930 @SystemApi
3931 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3932 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003933 * Provides information about the package it is in; typically used if
3934 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3935 * a front-door to the user without having to be shown in the all apps list.
3936 */
3937 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3938 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3939 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003940 * This is the home activity, that is the first activity that is displayed
3941 * when the device boots.
3942 */
3943 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3944 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3945 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003946 * This is the home activity that is displayed when the device is finished setting up and ready
3947 * for use.
3948 * @hide
3949 */
3950 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3951 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3952 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003953 * This is the setup wizard activity, that is the first activity that is displayed
3954 * when the user sets up the device for the first time.
3955 * @hide
3956 */
3957 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3958 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3959 /**
Svet Ganov5bb6bc62017-08-28 12:39:35 -07003960 * This is the home activity, that is the activity that serves as the launcher app
3961 * from there the user can start other apps. Often components with lower/higher
3962 * priority intent filters handle the home intent, for example SetupWizard, to
3963 * setup the device and we need to be able to distinguish the home app from these
3964 * setup helpers.
3965 * @hide
3966 */
3967 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3968 public static final String CATEGORY_LAUNCHER_APP = "android.intent.category.LAUNCHER_APP";
3969 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003970 * This activity is a preference panel.
3971 */
3972 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3973 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3974 /**
3975 * This activity is a development preference panel.
3976 */
3977 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3978 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3979 /**
3980 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003981 */
3982 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3983 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3984 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003985 * This activity allows the user to browse and download new applications.
3986 */
3987 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3988 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3989 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003990 * This activity may be exercised by the monkey or other automated test tools.
3991 */
3992 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3993 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3994 /**
3995 * To be used as a test (not part of the normal user experience).
3996 */
3997 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3998 /**
3999 * To be used as a unit test (run through the Test Harness).
4000 */
4001 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
4002 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004003 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004004 * experience).
4005 */
4006 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004007
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004008 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004009 * Used to indicate that an intent only wants URIs that can be opened with
4010 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
4011 * must support at least the columns defined in {@link OpenableColumns} when
4012 * queried.
4013 *
4014 * @see #ACTION_GET_CONTENT
4015 * @see #ACTION_OPEN_DOCUMENT
4016 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004017 */
4018 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4019 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
4020
4021 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09004022 * Used to indicate that an intent filter can accept files which are not necessarily
4023 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
4024 * at least streamable via
4025 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
4026 * using one of the stream types exposed via
4027 * {@link ContentResolver#getStreamTypes(Uri, String)}.
4028 *
4029 * @see #ACTION_SEND
4030 * @see #ACTION_SEND_MULTIPLE
4031 */
4032 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4033 public static final String CATEGORY_TYPED_OPENABLE =
4034 "android.intent.category.TYPED_OPENABLE";
4035
4036 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004037 * To be used as code under test for framework instrumentation tests.
4038 */
4039 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
4040 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04004041 /**
4042 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004043 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4044 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004045 */
4046 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4047 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
4048 /**
4049 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004050 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4051 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004052 */
4053 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4054 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004055 /**
4056 * An activity to run when device is inserted into a analog (low end) dock.
4057 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4058 * information, see {@link android.app.UiModeManager}.
4059 */
4060 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4061 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
4062
4063 /**
4064 * An activity to run when device is inserted into a digital (high end) dock.
4065 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4066 * information, see {@link android.app.UiModeManager}.
4067 */
4068 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4069 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004070
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004071 /**
4072 * Used to indicate that the activity can be used in a car environment.
4073 */
4074 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4075 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4076
Zak Cohendb6ca492017-01-26 14:09:00 -08004077 /**
4078 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4079 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4080 * information, see {@link android.app.UiModeManager}.
4081 */
4082 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4083 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004084 // ---------------------------------------------------------------------
4085 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004086 // Application launch intent categories (see addCategory()).
4087
4088 /**
4089 * Used with {@link #ACTION_MAIN} to launch the browser application.
4090 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004091 * <p>NOTE: This should not be used as the primary key of an Intent,
4092 * since it will not result in the app launching with the correct
4093 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004094 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004095 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004096 */
4097 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4098 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4099
4100 /**
4101 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4102 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004103 * <p>NOTE: This should not be used as the primary key of an Intent,
4104 * since it will not result in the app launching with the correct
4105 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004106 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004107 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004108 */
4109 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4110 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4111
4112 /**
4113 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4114 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004115 * <p>NOTE: This should not be used as the primary key of an Intent,
4116 * since it will not result in the app launching with the correct
4117 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004118 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004119 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004120 */
4121 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4122 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4123
4124 /**
4125 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4126 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004127 * <p>NOTE: This should not be used as the primary key of an Intent,
4128 * since it will not result in the app launching with the correct
4129 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004130 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004131 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004132 */
4133 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4134 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4135
4136 /**
4137 * Used with {@link #ACTION_MAIN} to launch the email application.
4138 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004139 * <p>NOTE: This should not be used as the primary key of an Intent,
4140 * since it will not result in the app launching with the correct
4141 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004142 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004143 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004144 */
4145 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4146 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4147
4148 /**
4149 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4150 * The activity should be able to view and manipulate image and video files
4151 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004152 * <p>NOTE: This should not be used as the primary key of an Intent,
4153 * since it will not result in the app launching with the correct
4154 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004155 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004156 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004157 */
4158 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4159 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4160
4161 /**
4162 * Used with {@link #ACTION_MAIN} to launch the maps application.
4163 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004164 * <p>NOTE: This should not be used as the primary key of an Intent,
4165 * since it will not result in the app launching with the correct
4166 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004167 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004168 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004169 */
4170 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4171 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4172
4173 /**
4174 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4175 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004176 * <p>NOTE: This should not be used as the primary key of an Intent,
4177 * since it will not result in the app launching with the correct
4178 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004179 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004180 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004181 */
4182 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4183 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4184
4185 /**
4186 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004187 * The activity should be able to play, browse, or manipulate music files
4188 * stored on the device.
4189 * <p>NOTE: This should not be used as the primary key of an Intent,
4190 * since it will not result in the app launching with the correct
4191 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004192 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004193 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004194 */
4195 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4196 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4197
4198 // ---------------------------------------------------------------------
4199 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004200 // Standard extra data keys.
4201
4202 /**
4203 * The initial data to place in a newly created record. Use with
4204 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4205 * fields as would be given to the underlying ContentProvider.insert()
4206 * call.
4207 */
4208 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4209
4210 /**
4211 * A constant CharSequence that is associated with the Intent, used with
4212 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4213 * this may be a styled CharSequence, so you must use
4214 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4215 * retrieve it.
4216 */
4217 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4218
4219 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004220 * A constant String that is associated with the Intent, used with
4221 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4222 * as HTML formatted text. Note that you <em>must</em> also supply
4223 * {@link #EXTRA_TEXT}.
4224 */
4225 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4226
4227 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004228 * A content: URI holding a stream of data associated with the Intent,
4229 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004230 */
4231 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4232
4233 /**
4234 * A String[] holding e-mail addresses that should be delivered to.
4235 */
4236 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4237
4238 /**
4239 * A String[] holding e-mail addresses that should be carbon copied.
4240 */
4241 public static final String EXTRA_CC = "android.intent.extra.CC";
4242
4243 /**
4244 * A String[] holding e-mail addresses that should be blind carbon copied.
4245 */
4246 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4247
4248 /**
4249 * A constant string holding the desired subject line of a message.
4250 */
4251 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4252
4253 /**
4254 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004255 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004256 */
4257 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4258
4259 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004260 * An int representing the user id to be used.
4261 *
4262 * @hide
4263 */
4264 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4265
4266 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004267 * An int representing the task id to be retrieved. This is used when a launch from recents is
4268 * intercepted by another action such as credentials confirmation to remember which task should
4269 * be resumed when complete.
4270 *
4271 * @hide
4272 */
4273 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4274
4275 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004276 * An Intent[] describing additional, alternate choices you would like shown with
4277 * {@link #ACTION_CHOOSER}.
4278 *
4279 * <p>An app may be capable of providing several different payload types to complete a
4280 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4281 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4282 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4283 * photo data or a hosted link where the photos can be viewed.</p>
4284 *
4285 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4286 * first/primary/preferred intent in the set. Additional intents specified in
4287 * this extra are ordered; by default intents that appear earlier in the array will be
4288 * preferred over intents that appear later in the array as matches for the same
4289 * target component. To alter this preference, a calling app may also supply
4290 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4291 */
4292 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4293
4294 /**
Adam Powell52c39212016-04-07 15:14:18 -07004295 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4296 * and omitted from a list of components presented to the user.
4297 *
4298 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4299 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4300 * from your own package or other apps from your organization if the idea of sending to those
4301 * targets would be redundant with other app functionality. Filtered components will not
4302 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4303 */
4304 public static final String EXTRA_EXCLUDE_COMPONENTS
4305 = "android.intent.extra.EXCLUDE_COMPONENTS";
4306
4307 /**
4308 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4309 * describing additional high-priority deep-link targets for the chooser to present to the user.
4310 *
4311 * <p>Targets provided in this way will be presented inline with all other targets provided
4312 * by services from other apps. They will be prioritized before other service targets, but
4313 * after those targets provided by sources that the user has manually pinned to the front.</p>
4314 *
4315 * @see #ACTION_CHOOSER
4316 */
4317 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4318
4319 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004320 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4321 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4322 *
4323 * <p>An app preparing an action for another app to complete may wish to allow the user to
4324 * disambiguate between several options for completing the action based on the chosen target
4325 * or otherwise refine the action before it is invoked.
4326 * </p>
4327 *
4328 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4329 * <ul>
4330 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4331 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4332 * chosen target beyond the first</li>
4333 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4334 * should fill in and send once the disambiguation is complete</li>
4335 * </ul>
4336 */
4337 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4338 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4339
4340 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004341 * An {@code ArrayList} of {@code String} annotations describing content for
4342 * {@link #ACTION_CHOOSER}.
4343 *
4344 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4345 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4346 *
4347 * <p>Annotations should describe the major components or topics of the content. It is up to
4348 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4349 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004350 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4351 * character. Performance on customized annotations can suffer, if they are rarely used for
4352 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4353 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004354 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004355 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004356 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004357 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004358 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004359 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004360 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004361 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004362 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004363 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4364 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4365 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4366 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4367 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004368 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004369 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4370 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004371 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004372 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004373 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004374 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004375 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004376 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004377 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004378 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004379 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004380 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004381 * Christmas and Thanksgiving.</li>
4382 * </ul>
4383 */
4384 public static final String EXTRA_CONTENT_ANNOTATIONS
4385 = "android.intent.extra.CONTENT_ANNOTATIONS";
4386
4387 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004388 * A {@link ResultReceiver} used to return data back to the sender.
4389 *
4390 * <p>Used to complete an app-specific
4391 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4392 *
4393 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4394 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4395 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4396 * when the user selects a target component from the chooser. It is up to the recipient
4397 * to send a result to this ResultReceiver to signal that disambiguation is complete
4398 * and that the chooser should invoke the user's choice.</p>
4399 *
4400 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4401 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4402 * to match and fill in the final Intent or ChooserTarget before starting it.
4403 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4404 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4405 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4406 *
4407 * <p>The result code passed to the ResultReceiver should be
4408 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4409 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4410 * the chooser should finish without starting a target.</p>
4411 */
4412 public static final String EXTRA_RESULT_RECEIVER
4413 = "android.intent.extra.RESULT_RECEIVER";
4414
4415 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004416 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004417 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004418 */
4419 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4420
4421 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004422 * A Parcelable[] of {@link Intent} or
4423 * {@link android.content.pm.LabeledIntent} objects as set with
4424 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4425 * a the front of the list of choices, when shown to the user with a
4426 * {@link #ACTION_CHOOSER}.
4427 */
4428 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4429
4430 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004431 * A {@link IntentSender} to start after ephemeral installation success.
4432 * @hide
4433 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004434 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4435
4436 /**
4437 * A {@link IntentSender} to start after ephemeral installation failure.
4438 * @hide
4439 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004440 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4441
4442 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004443 * The host name that triggered an ephemeral resolution.
4444 * @hide
4445 */
4446 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4447
4448 /**
4449 * An opaque token to track ephemeral resolution.
4450 * @hide
4451 */
4452 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4453
4454 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004455 * The version code of the app to install components from.
4456 * @hide
4457 */
4458 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4459
4460 /**
Chad Brubaker06068612017-04-06 09:43:47 -07004461 * The app that triggered the ephemeral installation.
4462 * @hide
4463 */
4464 public static final String EXTRA_CALLING_PACKAGE
4465 = "android.intent.extra.CALLING_PACKAGE";
4466
4467 /**
4468 * Optional calling app provided bundle containing additional launch information the
4469 * installer may use.
4470 * @hide
4471 */
4472 public static final String EXTRA_VERIFICATION_BUNDLE
4473 = "android.intent.extra.VERIFICATION_BUNDLE";
4474
4475 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004476 * A Bundle forming a mapping of potential target package names to different extras Bundles
4477 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4478 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4479 * be currently installed on the device.
4480 *
4481 * <p>An application may choose to provide alternate extras for the case where a user
4482 * selects an activity from a predetermined set of target packages. If the activity
4483 * the user selects from the chooser belongs to a package with its package name as
4484 * a key in this bundle, the corresponding extras for that package will be merged with
4485 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4486 * extra has the same key as an extra already present in the intent it will overwrite
4487 * the extra from the intent.</p>
4488 *
4489 * <p><em>Examples:</em>
4490 * <ul>
4491 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4492 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4493 * parameters for that target.</li>
4494 * <li>An application may offer additional metadata for known targets of a given intent
4495 * to pass along information only relevant to that target such as account or content
4496 * identifiers already known to that application.</li>
4497 * </ul></p>
4498 */
4499 public static final String EXTRA_REPLACEMENT_EXTRAS =
4500 "android.intent.extra.REPLACEMENT_EXTRAS";
4501
4502 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004503 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4504 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4505 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4506 * {@link ComponentName} of the chosen component.
4507 *
4508 * <p>In some situations this callback may never come, for example if the user abandons
4509 * the chooser, switches to another task or any number of other reasons. Apps should not
4510 * be written assuming that this callback will always occur.</p>
4511 */
4512 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4513 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4514
4515 /**
4516 * The {@link ComponentName} chosen by the user to complete an action.
4517 *
4518 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4519 */
4520 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4521
4522 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004523 * A {@link android.view.KeyEvent} object containing the event that
4524 * triggered the creation of the Intent it is in.
4525 */
4526 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4527
4528 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004529 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4530 * before shutting down.
4531 *
4532 * {@hide}
4533 */
4534 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4535
4536 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004537 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4538 * requested by the user.
4539 *
4540 * {@hide}
4541 */
4542 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4543 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4544
4545 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004546 * 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 -07004547 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4548 * of restarting the application.
4549 */
4550 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4551
4552 /**
4553 * A String holding the phone number originally entered in
4554 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4555 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4556 */
4557 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004558
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004559 /**
4560 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4561 * intents to supply the uid the package had been assigned. Also an optional
4562 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4563 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4564 * purpose.
4565 */
4566 public static final String EXTRA_UID = "android.intent.extra.UID";
4567
4568 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004569 * @hide String array of package names.
4570 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004571 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004572 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
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 whether this represents a full uninstall (removing
4577 * both the code and its data) or a partial uninstall (leaving its data,
4578 * implying that this is an update).
4579 */
4580 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004581
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004582 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004583 * @hide
4584 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4585 * intents to indicate that at this point the package has been removed for
4586 * all users on the device.
4587 */
4588 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4589 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4590
4591 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004592 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4593 * intents to indicate that this is a replacement of the package, so this
4594 * broadcast will immediately be followed by an add broadcast for a
4595 * different version of the same package.
4596 */
4597 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004598
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004599 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004600 * Used as an int extra field in {@link android.app.AlarmManager} intents
4601 * to tell the application being invoked how many pending alarms are being
4602 * delievered with the intent. For one-shot alarms this will always be 1.
4603 * For recurring alarms, this might be greater than 1 if the device was
4604 * asleep or powered off at the time an earlier alarm would have been
4605 * delivered.
4606 */
4607 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004608
Jacek Surazski86b6c532009-05-13 14:38:28 +02004609 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004610 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4611 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004612 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4613 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004614 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4615 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4616 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004617 */
4618 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4619
4620 /**
4621 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4622 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004623 */
4624 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4625
4626 /**
4627 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4628 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004629 */
4630 public static final int EXTRA_DOCK_STATE_DESK = 1;
4631
4632 /**
4633 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4634 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004635 */
4636 public static final int EXTRA_DOCK_STATE_CAR = 2;
4637
4638 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004639 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4640 * to represent that the phone is in a analog (low end) dock.
4641 */
4642 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4643
4644 /**
4645 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4646 * to represent that the phone is in a digital (high end) dock.
4647 */
4648 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4649
4650 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004651 * Boolean that can be supplied as meta-data with a dock activity, to
4652 * indicate that the dock should take over the home key when it is active.
4653 */
4654 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004655
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004656 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004657 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4658 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004659 */
4660 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4661
4662 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004663 * Used in the extra field in the remote intent. It's astring token passed with the
4664 * remote intent.
4665 */
4666 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4667 "android.intent.extra.remote_intent_token";
4668
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004669 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004670 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004671 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004672 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004673 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004674 "android.intent.extra.changed_component_name";
4675
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004676 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004677 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004678 * and contains a string array of all of the components that have changed. If
4679 * the state of the overall package has changed, then it will contain an entry
4680 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004681 */
4682 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4683 "android.intent.extra.changed_component_name_list";
4684
4685 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004686 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004687 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004688 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4689 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4690 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004691 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004692 */
4693 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4694 "android.intent.extra.changed_package_list";
4695
4696 /**
4697 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004698 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4699 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004700 * and contains an integer array of uids of all of the components
4701 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004702 */
4703 public static final String EXTRA_CHANGED_UID_LIST =
4704 "android.intent.extra.changed_uid_list";
4705
4706 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004707 * @hide
4708 * Magic extra system code can use when binding, to give a label for
4709 * who it is that has bound to a service. This is an integer giving
4710 * a framework string resource that can be displayed to the user.
4711 */
4712 public static final String EXTRA_CLIENT_LABEL =
4713 "android.intent.extra.client_label";
4714
4715 /**
4716 * @hide
4717 * Magic extra system code can use when binding, to give a PendingIntent object
4718 * that can be launched for the user to disable the system's use of this
4719 * service.
4720 */
4721 public static final String EXTRA_CLIENT_INTENT =
4722 "android.intent.extra.client_intent";
4723
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004724 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004725 * Extra used to indicate that an intent should only return data that is on
4726 * the local device. This is a boolean extra; the default is false. If true,
4727 * an implementation should only allow the user to select data that is
4728 * already on the device, not requiring it be downloaded from a remote
4729 * service when opened.
4730 *
4731 * @see #ACTION_GET_CONTENT
4732 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004733 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004734 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004735 */
4736 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004737 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004738
Amith Yamasani13593602012-03-22 16:16:17 -07004739 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004740 * Extra used to indicate that an intent can allow the user to select and
4741 * return multiple items. This is a boolean extra; the default is false. If
4742 * true, an implementation is allowed to present the user with a UI where
4743 * they can pick multiple items that are all returned to the caller. When
4744 * this happens, they should be returned as the {@link #getClipData()} part
4745 * of the result Intent.
4746 *
4747 * @see #ACTION_GET_CONTENT
4748 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004749 */
4750 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004751 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004752
4753 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004754 * The integer userHandle carried with broadcast intents related to addition, removal and
4755 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4756 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4757 *
Amith Yamasani13593602012-03-22 16:16:17 -07004758 * @hide
4759 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004760 public static final String EXTRA_USER_HANDLE =
4761 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004762
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004763 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004764 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4765 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4766 */
4767 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004768 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004769
4770 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004771 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004772 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4773 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004774 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004775 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4776
4777 /**
4778 * Extra sent in the intent to the BroadcastReceiver that handles
4779 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4780 * the restrictions as key/value pairs.
4781 */
4782 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4783 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004784
Amith Yamasani86118ba2013-03-28 14:33:16 -07004785 /**
4786 * Extra used in the response from a BroadcastReceiver that handles
4787 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4788 */
4789 public static final String EXTRA_RESTRICTIONS_INTENT =
4790 "android.intent.extra.restrictions_intent";
4791
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004792 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004793 * Extra used to communicate a set of acceptable MIME types. The type of the
4794 * extra is {@code String[]}. Values may be a combination of concrete MIME
4795 * types (such as "image/png") and/or partial MIME types (such as
4796 * "audio/*").
4797 *
4798 * @see #ACTION_GET_CONTENT
4799 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004800 */
4801 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4802
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004803 /**
4804 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4805 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004806 * When this is true, hardware devices can use this information to determine that
4807 * they shouldn't do a complete shutdown of their device since this is not a
4808 * complete shutdown down to the kernel, but only user space restarting.
4809 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004810 */
4811 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4812 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4813
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004814 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004815 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4816 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4817 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4818 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004819 *
4820 * @hide for internal use only.
4821 */
4822 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4823 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004824 /** @hide */
4825 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4826 /** @hide */
4827 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4828 /** @hide */
4829 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004830
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07004831 /**
4832 * Intent extra: the reason that the operation associated with this intent is being performed.
4833 *
4834 * <p>Type: String
4835 * @hide
4836 */
4837 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004838 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4839
qingxi240c2bb2017-04-12 17:31:18 -07004840 /**
4841 * {@hide}
4842 * This extra will be send together with {@link #ACTION_FACTORY_RESET}
4843 */
Rubin Xue8490f12015-06-25 12:17:48 +01004844 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4845
Santos Cordon15a13782015-03-31 18:32:31 -07004846 /**
qingxi240c2bb2017-04-12 17:31:18 -07004847 * {@hide}
4848 * This extra will be set to true when the user choose to wipe the data on eSIM during factory
4849 * reset for the device with eSIM. This extra will be sent together with
4850 * {@link #ACTION_FACTORY_RESET}
4851 */
4852 public static final String EXTRA_WIPE_ESIMS = "com.android.internal.intent.extra.WIPE_ESIMS";
4853
4854 /**
Santos Cordon15a13782015-03-31 18:32:31 -07004855 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4856 * activation request.
4857 * TODO: Add information about the structure and response data used with the pending intent.
4858 * @hide
4859 */
4860 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4861 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4862
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004863 /**
4864 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004865 *
4866 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07004867 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004868 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004869 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4870
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004871 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004872 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
4873 * such as opening in other apps, sharing, opening, editing, printing, deleting,
4874 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004875 *
4876 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07004877 * @see #ACTION_QUICK_VIEW
4878 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004879 */
Garfield Tance1d0e92017-03-23 10:52:48 -07004880 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004881 public static final String EXTRA_QUICK_VIEW_ADVANCED =
4882 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004883
4884 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07004885 * An optional extra of {@code String[]} indicating which quick view features should be made
4886 * available to the user in the quick view UI while handing a
4887 * {@link Intent#ACTION_QUICK_VIEW} intent.
4888 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
4889 * Quick viewer can implement features not listed below.
4890 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
4891 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DOWNLOAD},
4892 * {@link QuickViewConstants#FEATURE_SEND}, {@link QuickViewConstants#FEATURE_PRINT}.
4893 * <p>
4894 * Requirements:
4895 * <li>Quick viewer shouldn't show a feature if the feature is absent in
4896 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
4897 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
4898 * internal policies.
4899 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
4900 * requirement that the feature be shown. Quick viewer may, according to its own policies,
4901 * disable or hide features.
4902 *
4903 * @see #ACTION_QUICK_VIEW
4904 */
4905 public static final String EXTRA_QUICK_VIEW_FEATURES =
4906 "android.intent.extra.QUICK_VIEW_FEATURES";
4907
4908 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004909 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004910 * When a profile goes into quiet mode, all apps in the profile are killed and the
4911 * profile user is stopped. Widgets originating from the profile are masked, and app
4912 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004913 */
4914 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004915
4916 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004917 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004918 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004919 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4920 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004921 *
4922 * @hide
4923 */
4924 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4925 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4926
4927 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004928 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4929 * whether to show the chooser or not when there is only one application available
4930 * to choose from.
4931 *
4932 * @hide
4933 */
4934 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4935 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4936
4937 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004938 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004939 * to represent that a video codec is allowed to use.
4940 *
4941 * @hide
4942 */
4943 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4944
4945 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004946 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004947 * to represent that a audio codec is allowed to use.
4948 *
4949 * @hide
4950 */
4951 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4952
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004953 // ---------------------------------------------------------------------
4954 // ---------------------------------------------------------------------
4955 // Intent flags (see mFlags variable).
4956
Tor Norbyed9273d62013-05-30 15:59:53 -07004957 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06004958 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07004959 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4960 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004961 @Retention(RetentionPolicy.SOURCE)
4962 public @interface GrantUriMode {}
4963
Jeff Sharkey846318a2014-04-04 12:12:41 -07004964 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06004965 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07004966 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4967 @Retention(RetentionPolicy.SOURCE)
4968 public @interface AccessUriMode {}
4969
4970 /**
4971 * Test if given mode flags specify an access mode, which must be at least
4972 * read and/or write.
4973 *
4974 * @hide
4975 */
4976 public static boolean isAccessUriMode(int modeFlags) {
4977 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4978 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4979 }
4980
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06004981 /** @hide */
4982 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
4983 FLAG_GRANT_READ_URI_PERMISSION,
4984 FLAG_GRANT_WRITE_URI_PERMISSION,
4985 FLAG_FROM_BACKGROUND,
4986 FLAG_DEBUG_LOG_RESOLUTION,
4987 FLAG_EXCLUDE_STOPPED_PACKAGES,
4988 FLAG_INCLUDE_STOPPED_PACKAGES,
4989 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
4990 FLAG_GRANT_PREFIX_URI_PERMISSION,
4991 FLAG_DEBUG_TRIAGED_MISSING,
4992 FLAG_IGNORE_EPHEMERAL,
4993 FLAG_ACTIVITY_NO_HISTORY,
4994 FLAG_ACTIVITY_SINGLE_TOP,
4995 FLAG_ACTIVITY_NEW_TASK,
4996 FLAG_ACTIVITY_MULTIPLE_TASK,
4997 FLAG_ACTIVITY_CLEAR_TOP,
4998 FLAG_ACTIVITY_FORWARD_RESULT,
4999 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5000 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5001 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5002 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5003 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5004 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5005 FLAG_ACTIVITY_NEW_DOCUMENT,
5006 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5007 FLAG_ACTIVITY_NO_USER_ACTION,
5008 FLAG_ACTIVITY_REORDER_TO_FRONT,
5009 FLAG_ACTIVITY_NO_ANIMATION,
5010 FLAG_ACTIVITY_CLEAR_TASK,
5011 FLAG_ACTIVITY_TASK_ON_HOME,
5012 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5013 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5014 FLAG_RECEIVER_REGISTERED_ONLY,
5015 FLAG_RECEIVER_REPLACE_PENDING,
5016 FLAG_RECEIVER_FOREGROUND,
5017 FLAG_RECEIVER_NO_ABORT,
5018 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5019 FLAG_RECEIVER_BOOT_UPGRADE,
5020 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5021 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5022 FLAG_RECEIVER_FROM_SHELL,
5023 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5024 })
5025 @Retention(RetentionPolicy.SOURCE)
5026 public @interface Flags {}
5027
5028 /** @hide */
5029 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5030 FLAG_FROM_BACKGROUND,
5031 FLAG_DEBUG_LOG_RESOLUTION,
5032 FLAG_EXCLUDE_STOPPED_PACKAGES,
5033 FLAG_INCLUDE_STOPPED_PACKAGES,
5034 FLAG_DEBUG_TRIAGED_MISSING,
5035 FLAG_IGNORE_EPHEMERAL,
5036 FLAG_ACTIVITY_NO_HISTORY,
5037 FLAG_ACTIVITY_SINGLE_TOP,
5038 FLAG_ACTIVITY_NEW_TASK,
5039 FLAG_ACTIVITY_MULTIPLE_TASK,
5040 FLAG_ACTIVITY_CLEAR_TOP,
5041 FLAG_ACTIVITY_FORWARD_RESULT,
5042 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5043 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5044 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5045 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5046 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5047 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5048 FLAG_ACTIVITY_NEW_DOCUMENT,
5049 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5050 FLAG_ACTIVITY_NO_USER_ACTION,
5051 FLAG_ACTIVITY_REORDER_TO_FRONT,
5052 FLAG_ACTIVITY_NO_ANIMATION,
5053 FLAG_ACTIVITY_CLEAR_TASK,
5054 FLAG_ACTIVITY_TASK_ON_HOME,
5055 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5056 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5057 FLAG_RECEIVER_REGISTERED_ONLY,
5058 FLAG_RECEIVER_REPLACE_PENDING,
5059 FLAG_RECEIVER_FOREGROUND,
5060 FLAG_RECEIVER_NO_ABORT,
5061 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5062 FLAG_RECEIVER_BOOT_UPGRADE,
5063 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5064 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5065 FLAG_RECEIVER_FROM_SHELL,
5066 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5067 })
5068 @Retention(RetentionPolicy.SOURCE)
5069 public @interface MutableFlags {}
5070
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005071 /**
5072 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005073 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005074 * specified in its ClipData. When applying to an Intent's ClipData,
5075 * all URIs as well as recursive traversals through data or other ClipData
5076 * in Intent items will be granted; only the grant flags of the top-level
5077 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005078 */
5079 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5080 /**
5081 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005082 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005083 * specified in its ClipData. When applying to an Intent's ClipData,
5084 * all URIs as well as recursive traversals through data or other ClipData
5085 * in Intent items will be granted; only the grant flags of the top-level
5086 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005087 */
5088 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5089 /**
5090 * Can be set by the caller to indicate that this Intent is coming from
5091 * a background operation, not from direct user interaction.
5092 */
5093 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5094 /**
5095 * A flag you can enable for debugging: when set, log messages will be
5096 * printed during the resolution of this intent to show you what has
5097 * been found to create the final resolved list.
5098 */
5099 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005100 /**
5101 * If set, this intent will not match any components in packages that
5102 * are currently stopped. If this is not set, then the default behavior
5103 * is to include such applications in the result.
5104 */
5105 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5106 /**
5107 * If set, this intent will always match any components in packages that
5108 * are currently stopped. This is the default behavior when
5109 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5110 * flags are set, this one wins (it allows overriding of exclude for
5111 * places where the framework may automatically set the exclude flag).
5112 */
5113 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005114
5115 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005116 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005117 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005118 * persisted across device reboots until explicitly revoked with
5119 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5120 * grant for possible persisting; the receiving application must call
5121 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5122 * actually persist.
5123 *
5124 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5125 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5126 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005127 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005128 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005129 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005130
5131 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005132 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5133 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5134 * applies to any URI that is a prefix match against the original granted
5135 * URI. (Without this flag, the URI must match exactly for access to be
5136 * granted.) Another URI is considered a prefix match only when scheme,
5137 * authority, and all path segments defined by the prefix are an exact
5138 * match.
5139 */
5140 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5141
5142 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005143 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005144 * homework and verified that they correctly handle packages and components
5145 * that come and go over time. In particular:
5146 * <ul>
5147 * <li>Apps installed on external storage, which will appear to be
5148 * uninstalled while the the device is ejected.
5149 * <li>Apps with encryption unaware components, which will appear to not
5150 * exist while the device is locked.
5151 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005152 *
5153 * @hide
5154 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005155 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005156
5157 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005158 * Internal flag used to indicate ephemeral applications should not be
5159 * considered when resolving the intent.
5160 *
5161 * @hide
5162 */
5163 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5164
5165 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005166 * If set, the new activity is not kept in the history stack. As soon as
5167 * the user navigates away from it, the activity is finished. This may also
5168 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5169 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005170 *
5171 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5172 * is never invoked when the current activity starts a new activity which
5173 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005174 */
5175 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5176 /**
5177 * If set, the activity will not be launched if it is already running
5178 * at the top of the history stack.
5179 */
5180 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5181 /**
5182 * If set, this activity will become the start of a new task on this
5183 * history stack. A task (from the activity that started it to the
5184 * next task activity) defines an atomic group of activities that the
5185 * user can move to. Tasks can be moved to the foreground and background;
5186 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005187 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005188 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5189 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005190 *
5191 * <p>This flag is generally used by activities that want
5192 * to present a "launcher" style behavior: they give the user a list of
5193 * separate things that can be done, which otherwise run completely
5194 * independently of the activity launching them.
5195 *
5196 * <p>When using this flag, if a task is already running for the activity
5197 * you are now starting, then a new activity will not be started; instead,
5198 * the current task will simply be brought to the front of the screen with
5199 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5200 * to disable this behavior.
5201 *
5202 * <p>This flag can not be used when the caller is requesting a result from
5203 * the activity being launched.
5204 */
5205 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5206 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005207 * This flag is used to create a new task and launch an activity into it.
5208 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5209 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5210 * search through existing tasks for ones matching this Intent. Only if no such
5211 * task is found would a new task be created. When paired with
5212 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5213 * the search for a matching task and unconditionally start a new task.
5214 *
5215 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5216 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005217 * top-level application launcher.</strong> Used in conjunction with
5218 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5219 * behavior of bringing an existing task to the foreground. When set,
5220 * a new task is <em>always</em> started to host the Activity for the
5221 * Intent, regardless of whether there is already an existing task running
5222 * the same thing.
5223 *
5224 * <p><strong>Because the default system does not include graphical task management,
5225 * you should not use this flag unless you provide some way for a user to
5226 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005227 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005228 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5229 * creating new document tasks.
5230 *
5231 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005232 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005233 *
Scott Main7aee61f2011-02-08 11:25:01 -08005234 * <p>See
5235 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5236 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005237 *
5238 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5239 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005240 */
5241 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5242 /**
5243 * If set, and the activity being launched is already running in the
5244 * current task, then instead of launching a new instance of that activity,
5245 * all of the other activities on top of it will be closed and this Intent
5246 * will be delivered to the (now on top) old activity as a new Intent.
5247 *
5248 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5249 * If D calls startActivity() with an Intent that resolves to the component
5250 * of activity B, then C and D will be finished and B receive the given
5251 * Intent, resulting in the stack now being: A, B.
5252 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005253 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005254 * either receive the new intent you are starting here in its
5255 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005256 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005257 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5258 * the same intent, then it will be finished and re-created; for all other
5259 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5260 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005261 *
5262 * <p>This launch mode can also be used to good effect in conjunction with
5263 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5264 * of a task, it will bring any currently running instance of that task
5265 * to the foreground, and then clear it to its root state. This is
5266 * especially useful, for example, when launching an activity from the
5267 * notification manager.
5268 *
Scott Main7aee61f2011-02-08 11:25:01 -08005269 * <p>See
5270 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5271 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005272 */
5273 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5274 /**
5275 * If set and this intent is being used to launch a new activity from an
5276 * existing one, then the reply target of the existing activity will be
5277 * transfered to the new activity. This way the new activity can call
5278 * {@link android.app.Activity#setResult} and have that result sent back to
5279 * the reply target of the original activity.
5280 */
5281 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5282 /**
5283 * If set and this intent is being used to launch a new activity from an
5284 * existing one, the current activity will not be counted as the top
5285 * activity for deciding whether the new intent should be delivered to
5286 * the top instead of starting a new one. The previous activity will
5287 * be used as the top, with the assumption being that the current activity
5288 * will finish itself immediately.
5289 */
5290 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5291 /**
5292 * If set, the new activity is not kept in the list of recently launched
5293 * activities.
5294 */
5295 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5296 /**
5297 * This flag is not normally set by application code, but set for you by
5298 * the system as described in the
5299 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5300 * launchMode} documentation for the singleTask mode.
5301 */
5302 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5303 /**
5304 * If set, and this activity is either being started in a new task or
5305 * bringing to the top an existing task, then it will be launched as
5306 * the front door of the task. This will result in the application of
5307 * any affinities needed to have that task in the proper state (either
5308 * moving activities to or from it), or simply resetting that task to
5309 * its initial state if needed.
5310 */
5311 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5312 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005313 * This flag is not normally set by application code, but set for you by
5314 * the system if this activity is being launched from history
5315 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005316 */
5317 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005318 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005319 * @deprecated As of API 21 this performs identically to
5320 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005321 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005322 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005323 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005324 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005325 * This flag is used to open a document into a new task rooted at the activity launched
5326 * by this Intent. Through the use of this flag, or its equivalent attribute,
5327 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005328 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005329 *
Craig Mautner026596b2014-05-21 15:35:44 -07005330 * <p>The use of the activity attribute form of this,
5331 * {@link android.R.attr#documentLaunchMode}, is
5332 * preferred over the Intent flag described here. The attribute form allows the
5333 * Activity to specify multiple document behavior for all launchers of the Activity
5334 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005335 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005336 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5337 * it is kept after the activity is finished is different than the use of
5338 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5339 * this flag is being used to create a new recents entry, then by default that entry
5340 * will be removed once the activity is finished. You can modify this behavior with
5341 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5342 *
Craig Mautner026596b2014-05-21 15:35:44 -07005343 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5344 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5345 * equivalent of the Activity manifest specifying {@link
5346 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5347 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5348 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005349 *
Craig Mautner026596b2014-05-21 15:35:44 -07005350 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005351 *
Craig Mautner026596b2014-05-21 15:35:44 -07005352 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005353 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5354 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005355 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005356 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005357 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005358 * callback from occurring on the current frontmost activity before it is
5359 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005360 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005361 * <p>Typically, an activity can rely on that callback to indicate that an
5362 * explicit user action has caused their activity to be moved out of the
5363 * foreground. The callback marks an appropriate point in the activity's
5364 * lifecycle for it to dismiss any notifications that it intends to display
5365 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005366 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005367 * <p>If an activity is ever started via any non-user-driven events such as
5368 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5369 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005370 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005371 */
5372 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005373 /**
5374 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5375 * this flag will cause the launched activity to be brought to the front of its
5376 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005377 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005378 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5379 * If D calls startActivity() with an Intent that resolves to the component
5380 * of activity B, then B will be brought to the front of the history stack,
5381 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005382 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005383 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005384 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005385 */
5386 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005387 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005388 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5389 * this flag will prevent the system from applying an activity transition
5390 * animation to go to the next activity state. This doesn't mean an
5391 * animation will never run -- if another activity change happens that doesn't
5392 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005393 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005394 * when you are going to do a series of activity operations but the
5395 * animation seen by the user shouldn't be driven by the first activity
5396 * change but rather a later one.
5397 */
5398 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5399 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005400 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5401 * this flag will cause any existing task that would be associated with the
5402 * activity to be cleared before the activity is started. That is, the activity
5403 * becomes the new root of an otherwise empty task, and any old activities
5404 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5405 */
5406 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5407 /**
5408 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5409 * this flag will cause a newly launching task to be placed on top of the current
5410 * home activity task (if there is one). That is, pressing back from the task
5411 * will always return the user to home even if that was not the last activity they
5412 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5413 */
5414 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5415 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005416 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5417 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005418 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005419 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005420 * this flag. When set and the task's activity is finished, the recents
5421 * entry will remain in the interface for the user to re-launch it, like a
5422 * recents entry for a top-level application.
5423 * <p>
5424 * The receiving activity can override this request with
5425 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5426 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005427 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005428 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005429 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005430
5431 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005432 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5433 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005434 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5435 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005436 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005437 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005438
5439 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005440 * If set, when sending a broadcast only registered receivers will be
5441 * called -- no BroadcastReceiver components will be launched.
5442 */
5443 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005444 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005445 * If set, when sending a broadcast the new broadcast will replace
5446 * any existing pending broadcast that matches it. Matching is defined
5447 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5448 * true for the intents of the two broadcasts. When a match is found,
5449 * the new broadcast (and receivers associated with it) will replace the
5450 * existing one in the pending broadcast list, remaining at the same
5451 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005452 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005453 * <p>This flag is most typically used with sticky broadcasts, which
5454 * only care about delivering the most recent values of the broadcast
5455 * to their receivers.
5456 */
5457 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5458 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005459 * If set, when sending a broadcast the recipient is allowed to run at
5460 * foreground priority, with a shorter timeout interval. During normal
5461 * broadcasts the receivers are not automatically hoisted out of the
5462 * background priority class.
5463 */
5464 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5465 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005466 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5467 * They can still propagate results through to later receivers, but they can not prevent
5468 * later receivers from seeing the broadcast.
5469 */
5470 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5471 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005472 * If set, when sending a broadcast <i>before boot has completed</i> only
5473 * registered receivers will be called -- no BroadcastReceiver components
5474 * will be launched. Sticky intent state will be recorded properly even
5475 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5476 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005477 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005478 * <p>This flag is only for use by system sevices as a convenience to
5479 * avoid having to implement a more complex mechanism around detection
5480 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005481 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005482 * @hide
5483 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005484 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005485 /**
5486 * Set when this broadcast is for a boot upgrade, a special mode that
5487 * allows the broadcast to be sent before the system is ready and launches
5488 * the app process with no providers running in it.
5489 * @hide
5490 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005491 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005492 /**
5493 * If set, the broadcast will always go to manifest receivers in background (cached
5494 * or not running) apps, regardless of whether that would be done by default. By
5495 * default they will only receive broadcasts if the broadcast has specified an
5496 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005497 *
5498 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5499 * the broadcast code there must also be changed to match.
5500 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005501 * @hide
5502 */
5503 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5504 /**
5505 * If set, the broadcast will never go to manifest receivers in background (cached
5506 * or not running) apps, regardless of whether that would be done by default. By
5507 * default they will receive broadcasts if the broadcast has specified an
5508 * explicit component or package name.
5509 * @hide
5510 */
5511 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005512 /**
5513 * If set, this broadcast is being sent from the shell.
5514 * @hide
5515 */
5516 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005517
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005518 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005519 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5520 * will not receive broadcasts.
5521 *
5522 * <em>This flag has no effect when used by an Instant App.</em>
5523 */
5524 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5525
5526 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005527 * @hide Flags that can't be changed with PendingIntent.
5528 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005529 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5530 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5531 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005532
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005533 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005534 // ---------------------------------------------------------------------
5535 // toUri() and parseUri() options.
5536
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005537 /** @hide */
5538 @IntDef(flag = true, prefix = { "URI_" }, value = {
5539 URI_ALLOW_UNSAFE,
5540 URI_ANDROID_APP_SCHEME,
5541 URI_INTENT_SCHEME,
5542 })
5543 @Retention(RetentionPolicy.SOURCE)
5544 public @interface UriFlags {}
5545
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005546 /**
5547 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5548 * always has the "intent:" scheme. This syntax can be used when you want
5549 * to later disambiguate between URIs that are intended to describe an
5550 * Intent vs. all others that should be treated as raw URIs. When used
5551 * with {@link #parseUri}, any other scheme will result in a generic
5552 * VIEW action for that raw URI.
5553 */
5554 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005555
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005556 /**
5557 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5558 * always has the "android-app:" scheme. This is a variation of
5559 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5560 * http/https URI being delivered to a specific package name. The format
5561 * is:
5562 *
5563 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005564 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005565 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005566 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5567 * you must also include a scheme; including a path also requires both a host and a scheme.
5568 * The final #Intent; fragment can be used without a scheme, host, or path.
5569 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005570 * used with intents that have a {@link #setSelector}, since the base intent
5571 * will always have an explicit package name.</p>
5572 *
5573 * <p>Some examples of how this scheme maps to Intent objects:</p>
5574 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5575 * <colgroup align="left" />
5576 * <colgroup align="left" />
5577 * <thead>
5578 * <tr><th>URI</th> <th>Intent</th></tr>
5579 * </thead>
5580 *
5581 * <tbody>
5582 * <tr><td><code>android-app://com.example.app</code></td>
5583 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5584 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5585 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5586 * </table></td>
5587 * </tr>
5588 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5589 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5590 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5591 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5592 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5593 * </table></td>
5594 * </tr>
5595 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5596 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5597 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5598 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5599 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5600 * </table></td>
5601 * </tr>
5602 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5603 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5604 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5605 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5606 * </table></td>
5607 * </tr>
5608 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5609 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5610 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5611 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5612 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5613 * </table></td>
5614 * </tr>
5615 * <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>
5616 * <td><table border="" style="margin:0" >
5617 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5618 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5619 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5620 * </table></td>
5621 * </tr>
5622 * </tbody>
5623 * </table>
5624 */
5625 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5626
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005627 /**
5628 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5629 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5630 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5631 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5632 * generated Intent can not cause unexpected data access to happen.
5633 *
5634 * <p>If you do not trust the source of the URI being parsed, you should still do further
5635 * processing to protect yourself from it. In particular, when using it to start an
5636 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5637 * that can handle it.</p>
5638 */
5639 public static final int URI_ALLOW_UNSAFE = 1<<2;
5640
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005641 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005642
5643 private String mAction;
5644 private Uri mData;
5645 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005646 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005647 private ComponentName mComponent;
5648 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005649 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005650 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005651 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005652 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005653 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005654 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005655 /** Token to track instant app launches. Local only; do not copy cross-process. */
5656 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005657
5658 // ---------------------------------------------------------------------
5659
Makoto Onuki97f82f22017-05-31 16:20:21 -07005660 private static final int COPY_MODE_ALL = 0;
5661 private static final int COPY_MODE_FILTER = 1;
5662 private static final int COPY_MODE_HISTORY = 2;
5663
5664 /** @hide */
5665 @IntDef(value = {COPY_MODE_ALL, COPY_MODE_FILTER, COPY_MODE_HISTORY})
5666 @Retention(RetentionPolicy.SOURCE)
5667 public @interface CopyMode {}
5668
5669
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005670 /**
5671 * Create an empty intent.
5672 */
5673 public Intent() {
5674 }
5675
5676 /**
5677 * Copy constructor.
5678 */
5679 public Intent(Intent o) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005680 this(o, COPY_MODE_ALL);
5681 }
5682
5683 private Intent(Intent o, @CopyMode int copyMode) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005684 this.mAction = o.mAction;
5685 this.mData = o.mData;
5686 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005687 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005688 this.mComponent = o.mComponent;
Makoto Onuki97f82f22017-05-31 16:20:21 -07005689
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005690 if (o.mCategories != null) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005691 this.mCategories = new ArraySet<>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005692 }
Makoto Onuki97f82f22017-05-31 16:20:21 -07005693
5694 if (copyMode != COPY_MODE_FILTER) {
5695 this.mFlags = o.mFlags;
5696 this.mContentUserHint = o.mContentUserHint;
5697 this.mLaunchToken = o.mLaunchToken;
5698 if (o.mSourceBounds != null) {
5699 this.mSourceBounds = new Rect(o.mSourceBounds);
5700 }
5701 if (o.mSelector != null) {
5702 this.mSelector = new Intent(o.mSelector);
5703 }
5704
5705 if (copyMode != COPY_MODE_HISTORY) {
5706 if (o.mExtras != null) {
5707 this.mExtras = new Bundle(o.mExtras);
5708 }
5709 if (o.mClipData != null) {
5710 this.mClipData = new ClipData(o.mClipData);
5711 }
5712 } else {
5713 if (o.mExtras != null && !o.mExtras.maybeIsEmpty()) {
5714 this.mExtras = Bundle.STRIPPED;
5715 }
5716
5717 // Also set "stripped" clip data when we ever log mClipData in the (broadcast)
5718 // history.
5719 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005720 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005721 }
5722
5723 @Override
5724 public Object clone() {
5725 return new Intent(this);
5726 }
5727
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005728 /**
5729 * Make a clone of only the parts of the Intent that are relevant for
5730 * filter matching: the action, data, type, component, and categories.
5731 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005732 public @NonNull Intent cloneFilter() {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005733 return new Intent(this, COPY_MODE_FILTER);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005734 }
5735
5736 /**
5737 * Create an intent with a given action. All other fields (data, type,
5738 * class) are null. Note that the action <em>must</em> be in a
5739 * namespace because Intents are used globally in the system -- for
5740 * example the system VIEW action is android.intent.action.VIEW; an
5741 * application's custom action would be something like
5742 * com.google.app.myapp.CUSTOM_ACTION.
5743 *
5744 * @param action The Intent action, such as ACTION_VIEW.
5745 */
5746 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005747 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005748 }
5749
5750 /**
5751 * Create an intent with a given action and for a given data url. Note
5752 * that the action <em>must</em> be in a namespace because Intents are
5753 * used globally in the system -- for example the system VIEW action is
5754 * android.intent.action.VIEW; an application's custom action would be
5755 * something like com.google.app.myapp.CUSTOM_ACTION.
5756 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005757 * <p><em>Note: scheme and host name matching in the Android framework is
5758 * case-sensitive, unlike the formal RFC. As a result,
5759 * you should always ensure that you write your Uri with these elements
5760 * using lower case letters, and normalize any Uris you receive from
5761 * outside of Android to ensure the scheme and host is lower case.</em></p>
5762 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005763 * @param action The Intent action, such as ACTION_VIEW.
5764 * @param uri The Intent data URI.
5765 */
5766 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005767 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005768 mData = uri;
5769 }
5770
5771 /**
5772 * Create an intent for a specific component. All other fields (action, data,
5773 * type, class) are null, though they can be modified later with explicit
5774 * calls. This provides a convenient way to create an intent that is
5775 * intended to execute a hard-coded class name, rather than relying on the
5776 * system to find an appropriate class for you; see {@link #setComponent}
5777 * for more information on the repercussions of this.
5778 *
5779 * @param packageContext A Context of the application package implementing
5780 * this class.
5781 * @param cls The component class that is to be used for the intent.
5782 *
5783 * @see #setClass
5784 * @see #setComponent
5785 * @see #Intent(String, android.net.Uri , Context, Class)
5786 */
5787 public Intent(Context packageContext, Class<?> cls) {
5788 mComponent = new ComponentName(packageContext, cls);
5789 }
5790
5791 /**
5792 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005793 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005794 * construct the Intent and then calling {@link #setClass} to set its
5795 * class.
5796 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005797 * <p><em>Note: scheme and host name matching in the Android framework is
5798 * case-sensitive, unlike the formal RFC. As a result,
5799 * you should always ensure that you write your Uri with these elements
5800 * using lower case letters, and normalize any Uris you receive from
5801 * outside of Android to ensure the scheme and host is lower case.</em></p>
5802 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005803 * @param action The Intent action, such as ACTION_VIEW.
5804 * @param uri The Intent data URI.
5805 * @param packageContext A Context of the application package implementing
5806 * this class.
5807 * @param cls The component class that is to be used for the intent.
5808 *
5809 * @see #Intent(String, android.net.Uri)
5810 * @see #Intent(Context, Class)
5811 * @see #setClass
5812 * @see #setComponent
5813 */
5814 public Intent(String action, Uri uri,
5815 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005816 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005817 mData = uri;
5818 mComponent = new ComponentName(packageContext, cls);
5819 }
5820
5821 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005822 * Create an intent to launch the main (root) activity of a task. This
5823 * is the Intent that is started when the application's is launched from
5824 * Home. For anything else that wants to launch an application in the
5825 * same way, it is important that they use an Intent structured the same
5826 * way, and can use this function to ensure this is the case.
5827 *
5828 * <p>The returned Intent has the given Activity component as its explicit
5829 * component, {@link #ACTION_MAIN} as its action, and includes the
5830 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5831 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5832 * to do that through {@link #addFlags(int)} on the returned Intent.
5833 *
5834 * @param mainActivity The main activity component that this Intent will
5835 * launch.
5836 * @return Returns a newly created Intent that can be used to launch the
5837 * activity as a main application entry.
5838 *
5839 * @see #setClass
5840 * @see #setComponent
5841 */
5842 public static Intent makeMainActivity(ComponentName mainActivity) {
5843 Intent intent = new Intent(ACTION_MAIN);
5844 intent.setComponent(mainActivity);
5845 intent.addCategory(CATEGORY_LAUNCHER);
5846 return intent;
5847 }
5848
5849 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005850 * Make an Intent for the main activity of an application, without
5851 * specifying a specific activity to run but giving a selector to find
5852 * the activity. This results in a final Intent that is structured
5853 * the same as when the application is launched from
5854 * Home. For anything else that wants to launch an application in the
5855 * same way, it is important that they use an Intent structured the same
5856 * way, and can use this function to ensure this is the case.
5857 *
5858 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5859 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5860 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5861 * to do that through {@link #addFlags(int)} on the returned Intent.
5862 *
5863 * @param selectorAction The action name of the Intent's selector.
5864 * @param selectorCategory The name of a category to add to the Intent's
5865 * selector.
5866 * @return Returns a newly created Intent that can be used to launch the
5867 * activity as a main application entry.
5868 *
5869 * @see #setSelector(Intent)
5870 */
5871 public static Intent makeMainSelectorActivity(String selectorAction,
5872 String selectorCategory) {
5873 Intent intent = new Intent(ACTION_MAIN);
5874 intent.addCategory(CATEGORY_LAUNCHER);
5875 Intent selector = new Intent();
5876 selector.setAction(selectorAction);
5877 selector.addCategory(selectorCategory);
5878 intent.setSelector(selector);
5879 return intent;
5880 }
5881
5882 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005883 * Make an Intent that can be used to re-launch an application's task
5884 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5885 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5886 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5887 *
5888 * @param mainActivity The activity component that is the root of the
5889 * task; this is the activity that has been published in the application's
5890 * manifest as the main launcher icon.
5891 *
5892 * @return Returns a newly created Intent that can be used to relaunch the
5893 * activity's task in its root state.
5894 */
5895 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5896 Intent intent = makeMainActivity(mainActivity);
5897 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5898 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5899 return intent;
5900 }
5901
5902 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005903 * Call {@link #parseUri} with 0 flags.
5904 * @deprecated Use {@link #parseUri} instead.
5905 */
5906 @Deprecated
5907 public static Intent getIntent(String uri) throws URISyntaxException {
5908 return parseUri(uri, 0);
5909 }
Tom Taylord4a47292009-12-21 13:59:18 -08005910
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005911 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005912 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005913 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005914 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005915 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005916 *
5917 * <p>The URI given here must not be relative -- that is, it must include
5918 * the scheme and full path.
5919 *
5920 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005921 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005922 *
5923 * @return Intent The newly created Intent object.
5924 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005925 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5926 * it bad (as parsed by the Uri class) or the Intent data within the
5927 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005928 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005929 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005930 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005931 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005932 int i = 0;
5933 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005934 final boolean androidApp = uri.startsWith("android-app:");
5935
5936 // Validate intent scheme if requested.
5937 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5938 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005939 Intent intent = new Intent(ACTION_VIEW);
5940 try {
5941 intent.setData(Uri.parse(uri));
5942 } catch (IllegalArgumentException e) {
5943 throw new URISyntaxException(uri, e.getMessage());
5944 }
5945 return intent;
5946 }
5947 }
Tom Taylord4a47292009-12-21 13:59:18 -08005948
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005949 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005950 // simple case
5951 if (i == -1) {
5952 if (!androidApp) {
5953 return new Intent(ACTION_VIEW, Uri.parse(uri));
5954 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005955
5956 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005957 } else if (!uri.startsWith("#Intent;", i)) {
5958 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005959 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005960 } else {
5961 i = -1;
5962 }
5963 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005964
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005965 // new format
5966 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005967 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005968 boolean explicitAction = false;
5969 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005970
5971 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005972 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005973 String data;
5974 if (i >= 0) {
5975 data = uri.substring(0, i);
5976 i += 8; // length of "#Intent;"
5977 } else {
5978 data = uri;
5979 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005980
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005981 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005982 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005983 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005984 if (eq < 0) eq = i-1;
5985 int semi = uri.indexOf(';', i);
5986 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005987
5988 // action
5989 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005990 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005991 if (!inSelector) {
5992 explicitAction = true;
5993 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005994 }
5995
5996 // categories
5997 else if (uri.startsWith("category=", i)) {
5998 intent.addCategory(value);
5999 }
6000
6001 // type
6002 else if (uri.startsWith("type=", i)) {
6003 intent.mType = value;
6004 }
6005
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006006 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006007 else if (uri.startsWith("launchFlags=", i)) {
6008 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006009 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6010 intent.mFlags &= ~IMMUTABLE_FLAGS;
6011 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006012 }
6013
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006014 // package
6015 else if (uri.startsWith("package=", i)) {
6016 intent.mPackage = value;
6017 }
6018
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006019 // component
6020 else if (uri.startsWith("component=", i)) {
6021 intent.mComponent = ComponentName.unflattenFromString(value);
6022 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006023
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006024 // scheme
6025 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006026 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006027 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006028 } else {
6029 scheme = value;
6030 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006031 }
6032
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006033 // source bounds
6034 else if (uri.startsWith("sourceBounds=", i)) {
6035 intent.mSourceBounds = Rect.unflattenFromString(value);
6036 }
6037
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006038 // selector
6039 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
6040 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006041 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006042 }
6043
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006044 // extra
6045 else {
6046 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006047 // create Bundle if it doesn't already exist
6048 if (intent.mExtras == null) intent.mExtras = new Bundle();
6049 Bundle b = intent.mExtras;
6050 // add EXTRA
6051 if (uri.startsWith("S.", i)) b.putString(key, value);
6052 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
6053 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
6054 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
6055 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
6056 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
6057 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
6058 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
6059 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
6060 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
6061 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006062
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006063 // move to the next item
6064 i = semi + 1;
6065 }
6066
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006067 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006068 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006069 if (baseIntent.mPackage == null) {
6070 baseIntent.setSelector(intent);
6071 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006072 intent = baseIntent;
6073 }
6074
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006075 if (data != null) {
6076 if (data.startsWith("intent:")) {
6077 data = data.substring(7);
6078 if (scheme != null) {
6079 data = scheme + ':' + data;
6080 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006081 } else if (data.startsWith("android-app:")) {
6082 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
6083 // Correctly formed android-app, first part is package name.
6084 int end = data.indexOf('/', 14);
6085 if (end < 0) {
6086 // All we have is a package name.
6087 intent.mPackage = data.substring(14);
6088 if (!explicitAction) {
6089 intent.setAction(ACTION_MAIN);
6090 }
6091 data = "";
6092 } else {
6093 // Target the Intent at the given package name always.
6094 String authority = null;
6095 intent.mPackage = data.substring(14, end);
6096 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006097 if ((end+1) < data.length()) {
6098 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6099 // Found a scheme, remember it.
6100 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006101 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006102 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6103 // Found a authority, remember it.
6104 authority = data.substring(end+1, newEnd);
6105 end = newEnd;
6106 }
6107 } else {
6108 // All we have is a scheme.
6109 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006110 }
6111 }
6112 if (scheme == null) {
6113 // If there was no scheme, then this just targets the package.
6114 if (!explicitAction) {
6115 intent.setAction(ACTION_MAIN);
6116 }
6117 data = "";
6118 } else if (authority == null) {
6119 data = scheme + ":";
6120 } else {
6121 data = scheme + "://" + authority + data.substring(end);
6122 }
6123 }
6124 } else {
6125 data = "";
6126 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006127 }
Tom Taylord4a47292009-12-21 13:59:18 -08006128
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006129 if (data.length() > 0) {
6130 try {
6131 intent.mData = Uri.parse(data);
6132 } catch (IllegalArgumentException e) {
6133 throw new URISyntaxException(uri, e.getMessage());
6134 }
6135 }
6136 }
Tom Taylord4a47292009-12-21 13:59:18 -08006137
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006138 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006139
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006140 } catch (IndexOutOfBoundsException e) {
6141 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6142 }
6143 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006144
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006145 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006146 return getIntentOld(uri, 0);
6147 }
6148
6149 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006150 Intent intent;
6151
6152 int i = uri.lastIndexOf('#');
6153 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006154 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006155 final int intentFragmentStart = i;
6156 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006157
6158 i++;
6159
6160 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006161 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006162 i += 7;
6163 int j = uri.indexOf(')', i);
6164 action = uri.substring(i, j);
6165 i = j + 1;
6166 }
6167
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006168 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006169
6170 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006171 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006172 i += 11;
6173 int j = uri.indexOf(')', i);
6174 while (i < j) {
6175 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006176 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006177 if (i < sep) {
6178 intent.addCategory(uri.substring(i, sep));
6179 }
6180 i = sep + 1;
6181 }
6182 i = j + 1;
6183 }
6184
6185 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006186 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006187 i += 5;
6188 int j = uri.indexOf(')', i);
6189 intent.mType = uri.substring(i, j);
6190 i = j + 1;
6191 }
6192
6193 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006194 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006195 i += 12;
6196 int j = uri.indexOf(')', i);
6197 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006198 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6199 intent.mFlags &= ~IMMUTABLE_FLAGS;
6200 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006201 i = j + 1;
6202 }
6203
6204 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006205 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006206 i += 10;
6207 int j = uri.indexOf(')', i);
6208 int sep = uri.indexOf('!', i);
6209 if (sep >= 0 && sep < j) {
6210 String pkg = uri.substring(i, sep);
6211 String cls = uri.substring(sep + 1, j);
6212 intent.mComponent = new ComponentName(pkg, cls);
6213 }
6214 i = j + 1;
6215 }
6216
6217 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006218 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006219 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006220
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006221 final int closeParen = uri.indexOf(')', i);
6222 if (closeParen == -1) throw new URISyntaxException(uri,
6223 "EXTRA missing trailing ')'", i);
6224
6225 while (i < closeParen) {
6226 // fetch the key value
6227 int j = uri.indexOf('=', i);
6228 if (j <= i + 1 || i >= closeParen) {
6229 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6230 }
6231 char type = uri.charAt(i);
6232 i++;
6233 String key = uri.substring(i, j);
6234 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006235
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006236 // get type-value
6237 j = uri.indexOf('!', i);
6238 if (j == -1 || j >= closeParen) j = closeParen;
6239 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6240 String value = uri.substring(i, j);
6241 i = j;
6242
6243 // create Bundle if it doesn't already exist
6244 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006245
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006246 // add item to bundle
6247 try {
6248 switch (type) {
6249 case 'S':
6250 intent.mExtras.putString(key, Uri.decode(value));
6251 break;
6252 case 'B':
6253 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6254 break;
6255 case 'b':
6256 intent.mExtras.putByte(key, Byte.parseByte(value));
6257 break;
6258 case 'c':
6259 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6260 break;
6261 case 'd':
6262 intent.mExtras.putDouble(key, Double.parseDouble(value));
6263 break;
6264 case 'f':
6265 intent.mExtras.putFloat(key, Float.parseFloat(value));
6266 break;
6267 case 'i':
6268 intent.mExtras.putInt(key, Integer.parseInt(value));
6269 break;
6270 case 'l':
6271 intent.mExtras.putLong(key, Long.parseLong(value));
6272 break;
6273 case 's':
6274 intent.mExtras.putShort(key, Short.parseShort(value));
6275 break;
6276 default:
6277 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6278 }
6279 } catch (NumberFormatException e) {
6280 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6281 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006282
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006283 char ch = uri.charAt(i);
6284 if (ch == ')') break;
6285 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6286 i++;
6287 }
6288 }
6289
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006290 if (isIntentFragment) {
6291 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6292 } else {
6293 intent.mData = Uri.parse(uri);
6294 }
Tom Taylord4a47292009-12-21 13:59:18 -08006295
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006296 if (intent.mAction == null) {
6297 // By default, if no action is specified, then use VIEW.
6298 intent.mAction = ACTION_VIEW;
6299 }
6300
6301 } else {
6302 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6303 }
6304
6305 return intent;
6306 }
6307
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006308 /** @hide */
6309 public interface CommandOptionHandler {
6310 boolean handleOption(String opt, ShellCommand cmd);
6311 }
6312
6313 /** @hide */
6314 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6315 throws URISyntaxException {
6316 Intent intent = new Intent();
6317 Intent baseIntent = intent;
6318 boolean hasIntentInfo = false;
6319
6320 Uri data = null;
6321 String type = null;
6322
6323 String opt;
6324 while ((opt=cmd.getNextOption()) != null) {
6325 switch (opt) {
6326 case "-a":
6327 intent.setAction(cmd.getNextArgRequired());
6328 if (intent == baseIntent) {
6329 hasIntentInfo = true;
6330 }
6331 break;
6332 case "-d":
6333 data = Uri.parse(cmd.getNextArgRequired());
6334 if (intent == baseIntent) {
6335 hasIntentInfo = true;
6336 }
6337 break;
6338 case "-t":
6339 type = cmd.getNextArgRequired();
6340 if (intent == baseIntent) {
6341 hasIntentInfo = true;
6342 }
6343 break;
6344 case "-c":
6345 intent.addCategory(cmd.getNextArgRequired());
6346 if (intent == baseIntent) {
6347 hasIntentInfo = true;
6348 }
6349 break;
6350 case "-e":
6351 case "--es": {
6352 String key = cmd.getNextArgRequired();
6353 String value = cmd.getNextArgRequired();
6354 intent.putExtra(key, value);
6355 }
6356 break;
6357 case "--esn": {
6358 String key = cmd.getNextArgRequired();
6359 intent.putExtra(key, (String) null);
6360 }
6361 break;
6362 case "--ei": {
6363 String key = cmd.getNextArgRequired();
6364 String value = cmd.getNextArgRequired();
6365 intent.putExtra(key, Integer.decode(value));
6366 }
6367 break;
6368 case "--eu": {
6369 String key = cmd.getNextArgRequired();
6370 String value = cmd.getNextArgRequired();
6371 intent.putExtra(key, Uri.parse(value));
6372 }
6373 break;
6374 case "--ecn": {
6375 String key = cmd.getNextArgRequired();
6376 String value = cmd.getNextArgRequired();
6377 ComponentName cn = ComponentName.unflattenFromString(value);
6378 if (cn == null)
6379 throw new IllegalArgumentException("Bad component name: " + value);
6380 intent.putExtra(key, cn);
6381 }
6382 break;
6383 case "--eia": {
6384 String key = cmd.getNextArgRequired();
6385 String value = cmd.getNextArgRequired();
6386 String[] strings = value.split(",");
6387 int[] list = new int[strings.length];
6388 for (int i = 0; i < strings.length; i++) {
6389 list[i] = Integer.decode(strings[i]);
6390 }
6391 intent.putExtra(key, list);
6392 }
6393 break;
6394 case "--eial": {
6395 String key = cmd.getNextArgRequired();
6396 String value = cmd.getNextArgRequired();
6397 String[] strings = value.split(",");
6398 ArrayList<Integer> list = new ArrayList<>(strings.length);
6399 for (int i = 0; i < strings.length; i++) {
6400 list.add(Integer.decode(strings[i]));
6401 }
6402 intent.putExtra(key, list);
6403 }
6404 break;
6405 case "--el": {
6406 String key = cmd.getNextArgRequired();
6407 String value = cmd.getNextArgRequired();
6408 intent.putExtra(key, Long.valueOf(value));
6409 }
6410 break;
6411 case "--ela": {
6412 String key = cmd.getNextArgRequired();
6413 String value = cmd.getNextArgRequired();
6414 String[] strings = value.split(",");
6415 long[] list = new long[strings.length];
6416 for (int i = 0; i < strings.length; i++) {
6417 list[i] = Long.valueOf(strings[i]);
6418 }
6419 intent.putExtra(key, list);
6420 hasIntentInfo = true;
6421 }
6422 break;
6423 case "--elal": {
6424 String key = cmd.getNextArgRequired();
6425 String value = cmd.getNextArgRequired();
6426 String[] strings = value.split(",");
6427 ArrayList<Long> list = new ArrayList<>(strings.length);
6428 for (int i = 0; i < strings.length; i++) {
6429 list.add(Long.valueOf(strings[i]));
6430 }
6431 intent.putExtra(key, list);
6432 hasIntentInfo = true;
6433 }
6434 break;
6435 case "--ef": {
6436 String key = cmd.getNextArgRequired();
6437 String value = cmd.getNextArgRequired();
6438 intent.putExtra(key, Float.valueOf(value));
6439 hasIntentInfo = true;
6440 }
6441 break;
6442 case "--efa": {
6443 String key = cmd.getNextArgRequired();
6444 String value = cmd.getNextArgRequired();
6445 String[] strings = value.split(",");
6446 float[] list = new float[strings.length];
6447 for (int i = 0; i < strings.length; i++) {
6448 list[i] = Float.valueOf(strings[i]);
6449 }
6450 intent.putExtra(key, list);
6451 hasIntentInfo = true;
6452 }
6453 break;
6454 case "--efal": {
6455 String key = cmd.getNextArgRequired();
6456 String value = cmd.getNextArgRequired();
6457 String[] strings = value.split(",");
6458 ArrayList<Float> list = new ArrayList<>(strings.length);
6459 for (int i = 0; i < strings.length; i++) {
6460 list.add(Float.valueOf(strings[i]));
6461 }
6462 intent.putExtra(key, list);
6463 hasIntentInfo = true;
6464 }
6465 break;
6466 case "--esa": {
6467 String key = cmd.getNextArgRequired();
6468 String value = cmd.getNextArgRequired();
6469 // Split on commas unless they are preceeded by an escape.
6470 // The escape character must be escaped for the string and
6471 // again for the regex, thus four escape characters become one.
6472 String[] strings = value.split("(?<!\\\\),");
6473 intent.putExtra(key, strings);
6474 hasIntentInfo = true;
6475 }
6476 break;
6477 case "--esal": {
6478 String key = cmd.getNextArgRequired();
6479 String value = cmd.getNextArgRequired();
6480 // Split on commas unless they are preceeded by an escape.
6481 // The escape character must be escaped for the string and
6482 // again for the regex, thus four escape characters become one.
6483 String[] strings = value.split("(?<!\\\\),");
6484 ArrayList<String> list = new ArrayList<>(strings.length);
6485 for (int i = 0; i < strings.length; i++) {
6486 list.add(strings[i]);
6487 }
6488 intent.putExtra(key, list);
6489 hasIntentInfo = true;
6490 }
6491 break;
6492 case "--ez": {
6493 String key = cmd.getNextArgRequired();
6494 String value = cmd.getNextArgRequired().toLowerCase();
6495 // Boolean.valueOf() results in false for anything that is not "true", which is
6496 // error-prone in shell commands
6497 boolean arg;
6498 if ("true".equals(value) || "t".equals(value)) {
6499 arg = true;
6500 } else if ("false".equals(value) || "f".equals(value)) {
6501 arg = false;
6502 } else {
6503 try {
6504 arg = Integer.decode(value) != 0;
6505 } catch (NumberFormatException ex) {
6506 throw new IllegalArgumentException("Invalid boolean value: " + value);
6507 }
6508 }
6509
6510 intent.putExtra(key, arg);
6511 }
6512 break;
6513 case "-n": {
6514 String str = cmd.getNextArgRequired();
6515 ComponentName cn = ComponentName.unflattenFromString(str);
6516 if (cn == null)
6517 throw new IllegalArgumentException("Bad component name: " + str);
6518 intent.setComponent(cn);
6519 if (intent == baseIntent) {
6520 hasIntentInfo = true;
6521 }
6522 }
6523 break;
6524 case "-p": {
6525 String str = cmd.getNextArgRequired();
6526 intent.setPackage(str);
6527 if (intent == baseIntent) {
6528 hasIntentInfo = true;
6529 }
6530 }
6531 break;
6532 case "-f":
6533 String str = cmd.getNextArgRequired();
6534 intent.setFlags(Integer.decode(str).intValue());
6535 break;
6536 case "--grant-read-uri-permission":
6537 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6538 break;
6539 case "--grant-write-uri-permission":
6540 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6541 break;
6542 case "--grant-persistable-uri-permission":
6543 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6544 break;
6545 case "--grant-prefix-uri-permission":
6546 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6547 break;
6548 case "--exclude-stopped-packages":
6549 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6550 break;
6551 case "--include-stopped-packages":
6552 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6553 break;
6554 case "--debug-log-resolution":
6555 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6556 break;
6557 case "--activity-brought-to-front":
6558 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6559 break;
6560 case "--activity-clear-top":
6561 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6562 break;
6563 case "--activity-clear-when-task-reset":
6564 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6565 break;
6566 case "--activity-exclude-from-recents":
6567 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6568 break;
6569 case "--activity-launched-from-history":
6570 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6571 break;
6572 case "--activity-multiple-task":
6573 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6574 break;
6575 case "--activity-no-animation":
6576 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6577 break;
6578 case "--activity-no-history":
6579 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6580 break;
6581 case "--activity-no-user-action":
6582 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6583 break;
6584 case "--activity-previous-is-top":
6585 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6586 break;
6587 case "--activity-reorder-to-front":
6588 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6589 break;
6590 case "--activity-reset-task-if-needed":
6591 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6592 break;
6593 case "--activity-single-top":
6594 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6595 break;
6596 case "--activity-clear-task":
6597 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6598 break;
6599 case "--activity-task-on-home":
6600 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6601 break;
6602 case "--receiver-registered-only":
6603 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6604 break;
6605 case "--receiver-replace-pending":
6606 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6607 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006608 case "--receiver-foreground":
6609 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6610 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006611 case "--receiver-no-abort":
6612 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6613 break;
6614 case "--receiver-include-background":
6615 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6616 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006617 case "--selector":
6618 intent.setDataAndType(data, type);
6619 intent = new Intent();
6620 break;
6621 default:
6622 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6623 // Okay, caller handled this option.
6624 } else {
6625 throw new IllegalArgumentException("Unknown option: " + opt);
6626 }
6627 break;
6628 }
6629 }
6630 intent.setDataAndType(data, type);
6631
6632 final boolean hasSelector = intent != baseIntent;
6633 if (hasSelector) {
6634 // A selector was specified; fix up.
6635 baseIntent.setSelector(intent);
6636 intent = baseIntent;
6637 }
6638
6639 String arg = cmd.getNextArg();
6640 baseIntent = null;
6641 if (arg == null) {
6642 if (hasSelector) {
6643 // If a selector has been specified, and no arguments
6644 // have been supplied for the main Intent, then we can
6645 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6646 // need to have a component name specified yet, the
6647 // selector will take care of that.
6648 baseIntent = new Intent(Intent.ACTION_MAIN);
6649 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6650 }
6651 } else if (arg.indexOf(':') >= 0) {
6652 // The argument is a URI. Fully parse it, and use that result
6653 // to fill in any data not specified so far.
6654 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6655 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6656 } else if (arg.indexOf('/') >= 0) {
6657 // The argument is a component name. Build an Intent to launch
6658 // it.
6659 baseIntent = new Intent(Intent.ACTION_MAIN);
6660 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6661 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6662 } else {
6663 // Assume the argument is a package name.
6664 baseIntent = new Intent(Intent.ACTION_MAIN);
6665 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6666 baseIntent.setPackage(arg);
6667 }
6668 if (baseIntent != null) {
6669 Bundle extras = intent.getExtras();
6670 intent.replaceExtras((Bundle)null);
6671 Bundle uriExtras = baseIntent.getExtras();
6672 baseIntent.replaceExtras((Bundle)null);
6673 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6674 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6675 for (String c : cats) {
6676 baseIntent.removeCategory(c);
6677 }
6678 }
6679 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6680 if (extras == null) {
6681 extras = uriExtras;
6682 } else if (uriExtras != null) {
6683 uriExtras.putAll(extras);
6684 extras = uriExtras;
6685 }
6686 intent.replaceExtras(extras);
6687 hasIntentInfo = true;
6688 }
6689
6690 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6691 return intent;
6692 }
6693
6694 /** @hide */
6695 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6696 final String[] lines = new String[] {
6697 "<INTENT> specifications include these flags and arguments:",
6698 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6699 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6700 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6701 " [--esn <EXTRA_KEY> ...]",
6702 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6703 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6704 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6705 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6706 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6707 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6708 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6709 " (mutiple extras passed as Integer[])",
6710 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6711 " (mutiple extras passed as List<Integer>)",
6712 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6713 " (mutiple extras passed as Long[])",
6714 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6715 " (mutiple extras passed as List<Long>)",
6716 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6717 " (mutiple extras passed as Float[])",
6718 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6719 " (mutiple extras passed as List<Float>)",
6720 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6721 " (mutiple extras passed as String[]; to embed a comma into a string,",
6722 " escape it using \"\\,\")",
6723 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6724 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6725 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006726 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006727 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6728 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6729 " [--debug-log-resolution] [--exclude-stopped-packages]",
6730 " [--include-stopped-packages]",
6731 " [--activity-brought-to-front] [--activity-clear-top]",
6732 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6733 " [--activity-launched-from-history] [--activity-multiple-task]",
6734 " [--activity-no-animation] [--activity-no-history]",
6735 " [--activity-no-user-action] [--activity-previous-is-top]",
6736 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6737 " [--activity-single-top] [--activity-clear-task]",
6738 " [--activity-task-on-home]",
6739 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08006740 " [--receiver-foreground] [--receiver-no-abort]",
6741 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006742 " [--selector]",
6743 " [<URI> | <PACKAGE> | <COMPONENT>]"
6744 };
6745 for (String line : lines) {
6746 pw.print(prefix);
6747 pw.println(line);
6748 }
6749 }
6750
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006751 /**
6752 * Retrieve the general action to be performed, such as
6753 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6754 * the information in the intent should be interpreted -- most importantly,
6755 * what to do with the data returned by {@link #getData}.
6756 *
6757 * @return The action of this intent or null if none is specified.
6758 *
6759 * @see #setAction
6760 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006761 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006762 return mAction;
6763 }
6764
6765 /**
6766 * Retrieve data this intent is operating on. This URI specifies the name
6767 * of the data; often it uses the content: scheme, specifying data in a
6768 * content provider. Other schemes may be handled by specific activities,
6769 * such as http: by the web browser.
6770 *
6771 * @return The URI of the data this intent is targeting or null.
6772 *
6773 * @see #getScheme
6774 * @see #setData
6775 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006776 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006777 return mData;
6778 }
6779
6780 /**
6781 * The same as {@link #getData()}, but returns the URI as an encoded
6782 * String.
6783 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006784 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006785 return mData != null ? mData.toString() : null;
6786 }
6787
6788 /**
6789 * Return the scheme portion of the intent's data. If the data is null or
6790 * does not include a scheme, null is returned. Otherwise, the scheme
6791 * prefix without the final ':' is returned, i.e. "http".
6792 *
6793 * <p>This is the same as calling getData().getScheme() (and checking for
6794 * null data).
6795 *
6796 * @return The scheme of this intent.
6797 *
6798 * @see #getData
6799 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006800 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006801 return mData != null ? mData.getScheme() : null;
6802 }
6803
6804 /**
6805 * Retrieve any explicit MIME type included in the intent. This is usually
6806 * null, as the type is determined by the intent data.
6807 *
6808 * @return If a type was manually set, it is returned; else null is
6809 * returned.
6810 *
6811 * @see #resolveType(ContentResolver)
6812 * @see #setType
6813 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006814 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006815 return mType;
6816 }
6817
6818 /**
6819 * Return the MIME data type of this intent. If the type field is
6820 * explicitly set, that is simply returned. Otherwise, if the data is set,
6821 * the type of that data is returned. If neither fields are set, a null is
6822 * returned.
6823 *
6824 * @return The MIME type of this intent.
6825 *
6826 * @see #getType
6827 * @see #resolveType(ContentResolver)
6828 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006829 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006830 return resolveType(context.getContentResolver());
6831 }
6832
6833 /**
6834 * Return the MIME data type of this intent. If the type field is
6835 * explicitly set, that is simply returned. Otherwise, if the data is set,
6836 * the type of that data is returned. If neither fields are set, a null is
6837 * returned.
6838 *
6839 * @param resolver A ContentResolver that can be used to determine the MIME
6840 * type of the intent's data.
6841 *
6842 * @return The MIME type of this intent.
6843 *
6844 * @see #getType
6845 * @see #resolveType(Context)
6846 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006847 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006848 if (mType != null) {
6849 return mType;
6850 }
6851 if (mData != null) {
6852 if ("content".equals(mData.getScheme())) {
6853 return resolver.getType(mData);
6854 }
6855 }
6856 return null;
6857 }
6858
6859 /**
6860 * Return the MIME data type of this intent, only if it will be needed for
6861 * intent resolution. This is not generally useful for application code;
6862 * it is used by the frameworks for communicating with back-end system
6863 * services.
6864 *
6865 * @param resolver A ContentResolver that can be used to determine the MIME
6866 * type of the intent's data.
6867 *
6868 * @return The MIME type of this intent, or null if it is unknown or not
6869 * needed.
6870 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006871 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006872 if (mComponent != null) {
6873 return mType;
6874 }
6875 return resolveType(resolver);
6876 }
6877
6878 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006879 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006880 *
6881 * @param category The category to check.
6882 *
6883 * @return boolean True if the intent contains the category, else false.
6884 *
6885 * @see #getCategories
6886 * @see #addCategory
6887 */
6888 public boolean hasCategory(String category) {
6889 return mCategories != null && mCategories.contains(category);
6890 }
6891
6892 /**
6893 * Return the set of all categories in the intent. If there are no categories,
6894 * returns NULL.
6895 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006896 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006897 *
6898 * @see #hasCategory
6899 * @see #addCategory
6900 */
6901 public Set<String> getCategories() {
6902 return mCategories;
6903 }
6904
6905 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006906 * Return the specific selector associated with this Intent. If there is
6907 * none, returns null. See {@link #setSelector} for more information.
6908 *
6909 * @see #setSelector
6910 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006911 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006912 return mSelector;
6913 }
6914
6915 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006916 * Return the {@link ClipData} associated with this Intent. If there is
6917 * none, returns null. See {@link #setClipData} for more information.
6918 *
John Spurlock125d1332013-11-25 11:58:37 -05006919 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006920 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006921 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006922 return mClipData;
6923 }
6924
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006925 /** @hide */
6926 public int getContentUserHint() {
6927 return mContentUserHint;
6928 }
6929
Todd Kennedyb3b431302017-03-20 16:05:48 -07006930 /** @hide */
6931 public String getLaunchToken() {
6932 return mLaunchToken;
6933 }
6934
6935 /** @hide */
6936 public void setLaunchToken(String launchToken) {
6937 mLaunchToken = launchToken;
6938 }
6939
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006940 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006941 * Sets the ClassLoader that will be used when unmarshalling
6942 * any Parcelable values from the extras of this Intent.
6943 *
6944 * @param loader a ClassLoader, or null to use the default loader
6945 * at the time of unmarshalling.
6946 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006947 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006948 if (mExtras != null) {
6949 mExtras.setClassLoader(loader);
6950 }
6951 }
6952
6953 /**
6954 * Returns true if an extra value is associated with the given name.
6955 * @param name the extra's name
6956 * @return true if the given extra is present.
6957 */
6958 public boolean hasExtra(String name) {
6959 return mExtras != null && mExtras.containsKey(name);
6960 }
6961
6962 /**
6963 * Returns true if the Intent's extras contain a parcelled file descriptor.
6964 * @return true if the Intent contains a parcelled file descriptor.
6965 */
6966 public boolean hasFileDescriptors() {
6967 return mExtras != null && mExtras.hasFileDescriptors();
6968 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006969
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006970 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006971 public void setAllowFds(boolean allowFds) {
6972 if (mExtras != null) {
6973 mExtras.setAllowFds(allowFds);
6974 }
6975 }
6976
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006977 /** {@hide} */
6978 public void setDefusable(boolean defusable) {
6979 if (mExtras != null) {
6980 mExtras.setDefusable(defusable);
6981 }
6982 }
6983
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006984 /**
6985 * Retrieve extended data from the intent.
6986 *
6987 * @param name The name of the desired item.
6988 *
6989 * @return the value of an item that previously added with putExtra()
6990 * or null if none was found.
6991 *
6992 * @deprecated
6993 * @hide
6994 */
6995 @Deprecated
6996 public Object getExtra(String name) {
6997 return getExtra(name, null);
6998 }
6999
7000 /**
7001 * Retrieve extended data from the intent.
7002 *
7003 * @param name The name of the desired item.
7004 * @param defaultValue the value to be returned if no value of the desired
7005 * type is stored with the given name.
7006 *
7007 * @return the value of an item that previously added with putExtra()
7008 * or the default value if none was found.
7009 *
7010 * @see #putExtra(String, boolean)
7011 */
7012 public boolean getBooleanExtra(String name, boolean defaultValue) {
7013 return mExtras == null ? defaultValue :
7014 mExtras.getBoolean(name, defaultValue);
7015 }
7016
7017 /**
7018 * Retrieve extended data from the intent.
7019 *
7020 * @param name The name of the desired item.
7021 * @param defaultValue the value to be returned if no value of the desired
7022 * type is stored with the given name.
7023 *
7024 * @return the value of an item that previously added with putExtra()
7025 * or the default value if none was found.
7026 *
7027 * @see #putExtra(String, byte)
7028 */
7029 public byte getByteExtra(String name, byte defaultValue) {
7030 return mExtras == null ? defaultValue :
7031 mExtras.getByte(name, defaultValue);
7032 }
7033
7034 /**
7035 * Retrieve extended data from the intent.
7036 *
7037 * @param name The name of the desired item.
7038 * @param defaultValue the value to be returned if no value of the desired
7039 * type is stored with the given name.
7040 *
7041 * @return the value of an item that previously added with putExtra()
7042 * or the default value if none was found.
7043 *
7044 * @see #putExtra(String, short)
7045 */
7046 public short getShortExtra(String name, short defaultValue) {
7047 return mExtras == null ? defaultValue :
7048 mExtras.getShort(name, defaultValue);
7049 }
7050
7051 /**
7052 * Retrieve extended data from the intent.
7053 *
7054 * @param name The name of the desired item.
7055 * @param defaultValue the value to be returned if no value of the desired
7056 * type is stored with the given name.
7057 *
7058 * @return the value of an item that previously added with putExtra()
7059 * or the default value if none was found.
7060 *
7061 * @see #putExtra(String, char)
7062 */
7063 public char getCharExtra(String name, char defaultValue) {
7064 return mExtras == null ? defaultValue :
7065 mExtras.getChar(name, defaultValue);
7066 }
7067
7068 /**
7069 * Retrieve extended data from the intent.
7070 *
7071 * @param name The name of the desired item.
7072 * @param defaultValue the value to be returned if no value of the desired
7073 * type is stored with the given name.
7074 *
7075 * @return the value of an item that previously added with putExtra()
7076 * or the default value if none was found.
7077 *
7078 * @see #putExtra(String, int)
7079 */
7080 public int getIntExtra(String name, int defaultValue) {
7081 return mExtras == null ? defaultValue :
7082 mExtras.getInt(name, defaultValue);
7083 }
7084
7085 /**
7086 * Retrieve extended data from the intent.
7087 *
7088 * @param name The name of the desired item.
7089 * @param defaultValue the value to be returned if no value of the desired
7090 * type is stored with the given name.
7091 *
7092 * @return the value of an item that previously added with putExtra()
7093 * or the default value if none was found.
7094 *
7095 * @see #putExtra(String, long)
7096 */
7097 public long getLongExtra(String name, long defaultValue) {
7098 return mExtras == null ? defaultValue :
7099 mExtras.getLong(name, defaultValue);
7100 }
7101
7102 /**
7103 * Retrieve extended data from the intent.
7104 *
7105 * @param name The name of the desired item.
7106 * @param defaultValue the value to be returned if no value of the desired
7107 * type is stored with the given name.
7108 *
7109 * @return the value of an item that previously added with putExtra(),
7110 * or the default value if no such item is present
7111 *
7112 * @see #putExtra(String, float)
7113 */
7114 public float getFloatExtra(String name, float defaultValue) {
7115 return mExtras == null ? defaultValue :
7116 mExtras.getFloat(name, defaultValue);
7117 }
7118
7119 /**
7120 * Retrieve extended data from the intent.
7121 *
7122 * @param name The name of the desired item.
7123 * @param defaultValue the value to be returned if no value of the desired
7124 * type is stored with the given name.
7125 *
7126 * @return the value of an item that previously added with putExtra()
7127 * or the default value if none was found.
7128 *
7129 * @see #putExtra(String, double)
7130 */
7131 public double getDoubleExtra(String name, double defaultValue) {
7132 return mExtras == null ? defaultValue :
7133 mExtras.getDouble(name, defaultValue);
7134 }
7135
7136 /**
7137 * Retrieve extended data from the intent.
7138 *
7139 * @param name The name of the desired item.
7140 *
7141 * @return the value of an item that previously added with putExtra()
7142 * or null if no String value was found.
7143 *
7144 * @see #putExtra(String, String)
7145 */
7146 public String getStringExtra(String name) {
7147 return mExtras == null ? null : mExtras.getString(name);
7148 }
7149
7150 /**
7151 * Retrieve extended data from the intent.
7152 *
7153 * @param name The name of the desired item.
7154 *
7155 * @return the value of an item that previously added with putExtra()
7156 * or null if no CharSequence value was found.
7157 *
7158 * @see #putExtra(String, CharSequence)
7159 */
7160 public CharSequence getCharSequenceExtra(String name) {
7161 return mExtras == null ? null : mExtras.getCharSequence(name);
7162 }
7163
7164 /**
7165 * Retrieve extended data from the intent.
7166 *
7167 * @param name The name of the desired item.
7168 *
7169 * @return the value of an item that previously added with putExtra()
7170 * or null if no Parcelable value was found.
7171 *
7172 * @see #putExtra(String, Parcelable)
7173 */
7174 public <T extends Parcelable> T getParcelableExtra(String name) {
7175 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7176 }
7177
7178 /**
7179 * Retrieve extended data from the intent.
7180 *
7181 * @param name The name of the desired item.
7182 *
7183 * @return the value of an item that previously added with putExtra()
7184 * or null if no Parcelable[] value was found.
7185 *
7186 * @see #putExtra(String, Parcelable[])
7187 */
7188 public Parcelable[] getParcelableArrayExtra(String name) {
7189 return mExtras == null ? null : mExtras.getParcelableArray(name);
7190 }
7191
7192 /**
7193 * Retrieve extended data from the intent.
7194 *
7195 * @param name The name of the desired item.
7196 *
7197 * @return the value of an item that previously added with putExtra()
7198 * or null if no ArrayList<Parcelable> value was found.
7199 *
7200 * @see #putParcelableArrayListExtra(String, ArrayList)
7201 */
7202 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
7203 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7204 }
7205
7206 /**
7207 * Retrieve extended data from the intent.
7208 *
7209 * @param name The name of the desired item.
7210 *
7211 * @return the value of an item that previously added with putExtra()
7212 * or null if no Serializable value was found.
7213 *
7214 * @see #putExtra(String, Serializable)
7215 */
7216 public Serializable getSerializableExtra(String name) {
7217 return mExtras == null ? null : mExtras.getSerializable(name);
7218 }
7219
7220 /**
7221 * Retrieve extended data from the intent.
7222 *
7223 * @param name The name of the desired item.
7224 *
7225 * @return the value of an item that previously added with putExtra()
7226 * or null if no ArrayList<Integer> value was found.
7227 *
7228 * @see #putIntegerArrayListExtra(String, ArrayList)
7229 */
7230 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
7231 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7232 }
7233
7234 /**
7235 * Retrieve extended data from the intent.
7236 *
7237 * @param name The name of the desired item.
7238 *
7239 * @return the value of an item that previously added with putExtra()
7240 * or null if no ArrayList<String> value was found.
7241 *
7242 * @see #putStringArrayListExtra(String, ArrayList)
7243 */
7244 public ArrayList<String> getStringArrayListExtra(String name) {
7245 return mExtras == null ? null : mExtras.getStringArrayList(name);
7246 }
7247
7248 /**
7249 * Retrieve extended data from the intent.
7250 *
7251 * @param name The name of the desired item.
7252 *
7253 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007254 * or null if no ArrayList<CharSequence> value was found.
7255 *
7256 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7257 */
7258 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
7259 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7260 }
7261
7262 /**
7263 * Retrieve extended data from the intent.
7264 *
7265 * @param name The name of the desired item.
7266 *
7267 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007268 * or null if no boolean array value was found.
7269 *
7270 * @see #putExtra(String, boolean[])
7271 */
7272 public boolean[] getBooleanArrayExtra(String name) {
7273 return mExtras == null ? null : mExtras.getBooleanArray(name);
7274 }
7275
7276 /**
7277 * Retrieve extended data from the intent.
7278 *
7279 * @param name The name of the desired item.
7280 *
7281 * @return the value of an item that previously added with putExtra()
7282 * or null if no byte array value was found.
7283 *
7284 * @see #putExtra(String, byte[])
7285 */
7286 public byte[] getByteArrayExtra(String name) {
7287 return mExtras == null ? null : mExtras.getByteArray(name);
7288 }
7289
7290 /**
7291 * Retrieve extended data from the intent.
7292 *
7293 * @param name The name of the desired item.
7294 *
7295 * @return the value of an item that previously added with putExtra()
7296 * or null if no short array value was found.
7297 *
7298 * @see #putExtra(String, short[])
7299 */
7300 public short[] getShortArrayExtra(String name) {
7301 return mExtras == null ? null : mExtras.getShortArray(name);
7302 }
7303
7304 /**
7305 * Retrieve extended data from the intent.
7306 *
7307 * @param name The name of the desired item.
7308 *
7309 * @return the value of an item that previously added with putExtra()
7310 * or null if no char array value was found.
7311 *
7312 * @see #putExtra(String, char[])
7313 */
7314 public char[] getCharArrayExtra(String name) {
7315 return mExtras == null ? null : mExtras.getCharArray(name);
7316 }
7317
7318 /**
7319 * Retrieve extended data from the intent.
7320 *
7321 * @param name The name of the desired item.
7322 *
7323 * @return the value of an item that previously added with putExtra()
7324 * or null if no int array value was found.
7325 *
7326 * @see #putExtra(String, int[])
7327 */
7328 public int[] getIntArrayExtra(String name) {
7329 return mExtras == null ? null : mExtras.getIntArray(name);
7330 }
7331
7332 /**
7333 * Retrieve extended data from the intent.
7334 *
7335 * @param name The name of the desired item.
7336 *
7337 * @return the value of an item that previously added with putExtra()
7338 * or null if no long array value was found.
7339 *
7340 * @see #putExtra(String, long[])
7341 */
7342 public long[] getLongArrayExtra(String name) {
7343 return mExtras == null ? null : mExtras.getLongArray(name);
7344 }
7345
7346 /**
7347 * Retrieve extended data from the intent.
7348 *
7349 * @param name The name of the desired item.
7350 *
7351 * @return the value of an item that previously added with putExtra()
7352 * or null if no float array value was found.
7353 *
7354 * @see #putExtra(String, float[])
7355 */
7356 public float[] getFloatArrayExtra(String name) {
7357 return mExtras == null ? null : mExtras.getFloatArray(name);
7358 }
7359
7360 /**
7361 * Retrieve extended data from the intent.
7362 *
7363 * @param name The name of the desired item.
7364 *
7365 * @return the value of an item that previously added with putExtra()
7366 * or null if no double array value was found.
7367 *
7368 * @see #putExtra(String, double[])
7369 */
7370 public double[] getDoubleArrayExtra(String name) {
7371 return mExtras == null ? null : mExtras.getDoubleArray(name);
7372 }
7373
7374 /**
7375 * Retrieve extended data from the intent.
7376 *
7377 * @param name The name of the desired item.
7378 *
7379 * @return the value of an item that previously added with putExtra()
7380 * or null if no String array value was found.
7381 *
7382 * @see #putExtra(String, String[])
7383 */
7384 public String[] getStringArrayExtra(String name) {
7385 return mExtras == null ? null : mExtras.getStringArray(name);
7386 }
7387
7388 /**
7389 * Retrieve extended data from the intent.
7390 *
7391 * @param name The name of the desired item.
7392 *
7393 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007394 * or null if no CharSequence array value was found.
7395 *
7396 * @see #putExtra(String, CharSequence[])
7397 */
7398 public CharSequence[] getCharSequenceArrayExtra(String name) {
7399 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7400 }
7401
7402 /**
7403 * Retrieve extended data from the intent.
7404 *
7405 * @param name The name of the desired item.
7406 *
7407 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007408 * or null if no Bundle value was found.
7409 *
7410 * @see #putExtra(String, Bundle)
7411 */
7412 public Bundle getBundleExtra(String name) {
7413 return mExtras == null ? null : mExtras.getBundle(name);
7414 }
7415
7416 /**
7417 * Retrieve extended data from the intent.
7418 *
7419 * @param name The name of the desired item.
7420 *
7421 * @return the value of an item that previously added with putExtra()
7422 * or null if no IBinder value was found.
7423 *
7424 * @see #putExtra(String, IBinder)
7425 *
7426 * @deprecated
7427 * @hide
7428 */
7429 @Deprecated
7430 public IBinder getIBinderExtra(String name) {
7431 return mExtras == null ? null : mExtras.getIBinder(name);
7432 }
7433
7434 /**
7435 * Retrieve extended data from the intent.
7436 *
7437 * @param name The name of the desired item.
7438 * @param defaultValue The default value to return in case no item is
7439 * associated with the key 'name'
7440 *
7441 * @return the value of an item that previously added with putExtra()
7442 * or defaultValue if none was found.
7443 *
7444 * @see #putExtra
7445 *
7446 * @deprecated
7447 * @hide
7448 */
7449 @Deprecated
7450 public Object getExtra(String name, Object defaultValue) {
7451 Object result = defaultValue;
7452 if (mExtras != null) {
7453 Object result2 = mExtras.get(name);
7454 if (result2 != null) {
7455 result = result2;
7456 }
7457 }
7458
7459 return result;
7460 }
7461
7462 /**
7463 * Retrieves a map of extended data from the intent.
7464 *
7465 * @return the map of all extras previously added with putExtra(),
7466 * or null if none have been added.
7467 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007468 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007469 return (mExtras != null)
7470 ? new Bundle(mExtras)
7471 : null;
7472 }
7473
7474 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007475 * Filter extras to only basic types.
7476 * @hide
7477 */
7478 public void removeUnsafeExtras() {
7479 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007480 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007481 }
7482 }
7483
7484 /**
Makoto Onuki97f82f22017-05-31 16:20:21 -07007485 * @return Whether {@link #maybeStripForHistory} will return an lightened intent or
7486 * return itself as-is.
7487 * @hide
7488 */
7489 public boolean canStripForHistory() {
7490 return ((mExtras != null) && mExtras.isParcelled()) || (mClipData != null);
7491 }
7492
7493 /**
7494 * Call it when the system needs to keep an intent for logging purposes to remove fields
7495 * that are not needed for logging.
7496 * @hide
7497 */
7498 public Intent maybeStripForHistory() {
7499 // TODO Scan and remove possibly heavy instances like Bitmaps from unparcelled extras?
7500
7501 if (!canStripForHistory()) {
7502 return this;
7503 }
7504 return new Intent(this, COPY_MODE_HISTORY);
7505 }
7506
7507 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007508 * Retrieve any special flags associated with this intent. You will
7509 * normally just set them with {@link #setFlags} and let the system
7510 * take the appropriate action with them.
7511 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007512 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007513 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007514 * @see #addFlags
7515 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007516 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007517 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007518 return mFlags;
7519 }
7520
Dianne Hackborne7f97212011-02-24 14:40:20 -08007521 /** @hide */
7522 public boolean isExcludingStopped() {
7523 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7524 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7525 }
7526
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007527 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007528 * Retrieve the application package name this Intent is limited to. When
7529 * resolving an Intent, if non-null this limits the resolution to only
7530 * components in the given application package.
7531 *
7532 * @return The name of the application package for the Intent.
7533 *
7534 * @see #resolveActivity
7535 * @see #setPackage
7536 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007537 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007538 return mPackage;
7539 }
7540
7541 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007542 * Retrieve the concrete component associated with the intent. When receiving
7543 * an intent, this is the component that was found to best handle it (that is,
7544 * yourself) and will always be non-null; in all other cases it will be
7545 * null unless explicitly set.
7546 *
7547 * @return The name of the application component to handle the intent.
7548 *
7549 * @see #resolveActivity
7550 * @see #setComponent
7551 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007552 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007553 return mComponent;
7554 }
7555
7556 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007557 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7558 * used as a hint to the receiver for animations and the like. Null means that there
7559 * is no source bounds.
7560 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007561 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007562 return mSourceBounds;
7563 }
7564
7565 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007566 * Return the Activity component that should be used to handle this intent.
7567 * The appropriate component is determined based on the information in the
7568 * intent, evaluated as follows:
7569 *
7570 * <p>If {@link #getComponent} returns an explicit class, that is returned
7571 * without any further consideration.
7572 *
7573 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7574 * category to be considered.
7575 *
7576 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7577 * action.
7578 *
7579 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7580 * this type.
7581 *
7582 * <p>If {@link #addCategory} has added any categories, the activity must
7583 * handle ALL of the categories specified.
7584 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007585 * <p>If {@link #getPackage} is non-NULL, only activity components in
7586 * that application package will be considered.
7587 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007588 * <p>If there are no activities that satisfy all of these conditions, a
7589 * null string is returned.
7590 *
7591 * <p>If multiple activities are found to satisfy the intent, the one with
7592 * the highest priority will be used. If there are multiple activities
7593 * with the same priority, the system will either pick the best activity
7594 * based on user preference, or resolve to a system class that will allow
7595 * the user to pick an activity and forward from there.
7596 *
7597 * <p>This method is implemented simply by calling
7598 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7599 * true.</p>
7600 * <p> This API is called for you as part of starting an activity from an
7601 * intent. You do not normally need to call it yourself.</p>
7602 *
7603 * @param pm The package manager with which to resolve the Intent.
7604 *
7605 * @return Name of the component implementing an activity that can
7606 * display the intent.
7607 *
7608 * @see #setComponent
7609 * @see #getComponent
7610 * @see #resolveActivityInfo
7611 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007612 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007613 if (mComponent != null) {
7614 return mComponent;
7615 }
7616
7617 ResolveInfo info = pm.resolveActivity(
7618 this, PackageManager.MATCH_DEFAULT_ONLY);
7619 if (info != null) {
7620 return new ComponentName(
7621 info.activityInfo.applicationInfo.packageName,
7622 info.activityInfo.name);
7623 }
7624
7625 return null;
7626 }
7627
7628 /**
7629 * Resolve the Intent into an {@link ActivityInfo}
7630 * describing the activity that should execute the intent. Resolution
7631 * follows the same rules as described for {@link #resolveActivity}, but
7632 * you get back the completely information about the resolved activity
7633 * instead of just its class name.
7634 *
7635 * @param pm The package manager with which to resolve the Intent.
7636 * @param flags Addition information to retrieve as per
7637 * {@link PackageManager#getActivityInfo(ComponentName, int)
7638 * PackageManager.getActivityInfo()}.
7639 *
7640 * @return PackageManager.ActivityInfo
7641 *
7642 * @see #resolveActivity
7643 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007644 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
7645 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007646 ActivityInfo ai = null;
7647 if (mComponent != null) {
7648 try {
7649 ai = pm.getActivityInfo(mComponent, flags);
7650 } catch (PackageManager.NameNotFoundException e) {
7651 // ignore
7652 }
7653 } else {
7654 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007655 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007656 if (info != null) {
7657 ai = info.activityInfo;
7658 }
7659 }
7660
7661 return ai;
7662 }
7663
7664 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007665 * Special function for use by the system to resolve service
7666 * intents to system apps. Throws an exception if there are
7667 * multiple potential matches to the Intent. Returns null if
7668 * there are no matches.
7669 * @hide
7670 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007671 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
7672 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07007673 if (mComponent != null) {
7674 return mComponent;
7675 }
7676
7677 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7678 if (results == null) {
7679 return null;
7680 }
7681 ComponentName comp = null;
7682 for (int i=0; i<results.size(); i++) {
7683 ResolveInfo ri = results.get(i);
7684 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7685 continue;
7686 }
7687 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7688 ri.serviceInfo.name);
7689 if (comp != null) {
7690 throw new IllegalStateException("Multiple system services handle " + this
7691 + ": " + comp + ", " + foundComp);
7692 }
7693 comp = foundComp;
7694 }
7695 return comp;
7696 }
7697
7698 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007699 * Set the general action to be performed.
7700 *
7701 * @param action An action name, such as ACTION_VIEW. Application-specific
7702 * actions should be prefixed with the vendor's package name.
7703 *
7704 * @return Returns the same Intent object, for chaining multiple calls
7705 * into a single statement.
7706 *
7707 * @see #getAction
7708 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007709 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007710 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007711 return this;
7712 }
7713
7714 /**
7715 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007716 * clears any type that was previously set by {@link #setType} or
7717 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007718 *
Nick Pellyccae4122012-01-09 14:12:58 -08007719 * <p><em>Note: scheme matching in the Android framework is
7720 * case-sensitive, unlike the formal RFC. As a result,
7721 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007722 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007723 * {@link #setDataAndNormalize}
7724 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007725 *
Nick Pellyccae4122012-01-09 14:12:58 -08007726 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007727 *
7728 * @return Returns the same Intent object, for chaining multiple calls
7729 * into a single statement.
7730 *
7731 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007732 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007733 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007734 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007735 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007736 mData = data;
7737 mType = null;
7738 return this;
7739 }
7740
7741 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007742 * Normalize and set the data this intent is operating on.
7743 *
7744 * <p>This method automatically clears any type that was
7745 * previously set (for example, by {@link #setType}).
7746 *
7747 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007748 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007749 * so really this is just a convenience method for
7750 * <pre>
7751 * setData(data.normalize())
7752 * </pre>
7753 *
7754 * @param data The Uri of the data this intent is now targeting.
7755 *
7756 * @return Returns the same Intent object, for chaining multiple calls
7757 * into a single statement.
7758 *
7759 * @see #getData
7760 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007761 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007762 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007763 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007764 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007765 }
7766
7767 /**
7768 * Set an explicit MIME data type.
7769 *
7770 * <p>This is used to create intents that only specify a type and not data,
7771 * for example to indicate the type of data to return.
7772 *
7773 * <p>This method automatically clears any data that was
7774 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007775 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007776 * <p><em>Note: MIME type matching in the Android framework is
7777 * case-sensitive, unlike formal RFC MIME types. As a result,
7778 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007779 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7780 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007781 *
7782 * @param type The MIME type of the data being handled by this intent.
7783 *
7784 * @return Returns the same Intent object, for chaining multiple calls
7785 * into a single statement.
7786 *
7787 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007788 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007789 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007790 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007791 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007792 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007793 mData = null;
7794 mType = type;
7795 return this;
7796 }
7797
7798 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007799 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007800 *
Nick Pellyccae4122012-01-09 14:12:58 -08007801 * <p>This is used to create intents that only specify a type and not data,
7802 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007803 *
Nick Pellyccae4122012-01-09 14:12:58 -08007804 * <p>This method automatically clears any data that was
7805 * previously set (for example by {@link #setData}).
7806 *
7807 * <p>The MIME type is normalized using
7808 * {@link #normalizeMimeType} before it is set,
7809 * so really this is just a convenience method for
7810 * <pre>
7811 * setType(Intent.normalizeMimeType(type))
7812 * </pre>
7813 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007814 * @param type The MIME type of the data being handled by this intent.
7815 *
7816 * @return Returns the same Intent object, for chaining multiple calls
7817 * into a single statement.
7818 *
Nick Pellyccae4122012-01-09 14:12:58 -08007819 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007820 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007821 * @see #normalizeMimeType
7822 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007823 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08007824 return setType(normalizeMimeType(type));
7825 }
7826
7827 /**
7828 * (Usually optional) Set the data for the intent along with an explicit
7829 * MIME data type. This method should very rarely be used -- it allows you
7830 * to override the MIME type that would ordinarily be inferred from the
7831 * data with your own type given here.
7832 *
7833 * <p><em>Note: MIME type and Uri scheme matching in the
7834 * Android framework is case-sensitive, unlike the formal RFC definitions.
7835 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007836 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007837 * {@link #setDataAndTypeAndNormalize}
7838 * to ensure that they are converted to lower case.</em>
7839 *
7840 * @param data The Uri of the data this intent is now targeting.
7841 * @param type The MIME type of the data being handled by this intent.
7842 *
7843 * @return Returns the same Intent object, for chaining multiple calls
7844 * into a single statement.
7845 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007846 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007847 * @see #setData
7848 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007849 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007850 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007851 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007852 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007853 mData = data;
7854 mType = type;
7855 return this;
7856 }
7857
7858 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007859 * (Usually optional) Normalize and set both the data Uri and an explicit
7860 * MIME data type. This method should very rarely be used -- it allows you
7861 * to override the MIME type that would ordinarily be inferred from the
7862 * data with your own type given here.
7863 *
7864 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007865 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007866 * before they are set, so really this is just a convenience method for
7867 * <pre>
7868 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7869 * </pre>
7870 *
7871 * @param data The Uri of the data this intent is now targeting.
7872 * @param type The MIME type of the data being handled by this intent.
7873 *
7874 * @return Returns the same Intent object, for chaining multiple calls
7875 * into a single statement.
7876 *
7877 * @see #setType
7878 * @see #setData
7879 * @see #setDataAndType
7880 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007881 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007882 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007883 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007884 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007885 }
7886
7887 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007888 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007889 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007890 * activities that provide <em>all</em> of the requested categories will be
7891 * used.
7892 *
7893 * @param category The desired category. This can be either one of the
7894 * predefined Intent categories, or a custom category in your own
7895 * namespace.
7896 *
7897 * @return Returns the same Intent object, for chaining multiple calls
7898 * into a single statement.
7899 *
7900 * @see #hasCategory
7901 * @see #removeCategory
7902 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007903 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007904 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007905 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007906 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007907 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007908 return this;
7909 }
7910
7911 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007912 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007913 *
7914 * @param category The category to remove.
7915 *
7916 * @see #addCategory
7917 */
7918 public void removeCategory(String category) {
7919 if (mCategories != null) {
7920 mCategories.remove(category);
7921 if (mCategories.size() == 0) {
7922 mCategories = null;
7923 }
7924 }
7925 }
7926
7927 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007928 * Set a selector for this Intent. This is a modification to the kinds of
7929 * things the Intent will match. If the selector is set, it will be used
7930 * when trying to find entities that can handle the Intent, instead of the
7931 * main contents of the Intent. This allows you build an Intent containing
7932 * a generic protocol while targeting it more specifically.
7933 *
7934 * <p>An example of where this may be used is with things like
7935 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7936 * Intent that will launch the Browser application. However, the correct
7937 * main entry point of an application is actually {@link #ACTION_MAIN}
7938 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7939 * used to specify the actual Activity to launch. If you launch the browser
7940 * with something different, undesired behavior may happen if the user has
7941 * previously or later launches it the normal way, since they do not match.
7942 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7943 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7944 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7945 *
7946 * <p>Setting a selector does not impact the behavior of
7947 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7948 * desired behavior of a selector -- it does not impact the base meaning
7949 * of the Intent, just what kinds of things will be matched against it
7950 * when determining who can handle it.</p>
7951 *
7952 * <p>You can not use both a selector and {@link #setPackage(String)} on
7953 * the same base Intent.</p>
7954 *
7955 * @param selector The desired selector Intent; set to null to not use
7956 * a special selector.
7957 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007958 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007959 if (selector == this) {
7960 throw new IllegalArgumentException(
7961 "Intent being set as a selector of itself");
7962 }
7963 if (selector != null && mPackage != null) {
7964 throw new IllegalArgumentException(
7965 "Can't set selector when package name is already set");
7966 }
7967 mSelector = selector;
7968 }
7969
7970 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007971 * Set a {@link ClipData} associated with this Intent. This replaces any
7972 * previously set ClipData.
7973 *
7974 * <p>The ClipData in an intent is not used for Intent matching or other
7975 * such operations. Semantically it is like extras, used to transmit
7976 * additional data with the Intent. The main feature of using this over
7977 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7978 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7979 * items included in the clip data. This is useful, in particular, if
7980 * you want to transmit an Intent containing multiple <code>content:</code>
7981 * URIs for which the recipient may not have global permission to access the
7982 * content provider.
7983 *
7984 * <p>If the ClipData contains items that are themselves Intents, any
7985 * grant flags in those Intents will be ignored. Only the top-level flags
7986 * of the main Intent are respected, and will be applied to all Uri or
7987 * Intent items in the clip (or sub-items of the clip).
7988 *
7989 * <p>The MIME type, label, and icon in the ClipData object are not
7990 * directly used by Intent. Applications should generally rely on the
7991 * MIME type of the Intent itself, not what it may find in the ClipData.
7992 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007993 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007994 *
7995 * @param clip The new clip to set. May be null to clear the current clip.
7996 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007997 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007998 mClipData = clip;
7999 }
8000
8001 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008002 * This is NOT a secure mechanism to identify the user who sent the intent.
8003 * When the intent is sent to a different user, it is used to fix uris by adding the userId
8004 * who sent the intent.
8005 * @hide
8006 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01008007 public void prepareToLeaveUser(int userId) {
8008 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
8009 // We want mContentUserHint to refer to the original user, so don't do anything.
8010 if (mContentUserHint == UserHandle.USER_CURRENT) {
8011 mContentUserHint = userId;
8012 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008013 }
8014
8015 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008016 * 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 boolean 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 #getBooleanExtra(String, boolean)
8029 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008030 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008031 if (mExtras == null) {
8032 mExtras = new Bundle();
8033 }
8034 mExtras.putBoolean(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 byte 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 #getByteExtra(String, byte)
8052 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008053 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008054 if (mExtras == null) {
8055 mExtras = new Bundle();
8056 }
8057 mExtras.putByte(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 char 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 #getCharExtra(String, char)
8075 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008076 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008077 if (mExtras == null) {
8078 mExtras = new Bundle();
8079 }
8080 mExtras.putChar(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 short 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 #getShortExtra(String, short)
8098 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008099 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008100 if (mExtras == null) {
8101 mExtras = new Bundle();
8102 }
8103 mExtras.putShort(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 integer 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 #getIntExtra(String, int)
8121 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008122 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008123 if (mExtras == null) {
8124 mExtras = new Bundle();
8125 }
8126 mExtras.putInt(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 long 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 #getLongExtra(String, long)
8144 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008145 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008146 if (mExtras == null) {
8147 mExtras = new Bundle();
8148 }
8149 mExtras.putLong(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 float 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 #getFloatExtra(String, float)
8167 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008168 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008169 if (mExtras == null) {
8170 mExtras = new Bundle();
8171 }
8172 mExtras.putFloat(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 double 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 #getDoubleExtra(String, double)
8190 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008191 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008192 if (mExtras == null) {
8193 mExtras = new Bundle();
8194 }
8195 mExtras.putDouble(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 String 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 #getStringExtra(String)
8213 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008214 public @NonNull Intent putExtra(String name, String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008215 if (mExtras == null) {
8216 mExtras = new Bundle();
8217 }
8218 mExtras.putString(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 CharSequence 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 #getCharSequenceExtra(String)
8236 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008237 public @NonNull Intent putExtra(String name, CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008238 if (mExtras == null) {
8239 mExtras = new Bundle();
8240 }
8241 mExtras.putCharSequence(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 #getParcelableExtra(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.putParcelable(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 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 #getParcelableArrayExtra(String)
8282 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008283 public @NonNull Intent putExtra(String name, Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008284 if (mExtras == null) {
8285 mExtras = new Bundle();
8286 }
8287 mExtras.putParcelableArray(name, value);
8288 return this;
8289 }
8290
8291 /**
8292 * Add extended data to the intent. The name must include a package
8293 * prefix, for example the app com.android.contacts would use names
8294 * like "com.android.contacts.ShowAll".
8295 *
8296 * @param name The name of the extra data, with package prefix.
8297 * @param value The ArrayList<Parcelable> data value.
8298 *
8299 * @return Returns the same Intent object, for chaining multiple calls
8300 * into a single statement.
8301 *
8302 * @see #putExtras
8303 * @see #removeExtra
8304 * @see #getParcelableArrayListExtra(String)
8305 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008306 public @NonNull Intent putParcelableArrayListExtra(String name,
8307 ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008308 if (mExtras == null) {
8309 mExtras = new Bundle();
8310 }
8311 mExtras.putParcelableArrayList(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<Integer> 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 #getIntegerArrayListExtra(String)
8329 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008330 public @NonNull Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008331 if (mExtras == null) {
8332 mExtras = new Bundle();
8333 }
8334 mExtras.putIntegerArrayList(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.
8344 * @param value The ArrayList<String> 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 #getStringArrayListExtra(String)
8352 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008353 public @NonNull Intent putStringArrayListExtra(String name, ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008354 if (mExtras == null) {
8355 mExtras = new Bundle();
8356 }
8357 mExtras.putStringArrayList(name, value);
8358 return this;
8359 }
8360
8361 /**
8362 * Add extended data to the intent. The name must include a package
8363 * prefix, for example the app com.android.contacts would use names
8364 * like "com.android.contacts.ShowAll".
8365 *
8366 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008367 * @param value The ArrayList<CharSequence> data value.
8368 *
8369 * @return Returns the same Intent object, for chaining multiple calls
8370 * into a single statement.
8371 *
8372 * @see #putExtras
8373 * @see #removeExtra
8374 * @see #getCharSequenceArrayListExtra(String)
8375 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008376 public @NonNull Intent putCharSequenceArrayListExtra(String name,
8377 ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008378 if (mExtras == null) {
8379 mExtras = new Bundle();
8380 }
8381 mExtras.putCharSequenceArrayList(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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008391 * @param value The Serializable 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 #getSerializableExtra(String)
8399 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008400 public @NonNull Intent putExtra(String name, Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008401 if (mExtras == null) {
8402 mExtras = new Bundle();
8403 }
8404 mExtras.putSerializable(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 boolean 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 #getBooleanArrayExtra(String)
8422 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008423 public @NonNull Intent putExtra(String name, boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008424 if (mExtras == null) {
8425 mExtras = new Bundle();
8426 }
8427 mExtras.putBooleanArray(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 byte 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 #getByteArrayExtra(String)
8445 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008446 public @NonNull Intent putExtra(String name, byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008447 if (mExtras == null) {
8448 mExtras = new Bundle();
8449 }
8450 mExtras.putByteArray(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 short 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 #getShortArrayExtra(String)
8468 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008469 public @NonNull Intent putExtra(String name, short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008470 if (mExtras == null) {
8471 mExtras = new Bundle();
8472 }
8473 mExtras.putShortArray(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 char 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 #getCharArrayExtra(String)
8491 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008492 public @NonNull Intent putExtra(String name, char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008493 if (mExtras == null) {
8494 mExtras = new Bundle();
8495 }
8496 mExtras.putCharArray(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 int 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 #getIntArrayExtra(String)
8514 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008515 public @NonNull Intent putExtra(String name, int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008516 if (mExtras == null) {
8517 mExtras = new Bundle();
8518 }
8519 mExtras.putIntArray(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 byte 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 #getLongArrayExtra(String)
8537 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008538 public @NonNull Intent putExtra(String name, long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008539 if (mExtras == null) {
8540 mExtras = new Bundle();
8541 }
8542 mExtras.putLongArray(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 float 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 #getFloatArrayExtra(String)
8560 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008561 public @NonNull Intent putExtra(String name, float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008562 if (mExtras == null) {
8563 mExtras = new Bundle();
8564 }
8565 mExtras.putFloatArray(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 double 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 #getDoubleArrayExtra(String)
8583 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008584 public @NonNull Intent putExtra(String name, double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008585 if (mExtras == null) {
8586 mExtras = new Bundle();
8587 }
8588 mExtras.putDoubleArray(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.
8598 * @param value The String 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 #getStringArrayExtra(String)
8606 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008607 public @NonNull Intent putExtra(String name, String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008608 if (mExtras == null) {
8609 mExtras = new Bundle();
8610 }
8611 mExtras.putStringArray(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.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008621 * @param value The CharSequence array 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 #getCharSequenceArrayExtra(String)
8629 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008630 public @NonNull Intent putExtra(String name, CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008631 if (mExtras == null) {
8632 mExtras = new Bundle();
8633 }
8634 mExtras.putCharSequenceArray(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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008644 * @param value The Bundle 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 #getBundleExtra(String)
8652 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008653 public @NonNull Intent putExtra(String name, Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008654 if (mExtras == null) {
8655 mExtras = new Bundle();
8656 }
8657 mExtras.putBundle(name, value);
8658 return this;
8659 }
8660
8661 /**
8662 * Add extended data to the intent. The name must include a package
8663 * prefix, for example the app com.android.contacts would use names
8664 * like "com.android.contacts.ShowAll".
8665 *
8666 * @param name The name of the extra data, with package prefix.
8667 * @param value The IBinder data value.
8668 *
8669 * @return Returns the same Intent object, for chaining multiple calls
8670 * into a single statement.
8671 *
8672 * @see #putExtras
8673 * @see #removeExtra
8674 * @see #getIBinderExtra(String)
8675 *
8676 * @deprecated
8677 * @hide
8678 */
8679 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008680 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008681 if (mExtras == null) {
8682 mExtras = new Bundle();
8683 }
8684 mExtras.putIBinder(name, value);
8685 return this;
8686 }
8687
8688 /**
8689 * Copy all extras in 'src' in to this intent.
8690 *
8691 * @param src Contains the extras to copy.
8692 *
8693 * @see #putExtra
8694 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008695 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008696 if (src.mExtras != null) {
8697 if (mExtras == null) {
8698 mExtras = new Bundle(src.mExtras);
8699 } else {
8700 mExtras.putAll(src.mExtras);
8701 }
8702 }
8703 return this;
8704 }
8705
8706 /**
8707 * Add a set of extended data to the intent. The keys must include a package
8708 * prefix, for example the app com.android.contacts would use names
8709 * like "com.android.contacts.ShowAll".
8710 *
8711 * @param extras The Bundle of extras to add to this intent.
8712 *
8713 * @see #putExtra
8714 * @see #removeExtra
8715 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008716 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008717 if (mExtras == null) {
8718 mExtras = new Bundle();
8719 }
8720 mExtras.putAll(extras);
8721 return this;
8722 }
8723
8724 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008725 * Completely replace the extras in the Intent with the extras in the
8726 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008727 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008728 * @param src The exact extras contained in this Intent are copied
8729 * into the target intent, replacing any that were previously there.
8730 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008731 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008732 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8733 return this;
8734 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008735
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008736 /**
8737 * Completely replace the extras in the Intent with the given Bundle of
8738 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008739 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008740 * @param extras The new set of extras in the Intent, or null to erase
8741 * all extras.
8742 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008743 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008744 mExtras = extras != null ? new Bundle(extras) : null;
8745 return this;
8746 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008747
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008748 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008749 * Remove extended data from the intent.
8750 *
8751 * @see #putExtra
8752 */
8753 public void removeExtra(String name) {
8754 if (mExtras != null) {
8755 mExtras.remove(name);
8756 if (mExtras.size() == 0) {
8757 mExtras = null;
8758 }
8759 }
8760 }
8761
8762 /**
8763 * Set special flags controlling how this intent is handled. Most values
8764 * here depend on the type of component being executed by the Intent,
8765 * specifically the FLAG_ACTIVITY_* flags are all for use with
8766 * {@link Context#startActivity Context.startActivity()} and the
8767 * FLAG_RECEIVER_* flags are all for use with
8768 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8769 *
Scott Main7aee61f2011-02-08 11:25:01 -08008770 * <p>See the
8771 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8772 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008773 * the behavior of your application.
8774 *
8775 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008776 * @return Returns the same Intent object, for chaining multiple calls
8777 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008778 * @see #getFlags
8779 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008780 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008781 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008782 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008783 mFlags = flags;
8784 return this;
8785 }
8786
8787 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008788 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008789 *
8790 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008791 * @return Returns the same Intent object, for chaining multiple calls into
8792 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008793 * @see #setFlags
8794 * @see #getFlags
8795 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008796 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008797 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008798 mFlags |= flags;
8799 return this;
8800 }
8801
8802 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008803 * Remove these flags from the intent.
8804 *
8805 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008806 * @see #setFlags
8807 * @see #getFlags
8808 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008809 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008810 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008811 mFlags &= ~flags;
8812 }
8813
8814 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008815 * (Usually optional) Set an explicit application package name that limits
8816 * the components this Intent will resolve to. If left to the default
8817 * value of null, all components in all applications will considered.
8818 * If non-null, the Intent can only match the components in the given
8819 * application package.
8820 *
8821 * @param packageName The name of the application package to handle the
8822 * intent, or null to allow any application package.
8823 *
8824 * @return Returns the same Intent object, for chaining multiple calls
8825 * into a single statement.
8826 *
8827 * @see #getPackage
8828 * @see #resolveActivity
8829 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008830 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008831 if (packageName != null && mSelector != null) {
8832 throw new IllegalArgumentException(
8833 "Can't set package name when selector is already set");
8834 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008835 mPackage = packageName;
8836 return this;
8837 }
8838
8839 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008840 * (Usually optional) Explicitly set the component to handle the intent.
8841 * If left with the default value of null, the system will determine the
8842 * appropriate class to use based on the other fields (action, data,
8843 * type, categories) in the Intent. If this class is defined, the
8844 * specified class will always be used regardless of the other fields. You
8845 * should only set this value when you know you absolutely want a specific
8846 * class to be used; otherwise it is better to let the system find the
8847 * appropriate class so that you will respect the installed applications
8848 * and user preferences.
8849 *
8850 * @param component The name of the application component to handle the
8851 * intent, or null to let the system find one for you.
8852 *
8853 * @return Returns the same Intent object, for chaining multiple calls
8854 * into a single statement.
8855 *
8856 * @see #setClass
8857 * @see #setClassName(Context, String)
8858 * @see #setClassName(String, String)
8859 * @see #getComponent
8860 * @see #resolveActivity
8861 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008862 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008863 mComponent = component;
8864 return this;
8865 }
8866
8867 /**
8868 * Convenience for calling {@link #setComponent} with an
8869 * explicit class name.
8870 *
8871 * @param packageContext A Context of the application package implementing
8872 * this class.
8873 * @param className The name of a class inside of the application package
8874 * that will be used as the component for this Intent.
8875 *
8876 * @return Returns the same Intent object, for chaining multiple calls
8877 * into a single statement.
8878 *
8879 * @see #setComponent
8880 * @see #setClass
8881 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008882 public @NonNull Intent setClassName(@NonNull Context packageContext,
8883 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008884 mComponent = new ComponentName(packageContext, className);
8885 return this;
8886 }
8887
8888 /**
8889 * Convenience for calling {@link #setComponent} with an
8890 * explicit application package name and class name.
8891 *
8892 * @param packageName The name of the package implementing the desired
8893 * component.
8894 * @param className The name of a class inside of the application package
8895 * that will be used as the component for this Intent.
8896 *
8897 * @return Returns the same Intent object, for chaining multiple calls
8898 * into a single statement.
8899 *
8900 * @see #setComponent
8901 * @see #setClass
8902 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008903 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008904 mComponent = new ComponentName(packageName, className);
8905 return this;
8906 }
8907
8908 /**
8909 * Convenience for calling {@link #setComponent(ComponentName)} with the
8910 * name returned by a {@link Class} object.
8911 *
8912 * @param packageContext A Context of the application package implementing
8913 * this class.
8914 * @param cls The class name to set, equivalent to
8915 * <code>setClassName(context, cls.getName())</code>.
8916 *
8917 * @return Returns the same Intent object, for chaining multiple calls
8918 * into a single statement.
8919 *
8920 * @see #setComponent
8921 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008922 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008923 mComponent = new ComponentName(packageContext, cls);
8924 return this;
8925 }
8926
8927 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008928 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8929 * used as a hint to the receiver for animations and the like. Null means that there
8930 * is no source bounds.
8931 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008932 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008933 if (r != null) {
8934 mSourceBounds = new Rect(r);
8935 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008936 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008937 }
8938 }
8939
Tor Norbyed9273d62013-05-30 15:59:53 -07008940 /** @hide */
8941 @IntDef(flag = true,
8942 value = {
8943 FILL_IN_ACTION,
8944 FILL_IN_DATA,
8945 FILL_IN_CATEGORIES,
8946 FILL_IN_COMPONENT,
8947 FILL_IN_PACKAGE,
8948 FILL_IN_SOURCE_BOUNDS,
8949 FILL_IN_SELECTOR,
8950 FILL_IN_CLIP_DATA
8951 })
8952 @Retention(RetentionPolicy.SOURCE)
8953 public @interface FillInFlags {}
8954
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008955 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008956 * Use with {@link #fillIn} to allow the current action value to be
8957 * overwritten, even if it is already set.
8958 */
8959 public static final int FILL_IN_ACTION = 1<<0;
8960
8961 /**
8962 * Use with {@link #fillIn} to allow the current data or type value
8963 * overwritten, even if it is already set.
8964 */
8965 public static final int FILL_IN_DATA = 1<<1;
8966
8967 /**
8968 * Use with {@link #fillIn} to allow the current categories to be
8969 * overwritten, even if they are already set.
8970 */
8971 public static final int FILL_IN_CATEGORIES = 1<<2;
8972
8973 /**
8974 * Use with {@link #fillIn} to allow the current component value to be
8975 * overwritten, even if it is already set.
8976 */
8977 public static final int FILL_IN_COMPONENT = 1<<3;
8978
8979 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008980 * Use with {@link #fillIn} to allow the current package value to be
8981 * overwritten, even if it is already set.
8982 */
8983 public static final int FILL_IN_PACKAGE = 1<<4;
8984
8985 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008986 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008987 * overwritten, even if it is already set.
8988 */
8989 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8990
8991 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008992 * Use with {@link #fillIn} to allow the current selector to be
8993 * overwritten, even if it is already set.
8994 */
8995 public static final int FILL_IN_SELECTOR = 1<<6;
8996
8997 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008998 * Use with {@link #fillIn} to allow the current ClipData to be
8999 * overwritten, even if it is already set.
9000 */
9001 public static final int FILL_IN_CLIP_DATA = 1<<7;
9002
9003 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009004 * Copy the contents of <var>other</var> in to this object, but only
9005 * where fields are not defined by this object. For purposes of a field
9006 * being defined, the following pieces of data in the Intent are
9007 * considered to be separate fields:
9008 *
9009 * <ul>
9010 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08009011 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009012 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
9013 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009014 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009015 * <li> component, as set by {@link #setComponent(ComponentName)} or
9016 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009017 * <li> source bounds, as set by {@link #setSourceBounds}.
9018 * <li> selector, as set by {@link #setSelector(Intent)}.
9019 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009020 * <li> each top-level name in the associated extras.
9021 * </ul>
9022 *
9023 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009024 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009025 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
9026 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
9027 * the restriction where the corresponding field will not be replaced if
9028 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009029 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009030 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
9031 * is explicitly specified. The selector will only be copied if
9032 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07009033 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009034 * <p>For example, consider Intent A with {data="foo", categories="bar"}
9035 * and Intent B with {action="gotit", data-type="some/thing",
9036 * categories="one","two"}.
9037 *
9038 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
9039 * containing: {action="gotit", data-type="some/thing",
9040 * categories="bar"}.
9041 *
9042 * @param other Another Intent whose values are to be used to fill in
9043 * the current one.
9044 * @param flags Options to control which fields can be filled in.
9045 *
9046 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009047 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07009048 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08009049 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07009050 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009051 */
Tor Norbyed9273d62013-05-30 15:59:53 -07009052 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009053 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009054 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009055 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009056 if (other.mAction != null
9057 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009058 mAction = other.mAction;
9059 changes |= FILL_IN_ACTION;
9060 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009061 if ((other.mData != null || other.mType != null)
9062 && ((mData == null && mType == null)
9063 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009064 mData = other.mData;
9065 mType = other.mType;
9066 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009067 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009068 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009069 if (other.mCategories != null
9070 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009071 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009072 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009073 }
9074 changes |= FILL_IN_CATEGORIES;
9075 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009076 if (other.mPackage != null
9077 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009078 // Only do this if mSelector is not set.
9079 if (mSelector == null) {
9080 mPackage = other.mPackage;
9081 changes |= FILL_IN_PACKAGE;
9082 }
9083 }
9084 // Selector is special: it can only be set if explicitly allowed,
9085 // for the same reason as the component name.
9086 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
9087 if (mPackage == null) {
9088 mSelector = new Intent(other.mSelector);
9089 mPackage = null;
9090 changes |= FILL_IN_SELECTOR;
9091 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009092 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009093 if (other.mClipData != null
9094 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
9095 mClipData = other.mClipData;
9096 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009097 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009098 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009099 // Component is special: it can -only- be set if explicitly allowed,
9100 // since otherwise the sender could force the intent somewhere the
9101 // originator didn't intend.
9102 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009103 mComponent = other.mComponent;
9104 changes |= FILL_IN_COMPONENT;
9105 }
9106 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009107 if (other.mSourceBounds != null
9108 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
9109 mSourceBounds = new Rect(other.mSourceBounds);
9110 changes |= FILL_IN_SOURCE_BOUNDS;
9111 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009112 if (mExtras == null) {
9113 if (other.mExtras != null) {
9114 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009115 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009116 }
9117 } else if (other.mExtras != null) {
9118 try {
9119 Bundle newb = new Bundle(other.mExtras);
9120 newb.putAll(mExtras);
9121 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009122 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009123 } catch (RuntimeException e) {
9124 // Modifying the extras can cause us to unparcel the contents
9125 // of the bundle, and if we do this in the system process that
9126 // may fail. We really should handle this (i.e., the Bundle
9127 // impl shouldn't be on top of a plain map), but for now just
9128 // ignore it and keep the original contents. :(
9129 Log.w("Intent", "Failure filling in extras", e);
9130 }
9131 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009132 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9133 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9134 mContentUserHint = other.mContentUserHint;
9135 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009136 return changes;
9137 }
9138
9139 /**
9140 * Wrapper class holding an Intent and implementing comparisons on it for
9141 * the purpose of filtering. The class implements its
9142 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9143 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9144 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9145 * on the wrapped Intent.
9146 */
9147 public static final class FilterComparison {
9148 private final Intent mIntent;
9149 private final int mHashCode;
9150
9151 public FilterComparison(Intent intent) {
9152 mIntent = intent;
9153 mHashCode = intent.filterHashCode();
9154 }
9155
9156 /**
9157 * Return the Intent that this FilterComparison represents.
9158 * @return Returns the Intent held by the FilterComparison. Do
9159 * not modify!
9160 */
9161 public Intent getIntent() {
9162 return mIntent;
9163 }
9164
9165 @Override
9166 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009167 if (obj instanceof FilterComparison) {
9168 Intent other = ((FilterComparison)obj).mIntent;
9169 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009170 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009171 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009172 }
9173
9174 @Override
9175 public int hashCode() {
9176 return mHashCode;
9177 }
9178 }
9179
9180 /**
9181 * Determine if two intents are the same for the purposes of intent
9182 * resolution (filtering). That is, if their action, data, type,
9183 * class, and categories are the same. This does <em>not</em> compare
9184 * any extra data included in the intents.
9185 *
9186 * @param other The other Intent to compare against.
9187 *
9188 * @return Returns true if action, data, type, class, and categories
9189 * are the same.
9190 */
9191 public boolean filterEquals(Intent other) {
9192 if (other == null) {
9193 return false;
9194 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009195 if (!Objects.equals(this.mAction, other.mAction)) return false;
9196 if (!Objects.equals(this.mData, other.mData)) return false;
9197 if (!Objects.equals(this.mType, other.mType)) return false;
9198 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9199 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9200 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009201
9202 return true;
9203 }
9204
9205 /**
9206 * Generate hash code that matches semantics of filterEquals().
9207 *
9208 * @return Returns the hash value of the action, data, type, class, and
9209 * categories.
9210 *
9211 * @see #filterEquals
9212 */
9213 public int filterHashCode() {
9214 int code = 0;
9215 if (mAction != null) {
9216 code += mAction.hashCode();
9217 }
9218 if (mData != null) {
9219 code += mData.hashCode();
9220 }
9221 if (mType != null) {
9222 code += mType.hashCode();
9223 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009224 if (mPackage != null) {
9225 code += mPackage.hashCode();
9226 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009227 if (mComponent != null) {
9228 code += mComponent.hashCode();
9229 }
9230 if (mCategories != null) {
9231 code += mCategories.hashCode();
9232 }
9233 return code;
9234 }
9235
9236 @Override
9237 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009238 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009239
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009240 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009241 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009242 b.append(" }");
9243
9244 return b.toString();
9245 }
9246
9247 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009248 public String toInsecureString() {
9249 StringBuilder b = new StringBuilder(128);
9250
9251 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009252 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009253 b.append(" }");
9254
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009255 return b.toString();
9256 }
Romain Guy4969af72009-06-17 10:53:19 -07009257
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009258 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009259 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009260 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009261
9262 b.append("Intent { ");
9263 toShortString(b, false, true, true, true);
9264 b.append(" }");
9265
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009266 return b.toString();
9267 }
9268
9269 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009270 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9271 StringBuilder b = new StringBuilder(128);
9272 toShortString(b, secure, comp, extras, clip);
9273 return b.toString();
9274 }
9275
9276 /** @hide */
9277 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9278 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009279 boolean first = true;
9280 if (mAction != null) {
9281 b.append("act=").append(mAction);
9282 first = false;
9283 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009284 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009285 if (!first) {
9286 b.append(' ');
9287 }
9288 first = false;
9289 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009290 for (int i=0; i<mCategories.size(); i++) {
9291 if (i > 0) b.append(',');
9292 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009293 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009294 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009295 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009296 if (mData != null) {
9297 if (!first) {
9298 b.append(' ');
9299 }
9300 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009301 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009302 if (secure) {
9303 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009304 } else {
9305 b.append(mData);
9306 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009307 }
9308 if (mType != null) {
9309 if (!first) {
9310 b.append(' ');
9311 }
9312 first = false;
9313 b.append("typ=").append(mType);
9314 }
9315 if (mFlags != 0) {
9316 if (!first) {
9317 b.append(' ');
9318 }
9319 first = false;
9320 b.append("flg=0x").append(Integer.toHexString(mFlags));
9321 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009322 if (mPackage != null) {
9323 if (!first) {
9324 b.append(' ');
9325 }
9326 first = false;
9327 b.append("pkg=").append(mPackage);
9328 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009329 if (comp && mComponent != null) {
9330 if (!first) {
9331 b.append(' ');
9332 }
9333 first = false;
9334 b.append("cmp=").append(mComponent.flattenToShortString());
9335 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009336 if (mSourceBounds != null) {
9337 if (!first) {
9338 b.append(' ');
9339 }
9340 first = false;
9341 b.append("bnds=").append(mSourceBounds.toShortString());
9342 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009343 if (mClipData != null) {
9344 if (!first) {
9345 b.append(' ');
9346 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009347 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009348 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009349 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009350 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009351 if (mClipData.getDescription() != null) {
9352 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9353 } else {
9354 first = true;
9355 }
9356 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009357 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009358 first = false;
9359 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009360 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009361 if (extras && mExtras != null) {
9362 if (!first) {
9363 b.append(' ');
9364 }
9365 first = false;
9366 b.append("(has extras)");
9367 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009368 if (mContentUserHint != UserHandle.USER_CURRENT) {
9369 if (!first) {
9370 b.append(' ');
9371 }
9372 first = false;
9373 b.append("u=").append(mContentUserHint);
9374 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009375 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009376 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009377 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009378 b.append("}");
9379 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009380 }
9381
Yi Jin129fc6c2017-09-28 15:48:38 -07009382 /** @hide */
9383 public void writeToProto(ProtoOutputStream proto, long fieldId, boolean secure, boolean comp,
9384 boolean extras, boolean clip) {
9385 long token = proto.start(fieldId);
9386 if (mAction != null) {
9387 proto.write(IntentProto.ACTION, mAction);
9388 }
9389 if (mCategories != null) {
9390 for (String category : mCategories) {
9391 proto.write(IntentProto.CATEGORIES, category);
9392 }
9393 }
9394 if (mData != null) {
9395 proto.write(IntentProto.DATA, secure ? mData.toSafeString() : mData.toString());
9396 }
9397 if (mType != null) {
9398 proto.write(IntentProto.TYPE, mType);
9399 }
9400 if (mFlags != 0) {
9401 proto.write(IntentProto.FLAG, "0x" + Integer.toHexString(mFlags));
9402 }
9403 if (mPackage != null) {
9404 proto.write(IntentProto.PACKAGE, mPackage);
9405 }
9406 if (comp && mComponent != null) {
9407 proto.write(IntentProto.COMPONENT, mComponent.flattenToShortString());
9408 }
9409 if (mSourceBounds != null) {
9410 proto.write(IntentProto.SOURCE_BOUNDS, mSourceBounds.toShortString());
9411 }
9412 if (mClipData != null) {
9413 StringBuilder b = new StringBuilder();
9414 if (clip) {
9415 mClipData.toShortString(b);
9416 } else {
9417 mClipData.toShortStringShortItems(b, false);
9418 }
9419 proto.write(IntentProto.CLIP_DATA, b.toString());
9420 }
9421 if (extras && mExtras != null) {
9422 proto.write(IntentProto.EXTRAS, mExtras.toShortString());
9423 }
9424 if (mContentUserHint != 0) {
9425 proto.write(IntentProto.CONTENT_USER_HINT, mContentUserHint);
9426 }
9427 if (mSelector != null) {
9428 proto.write(IntentProto.SELECTOR, mSelector.toShortString(secure, comp, extras, clip));
9429 }
9430 proto.end(token);
9431 }
9432
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009433 /**
9434 * Call {@link #toUri} with 0 flags.
9435 * @deprecated Use {@link #toUri} instead.
9436 */
9437 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009438 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009439 return toUri(0);
9440 }
9441
9442 /**
9443 * Convert this Intent into a String holding a URI representation of it.
9444 * The returned URI string has been properly URI encoded, so it can be
9445 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9446 * Intent's data as the base URI, with an additional fragment describing
9447 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009448 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009449 * <p>You can convert the returned string back to an Intent with
9450 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009451 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009452 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009453 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009454 * @return Returns a URI encoding URI string describing the entire contents
9455 * of the Intent.
9456 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009457 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009458 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009459 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9460 if (mPackage == null) {
9461 throw new IllegalArgumentException(
9462 "Intent must include an explicit package name to build an android-app: "
9463 + this);
9464 }
9465 uri.append("android-app://");
9466 uri.append(mPackage);
9467 String scheme = null;
9468 if (mData != null) {
9469 scheme = mData.getScheme();
9470 if (scheme != null) {
9471 uri.append('/');
9472 uri.append(scheme);
9473 String authority = mData.getEncodedAuthority();
9474 if (authority != null) {
9475 uri.append('/');
9476 uri.append(authority);
9477 String path = mData.getEncodedPath();
9478 if (path != null) {
9479 uri.append(path);
9480 }
9481 String queryParams = mData.getEncodedQuery();
9482 if (queryParams != null) {
9483 uri.append('?');
9484 uri.append(queryParams);
9485 }
9486 String fragment = mData.getEncodedFragment();
9487 if (fragment != null) {
9488 uri.append('#');
9489 uri.append(fragment);
9490 }
9491 }
9492 }
9493 }
9494 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9495 mPackage, flags);
9496 return uri.toString();
9497 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009498 String scheme = null;
9499 if (mData != null) {
9500 String data = mData.toString();
9501 if ((flags&URI_INTENT_SCHEME) != 0) {
9502 final int N = data.length();
9503 for (int i=0; i<N; i++) {
9504 char c = data.charAt(i);
9505 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
Christopher Schuster42c3a6e2017-07-21 14:53:52 -07009506 || (c >= '0' && c <= '9') || c == '.' || c == '-' || c == '+') {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009507 continue;
9508 }
9509 if (c == ':' && i > 0) {
9510 // Valid scheme.
9511 scheme = data.substring(0, i);
9512 uri.append("intent:");
9513 data = data.substring(i+1);
9514 break;
9515 }
Tom Taylord4a47292009-12-21 13:59:18 -08009516
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009517 // No scheme.
9518 break;
9519 }
9520 }
9521 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009522
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009523 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9524 uri.append("intent:");
9525 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009526
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009527 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009528
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009529 return uri.toString();
9530 }
9531
9532 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9533 String defPackage, int flags) {
9534 StringBuilder frag = new StringBuilder(128);
9535
9536 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009537 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009538 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009539 // Note that for now we are not going to try to handle the
9540 // data part; not clear how to represent this as a URI, and
9541 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009542 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9543 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009544 }
9545
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009546 if (frag.length() > 0) {
9547 uri.append("#Intent;");
9548 uri.append(frag);
9549 uri.append("end");
9550 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009551 }
9552
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009553 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9554 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009555 if (scheme != null) {
9556 uri.append("scheme=").append(scheme).append(';');
9557 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009558 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009559 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009560 }
9561 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009562 for (int i=0; i<mCategories.size(); i++) {
9563 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009564 }
9565 }
9566 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009567 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009568 }
9569 if (mFlags != 0) {
9570 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9571 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009572 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009573 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9574 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009575 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009576 uri.append("component=").append(Uri.encode(
9577 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009578 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009579 if (mSourceBounds != null) {
9580 uri.append("sourceBounds=")
9581 .append(Uri.encode(mSourceBounds.flattenToString()))
9582 .append(';');
9583 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009584 if (mExtras != null) {
9585 for (String key : mExtras.keySet()) {
9586 final Object value = mExtras.get(key);
9587 char entryType =
9588 value instanceof String ? 'S' :
9589 value instanceof Boolean ? 'B' :
9590 value instanceof Byte ? 'b' :
9591 value instanceof Character ? 'c' :
9592 value instanceof Double ? 'd' :
9593 value instanceof Float ? 'f' :
9594 value instanceof Integer ? 'i' :
9595 value instanceof Long ? 'l' :
9596 value instanceof Short ? 's' :
9597 '\0';
9598
9599 if (entryType != '\0') {
9600 uri.append(entryType);
9601 uri.append('.');
9602 uri.append(Uri.encode(key));
9603 uri.append('=');
9604 uri.append(Uri.encode(value.toString()));
9605 uri.append(';');
9606 }
9607 }
9608 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009609 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009610
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009611 public int describeContents() {
9612 return (mExtras != null) ? mExtras.describeContents() : 0;
9613 }
9614
9615 public void writeToParcel(Parcel out, int flags) {
9616 out.writeString(mAction);
9617 Uri.writeToParcel(out, mData);
9618 out.writeString(mType);
9619 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009620 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009621 ComponentName.writeToParcel(mComponent, out);
9622
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009623 if (mSourceBounds != null) {
9624 out.writeInt(1);
9625 mSourceBounds.writeToParcel(out, flags);
9626 } else {
9627 out.writeInt(0);
9628 }
9629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009630 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009631 final int N = mCategories.size();
9632 out.writeInt(N);
9633 for (int i=0; i<N; i++) {
9634 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009635 }
9636 } else {
9637 out.writeInt(0);
9638 }
9639
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009640 if (mSelector != null) {
9641 out.writeInt(1);
9642 mSelector.writeToParcel(out, flags);
9643 } else {
9644 out.writeInt(0);
9645 }
9646
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009647 if (mClipData != null) {
9648 out.writeInt(1);
9649 mClipData.writeToParcel(out, flags);
9650 } else {
9651 out.writeInt(0);
9652 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009653 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009654 out.writeBundle(mExtras);
9655 }
9656
9657 public static final Parcelable.Creator<Intent> CREATOR
9658 = new Parcelable.Creator<Intent>() {
9659 public Intent createFromParcel(Parcel in) {
9660 return new Intent(in);
9661 }
9662 public Intent[] newArray(int size) {
9663 return new Intent[size];
9664 }
9665 };
9666
Dianne Hackborneb034652009-09-07 00:49:58 -07009667 /** @hide */
9668 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009669 readFromParcel(in);
9670 }
9671
9672 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009673 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009674 mData = Uri.CREATOR.createFromParcel(in);
9675 mType = in.readString();
9676 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009677 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009678 mComponent = ComponentName.readFromParcel(in);
9679
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009680 if (in.readInt() != 0) {
9681 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9682 }
9683
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009684 int N = in.readInt();
9685 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009686 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009687 int i;
9688 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009689 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009690 }
9691 } else {
9692 mCategories = null;
9693 }
9694
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009695 if (in.readInt() != 0) {
9696 mSelector = new Intent(in);
9697 }
9698
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009699 if (in.readInt() != 0) {
9700 mClipData = new ClipData(in);
9701 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009702 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009703 mExtras = in.readBundle();
9704 }
9705
9706 /**
9707 * Parses the "intent" element (and its children) from XML and instantiates
9708 * an Intent object. The given XML parser should be located at the tag
9709 * where parsing should start (often named "intent"), from which the
9710 * basic action, data, type, and package and class name will be
9711 * retrieved. The function will then parse in to any child elements,
9712 * looking for <category android:name="xxx"> tags to add categories and
9713 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9714 * to the intent.
9715 *
9716 * @param resources The Resources to use when inflating resources.
9717 * @param parser The XML parser pointing at an "intent" tag.
9718 * @param attrs The AttributeSet interface for retrieving extended
9719 * attribute data at the current <var>parser</var> location.
9720 * @return An Intent object matching the XML data.
9721 * @throws XmlPullParserException If there was an XML parsing error.
9722 * @throws IOException If there was an I/O error.
9723 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009724 public static @NonNull Intent parseIntent(@NonNull Resources resources,
9725 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009726 throws XmlPullParserException, IOException {
9727 Intent intent = new Intent();
9728
9729 TypedArray sa = resources.obtainAttributes(attrs,
9730 com.android.internal.R.styleable.Intent);
9731
9732 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9733
9734 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9735 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9736 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9737
9738 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9739 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9740 if (packageName != null && className != null) {
9741 intent.setComponent(new ComponentName(packageName, className));
9742 }
9743
9744 sa.recycle();
9745
9746 int outerDepth = parser.getDepth();
9747 int type;
9748 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9749 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9750 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9751 continue;
9752 }
9753
9754 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009755 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009756 sa = resources.obtainAttributes(attrs,
9757 com.android.internal.R.styleable.IntentCategory);
9758 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9759 sa.recycle();
9760
9761 if (cat != null) {
9762 intent.addCategory(cat);
9763 }
9764 XmlUtils.skipCurrentTag(parser);
9765
Craig Mautner21d24a22014-04-23 11:45:37 -07009766 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009767 if (intent.mExtras == null) {
9768 intent.mExtras = new Bundle();
9769 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009770 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009771 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009772
9773 } else {
9774 XmlUtils.skipCurrentTag(parser);
9775 }
9776 }
9777
9778 return intent;
9779 }
Nick Pellyccae4122012-01-09 14:12:58 -08009780
Craig Mautner21d24a22014-04-23 11:45:37 -07009781 /** @hide */
9782 public void saveToXml(XmlSerializer out) throws IOException {
9783 if (mAction != null) {
9784 out.attribute(null, ATTR_ACTION, mAction);
9785 }
9786 if (mData != null) {
9787 out.attribute(null, ATTR_DATA, mData.toString());
9788 }
9789 if (mType != null) {
9790 out.attribute(null, ATTR_TYPE, mType);
9791 }
9792 if (mComponent != null) {
9793 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9794 }
9795 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9796
9797 if (mCategories != null) {
9798 out.startTag(null, TAG_CATEGORIES);
9799 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9800 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9801 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009802 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009803 }
9804 }
9805
9806 /** @hide */
9807 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9808 XmlPullParserException {
9809 Intent intent = new Intent();
9810 final int outerDepth = in.getDepth();
9811
9812 int attrCount = in.getAttributeCount();
9813 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9814 final String attrName = in.getAttributeName(attrNdx);
9815 final String attrValue = in.getAttributeValue(attrNdx);
9816 if (ATTR_ACTION.equals(attrName)) {
9817 intent.setAction(attrValue);
9818 } else if (ATTR_DATA.equals(attrName)) {
9819 intent.setData(Uri.parse(attrValue));
9820 } else if (ATTR_TYPE.equals(attrName)) {
9821 intent.setType(attrValue);
9822 } else if (ATTR_COMPONENT.equals(attrName)) {
9823 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9824 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009825 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009826 } else {
9827 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9828 }
9829 }
9830
9831 int event;
9832 String name;
9833 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9834 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9835 if (event == XmlPullParser.START_TAG) {
9836 name = in.getName();
9837 if (TAG_CATEGORIES.equals(name)) {
9838 attrCount = in.getAttributeCount();
9839 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9840 intent.addCategory(in.getAttributeValue(attrNdx));
9841 }
9842 } else {
9843 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9844 XmlUtils.skipCurrentTag(in);
9845 }
9846 }
9847 }
9848
9849 return intent;
9850 }
9851
Nick Pellyccae4122012-01-09 14:12:58 -08009852 /**
9853 * Normalize a MIME data type.
9854 *
9855 * <p>A normalized MIME type has white-space trimmed,
9856 * content-type parameters removed, and is lower-case.
9857 * This aligns the type with Android best practices for
9858 * intent filtering.
9859 *
9860 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9861 * "text/x-vCard" becomes "text/x-vcard".
9862 *
9863 * <p>All MIME types received from outside Android (such as user input,
9864 * or external sources like Bluetooth, NFC, or the Internet) should
9865 * be normalized before they are used to create an Intent.
9866 *
9867 * @param type MIME data type to normalize
9868 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009869 * @see #setType
9870 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009871 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009872 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08009873 if (type == null) {
9874 return null;
9875 }
9876
Elliott Hughescb64d432013-08-02 10:00:44 -07009877 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009878
9879 final int semicolonIndex = type.indexOf(';');
9880 if (semicolonIndex != -1) {
9881 type = type.substring(0, semicolonIndex);
9882 }
9883 return type;
9884 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009885
9886 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009887 * Prepare this {@link Intent} to leave an app process.
9888 *
9889 * @hide
9890 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009891 public void prepareToLeaveProcess(Context context) {
9892 final boolean leavingPackage = (mComponent == null)
9893 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9894 prepareToLeaveProcess(leavingPackage);
9895 }
9896
9897 /**
9898 * Prepare this {@link Intent} to leave an app process.
9899 *
9900 * @hide
9901 */
9902 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009903 setAllowFds(false);
9904
9905 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009906 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009907 }
9908 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009909 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009910 }
9911
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -07009912 if (mExtras != null && !mExtras.isParcelled()) {
9913 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
9914 if (intent instanceof Intent) {
9915 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
9916 }
9917 }
9918
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009919 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9920 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009921 switch (mAction) {
9922 case ACTION_MEDIA_REMOVED:
9923 case ACTION_MEDIA_UNMOUNTED:
9924 case ACTION_MEDIA_CHECKING:
9925 case ACTION_MEDIA_NOFS:
9926 case ACTION_MEDIA_MOUNTED:
9927 case ACTION_MEDIA_SHARED:
9928 case ACTION_MEDIA_UNSHARED:
9929 case ACTION_MEDIA_BAD_REMOVAL:
9930 case ACTION_MEDIA_UNMOUNTABLE:
9931 case ACTION_MEDIA_EJECT:
9932 case ACTION_MEDIA_SCANNER_STARTED:
9933 case ACTION_MEDIA_SCANNER_FINISHED:
9934 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009935 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9936 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009937 // Ignore legacy actions
9938 break;
9939 default:
9940 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009941 }
9942 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009943
9944 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
9945 && leavingPackage) {
9946 switch (mAction) {
9947 case ACTION_PROVIDER_CHANGED:
Makoto Onuki7d1911f2017-06-09 12:30:09 -07009948 case QuickContact.ACTION_QUICK_CONTACT:
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009949 // Ignore actions that don't need to grant
9950 break;
9951 default:
9952 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
9953 }
9954 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009955 }
9956
9957 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009958 * @hide
9959 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009960 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009961 // We just entered destination process, so we should be able to read all
9962 // parcelables inside.
9963 setDefusable(true);
9964
9965 if (mSelector != null) {
9966 mSelector.prepareToEnterProcess();
9967 }
9968 if (mClipData != null) {
9969 mClipData.prepareToEnterProcess();
9970 }
9971
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009972 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009973 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9974 fixUris(mContentUserHint);
9975 mContentUserHint = UserHandle.USER_CURRENT;
9976 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009977 }
9978 }
9979
9980 /**
9981 * @hide
9982 */
9983 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009984 Uri data = getData();
9985 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009986 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009987 }
9988 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009989 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009990 }
9991 String action = getAction();
9992 if (ACTION_SEND.equals(action)) {
9993 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9994 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009995 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009996 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009997 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009998 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9999 if (streams != null) {
10000 ArrayList<Uri> newStreams = new ArrayList<Uri>();
10001 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010002 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010003 }
10004 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
10005 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010006 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10007 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10008 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10009 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10010 if (output != null) {
10011 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
10012 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010013 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010014 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010015
10016 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010017 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010018 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
10019 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010020 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010021 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010022 * @hide
10023 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010024 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010025 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010026 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010027
10028 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010029 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010030
10031 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010032 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010033 // Inspect contained intents to see if we need to migrate extras. We
10034 // don't promote ClipData to the parent, since ChooserActivity will
10035 // already start the picked item as the caller, and we can't combine
10036 // the flags in a safe way.
10037
10038 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -070010039 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010040 final Intent intent = getParcelableExtra(EXTRA_INTENT);
10041 if (intent != null) {
10042 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -070010043 }
10044 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010045 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010046 try {
10047 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
10048 if (intents != null) {
10049 for (int i = 0; i < intents.length; i++) {
10050 final Intent intent = (Intent) intents[i];
10051 if (intent != null) {
10052 migrated |= intent.migrateExtraStreamToClipData();
10053 }
10054 }
10055 }
10056 } catch (ClassCastException e) {
10057 }
10058 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010059
10060 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010061 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010062 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10063 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
10064 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
10065 if (stream != null || text != null || htmlText != null) {
10066 final ClipData clipData = new ClipData(
10067 null, new String[] { getType() },
10068 new ClipData.Item(text, htmlText, null, stream));
10069 setClipData(clipData);
10070 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010071 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010072 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010073 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010074 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010075
10076 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010077 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010078 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10079 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
10080 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
10081 int num = -1;
10082 if (streams != null) {
10083 num = streams.size();
10084 }
10085 if (texts != null) {
10086 if (num >= 0 && num != texts.size()) {
10087 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010088 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010089 }
10090 num = texts.size();
10091 }
10092 if (htmlTexts != null) {
10093 if (num >= 0 && num != htmlTexts.size()) {
10094 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010095 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010096 }
10097 num = htmlTexts.size();
10098 }
10099 if (num > 0) {
10100 final ClipData clipData = new ClipData(
10101 null, new String[] { getType() },
10102 makeClipItem(streams, texts, htmlTexts, 0));
10103
10104 for (int i = 1; i < num; i++) {
10105 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
10106 }
10107
10108 setClipData(clipData);
10109 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010110 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010111 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010112 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010113 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010114 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10115 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10116 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10117 final Uri output;
10118 try {
10119 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10120 } catch (ClassCastException e) {
10121 return false;
10122 }
10123 if (output != null) {
10124 setClipData(ClipData.newRawUri("", output));
10125 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
10126 return true;
10127 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010128 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010129
10130 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010131 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010132
Michael Wright19859762017-09-18 20:57:58 +010010133 /**
10134 * Convert the dock state to a human readable format.
10135 * @hide
10136 */
10137 public static String dockStateToString(int dock) {
10138 switch (dock) {
10139 case EXTRA_DOCK_STATE_HE_DESK:
10140 return "EXTRA_DOCK_STATE_HE_DESK";
10141 case EXTRA_DOCK_STATE_LE_DESK:
10142 return "EXTRA_DOCK_STATE_LE_DESK";
10143 case EXTRA_DOCK_STATE_CAR:
10144 return "EXTRA_DOCK_STATE_CAR";
10145 case EXTRA_DOCK_STATE_DESK:
10146 return "EXTRA_DOCK_STATE_DESK";
10147 case EXTRA_DOCK_STATE_UNDOCKED:
10148 return "EXTRA_DOCK_STATE_UNDOCKED";
10149 default:
10150 return Integer.toString(dock);
10151 }
10152 }
10153
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010154 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
10155 ArrayList<String> htmlTexts, int which) {
10156 Uri uri = streams != null ? streams.get(which) : null;
10157 CharSequence text = texts != null ? texts.get(which) : null;
10158 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
10159 return new ClipData.Item(text, htmlText, null, uri);
10160 }
Craig Mautnerd00f4742014-03-12 14:17:26 -070010161
10162 /** @hide */
10163 public boolean isDocument() {
10164 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
10165 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010166}