blob: f608fcb1a5dfd4900fbcdc134ac241b3e0faf7ff [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;
Suprabh Shukla96212bc2018-04-10 15:04:51 -070043import android.os.PersistableBundle;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000044import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050045import android.os.ResultReceiver;
46import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070047import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010048import android.os.UserHandle;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070049import android.provider.ContactsContract.QuickContact;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070050import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070051import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050052import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070053import android.provider.OpenableColumns;
Patrick Baumann577d4022018-01-31 16:55:10 +000054import android.text.TextUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050055import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070056import android.util.AttributeSet;
57import android.util.Log;
Yi Jin129fc6c2017-09-28 15:48:38 -070058import android.util.proto.ProtoOutputStream;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070059
Dianne Hackborn2269d1572010-02-24 19:54:22 -080060import com.android.internal.util.XmlUtils;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070061
Jason Monk2f68e8a2016-02-23 17:57:28 -050062import org.xmlpull.v1.XmlPullParser;
63import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070064import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070065
66import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080067import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070068import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070069import java.lang.annotation.Retention;
70import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070071import java.net.URISyntaxException;
72import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080073import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070074import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080075import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070076import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070077import java.util.Set;
78
79/**
80 * An intent is an abstract description of an operation to be performed. It
81 * can be used with {@link Context#startActivity(Intent) startActivity} to
82 * launch an {@link android.app.Activity},
83 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
84 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
85 * and {@link android.content.Context#startService} or
86 * {@link android.content.Context#bindService} to communicate with a
87 * background {@link android.app.Service}.
88 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070089 * <p>An Intent provides a facility for performing late runtime binding between the code in
90 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070091 * can be thought of as the glue between activities. It is basically a passive data structure
92 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070093 *
94 * <div class="special reference">
95 * <h3>Developer Guides</h3>
96 * <p>For information about how to create and resolve intents, read the
97 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
98 * developer guide.</p>
99 * </div>
100 *
101 * <a name="IntentStructure"></a>
102 * <h3>Intent Structure</h3>
103 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700104 *
105 * <ul>
106 * <li> <p><b>action</b> -- The general action to be performed, such as
107 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
108 * etc.</p>
109 * </li>
110 * <li> <p><b>data</b> -- The data to operate on, such as a person record
111 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
112 * </li>
113 * </ul>
114 *
115 *
116 * <p>Some examples of action/data pairs are:</p>
117 *
118 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700119 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700120 * information about the person whose identifier is "1".</p>
121 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700122 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700123 * the phone dialer with the person filled in.</p>
124 * </li>
125 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
126 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700127 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700128 * a particular URI.</p>
129 * </li>
130 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
131 * the phone dialer with the given number filled in.</p>
132 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700133 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700134 * information about the person whose identifier is "1".</p>
135 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700136 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700137 * a list of people, which the user can browse through. This example is a
138 * typical top-level entry into the Contacts application, showing you the
139 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700140 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700141 * being used to start an activity to display that person.</p>
142 * </li>
143 * </ul>
144 *
145 * <p>In addition to these primary attributes, there are a number of secondary
146 * attributes that you can also include with an intent:</p>
147 *
148 * <ul>
149 * <li> <p><b>category</b> -- Gives additional information about the action
150 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
151 * appear in the Launcher as a top-level application, while
152 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
153 * of alternative actions the user can perform on a piece of data.</p>
154 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
155 * intent data. Normally the type is inferred from the data itself.
156 * By setting this attribute, you disable that evaluation and force
157 * an explicit type.</p>
158 * <li> <p><b>component</b> -- Specifies an explicit name of a component
159 * class to use for the intent. Normally this is determined by looking
160 * at the other information in the intent (the action, data/type, and
161 * categories) and matching that with a component that can handle it.
162 * If this attribute is set then none of the evaluation is performed,
163 * and this component is used exactly as is. By specifying this attribute,
164 * all of the other Intent attributes become optional.</p>
165 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
166 * This can be used to provide extended information to the component.
167 * For example, if we have a action to send an e-mail message, we could
168 * also include extra pieces of data here to supply a subject, body,
169 * etc.</p>
170 * </ul>
171 *
172 * <p>Here are some examples of other operations you can specify as intents
173 * using these additional parameters:</p>
174 *
175 * <ul>
176 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
177 * Launch the home screen.</p>
178 * </li>
179 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
180 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
181 * vnd.android.cursor.item/phone}</i></b>
182 * -- Display the list of people's phone numbers, allowing the user to
183 * browse through them and pick one and return it to the parent activity.</p>
184 * </li>
185 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
186 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
187 * -- Display all pickers for data that can be opened with
188 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
189 * allowing the user to pick one of them and then some data inside of it
190 * and returning the resulting URI to the caller. This can be used,
191 * for example, in an e-mail application to allow the user to pick some
192 * data to include as an attachment.</p>
193 * </li>
194 * </ul>
195 *
196 * <p>There are a variety of standard Intent action and category constants
197 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700198 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700199 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700200 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700201 *
202 * <p>Put together, the set of actions, data types, categories, and extra data
203 * defines a language for the system allowing for the expression of phrases
204 * such as "call john smith's cell". As applications are added to the system,
205 * they can extend this language by adding new actions, types, and categories, or
206 * they can modify the behavior of existing phrases by supplying their own
207 * activities that handle them.</p>
208 *
209 * <a name="IntentResolution"></a>
210 * <h3>Intent Resolution</h3>
211 *
212 * <p>There are two primary forms of intents you will use.
213 *
214 * <ul>
215 * <li> <p><b>Explicit Intents</b> have specified a component (via
216 * {@link #setComponent} or {@link #setClass}), which provides the exact
217 * class to be run. Often these will not include any other information,
218 * simply being a way for an application to launch various internal
219 * activities it has as the user interacts with the application.
220 *
221 * <li> <p><b>Implicit Intents</b> have not specified a component;
222 * instead, they must include enough information for the system to
223 * determine which of the available components is best to run for that
224 * intent.
225 * </ul>
226 *
227 * <p>When using implicit intents, given such an arbitrary intent we need to
228 * know what to do with it. This is handled by the process of <em>Intent
229 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
230 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
231 * more activities/receivers) that can handle it.</p>
232 *
233 * <p>The intent resolution mechanism basically revolves around matching an
234 * Intent against all of the &lt;intent-filter&gt; descriptions in the
235 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
236 * objects explicitly registered with {@link Context#registerReceiver}.) More
237 * details on this can be found in the documentation on the {@link
238 * IntentFilter} class.</p>
239 *
240 * <p>There are three pieces of information in the Intent that are used for
241 * resolution: the action, type, and category. Using this information, a query
242 * is done on the {@link PackageManager} for a component that can handle the
243 * intent. The appropriate component is determined based on the intent
244 * information supplied in the <code>AndroidManifest.xml</code> file as
245 * follows:</p>
246 *
247 * <ul>
248 * <li> <p>The <b>action</b>, if given, must be listed by the component as
249 * one it handles.</p>
250 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
251 * already supplied in the Intent. Like the action, if a type is
252 * included in the intent (either explicitly or implicitly in its
253 * data), then this must be listed by the component as one it handles.</p>
254 * <li> For data that is not a <code>content:</code> URI and where no explicit
255 * type is included in the Intent, instead the <b>scheme</b> of the
256 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
257 * considered. Again like the action, if we are matching a scheme it
258 * must be listed by the component as one it can handle.
259 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
260 * by the activity as categories it handles. That is, if you include
261 * the categories {@link #CATEGORY_LAUNCHER} and
262 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
263 * with an intent that lists <em>both</em> of those categories.
264 * Activities will very often need to support the
265 * {@link #CATEGORY_DEFAULT} so that they can be found by
266 * {@link Context#startActivity Context.startActivity()}.</p>
267 * </ul>
268 *
269 * <p>For example, consider the Note Pad sample application that
Joshua Baxter9a841a62018-03-27 14:42:03 -0700270 * allows a user to browse through a list of notes data and view details about
271 * individual items. Text in italics indicates places where you would replace a
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700272 * name with one specific to your own package.</p>
273 *
274 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
275 * package="<i>com.android.notepad</i>"&gt;
276 * &lt;application android:icon="@drawable/app_notes"
277 * android:label="@string/app_name"&gt;
278 *
279 * &lt;provider class=".NotePadProvider"
280 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
281 *
282 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
283 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700284 * &lt;action android:name="android.intent.action.MAIN" /&gt;
285 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700286 * &lt;/intent-filter&gt;
287 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700288 * &lt;action android:name="android.intent.action.VIEW" /&gt;
289 * &lt;action android:name="android.intent.action.EDIT" /&gt;
290 * &lt;action android:name="android.intent.action.PICK" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700293 * &lt;/intent-filter&gt;
294 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700295 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
296 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
297 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700298 * &lt;/intent-filter&gt;
299 * &lt;/activity&gt;
300 *
301 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
302 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700303 * &lt;action android:name="android.intent.action.VIEW" /&gt;
304 * &lt;action android:name="android.intent.action.EDIT" /&gt;
305 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
306 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700307 * &lt;/intent-filter&gt;
308 *
309 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700310 * &lt;action android:name="android.intent.action.INSERT" /&gt;
311 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
312 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700313 * &lt;/intent-filter&gt;
314 *
315 * &lt;/activity&gt;
316 *
317 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
318 * android:theme="@android:style/Theme.Dialog"&gt;
319 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700320 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
321 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
322 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
323 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
324 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700325 * &lt;/intent-filter&gt;
326 * &lt;/activity&gt;
327 *
328 * &lt;/application&gt;
329 * &lt;/manifest&gt;</pre>
330 *
331 * <p>The first activity,
332 * <code>com.android.notepad.NotesList</code>, serves as our main
333 * entry into the app. It can do three things as described by its three intent
334 * templates:
335 * <ol>
336 * <li><pre>
337 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700338 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
339 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700340 * &lt;/intent-filter&gt;</pre>
341 * <p>This provides a top-level entry into the NotePad application: the standard
342 * MAIN action is a main entry point (not requiring any other information in
343 * the Intent), and the LAUNCHER category says that this entry point should be
344 * listed in the application launcher.</p>
345 * <li><pre>
346 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700347 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
348 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
349 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
350 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700351 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700352 * &lt;/intent-filter&gt;</pre>
353 * <p>This declares the things that the activity can do on a directory of
354 * notes. The type being supported is given with the &lt;type&gt; tag, where
355 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
356 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
357 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
358 * The activity allows the user to view or edit the directory of data (via
359 * the VIEW and EDIT actions), or to pick a particular note and return it
360 * to the caller (via the PICK action). Note also the DEFAULT category
361 * supplied here: this is <em>required</em> for the
362 * {@link Context#startActivity Context.startActivity} method to resolve your
363 * activity when its component name is not explicitly specified.</p>
364 * <li><pre>
365 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700366 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
367 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
368 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700369 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700370 * <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 -0700371 * the user without needing to know where it came from. The data type
372 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
373 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
374 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
375 * The GET_CONTENT action is similar to the PICK action, where the activity
376 * will return to its caller a piece of data selected by the user. Here,
377 * however, the caller specifies the type of data they desire instead of
378 * the type of data the user will be picking from.</p>
379 * </ol>
380 *
381 * <p>Given these capabilities, the following intents will resolve to the
382 * NotesList activity:</p>
383 *
384 * <ul>
385 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
386 * activities that can be used as top-level entry points into an
387 * application.</p>
388 * <li> <p><b>{ action=android.app.action.MAIN,
389 * category=android.app.category.LAUNCHER }</b> is the actual intent
390 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700391 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700392 * data=content://com.google.provider.NotePad/notes }</b>
393 * displays a list of all the notes under
394 * "content://com.google.provider.NotePad/notes", which
395 * the user can browse through and see the details on.</p>
396 * <li> <p><b>{ action=android.app.action.PICK
397 * data=content://com.google.provider.NotePad/notes }</b>
398 * provides a list of the notes under
399 * "content://com.google.provider.NotePad/notes", from which
400 * the user can pick a note whose data URL is returned back to the caller.</p>
401 * <li> <p><b>{ action=android.app.action.GET_CONTENT
402 * type=vnd.android.cursor.item/vnd.google.note }</b>
403 * is similar to the pick action, but allows the caller to specify the
404 * kind of data they want back so that the system can find the appropriate
405 * activity to pick something of that data type.</p>
406 * </ul>
407 *
408 * <p>The second activity,
409 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
410 * note entry and allows them to edit it. It can do two things as described
411 * by its two intent templates:
412 * <ol>
413 * <li><pre>
414 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700415 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
416 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
417 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
418 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700419 * &lt;/intent-filter&gt;</pre>
420 * <p>The first, primary, purpose of this activity is to let the user interact
421 * with a single note, as decribed by the MIME type
422 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
423 * either VIEW a note or allow the user to EDIT it. Again we support the
424 * DEFAULT category to allow the activity to be launched without explicitly
425 * specifying its component.</p>
426 * <li><pre>
427 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700428 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
429 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
430 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700431 * &lt;/intent-filter&gt;</pre>
432 * <p>The secondary use of this activity is to insert a new note entry into
433 * an existing directory of notes. This is used when the user creates a new
434 * note: the INSERT action is executed on the directory of notes, causing
435 * this activity to run and have the user create the new note data which
436 * it then adds to the content provider.</p>
437 * </ol>
438 *
439 * <p>Given these capabilities, the following intents will resolve to the
440 * NoteEditor activity:</p>
441 *
442 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700443 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700444 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
445 * shows the user the content of note <var>{ID}</var>.</p>
446 * <li> <p><b>{ action=android.app.action.EDIT
447 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
448 * allows the user to edit the content of note <var>{ID}</var>.</p>
449 * <li> <p><b>{ action=android.app.action.INSERT
450 * data=content://com.google.provider.NotePad/notes }</b>
451 * creates a new, empty note in the notes list at
452 * "content://com.google.provider.NotePad/notes"
453 * and allows the user to edit it. If they keep their changes, the URI
454 * of the newly created note is returned to the caller.</p>
455 * </ul>
456 *
457 * <p>The last activity,
458 * <code>com.android.notepad.TitleEditor</code>, allows the user to
459 * edit the title of a note. This could be implemented as a class that the
460 * application directly invokes (by explicitly setting its component in
461 * the Intent), but here we show a way you can publish alternative
462 * operations on existing data:</p>
463 *
464 * <pre>
465 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700466 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
467 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
468 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
469 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
470 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700471 * &lt;/intent-filter&gt;</pre>
472 *
473 * <p>In the single intent template here, we
474 * have created our own private action called
475 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
476 * edit the title of a note. It must be invoked on a specific note
477 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
478 * view and edit actions, but here displays and edits the title contained
479 * in the note data.
480 *
481 * <p>In addition to supporting the default category as usual, our title editor
482 * also supports two other standard categories: ALTERNATIVE and
483 * SELECTED_ALTERNATIVE. Implementing
484 * these categories allows others to find the special action it provides
485 * without directly knowing about it, through the
486 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
487 * more often to build dynamic menu items with
488 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
489 * template here was also supply an explicit name for the template
490 * (via <code>android:label="@string/resolve_title"</code>) to better control
491 * what the user sees when presented with this activity as an alternative
492 * action to the data they are viewing.
493 *
494 * <p>Given these capabilities, the following intent will resolve to the
495 * TitleEditor activity:</p>
496 *
497 * <ul>
498 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
499 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
500 * displays and allows the user to edit the title associated
501 * with note <var>{ID}</var>.</p>
502 * </ul>
503 *
504 * <h3>Standard Activity Actions</h3>
505 *
506 * <p>These are the current standard actions that Intent defines for launching
507 * activities (usually through {@link Context#startActivity}. The most
508 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
509 * {@link #ACTION_EDIT}.
510 *
511 * <ul>
512 * <li> {@link #ACTION_MAIN}
513 * <li> {@link #ACTION_VIEW}
514 * <li> {@link #ACTION_ATTACH_DATA}
515 * <li> {@link #ACTION_EDIT}
516 * <li> {@link #ACTION_PICK}
517 * <li> {@link #ACTION_CHOOSER}
518 * <li> {@link #ACTION_GET_CONTENT}
519 * <li> {@link #ACTION_DIAL}
520 * <li> {@link #ACTION_CALL}
521 * <li> {@link #ACTION_SEND}
522 * <li> {@link #ACTION_SENDTO}
523 * <li> {@link #ACTION_ANSWER}
524 * <li> {@link #ACTION_INSERT}
525 * <li> {@link #ACTION_DELETE}
526 * <li> {@link #ACTION_RUN}
527 * <li> {@link #ACTION_SYNC}
528 * <li> {@link #ACTION_PICK_ACTIVITY}
529 * <li> {@link #ACTION_SEARCH}
530 * <li> {@link #ACTION_WEB_SEARCH}
531 * <li> {@link #ACTION_FACTORY_TEST}
532 * </ul>
533 *
534 * <h3>Standard Broadcast Actions</h3>
535 *
536 * <p>These are the current standard actions that Intent defines for receiving
537 * broadcasts (usually through {@link Context#registerReceiver} or a
538 * &lt;receiver&gt; tag in a manifest).
539 *
540 * <ul>
541 * <li> {@link #ACTION_TIME_TICK}
542 * <li> {@link #ACTION_TIME_CHANGED}
543 * <li> {@link #ACTION_TIMEZONE_CHANGED}
544 * <li> {@link #ACTION_BOOT_COMPLETED}
545 * <li> {@link #ACTION_PACKAGE_ADDED}
546 * <li> {@link #ACTION_PACKAGE_CHANGED}
547 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800548 * <li> {@link #ACTION_PACKAGE_RESTARTED}
549 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000550 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
551 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700552 * <li> {@link #ACTION_UID_REMOVED}
553 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700554 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700555 * <li> {@link #ACTION_POWER_DISCONNECTED}
556 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700557 * </ul>
558 *
559 * <h3>Standard Categories</h3>
560 *
561 * <p>These are the current standard categories that can be used to further
562 * clarify an Intent via {@link #addCategory}.
563 *
564 * <ul>
565 * <li> {@link #CATEGORY_DEFAULT}
566 * <li> {@link #CATEGORY_BROWSABLE}
567 * <li> {@link #CATEGORY_TAB}
568 * <li> {@link #CATEGORY_ALTERNATIVE}
569 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
570 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800571 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700572 * <li> {@link #CATEGORY_HOME}
573 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700574 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400575 * <li> {@link #CATEGORY_CAR_DOCK}
576 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500577 * <li> {@link #CATEGORY_LE_DESK_DOCK}
578 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200579 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700580 * <li> {@link #CATEGORY_APP_MARKET}
Zak Cohendb6ca492017-01-26 14:09:00 -0800581 * <li> {@link #CATEGORY_VR_HOME}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700582 * </ul>
583 *
584 * <h3>Standard Extra Data</h3>
585 *
586 * <p>These are the current standard fields that can be used as extra data via
587 * {@link #putExtra}.
588 *
589 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800590 * <li> {@link #EXTRA_ALARM_COUNT}
591 * <li> {@link #EXTRA_BCC}
592 * <li> {@link #EXTRA_CC}
593 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
594 * <li> {@link #EXTRA_DATA_REMOVED}
595 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500596 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
597 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800598 * <li> {@link #EXTRA_DOCK_STATE_CAR}
599 * <li> {@link #EXTRA_DOCK_STATE_DESK}
600 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
601 * <li> {@link #EXTRA_DONT_KILL_APP}
602 * <li> {@link #EXTRA_EMAIL}
603 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700604 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800605 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700606 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800607 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700608 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800609 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
610 * <li> {@link #EXTRA_REPLACING}
611 * <li> {@link #EXTRA_SHORTCUT_ICON}
612 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
613 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700614 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800615 * <li> {@link #EXTRA_SHORTCUT_NAME}
616 * <li> {@link #EXTRA_SUBJECT}
617 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800619 * <li> {@link #EXTRA_TITLE}
620 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700621 * </ul>
622 *
623 * <h3>Flags</h3>
624 *
625 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800626 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
627 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700628 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800629public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700630 private static final String ATTR_ACTION = "action";
631 private static final String TAG_CATEGORIES = "categories";
632 private static final String ATTR_CATEGORY = "category";
633 private static final String TAG_EXTRA = "extra";
634 private static final String ATTR_TYPE = "type";
635 private static final String ATTR_COMPONENT = "component";
636 private static final String ATTR_DATA = "data";
637 private static final String ATTR_FLAGS = "flags";
638
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700639 // ---------------------------------------------------------------------
640 // ---------------------------------------------------------------------
641 // Standard intent activity actions (see action variable).
642
643 /**
644 * Activity Action: Start as a main entry point, does not expect to
645 * receive data.
646 * <p>Input: nothing
647 * <p>Output: nothing
648 */
649 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
650 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800651
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700652 /**
653 * Activity Action: Display the data to the user. This is the most common
654 * action performed on data -- it is the generic action you can use on
655 * a piece of data to get the most reasonable thing to occur. For example,
656 * when used on a contacts entry it will view the entry; when used on a
657 * mailto: URI it will bring up a compose window filled with the information
658 * supplied by the URI; when used with a tel: URI it will invoke the
659 * dialer.
660 * <p>Input: {@link #getData} is URI from which to retrieve data.
661 * <p>Output: nothing.
662 */
663 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
664 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800665
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700666 /**
Dianne Hackborna320f012017-04-07 13:57:48 -0700667 * Extra that can be included on activity intents coming from the storage UI
668 * when it launches sub-activities to manage various types of storage. For example,
669 * it may use {@link #ACTION_VIEW} with a "image/*" MIME type to have an app show
670 * the images on the device, and in that case also include this extra to tell the
671 * app it is coming from the storage UI so should help the user manage storage of
672 * this type.
673 */
674 public static final String EXTRA_FROM_STORAGE = "android.intent.extra.FROM_STORAGE";
675
676 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
678 * performed on a piece of data.
679 */
680 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800681
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700682 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900683 * Activity Action: Quick view the data. Launches a quick viewer for
684 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900685 * <p>Activities handling this intent action should handle the vast majority of
686 * MIME types rather than only specific ones.
Garfield Tance1d0e92017-03-23 10:52:48 -0700687 * <p>Quick viewers must render the quick view image locally, and must not send
688 * file content outside current device.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900689 * <p>Input: {@link #getData} is a mandatory content URI of the item to
690 * preview. {@link #getClipData} contains an optional list of content URIs
691 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
692 * optional index of the URI in the clip data to show first.
Garfield Tance1d0e92017-03-23 10:52:48 -0700693 * {@link #EXTRA_QUICK_VIEW_FEATURES} is an optional extra indicating the features
694 * that can be shown in the quick view UI.
Steve McKayc78bcb82015-07-31 14:35:22 -0700695 * <p>Output: nothing.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900696 * @see #EXTRA_INDEX
Garfield Tance1d0e92017-03-23 10:52:48 -0700697 * @see #EXTRA_QUICK_VIEW_FEATURES
Steve McKayc78bcb82015-07-31 14:35:22 -0700698 */
699 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
700 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
701
702 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700703 * Used to indicate that some piece of data should be attached to some other
704 * place. For example, image data could be attached to a contact. It is up
705 * to the recipient to decide where the data should be attached; the intent
706 * does not specify the ultimate destination.
707 * <p>Input: {@link #getData} is URI of data to be attached.
708 * <p>Output: nothing.
709 */
710 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
711 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800712
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700713 /**
714 * Activity Action: Provide explicit editable access to the given data.
715 * <p>Input: {@link #getData} is URI of data to be edited.
716 * <p>Output: nothing.
717 */
718 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
719 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800720
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700721 /**
722 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
723 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
724 * The extras can contain type specific data to pass through to the editing/creating
725 * activity.
726 * <p>Output: The URI of the item that was picked. This must be a content:
727 * URI so that any receiver can access it.
728 */
729 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
730 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800731
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700732 /**
733 * Activity Action: Pick an item from the data, returning what was selected.
734 * <p>Input: {@link #getData} is URI containing a directory of data
735 * (vnd.android.cursor.dir/*) from which to pick an item.
736 * <p>Output: The URI of the item that was picked.
737 */
738 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
739 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800740
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700741 /**
742 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800743 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800744 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
745 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700746 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
747 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800748 * (value: ShortcutIconResource).</p>
749 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800750 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700751 * @see #EXTRA_SHORTCUT_INTENT
752 * @see #EXTRA_SHORTCUT_NAME
753 * @see #EXTRA_SHORTCUT_ICON
754 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
755 * @see android.content.Intent.ShortcutIconResource
756 */
757 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
758 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
759
760 /**
761 * The name of the extra used to define the Intent of a shortcut.
762 *
763 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800764 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700765 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800766 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700767 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
768 /**
769 * The name of the extra used to define the name of a shortcut.
770 *
771 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800772 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700773 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800774 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700775 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
776 /**
777 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
778 *
779 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800780 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700781 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800782 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700783 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
784 /**
785 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
786 *
787 * @see #ACTION_CREATE_SHORTCUT
788 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800789 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700790 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800791 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700792 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
793 "android.intent.extra.shortcut.ICON_RESOURCE";
794
795 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500796 * An activity that provides a user interface for adjusting application preferences.
797 * Optional but recommended settings for all applications which have settings.
798 */
799 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
800 public static final String ACTION_APPLICATION_PREFERENCES
801 = "android.intent.action.APPLICATION_PREFERENCES";
802
803 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700804 * Activity Action: Launch an activity showing the app information.
805 * For applications which install other applications (such as app stores), it is recommended
806 * to handle this action for providing the app information to the user.
807 *
808 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
809 * to be displayed.
810 * <p>Output: Nothing.
811 */
812 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
813 public static final String ACTION_SHOW_APP_INFO
814 = "android.intent.action.SHOW_APP_INFO";
815
816 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800817 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700818 *
819 * @see Intent#ACTION_CREATE_SHORTCUT
820 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800821 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
822 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700823 */
824 public static class ShortcutIconResource implements Parcelable {
825 /**
826 * The package name of the application containing the icon.
827 */
828 public String packageName;
829
830 /**
831 * The resource name of the icon, including package, name and type.
832 */
833 public String resourceName;
834
835 /**
836 * Creates a new ShortcutIconResource for the specified context and resource
837 * identifier.
838 *
839 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700840 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700841 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700842 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700843 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700844 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700845 ShortcutIconResource icon = new ShortcutIconResource();
846 icon.packageName = context.getPackageName();
847 icon.resourceName = context.getResources().getResourceName(resourceId);
848 return icon;
849 }
850
851 /**
852 * Used to read a ShortcutIconResource from a Parcel.
853 */
854 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
855 new Parcelable.Creator<ShortcutIconResource>() {
856
857 public ShortcutIconResource createFromParcel(Parcel source) {
858 ShortcutIconResource icon = new ShortcutIconResource();
859 icon.packageName = source.readString();
860 icon.resourceName = source.readString();
861 return icon;
862 }
863
864 public ShortcutIconResource[] newArray(int size) {
865 return new ShortcutIconResource[size];
866 }
867 };
868
869 /**
870 * No special parcel contents.
871 */
872 public int describeContents() {
873 return 0;
874 }
875
876 public void writeToParcel(Parcel dest, int flags) {
877 dest.writeString(packageName);
878 dest.writeString(resourceName);
879 }
880
881 @Override
882 public String toString() {
883 return resourceName;
884 }
885 }
886
887 /**
888 * Activity Action: Display an activity chooser, allowing the user to pick
889 * what they want to before proceeding. This can be used as an alternative
890 * to the standard activity picker that is displayed by the system when
891 * you try to start an activity with multiple possible matches, with these
892 * differences in behavior:
893 * <ul>
894 * <li>You can specify the title that will appear in the activity chooser.
895 * <li>The user does not have the option to make one of the matching
896 * activities a preferred activity, and all possible activities will
897 * always be shown even if one of them is currently marked as the
898 * preferred activity.
899 * </ul>
900 * <p>
901 * This action should be used when the user will naturally expect to
902 * select an activity in order to proceed. An example if when not to use
903 * it is when the user clicks on a "mailto:" link. They would naturally
904 * expect to go directly to their mail app, so startActivity() should be
905 * called directly: it will
906 * either launch the current preferred app, or put up a dialog allowing the
907 * user to pick an app to use and optionally marking that as preferred.
908 * <p>
909 * In contrast, if the user is selecting a menu item to send a picture
910 * they are viewing to someone else, there are many different things they
911 * may want to do at this point: send it through e-mail, upload it to a
912 * web service, etc. In this case the CHOOSER action should be used, to
913 * always present to the user a list of the things they can do, with a
914 * nice title given by the caller such as "Send this photo with:".
915 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700916 * If you need to grant URI permissions through a chooser, you must specify
917 * the permissions to be granted on the ACTION_CHOOSER Intent
918 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
919 * {@link #setClipData} to specify the URIs to be granted as well as
920 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
921 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
922 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700923 * As a convenience, an Intent of this form can be created with the
924 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700925 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700926 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700927 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
928 * and can optionally have a {@link #EXTRA_TITLE} field containing the
929 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700930 * <p>
931 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700932 */
933 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
934 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
935
936 /**
937 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
938 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700939 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
940 * target intent, also optionally supplying a title. If the target
941 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
942 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
943 * set in the returned chooser intent, with its ClipData set appropriately:
944 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500945 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700946 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700947 * @param target The Intent that the user will be selecting an activity
948 * to perform.
949 * @param title Optional title that will be displayed in the chooser.
950 * @return Return a new Intent object that you can hand to
951 * {@link Context#startActivity(Intent) Context.startActivity()} and
952 * related methods.
953 */
954 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700955 return createChooser(target, title, null);
956 }
957
958 /**
959 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
960 *
961 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
962 * target intent, also optionally supplying a title. If the target
963 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
964 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
965 * set in the returned chooser intent, with its ClipData set appropriately:
966 * either a direct reflection of {@link #getClipData()} if that is non-null,
967 * or a new ClipData built from {@link #getData()}.</p>
968 *
969 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
970 * when the user makes a choice. This can be useful if the calling application wants
971 * to remember the last chosen target and surface it as a more prominent or one-touch
972 * affordance elsewhere in the UI for next time.</p>
973 *
974 * @param target The Intent that the user will be selecting an activity
975 * to perform.
976 * @param title Optional title that will be displayed in the chooser.
977 * @param sender Optional IntentSender to be called when a choice is made.
978 * @return Return a new Intent object that you can hand to
979 * {@link Context#startActivity(Intent) Context.startActivity()} and
980 * related methods.
981 */
982 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700983 Intent intent = new Intent(ACTION_CHOOSER);
984 intent.putExtra(EXTRA_INTENT, target);
985 if (title != null) {
986 intent.putExtra(EXTRA_TITLE, title);
987 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700988
Adam Powell0b3c1122014-10-09 12:50:14 -0700989 if (sender != null) {
990 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
991 }
992
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700993 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700994 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
995 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
996 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700997 if (permFlags != 0) {
998 ClipData targetClipData = target.getClipData();
999 if (targetClipData == null && target.getData() != null) {
1000 ClipData.Item item = new ClipData.Item(target.getData());
1001 String[] mimeTypes;
1002 if (target.getType() != null) {
1003 mimeTypes = new String[] { target.getType() };
1004 } else {
1005 mimeTypes = new String[] { };
1006 }
1007 targetClipData = new ClipData(null, mimeTypes, item);
1008 }
1009 if (targetClipData != null) {
1010 intent.setClipData(targetClipData);
1011 intent.addFlags(permFlags);
1012 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001013 }
Dianne Hackborne302a162012-05-15 14:58:32 -07001014
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001015 return intent;
1016 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001017
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001018 /**
1019 * Activity Action: Allow the user to select a particular kind of data and
1020 * return it. This is different than {@link #ACTION_PICK} in that here we
1021 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001022 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001023 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001024 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001025 * etc.
1026 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001027 * 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 -07001028 * of data, such as a person contact, you set the MIME type to the kind of
1029 * data you want and launch it with {@link Context#startActivity(Intent)}.
1030 * The system will then launch the best application to select that kind
1031 * of data for you.
1032 * <p>
1033 * You may also be interested in any of a set of types of content the user
1034 * can pick. For example, an e-mail application that wants to allow the
1035 * user to add an attachment to an e-mail message can use this action to
1036 * bring up a list of all of the types of content the user can attach.
1037 * <p>
1038 * In this case, you should wrap the GET_CONTENT intent with a chooser
1039 * (through {@link #createChooser}), which will give the proper interface
1040 * for the user to pick how to send your data and allow you to specify
1041 * a prompt indicating what they are doing. You will usually specify a
1042 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1043 * broad range of content types the user can select from.
1044 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001045 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001046 * only pick from data that can be represented as a stream. This is
1047 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1048 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001049 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001050 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001051 * is locally available on the device. For example, if this extra is set
1052 * to true then an image picker should not show any pictures that are available
1053 * from a remote server but not already on the local device (thus requiring
1054 * they be downloaded when opened).
1055 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001056 * If the caller can handle multiple returned items (the user performing
1057 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1058 * to indicate this.
1059 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001060 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1061 * that no URI is supplied in the intent, as there are no constraints on
1062 * where the returned data originally comes from. You may also include the
1063 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001064 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001065 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1066 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001067 * <p>
1068 * Output: The URI of the item that was picked. This must be a content:
1069 * URI so that any receiver can access it.
1070 */
1071 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1072 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1073 /**
1074 * Activity Action: Dial a number as specified by the data. This shows a
1075 * UI with the number being dialed, allowing the user to explicitly
1076 * initiate the call.
1077 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1078 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1079 * number.
1080 * <p>Output: nothing.
1081 */
1082 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1083 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1084 /**
1085 * Activity Action: Perform a call to someone specified by the data.
1086 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1087 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1088 * number.
1089 * <p>Output: nothing.
1090 *
1091 * <p>Note: there will be restrictions on which applications can initiate a
1092 * call; most applications should use the {@link #ACTION_DIAL}.
1093 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1094 * numbers. Applications can <strong>dial</strong> emergency numbers using
1095 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001096 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001097 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001098 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001099 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001100 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001101 */
1102 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1103 public static final String ACTION_CALL = "android.intent.action.CALL";
1104 /**
1105 * Activity Action: Perform a call to an emergency number specified by the
1106 * data.
1107 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1108 * tel: URI of an explicit phone number.
1109 * <p>Output: nothing.
1110 * @hide
1111 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001112 @SystemApi
1113 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001114 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1115 /**
1116 * Activity action: Perform a call to any number (emergency or not)
1117 * specified by the data.
1118 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1119 * tel: URI of an explicit phone number.
1120 * <p>Output: nothing.
1121 * @hide
1122 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001123 @SystemApi
1124 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001125 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
fionaxu77a744c2017-03-17 14:35:39 -07001126
Santos Cordon15a13782015-03-31 18:32:31 -07001127 /**
fionaxuadfe7002017-02-17 17:20:46 -08001128 * Activity Action: Main entry point for carrier setup apps.
1129 * <p>Carrier apps that provide an implementation for this action may be invoked to configure
1130 * carrier service and typically require
1131 * {@link android.telephony.TelephonyManager#hasCarrierPrivileges() carrier privileges} to
1132 * fulfill their duties.
1133 */
1134 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1135 public static final String ACTION_CARRIER_SETUP = "android.intent.action.CARRIER_SETUP";
1136 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001137 * Activity Action: Send a message to someone specified by the data.
1138 * <p>Input: {@link #getData} is URI describing the target.
1139 * <p>Output: nothing.
1140 */
1141 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1142 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1143 /**
1144 * Activity Action: Deliver some data to someone else. Who the data is
1145 * being delivered to is not specified; it is up to the receiver of this
1146 * action to ask the user where the data should be sent.
1147 * <p>
1148 * When launching a SEND intent, you should usually wrap it in a chooser
1149 * (through {@link #createChooser}), which will give the proper interface
1150 * for the user to pick how to send your data and allow you to specify
1151 * a prompt indicating what they are doing.
1152 * <p>
1153 * Input: {@link #getType} is the MIME type of the data being sent.
1154 * get*Extra can have either a {@link #EXTRA_TEXT}
1155 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1156 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1157 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1158 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001159 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1160 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1161 * your text with HTML formatting.
1162 * <p>
1163 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1164 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1165 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1166 * content: URIs and other advanced features of {@link ClipData}. If
1167 * using this approach, you still must supply the same data through the
1168 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1169 * for compatibility with old applications. If you don't set a ClipData,
1170 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001171 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001172 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1173 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1174 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1175 * be openable only as asset typed files using
1176 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1177 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001178 * Optional standard extras, which may be interpreted by some recipients as
1179 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1180 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1181 * <p>
1182 * Output: nothing.
1183 */
1184 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1185 public static final String ACTION_SEND = "android.intent.action.SEND";
1186 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001187 * Activity Action: Deliver multiple data to someone else.
1188 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001189 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001190 * <p>
1191 * Input: {@link #getType} is the MIME type of the data being sent.
1192 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001193 * #EXTRA_STREAM} field, containing the data to be sent. If using
1194 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1195 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001196 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001197 * Multiple types are supported, and receivers should handle mixed types
1198 * whenever possible. The right way for the receiver to check them is to
1199 * use the content resolver on each URI. The intent sender should try to
1200 * put the most concrete mime type in the intent type, but it can fall
1201 * back to {@literal <type>/*} or {@literal *}/* as needed.
1202 * <p>
1203 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1204 * be image/jpg, but if you are sending image/jpg and image/png, then the
1205 * intent's type should be image/*.
1206 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001207 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1208 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1209 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1210 * content: URIs and other advanced features of {@link ClipData}. If
1211 * using this approach, you still must supply the same data through the
1212 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1213 * for compatibility with old applications. If you don't set a ClipData,
1214 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1215 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001216 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1217 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1218 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1219 * be openable only as asset typed files using
1220 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1221 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001222 * Optional standard extras, which may be interpreted by some recipients as
1223 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1224 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1225 * <p>
1226 * Output: nothing.
1227 */
1228 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1229 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1230 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001231 * Activity Action: Handle an incoming phone call.
1232 * <p>Input: nothing.
1233 * <p>Output: nothing.
1234 */
1235 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1236 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1237 /**
1238 * Activity Action: Insert an empty item into the given container.
1239 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1240 * in which to place the data.
1241 * <p>Output: URI of the new data that was created.
1242 */
1243 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1244 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1245 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001246 * Activity Action: Create a new item in the given container, initializing it
1247 * from the current contents of the clipboard.
1248 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1249 * in which to place the data.
1250 * <p>Output: URI of the new data that was created.
1251 */
1252 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1253 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1254 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001255 * Activity Action: Delete the given data from its container.
1256 * <p>Input: {@link #getData} is URI of data to be deleted.
1257 * <p>Output: nothing.
1258 */
1259 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1260 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1261 /**
1262 * Activity Action: Run the data, whatever that means.
1263 * <p>Input: ? (Note: this is currently specific to the test harness.)
1264 * <p>Output: nothing.
1265 */
1266 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1267 public static final String ACTION_RUN = "android.intent.action.RUN";
1268 /**
1269 * Activity Action: Perform a data synchronization.
1270 * <p>Input: ?
1271 * <p>Output: ?
1272 */
1273 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1274 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1275 /**
1276 * Activity Action: Pick an activity given an intent, returning the class
1277 * selected.
1278 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1279 * used with {@link PackageManager#queryIntentActivities} to determine the
1280 * set of activities from which to pick.
1281 * <p>Output: Class name of the activity that was selected.
1282 */
1283 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1284 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1285 /**
1286 * Activity Action: Perform a search.
1287 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1288 * is the text to search for. If empty, simply
1289 * enter your search results Activity with the search UI activated.
1290 * <p>Output: nothing.
1291 */
1292 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1293 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1294 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001295 * Activity Action: Start the platform-defined tutorial
1296 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1297 * is the text to search for. If empty, simply
1298 * enter your search results Activity with the search UI activated.
1299 * <p>Output: nothing.
1300 */
1301 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1302 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1303 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001304 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001305 * <p>
1306 * Input: {@link android.app.SearchManager#QUERY
1307 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1308 * a url starts with http or https, the site will be opened. If it is plain
1309 * text, Google search will be applied.
1310 * <p>
1311 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001312 */
1313 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1314 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001315
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001316 /**
Jim Miller07994402012-05-02 14:22:27 -07001317 * Activity Action: Perform assist action.
1318 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001319 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1320 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001321 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1322 * information.
Jim Miller07994402012-05-02 14:22:27 -07001323 * Output: nothing.
1324 */
1325 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1326 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001327
1328 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001329 * Activity Action: Perform voice assist action.
1330 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001331 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1332 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001333 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001334 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001335 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001336 */
Amith Yamasani16452032017-03-03 10:15:57 -08001337 @SystemApi
Bjorn Bringertbc086862013-03-01 12:59:24 +00001338 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1339 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1340
1341 /**
Adam Skory7140a252013-09-11 12:04:58 +01001342 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1343 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001344 */
1345 public static final String EXTRA_ASSIST_PACKAGE
1346 = "android.intent.extra.ASSIST_PACKAGE";
1347
1348 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001349 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1350 * application package at the time the assist was invoked.
1351 */
1352 public static final String EXTRA_ASSIST_UID
1353 = "android.intent.extra.ASSIST_UID";
1354
1355 /**
Adam Skory7140a252013-09-11 12:04:58 +01001356 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1357 * information supplied by the current foreground app at the time of the assist request.
1358 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001359 */
1360 public static final String EXTRA_ASSIST_CONTEXT
1361 = "android.intent.extra.ASSIST_CONTEXT";
1362
Jim Miller07994402012-05-02 14:22:27 -07001363 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001364 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1365 * keyboard as the primary input device for assistance.
1366 */
1367 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1368 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1369
1370 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001371 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1372 * that was used to invoke the assist.
1373 */
1374 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1375 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1376
1377 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001378 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001379 * <p>Input: Nothing.
1380 * <p>Output: nothing.
1381 */
1382 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1383 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1384 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001385 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001386 * <p>Input: Nothing.
1387 * <p>Output: Nothing.
1388 */
1389 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1390 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1391
1392 /**
1393 * Activity Action: Show activity for reporting a bug.
1394 * <p>Input: Nothing.
1395 * <p>Output: Nothing.
1396 */
1397 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1398 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1399
1400 /**
1401 * Activity Action: Main entry point for factory tests. Only used when
1402 * the device is booting in factory test node. The implementing package
1403 * must be installed in the system image.
1404 * <p>Input: nothing
1405 * <p>Output: nothing
1406 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06001407 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001408 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1409
1410 /**
1411 * Activity Action: The user pressed the "call" button to go to the dialer
1412 * or other appropriate UI for placing a call.
1413 * <p>Input: Nothing.
1414 * <p>Output: Nothing.
1415 */
1416 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1417 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1418
1419 /**
1420 * Activity Action: Start Voice Command.
1421 * <p>Input: Nothing.
1422 * <p>Output: Nothing.
1423 */
1424 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1425 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001426
1427 /**
1428 * Activity Action: Start action associated with long pressing on the
1429 * search key.
1430 * <p>Input: Nothing.
1431 * <p>Output: Nothing.
1432 */
1433 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1434 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001435
Jacek Surazski86b6c532009-05-13 14:38:28 +02001436 /**
1437 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1438 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001439 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001440 * <p>Input: No data is specified. The bug report is passed in using
1441 * an {@link #EXTRA_BUG_REPORT} field.
1442 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001443 *
1444 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001445 */
1446 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1447 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001448
1449 /**
1450 * Activity Action: Show power usage information to the user.
1451 * <p>Input: Nothing.
1452 * <p>Output: Nothing.
1453 */
1454 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1455 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001456
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001457 /**
Russell Brenner4cd32e52017-02-24 11:11:47 -08001458 * Activity Action: Setup wizard action provided for OTA provisioning to determine if it needs
1459 * to run.
1460 * <p>Input: Nothing.
1461 * <p>Output: Nothing.
1462 * @deprecated As of {@link android.os.Build.VERSION_CODES#M}, setup wizard can be identified
1463 * using {@link #ACTION_MAIN} and {@link #CATEGORY_SETUP_WIZARD}
1464 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001465 * @removed
Russell Brenner4cd32e52017-02-24 11:11:47 -08001466 */
1467 @Deprecated
1468 @SystemApi
1469 public static final String ACTION_DEVICE_INITIALIZATION_WIZARD =
1470 "android.intent.action.DEVICE_INITIALIZATION_WIZARD";
1471
1472 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001473 * Activity Action: Setup wizard to launch after a platform update. This
1474 * activity should have a string meta-data field associated with it,
1475 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1476 * the platform for setup. The activity will be launched only if
1477 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1478 * same value.
1479 * <p>Input: Nothing.
1480 * <p>Output: Nothing.
1481 * @hide
1482 */
Russell Brenner4cd32e52017-02-24 11:11:47 -08001483 @SystemApi
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001484 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1485 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001486
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001487 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001488 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1489 * <p>Input: Nothing.
1490 * <p>Output: Nothing.
1491 * @hide
1492 */
1493 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1494 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001495 "com.android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001496
1497 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001498 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1499 * <p>Input: Nothing.
1500 * <p>Output: Nothing.
1501 * @hide
1502 */
1503 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1504 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001505 "com.android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001506
1507 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001508 * Activity Action: Show settings for managing network data usage of a
1509 * specific application. Applications should define an activity that offers
1510 * options to control data usage.
1511 */
1512 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1513 public static final String ACTION_MANAGE_NETWORK_USAGE =
1514 "android.intent.action.MANAGE_NETWORK_USAGE";
1515
1516 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001517 * Activity Action: Launch application installer.
1518 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001519 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001520 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1521 * you can also use "package:<package-name>" to install an application for the
1522 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001523 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1524 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1525 * <p>
1526 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1527 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001528 * <p>
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001529 * <strong>Note:</strong>If your app is targeting API level higher than 25 you
Svet Ganov86877e42015-05-28 08:19:48 -07001530 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1531 * in order to launch the application installer.
1532 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001533 *
1534 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1535 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1536 * @see #EXTRA_RETURN_RESULT
1537 */
1538 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1539 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1540
1541 /**
Todd Kennedyd0084f72017-07-28 13:56:14 -07001542 * Activity Action: Activity to handle split installation failures.
1543 * <p>Splits may be installed dynamically. This happens when an Activity is launched,
1544 * but the split that contains the application isn't installed. When a split is
1545 * installed in this manner, the containing package usually doesn't know this is
1546 * happening. However, if an error occurs during installation, the containing
1547 * package can define a single activity handling this action to deal with such
1548 * failures.
1549 * <p>The activity handling this action must be in the base package.
1550 * <p>
1551 * Input: {@link #EXTRA_INTENT} the original intent that started split installation.
1552 * {@link #EXTRA_SPLIT_NAME} the name of the split that failed to be installed.
1553 */
1554 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1555 public static final String ACTION_INSTALL_FAILURE = "android.intent.action.INSTALL_FAILURE";
1556
1557 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001558 * Activity Action: Launch instant application installer.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001559 * <p class="note">
1560 * This is a protected intent that can only be sent by the system.
1561 * </p>
1562 *
1563 * @hide
1564 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001565 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001566 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001567 public static final String ACTION_INSTALL_INSTANT_APP_PACKAGE
1568 = "android.intent.action.INSTALL_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001569
1570 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001571 * Service Action: Resolve instant application.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001572 * <p>
1573 * The system will have a persistent connection to this service.
1574 * This is a protected intent that can only be sent by the system.
1575 * </p>
1576 *
1577 * @hide
1578 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001579 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001580 @SdkConstant(SdkConstantType.SERVICE_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001581 public static final String ACTION_RESOLVE_INSTANT_APP_PACKAGE
1582 = "android.intent.action.RESOLVE_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001583
1584 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001585 * Activity Action: Launch instant app settings.
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001586 *
1587 * <p class="note">
1588 * This is a protected intent that can only be sent by the system.
1589 * </p>
1590 *
1591 * @hide
1592 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001593 @SystemApi
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001594 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001595 public static final String ACTION_INSTANT_APP_RESOLVER_SETTINGS
1596 = "android.intent.action.INSTANT_APP_RESOLVER_SETTINGS";
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001597
1598 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001599 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1600 * package. Specifies the installer package name; this package will receive the
1601 * {@link #ACTION_APP_ERROR} intent.
1602 */
1603 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1604 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1605
1606 /**
1607 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1608 * package. Specifies that the application being installed should not be
1609 * treated as coming from an unknown source, but as coming from the app
1610 * invoking the Intent. For this to work you must start the installer with
1611 * startActivityForResult().
1612 */
1613 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1614 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1615
1616 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001617 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1618 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001619 * data field originated from.
1620 */
rich cannings706e8ba2012-08-20 13:20:14 -07001621 public static final String EXTRA_ORIGINATING_URI
1622 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001623
1624 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001625 * This extra can be used with any Intent used to launch an activity, supplying information
1626 * about who is launching that activity. This field contains a {@link android.net.Uri}
1627 * object, typically an http: or https: URI of the web site that the referral came from;
1628 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1629 * a native application that it came from.
1630 *
1631 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1632 * instead of directly retrieving the extra. It is also valid for applications to
1633 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1634 * a string, not a Uri; the field here, if supplied, will always take precedence,
1635 * however.</p>
1636 *
1637 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001638 */
1639 public static final String EXTRA_REFERRER
1640 = "android.intent.extra.REFERRER";
1641
1642 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001643 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1644 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1645 * not be created, in particular when Intent extras are supplied through the
1646 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1647 * schemes.
1648 *
1649 * @see #EXTRA_REFERRER
1650 */
1651 public static final String EXTRA_REFERRER_NAME
1652 = "android.intent.extra.REFERRER_NAME";
1653
1654 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001655 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001656 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001657 * Currently only a system app that hosts the provider authority "downloads" or holds the
1658 * permission {@link android.Manifest.permission.MANAGE_DOCUMENTS} can use this.
Ben Gruver37d83a32012-09-27 13:02:06 -07001659 * @hide
1660 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001661 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001662 public static final String EXTRA_ORIGINATING_UID
1663 = "android.intent.extra.ORIGINATING_UID";
1664
1665 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001666 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1667 * package. Tells the installer UI to skip the confirmation with the user
1668 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001669 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1670 * will no longer show an interstitial message about updating existing
1671 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001672 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001673 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001674 public static final String EXTRA_ALLOW_REPLACE
1675 = "android.intent.extra.ALLOW_REPLACE";
1676
1677 /**
1678 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1679 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1680 * return to the application the result code of the install/uninstall. The returned result
1681 * code will be {@link android.app.Activity#RESULT_OK} on success or
1682 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1683 */
1684 public static final String EXTRA_RETURN_RESULT
1685 = "android.intent.extra.RETURN_RESULT";
1686
1687 /**
1688 * Package manager install result code. @hide because result codes are not
1689 * yet ready to be exposed.
1690 */
1691 public static final String EXTRA_INSTALL_RESULT
1692 = "android.intent.extra.INSTALL_RESULT";
1693
1694 /**
1695 * Activity Action: Launch application uninstaller.
1696 * <p>
1697 * Input: The data must be a package: URI whose scheme specific part is
1698 * the package name of the current installed package to be uninstalled.
1699 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1700 * <p>
1701 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1702 * succeeded.
Philip P. Moltmannd9bb39a2017-09-05 12:41:15 -07001703 * <p>
1704 * Requires {@link android.Manifest.permission#REQUEST_DELETE_PACKAGES}
1705 * since {@link Build.VERSION_CODES#P}.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001706 */
1707 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1708 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1709
1710 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001711 * Specify whether the package should be uninstalled for all users.
1712 * @hide because these should not be part of normal application flow.
1713 */
1714 public static final String EXTRA_UNINSTALL_ALL_USERS
1715 = "android.intent.extra.UNINSTALL_ALL_USERS";
1716
1717 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001718 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1719 * describing the last run version of the platform that was setup.
1720 * @hide
1721 */
1722 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1723
Svet Ganov3695b8a2015-03-24 16:30:25 -07001724 /**
1725 * Activity action: Launch UI to manage the permissions of an app.
1726 * <p>
1727 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1728 * will be managed by the launched UI.
1729 * </p>
1730 * <p>
1731 * Output: Nothing.
1732 * </p>
1733 *
1734 * @see #EXTRA_PACKAGE_NAME
1735 *
1736 * @hide
1737 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001738 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001739 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1740 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1741 "android.intent.action.MANAGE_APP_PERMISSIONS";
1742
1743 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001744 * Activity action: Launch UI to manage permissions.
1745 * <p>
1746 * Input: Nothing.
1747 * </p>
1748 * <p>
1749 * Output: Nothing.
1750 * </p>
1751 *
1752 * @hide
1753 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001754 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001755 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1756 public static final String ACTION_MANAGE_PERMISSIONS =
1757 "android.intent.action.MANAGE_PERMISSIONS";
1758
1759 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001760 * Activity action: Launch UI to review permissions for an app.
1761 * The system uses this intent if permission review for apps not
1762 * supporting the new runtime permissions model is enabled. In
1763 * this mode a permission review is required before any of the
1764 * app components can run.
1765 * <p>
1766 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1767 * permissions will be reviewed (mandatory).
1768 * </p>
1769 * <p>
1770 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1771 * be fired after the permission review (optional).
1772 * </p>
1773 * <p>
1774 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1775 * be invoked after the permission review (optional).
1776 * </p>
1777 * <p>
1778 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1779 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1780 * </p>
1781 * <p>
1782 * Output: Nothing.
1783 * </p>
1784 *
1785 * @see #EXTRA_PACKAGE_NAME
1786 * @see #EXTRA_INTENT
1787 * @see #EXTRA_REMOTE_CALLBACK
1788 * @see #EXTRA_RESULT_NEEDED
1789 *
1790 * @hide
1791 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001792 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001793 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1794 public static final String ACTION_REVIEW_PERMISSIONS =
1795 "android.intent.action.REVIEW_PERMISSIONS";
1796
1797 /**
1798 * Intent extra: A callback for reporting remote result as a bundle.
1799 * <p>
1800 * Type: IRemoteCallback
1801 * </p>
1802 *
1803 * @hide
1804 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001805 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001806 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1807
1808 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001809 * Intent extra: An app package name.
1810 * <p>
1811 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001812 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001813 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001814 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001815 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1816
1817 /**
Suprabh Shukla96212bc2018-04-10 15:04:51 -07001818 * Intent extra: A {@link Bundle} of extras for a package being suspended. Will be sent as an
1819 * extra with {@link #ACTION_MY_PACKAGE_SUSPENDED}.
1820 *
1821 * <p>The contents of this {@link Bundle} are a contract between the suspended app and the
1822 * suspending app, i.e. any app with the permission {@code android.permission.SUSPEND_APPS}.
1823 * This is meant to enable the suspended app to better handle the state of being suspended.
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07001824 *
1825 * @see #ACTION_MY_PACKAGE_SUSPENDED
1826 * @see #ACTION_MY_PACKAGE_UNSUSPENDED
1827 * @see PackageManager#isPackageSuspended()
1828 * @see PackageManager#getSuspendedPackageAppExtras()
1829 */
1830 public static final String EXTRA_SUSPENDED_PACKAGE_EXTRAS = "android.intent.extra.SUSPENDED_PACKAGE_EXTRAS";
1831
1832 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001833 * Intent extra: An app split name.
1834 * <p>
1835 * Type: String
1836 * </p>
Todd Kennedye5195dd2016-10-19 15:29:19 -07001837 */
Todd Kennedye5195dd2016-10-19 15:29:19 -07001838 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1839
1840 /**
Jeff Sharkey1a749422017-04-28 14:19:50 -06001841 * Intent extra: A {@link ComponentName} value.
1842 * <p>
1843 * Type: String
1844 * </p>
1845 */
1846 public static final String EXTRA_COMPONENT_NAME = "android.intent.extra.COMPONENT_NAME";
1847
1848 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001849 * Intent extra: An extra for specifying whether a result is needed.
1850 * <p>
1851 * Type: boolean
1852 * </p>
1853 *
1854 * @hide
1855 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001856 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001857 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1858
1859 /**
Suprabh Shukla19b41f32018-03-26 22:35:13 -07001860 * Intent extra: A {@link Bundle} of extras supplied for the launcher when any packages on
1861 * device are suspended. Will be sent with {@link #ACTION_PACKAGES_SUSPENDED}.
1862 *
1863 * @see PackageManager#isPackageSuspended()
1864 * @see #ACTION_PACKAGES_SUSPENDED
1865 *
1866 * @hide
1867 */
1868 public static final String EXTRA_LAUNCHER_EXTRAS = "android.intent.extra.LAUNCHER_EXTRAS";
1869
1870 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001871 * Activity action: Launch UI to manage which apps have a given permission.
1872 * <p>
1873 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1874 * to which will be managed by the launched UI.
1875 * </p>
1876 * <p>
1877 * Output: Nothing.
1878 * </p>
1879 *
1880 * @see #EXTRA_PERMISSION_NAME
1881 *
1882 * @hide
1883 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001884 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001885 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1886 public static final String ACTION_MANAGE_PERMISSION_APPS =
1887 "android.intent.action.MANAGE_PERMISSION_APPS";
1888
1889 /**
1890 * Intent extra: The name of a permission.
1891 * <p>
1892 * Type: String
1893 * </p>
1894 *
1895 * @hide
1896 */
1897 @SystemApi
1898 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1899
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001900 // ---------------------------------------------------------------------
1901 // ---------------------------------------------------------------------
1902 // Standard intent broadcast actions (see action variable).
1903
1904 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001905 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1906 * <p>
1907 * For historical reasons, the name of this broadcast action refers to the power
1908 * state of the screen but it is actually sent in response to changes in the
1909 * overall interactive state of the device.
1910 * </p><p>
1911 * This broadcast is sent when the device becomes non-interactive which may have
1912 * nothing to do with the screen turning off. To determine the
1913 * actual state of the screen, use {@link android.view.Display#getState}.
1914 * </p><p>
1915 * See {@link android.os.PowerManager#isInteractive} for details.
1916 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001917 * You <em>cannot</em> receive this through components declared in
1918 * manifests, only by explicitly registering for it with
1919 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1920 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001921 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001922 * <p class="note">This is a protected intent that can only be sent
1923 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001924 */
1925 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1926 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001927
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001928 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001929 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1930 * <p>
1931 * For historical reasons, the name of this broadcast action refers to the power
1932 * state of the screen but it is actually sent in response to changes in the
1933 * overall interactive state of the device.
1934 * </p><p>
1935 * This broadcast is sent when the device becomes interactive which may have
1936 * nothing to do with the screen turning on. To determine the
1937 * actual state of the screen, use {@link android.view.Display#getState}.
1938 * </p><p>
1939 * See {@link android.os.PowerManager#isInteractive} for details.
1940 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001941 * You <em>cannot</em> receive this through components declared in
1942 * manifests, only by explicitly registering for it with
1943 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1944 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001945 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001946 * <p class="note">This is a protected intent that can only be sent
1947 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001948 */
1949 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1950 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001951
1952 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001953 * Broadcast Action: Sent after the system stops dreaming.
1954 *
1955 * <p class="note">This is a protected intent that can only be sent by the system.
1956 * It is only sent to registered receivers.</p>
1957 */
1958 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1959 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1960
1961 /**
1962 * Broadcast Action: Sent after the system starts dreaming.
1963 *
1964 * <p class="note">This is a protected intent that can only be sent by the system.
1965 * It is only sent to registered receivers.</p>
1966 */
1967 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1968 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1969
1970 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001971 * 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 -07001972 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001973 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001974 * <p class="note">This is a protected intent that can only be sent
1975 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001976 */
1977 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001978 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001979
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001980 /**
1981 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001982 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001983 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001984 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1985 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001986 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001987 * <p class="note">This is a protected intent that can only be sent
1988 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001989 */
1990 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1991 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1992 /**
1993 * Broadcast Action: The time was set.
1994 */
1995 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1996 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1997 /**
1998 * Broadcast Action: The date has changed.
1999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
2002 /**
2003 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
2004 * <ul>
2005 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
2006 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002007 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002008 * <p class="note">This is a protected intent that can only be sent
2009 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002010 */
2011 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2012 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
2013 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07002014 * Clear DNS Cache Action: This is broadcast when networks have changed and old
2015 * DNS entries should be tossed.
2016 * @hide
2017 */
2018 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2019 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
2020 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002021 * Alarm Changed Action: This is broadcast when the AlarmClock
2022 * application's alarm is set or unset. It is used by the
2023 * AlarmClock application and the StatusBar service.
2024 * @hide
2025 */
2026 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2027 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002028
2029 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002030 * Broadcast Action: This is broadcast once, after the user has finished
2031 * booting, but while still in the "locked" state. It can be used to perform
2032 * application-specific initialization, such as installing alarms. You must
2033 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
2034 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002035 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002036 * This broadcast is sent immediately at boot by all devices (regardless of
2037 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
2038 * higher. Upon receipt of this broadcast, the user is still locked and only
2039 * device-protected storage can be accessed safely. If you want to access
2040 * credential-protected storage, you need to wait for the user to be
2041 * unlocked (typically by entering their lock pattern or PIN for the first
2042 * time), after which the {@link #ACTION_USER_UNLOCKED} and
2043 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
2044 * <p>
2045 * To receive this broadcast, your receiver component must be marked as
2046 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002047 * <p class="note">
2048 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002049 *
2050 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002051 */
2052 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2053 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2054
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002055 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002056 * Broadcast Action: This is broadcast once, after the user has finished
2057 * booting. It can be used to perform application-specific initialization,
2058 * such as installing alarms. You must hold the
2059 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2060 * order to receive this broadcast.
2061 * <p>
2062 * This broadcast is sent at boot by all devices (both with and without
2063 * direct boot support). Upon receipt of this broadcast, the user is
2064 * unlocked and both device-protected and credential-protected storage can
2065 * accessed safely.
2066 * <p>
2067 * If you need to run while the user is still locked (before they've entered
2068 * their lock pattern or PIN for the first time), you can listen for the
2069 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2070 * <p class="note">
2071 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002072 */
2073 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002074 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002075 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002076
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002077 /**
2078 * Broadcast Action: This is broadcast when a user action should request a
2079 * temporary system dialog to dismiss. Some examples of temporary system
2080 * dialogs are the notification window-shade and the recent tasks dialog.
2081 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002082 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002083 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2084 /**
2085 * Broadcast Action: Trigger the download and eventual installation
2086 * of a package.
2087 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002088 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002089 * <p class="note">This is a protected intent that can only be sent
2090 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002091 *
2092 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002093 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002094 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002095 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2096 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2097 /**
Christopher Tate94b91db2017-04-19 15:49:17 -07002098 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002099 * device. The data contains the name of the package. Note that the
2100 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002101 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002102 * <ul>
Christopher Tate94b91db2017-04-19 15:49:17 -07002103 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2104 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002105 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2106 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002107 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002108 * <p class="note">This is a protected intent that can only be sent
2109 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002110 */
2111 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2112 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2113 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002114 * Broadcast Action: A new version of an application package has been
2115 * installed, replacing an existing version that was previously installed.
2116 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002117 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002118 * <ul>
2119 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2120 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002121 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002122 * <p class="note">This is a protected intent that can only be sent
2123 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002124 */
2125 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2126 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2127 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002128 * Broadcast Action: A new version of your application has been installed
2129 * over an existing one. This is only sent to the application that was
2130 * replaced. It does not contain any additional data; to receive it, just
2131 * use an intent filter for this action.
2132 *
2133 * <p class="note">This is a protected intent that can only be sent
2134 * by the system.
2135 */
2136 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2137 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2138 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002139 * Broadcast Action: An existing application package has been removed from
2140 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002141 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002142 * <ul>
2143 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2144 * to the package.
2145 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2146 * application -- data and code -- is being removed.
2147 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2148 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2149 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002150 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002151 * <p class="note">This is a protected intent that can only be sent
2152 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002153 */
2154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2155 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2156 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002157 * Broadcast Action: An existing application package has been completely
2158 * removed from the device. The data contains the name of the package.
2159 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2160 * {@link #EXTRA_DATA_REMOVED} is true and
2161 * {@link #EXTRA_REPLACING} is false of that broadcast.
2162 *
2163 * <ul>
2164 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2165 * to the package.
2166 * </ul>
2167 *
2168 * <p class="note">This is a protected intent that can only be sent
2169 * by the system.
2170 */
2171 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2172 public static final String ACTION_PACKAGE_FULLY_REMOVED
2173 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2174 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002175 * Broadcast Action: An existing application package has been changed (for
2176 * example, a component has been enabled or disabled). The data contains
2177 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002178 * <ul>
2179 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002180 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002181 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002182 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2183 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002184 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002185 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002186 * <p class="note">This is a protected intent that can only be sent
2187 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002188 */
2189 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2190 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2191 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002192 * @hide
2193 * Broadcast Action: Ask system services if there is any reason to
2194 * restart the given package. The data contains the name of the
2195 * package.
2196 * <ul>
2197 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2198 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2199 * </ul>
2200 *
2201 * <p class="note">This is a protected intent that can only be sent
2202 * by the system.
2203 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002204 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002205 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2206 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2207 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002208 * Broadcast Action: The user has restarted a package, and all of its
2209 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002210 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002211 * be removed. Note that the restarted package does <em>not</em>
2212 * receive this broadcast.
2213 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002214 * <ul>
2215 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2216 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002217 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002218 * <p class="note">This is a protected intent that can only be sent
2219 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002220 */
2221 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2222 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2223 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002224 * Broadcast Action: The user has cleared the data of a package. This should
2225 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002226 * its persistent data is erased and this broadcast sent.
2227 * Note that the cleared package does <em>not</em>
2228 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002229 * <ul>
Svet Ganovf935a702017-08-22 12:15:58 -07002230 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package. If the
2231 * package whose data was cleared is an uninstalled instant app, then the UID
2232 * will be -1. The platform keeps some meta-data associated with instant apps
2233 * after they are uninstalled.
2234 * <li> {@link #EXTRA_PACKAGE_NAME} containing the package name only if the cleared
2235 * data was for an instant app.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002236 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002237 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002238 * <p class="note">This is a protected intent that can only be sent
2239 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002240 */
2241 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2242 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2243 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002244 * Broadcast Action: Packages have been suspended.
2245 * <p>Includes the following extras:
2246 * <ul>
2247 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2248 * </ul>
2249 *
2250 * <p class="note">This is a protected intent that can only be sent
2251 * by the system. It is only sent to registered receivers.
2252 */
2253 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2254 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2255 /**
2256 * Broadcast Action: Packages have been unsuspended.
2257 * <p>Includes the following extras:
2258 * <ul>
2259 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2260 * </ul>
2261 *
2262 * <p class="note">This is a protected intent that can only be sent
2263 * by the system. It is only sent to registered receivers.
2264 */
2265 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2266 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002267
2268 /**
2269 * Broadcast Action: Sent to a package that has been suspended by the system. This is sent
Suprabh Shukla19b41f32018-03-26 22:35:13 -07002270 * whenever a package is put into a suspended state or any of its app extras change while in the
2271 * suspended state.
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002272 * <p> Optionally includes the following extras:
2273 * <ul>
2274 * <li> {@link #EXTRA_SUSPENDED_PACKAGE_EXTRAS} which is a {@link Bundle} which will contain
2275 * useful information for the app being suspended.
2276 * </ul>
2277 * <p class="note">This is a protected intent that can only be sent
2278 * by the system. <em>This will be delivered to {@link BroadcastReceiver} components declared in
2279 * the manifest.</em>
2280 *
2281 * @see #ACTION_MY_PACKAGE_UNSUSPENDED
2282 * @see #EXTRA_SUSPENDED_PACKAGE_EXTRAS
2283 * @see PackageManager#isPackageSuspended()
2284 * @see PackageManager#getSuspendedPackageAppExtras()
2285 */
2286 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2287 public static final String ACTION_MY_PACKAGE_SUSPENDED = "android.intent.action.MY_PACKAGE_SUSPENDED";
2288
2289 /**
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002290 * Activity Action: Started to show more details about why an application was suspended.
2291 *
Suprabh Shukla96212bc2018-04-10 15:04:51 -07002292 * <p>Whenever the system detects an activity launch for a suspended app, it shows a dialog to
2293 * the user to inform them of the state and present them an affordance to start this activity
2294 * action to show more details about the reason for suspension.
2295 *
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002296 * <p>Apps holding {@link android.Manifest.permission#SUSPEND_APPS} must declare an activity
2297 * handling this intent and protect it with
2298 * {@link android.Manifest.permission#SEND_SHOW_SUSPENDED_APP_DETAILS}.
2299 *
2300 * <p>Includes an extra {@link #EXTRA_PACKAGE_NAME} which is the name of the suspended package.
2301 *
2302 * <p class="note">This is a protected intent that can only be sent
2303 * by the system.
2304 *
Suprabh Shukla96212bc2018-04-10 15:04:51 -07002305 * @see PackageManager#setPackagesSuspended(String[], boolean, PersistableBundle,
2306 * PersistableBundle, String)
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002307 * @see PackageManager#isPackageSuspended()
2308 * @see #ACTION_PACKAGES_SUSPENDED
2309 *
2310 * @hide
2311 */
2312 @SystemApi
2313 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2314 public static final String ACTION_SHOW_SUSPENDED_APP_DETAILS =
2315 "android.intent.action.SHOW_SUSPENDED_APP_DETAILS";
2316
2317 /**
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002318 * Broadcast Action: Sent to a package that has been unsuspended.
2319 *
2320 * <p class="note">This is a protected intent that can only be sent
2321 * by the system. <em>This will be delivered to {@link BroadcastReceiver} components declared in
2322 * the manifest.</em>
2323 *
2324 * @see #ACTION_MY_PACKAGE_SUSPENDED
2325 * @see #EXTRA_SUSPENDED_PACKAGE_EXTRAS
2326 * @see PackageManager#isPackageSuspended()
2327 * @see PackageManager#getSuspendedPackageAppExtras()
2328 */
2329 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2330 public static final String ACTION_MY_PACKAGE_UNSUSPENDED = "android.intent.action.MY_PACKAGE_UNSUSPENDED";
2331
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002332 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002333 * Broadcast Action: A user ID has been removed from the system. The user
2334 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002335 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002336 * <p class="note">This is a protected intent that can only be sent
2337 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002338 */
2339 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2340 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002341
2342 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002343 * Broadcast Action: Sent to the installer package of an application when
2344 * that application is first launched (that is the first time it is moved
2345 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002346 *
2347 * <p class="note">This is a protected intent that can only be sent
2348 * by the system.
2349 */
2350 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2351 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2352
2353 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002354 * Broadcast Action: Sent to the system package verifier when a package
2355 * needs to be verified. The data contains the package URI.
2356 * <p class="note">
2357 * This is a protected intent that can only be sent by the system.
2358 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002359 */
2360 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2361 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2362
2363 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002364 * Broadcast Action: Sent to the system package verifier when a package is
2365 * verified. The data contains the package URI.
2366 * <p class="note">
2367 * This is a protected intent that can only be sent by the system.
2368 */
2369 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2370 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2371
2372 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002373 * Broadcast Action: Sent to the system intent filter verifier when an
2374 * intent filter needs to be verified. The data contains the filter data
2375 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002376 * <p class="note">
2377 * This is a protected intent that can only be sent by the system.
2378 * </p>
2379 *
2380 * @hide
2381 */
2382 @SystemApi
2383 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2384 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2385
2386 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002387 * Broadcast Action: Resources for a set of packages (which were
2388 * previously unavailable) are currently
2389 * available since the media on which they exist is available.
2390 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2391 * list of packages whose availability changed.
2392 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2393 * list of uids of packages whose availability changed.
2394 * Note that the
2395 * packages in this list do <em>not</em> receive this broadcast.
2396 * The specified set of packages are now available on the system.
2397 * <p>Includes the following extras:
2398 * <ul>
2399 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2400 * whose resources(were previously unavailable) are currently available.
2401 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2402 * packages whose resources(were previously unavailable)
2403 * are currently available.
2404 * </ul>
2405 *
2406 * <p class="note">This is a protected intent that can only be sent
2407 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002408 */
2409 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002410 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2411 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002412
2413 /**
2414 * Broadcast Action: Resources for a set of packages are currently
2415 * unavailable since the media on which they exist is unavailable.
2416 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2417 * list of packages whose availability changed.
2418 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2419 * list of uids of packages whose availability changed.
2420 * The specified set of packages can no longer be
2421 * launched and are practically unavailable on the system.
2422 * <p>Inclues the following extras:
2423 * <ul>
2424 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2425 * whose resources are no longer available.
2426 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2427 * whose resources are no longer available.
2428 * </ul>
2429 *
2430 * <p class="note">This is a protected intent that can only be sent
2431 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002432 */
2433 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002434 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002435 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002436
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002437 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002438 * Broadcast Action: preferred activities have changed *explicitly*.
2439 *
2440 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2441 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2442 * be sent.
2443 *
2444 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2445 *
2446 * @hide
2447 */
2448 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2449 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2450 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2451
2452
2453 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002454 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002455 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002456 * This should <em>only</em> be used to determine when the wallpaper
2457 * has changed to show the new wallpaper to the user. You should certainly
2458 * never, in response to this, change the wallpaper or other attributes of
2459 * it such as the suggested size. That would be crazy, right? You'd cause
2460 * all kinds of loops, especially if other apps are doing similar things,
2461 * right? Of course. So please don't do this.
2462 *
2463 * @deprecated Modern applications should use
2464 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2465 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2466 * shown behind their UI, rather than watching for this broadcast and
2467 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002468 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002469 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002470 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2471 /**
2472 * Broadcast Action: The current device {@link android.content.res.Configuration}
2473 * (orientation, locale, etc) has changed. When such a change happens, the
2474 * UIs (view hierarchy) will need to be rebuilt based on this new
2475 * information; for the most part, applications don't need to worry about
2476 * this, because the system will take care of stopping and restarting the
2477 * application to make sure it sees the new changes. Some system code that
2478 * can not be restarted will need to watch for this action and handle it
2479 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002480 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002481 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002482 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002483 * in manifests, only by explicitly registering for it with
2484 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2485 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002486 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002487 * <p class="note">This is a protected intent that can only be sent
2488 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002489 *
2490 * @see android.content.res.Configuration
2491 */
2492 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2493 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
Adam Lesinski57fccd62018-01-25 13:03:57 -08002494
2495 /**
2496 * Broadcast Action: The current device {@link android.content.res.Configuration} has changed
2497 * such that the device may be eligible for the installation of additional configuration splits.
2498 * Configuration properties that can trigger this broadcast include locale and display density.
2499 *
2500 * <p class="note">
2501 * Unlike {@link #ACTION_CONFIGURATION_CHANGED}, you <em>can</em> receive this through
2502 * components declared in manifests. However, the receiver <em>must</em> hold the
2503 * {@link android.Manifest.permission#INSTALL_PACKAGES} permission.
2504 *
2505 * <p class="note">
2506 * This is a protected intent that can only be sent by the system.
2507 *
2508 * @hide
2509 */
2510 @SystemApi
2511 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2512 public static final String ACTION_SPLIT_CONFIGURATION_CHANGED =
2513 "android.intent.action.SPLIT_CONFIGURATION_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002514 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002515 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002516 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002517 * <p class="note">This is a protected intent that can only be sent
2518 * by the system.
2519 */
2520 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2521 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2522 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002523 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2524 * charging state, level, and other information about the battery.
2525 * See {@link android.os.BatteryManager} for documentation on the
2526 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002527 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002528 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002529 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002530 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002531 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002532 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2533 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2534 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2535 * broadcasts that are sent and can be received through manifest
2536 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002537 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002538 * <p class="note">This is a protected intent that can only be sent
2539 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002540 */
2541 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2542 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
Fyodor Kupolov70e75432018-03-01 18:29:06 -08002543
2544
2545 /**
2546 * Broadcast Action: Sent when the current battery level changes.
2547 *
2548 * It has {@link android.os.BatteryManager#EXTRA_EVENTS} that carries a list of {@link Bundle}
2549 * instances representing individual battery level changes with associated
2550 * extras from {@link #ACTION_BATTERY_CHANGED}.
2551 *
2552 * <p class="note">
2553 * This broadcast requires {@link android.Manifest.permission#BATTERY_STATS} permission.
2554 *
2555 * @hide
2556 */
2557 @SystemApi
2558 public static final String ACTION_BATTERY_LEVEL_CHANGED =
2559 "android.intent.action.BATTERY_LEVEL_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002560 /**
2561 * Broadcast Action: Indicates low battery condition on the device.
2562 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002563 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002564 * <p class="note">This is a protected intent that can only be sent
2565 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002566 */
2567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2568 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2569 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002570 * Broadcast Action: Indicates the battery is now okay after being low.
2571 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2572 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002573 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002574 * <p class="note">This is a protected intent that can only be sent
2575 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002576 */
2577 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2578 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2579 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002580 * Broadcast Action: External power has been connected to the device.
2581 * This is intended for applications that wish to register specifically to this notification.
2582 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2583 * stay active to receive this notification. This action can be used to implement actions
2584 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002585 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002586 * <p class="note">This is a protected intent that can only be sent
2587 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002588 */
2589 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002590 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002591 /**
2592 * Broadcast Action: External power has been removed from the device.
2593 * This is intended for applications that wish to register specifically to this notification.
2594 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2595 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002596 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002597 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002598 * <p class="note">This is a protected intent that can only be sent
2599 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002600 */
2601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002602 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002603 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002604 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002605 * Broadcast Action: Device is shutting down.
2606 * This is broadcast when the device is being shut down (completely turned
2607 * off, not sleeping). Once the broadcast is complete, the final shutdown
2608 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002609 * to handle this, since the foreground activity will be paused as well.
Fyodor Kupolov1fc62602018-02-01 15:48:53 -08002610 * <p>As of {@link Build.VERSION_CODES#P} this broadcast is only sent to receivers registered
2611 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2612 * Context.registerReceiver}.
Tom Taylord4a47292009-12-21 13:59:18 -08002613 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002614 * <p class="note">This is a protected intent that can only be sent
2615 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002616 * <p>May include the following extras:
2617 * <ul>
2618 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2619 * shutdown is only for userspace processes. If not set, assumed to be false.
2620 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002621 */
2622 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002623 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002624 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002625 * Activity Action: Start this activity to request system shutdown.
2626 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002627 * to request confirmation from the user before shutting down. The optional boolean
2628 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2629 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002630 *
2631 * <p class="note">This is a protected intent that can only be sent
2632 * by the system.
2633 *
2634 * {@hide}
2635 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002636 public static final String ACTION_REQUEST_SHUTDOWN
2637 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002638 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002639 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002640 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002641 * <p class="note">
2642 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002643 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002644 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2645 * or above, this broadcast will no longer be delivered to any
2646 * {@link BroadcastReceiver} defined in your manifest. Instead,
2647 * apps are strongly encouraged to use the improved
2648 * {@link Context#getCacheDir()} behavior so the system can
2649 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002650 */
2651 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002652 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002653 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2654 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002655 * Broadcast Action: Indicates low storage space condition on the device no
2656 * longer exists
2657 * <p class="note">
2658 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002659 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002660 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2661 * or above, this broadcast will no longer be delivered to any
2662 * {@link BroadcastReceiver} defined in your manifest. Instead,
2663 * apps are strongly encouraged to use the improved
2664 * {@link Context#getCacheDir()} behavior so the system can
2665 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002666 */
2667 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002668 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002669 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2670 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002671 * Broadcast Action: A sticky broadcast that indicates a storage space full
2672 * condition on the device. This is intended for activities that want to be
2673 * able to fill the data partition completely, leaving only enough free
2674 * space to prevent system-wide SQLite failures.
2675 * <p class="note">
2676 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002677 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002678 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2679 * or above, this broadcast will no longer be delivered to any
2680 * {@link BroadcastReceiver} defined in your manifest. Instead,
2681 * apps are strongly encouraged to use the improved
2682 * {@link Context#getCacheDir()} behavior so the system can
2683 * automatically free up storage when needed.
2684 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002685 */
2686 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002687 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002688 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2689 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002690 * Broadcast Action: Indicates storage space full condition on the device no
2691 * longer exists.
2692 * <p class="note">
2693 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002694 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002695 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2696 * or above, this broadcast will no longer be delivered to any
2697 * {@link BroadcastReceiver} defined in your manifest. Instead,
2698 * apps are strongly encouraged to use the improved
2699 * {@link Context#getCacheDir()} behavior so the system can
2700 * automatically free up storage when needed.
2701 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002702 */
2703 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002704 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002705 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2706 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002707 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2708 * and package management should be started.
2709 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2710 * notification.
2711 */
2712 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2713 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2714 /**
2715 * Broadcast Action: The device has entered USB Mass Storage mode.
2716 * This is used mainly for the USB Settings panel.
2717 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2718 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002719 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002720 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002721 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002722 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002723 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2724
2725 /**
2726 * Broadcast Action: The device has exited USB Mass Storage mode.
2727 * This is used mainly for the USB Settings panel.
2728 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2729 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002730 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002731 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002732 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002733 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002734 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2735
2736 /**
2737 * Broadcast Action: External media has been removed.
2738 * The path to the mount point for the removed media is contained in the Intent.mData field.
2739 */
2740 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2741 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2742
2743 /**
2744 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002745 * 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 -07002746 */
2747 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2748 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2749
2750 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002751 * Broadcast Action: External media is present, and being disk-checked
2752 * 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 -08002753 */
2754 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2755 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2756
2757 /**
2758 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2759 * 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 -08002760 */
2761 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2762 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2763
2764 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002765 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002766 * 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 -07002767 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2768 * media was mounted read only.
2769 */
2770 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2771 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2772
2773 /**
2774 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002775 * 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 -07002776 */
2777 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2778 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2779
2780 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002781 * Broadcast Action: External media is no longer being shared via USB mass storage.
2782 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2783 *
2784 * @hide
2785 */
2786 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2787
2788 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002789 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2790 * The path to the mount point for the removed media is contained in the Intent.mData field.
2791 */
2792 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2793 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2794
2795 /**
2796 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002797 * 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 -07002798 */
2799 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2800 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2801
2802 /**
2803 * Broadcast Action: User has expressed the desire to remove the external storage media.
2804 * Applications should close all files they have open within the mount point when they receive this intent.
2805 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2806 */
2807 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2808 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2809
2810 /**
2811 * Broadcast Action: The media scanner has started scanning a directory.
2812 * The path to the directory being scanned is contained in the Intent.mData field.
2813 */
2814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2815 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2816
2817 /**
2818 * Broadcast Action: The media scanner has finished scanning a directory.
2819 * The path to the scanned directory is contained in the Intent.mData field.
2820 */
2821 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2822 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2823
2824 /**
2825 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2826 * The path to the file is contained in the Intent.mData field.
2827 */
2828 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2829 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2830
2831 /**
2832 * Broadcast Action: The "Media Button" was pressed. Includes a single
2833 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2834 * caused the broadcast.
2835 */
2836 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2837 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2838
2839 /**
2840 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2841 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2842 * caused the broadcast.
2843 */
2844 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2845 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2846
2847 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2848 // location; they are not general-purpose actions.
2849
2850 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002851 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002852 */
2853 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2854 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2855 "android.intent.action.GTALK_CONNECTED";
2856
2857 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002858 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002859 */
2860 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2861 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2862 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002863
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002864 /**
2865 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002866 */
2867 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2868 public static final String ACTION_INPUT_METHOD_CHANGED =
2869 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002870
2871 /**
2872 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2873 * more radios have been turned off or on. The intent will have the following extra value:</p>
2874 * <ul>
2875 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2876 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2877 * turned off</li>
2878 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002879 *
Peng Xua35b5532016-01-20 00:05:45 -08002880 * <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 -07002881 */
2882 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2883 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2884
2885 /**
2886 * Broadcast Action: Some content providers have parts of their namespace
2887 * where they publish new events or items that the user may be especially
2888 * interested in. For these things, they may broadcast this action when the
2889 * set of interesting items change.
2890 *
2891 * For example, GmailProvider sends this notification when the set of unread
2892 * mail in the inbox changes.
2893 *
2894 * <p>The data of the intent identifies which part of which provider
2895 * changed. When queried through the content resolver, the data URI will
2896 * return the data set in question.
2897 *
2898 * <p>The intent will have the following extra values:
2899 * <ul>
2900 * <li><em>count</em> - The number of items in the data set. This is the
2901 * same as the number of items in the cursor returned by querying the
2902 * data URI. </li>
2903 * </ul>
2904 *
2905 * This intent will be sent at boot (if the count is non-zero) and when the
2906 * data set changes. It is possible for the data set to change without the
2907 * count changing (for example, if a new unread message arrives in the same
2908 * sync operation in which a message is archived). The phone should still
2909 * ring/vibrate/etc as normal in this case.
2910 */
2911 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2912 public static final String ACTION_PROVIDER_CHANGED =
2913 "android.intent.action.PROVIDER_CHANGED";
2914
2915 /**
2916 * Broadcast Action: Wired Headset plugged in or unplugged.
2917 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002918 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2919 * and documentation.
2920 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002921 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002922 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002923 */
2924 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002925 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002926
2927 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002928 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2929 * <ul>
2930 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2931 * </ul>
2932 *
2933 * <p class="note">This is a protected intent that can only be sent
2934 * by the system.
2935 *
2936 * @hide
2937 */
2938 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2939 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2940 = "android.intent.action.ADVANCED_SETTINGS";
2941
2942 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002943 * Broadcast Action: Sent after application restrictions are changed.
2944 *
2945 * <p class="note">This is a protected intent that can only be sent
2946 * by the system.</p>
2947 */
2948 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2949 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2950 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2951
2952 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002953 * Broadcast Action: An outgoing call is about to be placed.
2954 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002955 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002956 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002957 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002958 * the phone number originally intended to be dialed.</li>
2959 * </ul>
2960 * <p>Once the broadcast is finished, the resultData is used as the actual
2961 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002962 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002963 * outgoing call in turn: for example, a parental control application
2964 * might verify that the user is authorized to place the call at that
2965 * time, then a number-rewriting application might add an area code if
2966 * one was not specified.</p>
2967 * <p>For consistency, any receiver whose purpose is to prohibit phone
2968 * calls should have a priority of 0, to ensure it will see the final
2969 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002970 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002971 * should have a positive priority.
2972 * Negative priorities are reserved for the system for this broadcast;
2973 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002974 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2975 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002976 * <p>Emergency calls cannot be intercepted using this mechanism, and
2977 * other calls cannot be modified to call emergency numbers using this
2978 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002979 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2980 * call to use their own service instead. Those apps should first prevent
2981 * the call from being placed by setting resultData to <code>null</code>
2982 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002983 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002984 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2985 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002986 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002987 * <p class="note">This is a protected intent that can only be sent
2988 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002989 */
2990 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2991 public static final String ACTION_NEW_OUTGOING_CALL =
2992 "android.intent.action.NEW_OUTGOING_CALL";
2993
2994 /**
2995 * Broadcast Action: Have the device reboot. This is only for use by
2996 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002997 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002998 * <p class="note">This is a protected intent that can only be sent
2999 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003000 */
3001 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3002 public static final String ACTION_REBOOT =
3003 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003004
Wei Huang97ecc9c2009-05-11 17:44:20 -07003005 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08003006 * Broadcast Action: A sticky broadcast for changes in the physical
3007 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08003008 *
3009 * <p>The intent will have the following extra values:
3010 * <ul>
3011 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08003012 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08003013 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08003014 * <p>This is intended for monitoring the current physical dock state.
3015 * See {@link android.app.UiModeManager} for the normal API dealing with
3016 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07003017 */
3018 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3019 public static final String ACTION_DOCK_EVENT =
3020 "android.intent.action.DOCK_EVENT";
3021
3022 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08003023 * Broadcast Action: A broadcast when idle maintenance can be started.
3024 * This means that the user is not interacting with the device and is
3025 * not expected to do so soon. Typical use of the idle maintenance is
3026 * to perform somehow expensive tasks that can be postponed at a moment
3027 * when they will not degrade user experience.
3028 * <p>
3029 * <p class="note">In order to keep the device responsive in case of an
3030 * unexpected user interaction, implementations of a maintenance task
3031 * should be interruptible. In such a scenario a broadcast with action
3032 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
3033 * should not do the maintenance work in
3034 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
3035 * maintenance service by {@link Context#startService(Intent)}. Also
3036 * you should hold a wake lock while your maintenance service is running
3037 * to prevent the device going to sleep.
3038 * </p>
3039 * <p>
3040 * <p class="note">This is a protected intent that can only be sent by
3041 * the system.
3042 * </p>
3043 *
3044 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07003045 *
3046 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08003047 */
3048 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3049 public static final String ACTION_IDLE_MAINTENANCE_START =
3050 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
3051
3052 /**
3053 * Broadcast Action: A broadcast when idle maintenance should be stopped.
3054 * This means that the user was not interacting with the device as a result
3055 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
3056 * was sent and now the user started interacting with the device. Typical
3057 * use of the idle maintenance is to perform somehow expensive tasks that
3058 * can be postponed at a moment when they will not degrade user experience.
3059 * <p>
3060 * <p class="note">In order to keep the device responsive in case of an
3061 * unexpected user interaction, implementations of a maintenance task
3062 * should be interruptible. Hence, on receiving a broadcast with this
3063 * action, the maintenance task should be interrupted as soon as possible.
3064 * In other words, you should not do the maintenance work in
3065 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
3066 * maintenance service that was started on receiving of
3067 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
3068 * lock you acquired when your maintenance service started.
3069 * </p>
3070 * <p class="note">This is a protected intent that can only be sent
3071 * by the system.
3072 *
3073 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07003074 *
3075 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08003076 */
3077 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3078 public static final String ACTION_IDLE_MAINTENANCE_END =
3079 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
3080
3081 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003082 * Broadcast Action: a remote intent is to be broadcasted.
3083 *
3084 * A remote intent is used for remote RPC between devices. The remote intent
3085 * is serialized and sent from one device to another device. The receiving
3086 * device parses the remote intent and broadcasts it. Note that anyone can
3087 * broadcast a remote intent. However, if the intent receiver of the remote intent
3088 * does not trust intent broadcasts from arbitrary intent senders, it should require
3089 * the sender to hold certain permissions so only trusted sender's broadcast will be
3090 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07003091 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07003092 */
3093 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07003094 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07003095
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003096 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06003097 * Broadcast Action: This is broadcast once when the user is booting after a
3098 * system update. It can be used to perform cleanup or upgrades after a
3099 * system update.
3100 * <p>
3101 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
3102 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
3103 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
3104 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003105 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003106 * @hide
3107 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003108 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003109 public static final String ACTION_PRE_BOOT_COMPLETED =
3110 "android.intent.action.PRE_BOOT_COMPLETED";
3111
Amith Yamasani13593602012-03-22 16:16:17 -07003112 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003113 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003114 * on restricted users. The broadcast intent contains an extra
3115 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
3116 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
3117 * String[] depending on the restriction type.<p/>
3118 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07003119 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
3120 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
3121 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003122 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
3123 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003124 * @see RestrictionEntry
3125 */
3126 public static final String ACTION_GET_RESTRICTION_ENTRIES =
3127 "android.intent.action.GET_RESTRICTION_ENTRIES";
3128
3129 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003130 * Sent the first time a user is starting, to allow system apps to
3131 * perform one time initialization. (This will not be seen by third
3132 * party applications because a newly initialized user does not have any
3133 * third party applications installed for it.) This is sent early in
3134 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003135 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3136 * broadcast, since it is part of a visible user interaction; be as quick
3137 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003138 */
3139 public static final String ACTION_USER_INITIALIZE =
3140 "android.intent.action.USER_INITIALIZE";
3141
3142 /**
3143 * Sent when a user switch is happening, causing the process's user to be
3144 * brought to the foreground. This is only sent to receivers registered
3145 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3146 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003147 * foreground. This is sent as a foreground
3148 * broadcast, since it is part of a visible user interaction; be as quick
3149 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003150 */
3151 public static final String ACTION_USER_FOREGROUND =
3152 "android.intent.action.USER_FOREGROUND";
3153
3154 /**
3155 * Sent when a user switch is happening, causing the process's user to be
3156 * sent to the background. This is only sent to receivers registered
3157 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3158 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003159 * background. This is sent as a foreground
3160 * broadcast, since it is part of a visible user interaction; be as quick
3161 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003162 */
3163 public static final String ACTION_USER_BACKGROUND =
3164 "android.intent.action.USER_BACKGROUND";
3165
3166 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003167 * Broadcast sent to the system when a user is added. Carries an extra
3168 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3169 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003170 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003171 * @hide
3172 */
3173 public static final String ACTION_USER_ADDED =
3174 "android.intent.action.USER_ADDED";
3175
3176 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003177 * Broadcast sent by the system when a user is started. Carries an extra
3178 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003179 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003180 * that has been started. This is sent as a foreground
3181 * broadcast, since it is part of a visible user interaction; be as quick
3182 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003183 * @hide
3184 */
3185 public static final String ACTION_USER_STARTED =
3186 "android.intent.action.USER_STARTED";
3187
3188 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003189 * Broadcast sent when a user is in the process of starting. Carries an extra
3190 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3191 * sent to registered receivers, not manifest receivers. It is sent to all
3192 * users (including the one that is being started). You must hold
3193 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3194 * this broadcast. This is sent as a background broadcast, since
3195 * its result is not part of the primary UX flow; to safely keep track of
3196 * started/stopped state of a user you can use this in conjunction with
3197 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3198 * other user state broadcasts since those are foreground broadcasts so can
3199 * execute in a different order.
3200 * @hide
3201 */
3202 public static final String ACTION_USER_STARTING =
3203 "android.intent.action.USER_STARTING";
3204
3205 /**
3206 * Broadcast sent when a user is going to be stopped. Carries an extra
3207 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3208 * sent to registered receivers, not manifest receivers. It is sent to all
3209 * users (including the one that is being stopped). You must hold
3210 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3211 * this broadcast. The user will not stop until all receivers have
3212 * handled the broadcast. This is sent as a background broadcast, since
3213 * its result is not part of the primary UX flow; to safely keep track of
3214 * started/stopped state of a user you can use this in conjunction with
3215 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3216 * other user state broadcasts since those are foreground broadcasts so can
3217 * execute in a different order.
3218 * @hide
3219 */
3220 public static final String ACTION_USER_STOPPING =
3221 "android.intent.action.USER_STOPPING";
3222
3223 /**
3224 * Broadcast sent to the system when a user is stopped. Carries an extra
3225 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3226 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3227 * specific package. This is only sent to registered receivers, not manifest
3228 * receivers. It is sent to all running users <em>except</em> the one that
3229 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003230 * @hide
3231 */
3232 public static final String ACTION_USER_STOPPED =
3233 "android.intent.action.USER_STOPPED";
3234
3235 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003236 * 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 -07003237 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003238 * one that has been removed. The user will not be completely removed until all receivers have
3239 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003240 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003241 * @hide
3242 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003243 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003244 public static final String ACTION_USER_REMOVED =
3245 "android.intent.action.USER_REMOVED";
3246
3247 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003248 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003249 * the userHandle of the user to become the current one. This is only sent to
3250 * registered receivers, not manifest receivers. It is sent to all running users.
3251 * You must hold
3252 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003253 * @hide
3254 */
3255 public static final String ACTION_USER_SWITCHED =
3256 "android.intent.action.USER_SWITCHED";
3257
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003258 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003259 * Broadcast Action: Sent when the credential-encrypted private storage has
3260 * become unlocked for the target user. This is only sent to registered
3261 * receivers, not manifest receivers.
3262 */
3263 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3264 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3265
3266 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003267 * Broadcast sent to the system when a user's information changes. Carries an extra
3268 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003269 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003270 * @hide
3271 */
3272 public static final String ACTION_USER_INFO_CHANGED =
3273 "android.intent.action.USER_INFO_CHANGED";
3274
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003275 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003276 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3277 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003278 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3279 * that need to display merged content across both primary and managed profiles need to
3280 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003281 * not manifest receivers.
3282 */
3283 public static final String ACTION_MANAGED_PROFILE_ADDED =
3284 "android.intent.action.MANAGED_PROFILE_ADDED";
3285
3286 /**
3287 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003288 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3289 * Only applications (for example Launchers) that need to display merged content across both
3290 * primary and managed profiles need to worry about this broadcast. This is only sent to
3291 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003292 */
3293 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3294 "android.intent.action.MANAGED_PROFILE_REMOVED";
3295
3296 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003297 * Broadcast sent to the primary user when the credential-encrypted private storage for
3298 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3299 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3300 * Launchers) that need to display merged content across both primary and managed profiles
3301 * need to worry about this broadcast. This is only sent to registered receivers,
3302 * not manifest receivers.
3303 */
3304 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3305 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3306
3307 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003308 * Broadcast sent to the primary user when an associated managed profile has become available.
3309 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003310 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3311 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3312 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003313 */
Rubin Xue95057a2016-04-01 16:49:25 +01003314 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3315 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3316
3317 /**
3318 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3319 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3320 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3321 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3322 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3323 */
3324 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3325 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003326
3327 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003328 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3329 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3330 * the device was locked or unlocked.
3331 *
3332 * This is only sent to registered receivers.
3333 *
3334 * @hide
3335 */
3336 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3337 "android.intent.action.DEVICE_LOCKED_CHANGED";
3338
3339 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003340 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3341 */
3342 public static final String ACTION_QUICK_CLOCK =
3343 "android.intent.action.QUICK_CLOCK";
3344
Michael Wright0087a142013-02-05 16:29:39 -08003345 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003346 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003347 * @hide
3348 */
3349 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003350 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003351
Justin Kohd378ad72013-04-01 12:18:26 -07003352 /**
3353 * Broadcast Action: A global button was pressed. Includes a single
3354 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3355 * caused the broadcast.
3356 * @hide
3357 */
Sujith Ramakrishnan48e19c82017-04-24 15:57:58 -07003358 @SystemApi
Justin Kohd378ad72013-04-01 12:18:26 -07003359 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3360
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003361 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003362 * Broadcast Action: Sent when media resource is granted.
3363 * <p>
3364 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3365 * granted.
3366 * </p>
3367 * <p class="note">
3368 * This is a protected intent that can only be sent by the system.
3369 * </p>
3370 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003371 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003372 * </p>
3373 *
3374 * @hide
3375 */
3376 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3377 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3378
3379 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003380 * Broadcast Action: An overlay package has changed. The data contains the
3381 * name of the overlay package which has changed. This is broadcast on all
3382 * changes to the OverlayInfo returned by {@link
3383 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3384 * most common change is a state change that will change whether the
3385 * overlay is enabled or not.
3386 * @hide
3387 */
3388 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3389
3390 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003391 * Activity Action: Allow the user to select and return one or more existing
3392 * documents. When invoked, the system will display the various
3393 * {@link DocumentsProvider} instances installed on the device, letting the
3394 * user interactively navigate through them. These documents include local
3395 * media, such as photos and video, and documents provided by installed
3396 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003397 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003398 * Each document is represented as a {@code content://} URI backed by a
3399 * {@link DocumentsProvider}, which can be opened as a stream with
3400 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3401 * {@link android.provider.DocumentsContract.Document} metadata.
3402 * <p>
3403 * All selected documents are returned to the calling application with
3404 * persistable read and write permission grants. If you want to maintain
3405 * access to the documents across device reboots, you need to explicitly
3406 * take the persistable permissions using
3407 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3408 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003409 * Callers must indicate the acceptable document MIME types through
3410 * {@link #setType(String)}. For example, to select photos, use
3411 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3412 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3413 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003414 * <p>
3415 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003416 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3417 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003418 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003419 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3420 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003421 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003422 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003423 * Callers can set a document URI through
3424 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3425 * location of documents navigator. System will do its best to launch the
3426 * navigator in the specified document if it's a folder, or the folder that
3427 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003428 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003429 * Output: The URI of the item that was picked, returned in
3430 * {@link #getData()}. This must be a {@code content://} URI so that any
3431 * receiver can access it. If multiple documents were selected, they are
3432 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003433 *
3434 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003435 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003436 * @see #ACTION_CREATE_DOCUMENT
3437 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003438 */
3439 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3440 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3441
3442 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003443 * Activity Action: Allow the user to create a new document. When invoked,
3444 * the system will display the various {@link DocumentsProvider} instances
3445 * installed on the device, letting the user navigate through them. The
3446 * returned document may be a newly created document with no content, or it
3447 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003448 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003449 * Each document is represented as a {@code content://} URI backed by a
3450 * {@link DocumentsProvider}, which can be opened as a stream with
3451 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3452 * {@link android.provider.DocumentsContract.Document} metadata.
3453 * <p>
3454 * Callers must indicate the concrete MIME type of the document being
3455 * created by setting {@link #setType(String)}. This MIME type cannot be
3456 * changed after the document is created.
3457 * <p>
3458 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3459 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003460 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003461 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3462 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003463 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003464 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003465 * Callers can set a document URI through
3466 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3467 * location of documents navigator. System will do its best to launch the
3468 * navigator in the specified document if it's a folder, or the folder that
3469 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003470 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003471 * Output: The URI of the item that was created. This must be a
3472 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003473 *
3474 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003475 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003476 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003477 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003478 */
3479 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3480 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3481
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003482 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003483 * Activity Action: Allow the user to pick a directory subtree. When
3484 * invoked, the system will display the various {@link DocumentsProvider}
3485 * instances installed on the device, letting the user navigate through
3486 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003487 * <p>
3488 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003489 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3490 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3491 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003492 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003493 * Callers can set a document URI through
3494 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3495 * location of documents navigator. System will do its best to launch the
3496 * navigator in the specified document if it's a folder, or the folder that
3497 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003498 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003499 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003500 *
3501 * @see DocumentsContract
3502 */
3503 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003504 public static final String
3505 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003506
Felipe Lemec7b1f892016-01-15 15:02:31 -08003507 /**
Peng Xua35b5532016-01-20 00:05:45 -08003508 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3509 * exisiting sensor being disconnected.
3510 *
3511 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3512 *
3513 * {@hide}
3514 */
3515 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3516 public static final String
3517 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3518
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003519 /**
Sam Line707f832017-04-13 17:00:55 -07003520 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003521 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003522 * @removed
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003523 */
3524 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003525 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003526 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3527
Christopher Tate6597e342015-02-17 12:15:25 -08003528 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003529 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3530 * is about to be performed.
3531 * @hide
3532 */
3533 @SystemApi
3534 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3535 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3536 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3537
3538 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003539 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3540 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3541 *
3542 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3543 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003544 * @hide
3545 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003546 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003547 public static final String EXTRA_FORCE_MASTER_CLEAR =
3548 "android.intent.extra.FORCE_MASTER_CLEAR";
3549
3550 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003551 * A broadcast action to trigger a factory reset.
3552 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003553 * <p>The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission. The
3554 * reason for the factory reset should be specified as {@link #EXTRA_REASON}.
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003555 *
3556 * <p>Not for use by third-party applications.
3557 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003558 * @see #EXTRA_FORCE_FACTORY_RESET
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003559 *
3560 * {@hide}
3561 */
3562 @SystemApi
3563 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3564 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3565
3566 /**
3567 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3568 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3569 *
3570 * <p>Not for use by third-party applications.
3571 *
3572 * @hide
3573 */
3574 @SystemApi
3575 public static final String EXTRA_FORCE_FACTORY_RESET =
3576 "android.intent.extra.FORCE_FACTORY_RESET";
3577
3578 /**
Michal Karpinski6135a262017-08-11 10:45:58 +01003579 * Broadcast action: report that a settings element is being restored from backup. The intent
3580 * contains four extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3581 * EXTRA_SETTING_NEW_VALUE is the value being restored, EXTRA_SETTING_PREVIOUS_VALUE
3582 * is the value of that settings entry prior to the restore operation, and
3583 * EXTRA_SETTING_RESTORED_FROM_SDK_INT is the version of the SDK that the setting has been
3584 * restored from (corresponds to {@link android.os.Build.VERSION#SDK_INT}). The first three
3585 * values are represented as strings, the fourth one as int.
Christopher Tate6597e342015-02-17 12:15:25 -08003586 *
3587 * <p>This broadcast is sent only for settings provider entries known to require special handling
3588 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3589 * the provider's backup agent implementation.
3590 *
3591 * @see #EXTRA_SETTING_NAME
3592 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3593 * @see #EXTRA_SETTING_NEW_VALUE
Michal Karpinski6135a262017-08-11 10:45:58 +01003594 * @see #EXTRA_SETTING_RESTORED_FROM_SDK_INT
Christopher Tate6597e342015-02-17 12:15:25 -08003595 * {@hide}
3596 */
3597 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3598
3599 /** {@hide} */
3600 public static final String EXTRA_SETTING_NAME = "setting_name";
3601 /** {@hide} */
3602 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3603 /** {@hide} */
3604 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
Michal Karpinski6135a262017-08-11 10:45:58 +01003605 /** {@hide} */
3606 public static final String EXTRA_SETTING_RESTORED_FROM_SDK_INT = "restored_from_sdk_int";
Christopher Tate6597e342015-02-17 12:15:25 -08003607
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003608 /**
3609 * Activity Action: Process a piece of text.
3610 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3611 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3612 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3613 */
3614 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3615 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003616
3617 /**
3618 * Broadcast Action: The sim card state has changed.
3619 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3620 * because TelephonyIntents is an internal class.
3621 * @hide
Amit Mahajan052e1e22018-01-12 17:40:29 -08003622 * @deprecated Use {@link #ACTION_SIM_CARD_STATE_CHANGED} or
3623 * {@link #ACTION_SIM_APPLICATION_STATE_CHANGED}
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003624 */
Amit Mahajan052e1e22018-01-12 17:40:29 -08003625 @Deprecated
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003626 @SystemApi
3627 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3628 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3629
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003630 /**
fionaxu90fee272017-03-31 12:45:12 -07003631 * Broadcast Action: indicate that the phone service state has changed.
3632 * The intent will have the following extra values:</p>
3633 * <p>
3634 * @see #EXTRA_VOICE_REG_STATE
3635 * @see #EXTRA_DATA_REG_STATE
3636 * @see #EXTRA_VOICE_ROAMING_TYPE
3637 * @see #EXTRA_DATA_ROAMING_TYPE
3638 * @see #EXTRA_OPERATOR_ALPHA_LONG
3639 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3640 * @see #EXTRA_OPERATOR_NUMERIC
3641 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3642 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3643 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3644 * @see #EXTRA_MANUAL
3645 * @see #EXTRA_VOICE_RADIO_TECH
3646 * @see #EXTRA_DATA_RADIO_TECH
3647 * @see #EXTRA_CSS_INDICATOR
3648 * @see #EXTRA_NETWORK_ID
3649 * @see #EXTRA_SYSTEM_ID
3650 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3651 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3652 * @see #EXTRA_EMERGENCY_ONLY
3653 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3654 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3655 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3656 *
3657 * <p class="note">
3658 * Requires the READ_PHONE_STATE permission.
3659 *
3660 * <p class="note">This is a protected intent that can only be sent by the system.
3661 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003662 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003663 */
3664 @Deprecated
3665 @SystemApi
3666 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3667 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3668
3669 /**
3670 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3671 * state.
3672 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3673 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3674 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3675 * @see android.telephony.ServiceState#STATE_POWER_OFF
3676 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003677 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003678 */
3679 @Deprecated
3680 @SystemApi
3681 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3682
3683 /**
3684 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3685 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3686 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3687 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3688 * @see android.telephony.ServiceState#STATE_POWER_OFF
3689 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003690 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003691 */
3692 @Deprecated
3693 @SystemApi
3694 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3695
3696 /**
3697 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3698 * type.
3699 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003700 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003701 */
3702 @Deprecated
3703 @SystemApi
3704 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3705
3706 /**
3707 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3708 * type.
3709 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003710 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003711 */
3712 @Deprecated
3713 @SystemApi
3714 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3715
3716 /**
3717 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3718 * registered voice operator name in long alphanumeric format.
3719 * {@code null} if the operator name is not known or unregistered.
3720 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003721 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003722 */
3723 @Deprecated
3724 @SystemApi
3725 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3726
3727 /**
3728 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3729 * registered voice operator name in short alphanumeric format.
3730 * {@code null} if the operator name is not known or unregistered.
3731 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003732 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003733 */
3734 @Deprecated
3735 @SystemApi
3736 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3737
3738 /**
3739 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3740 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3741 * network.
3742 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003743 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003744 */
3745 @Deprecated
3746 @SystemApi
3747 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3748
3749 /**
3750 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3751 * registered data operator name in long alphanumeric format.
3752 * {@code null} if the operator name is not known or unregistered.
3753 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003754 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003755 */
3756 @Deprecated
3757 @SystemApi
3758 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3759
3760 /**
3761 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3762 * registered data operator name in short alphanumeric format.
3763 * {@code null} if the operator name is not known or unregistered.
3764 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003765 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003766 */
3767 @Deprecated
3768 @SystemApi
3769 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3770
3771 /**
3772 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3773 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3774 * data operator.
3775 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003776 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003777 */
3778 @Deprecated
3779 @SystemApi
3780 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3781
3782 /**
3783 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3784 * network selection mode is manual.
3785 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3786 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003787 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003788 */
3789 @Deprecated
3790 @SystemApi
3791 public static final String EXTRA_MANUAL = "manual";
3792
3793 /**
3794 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3795 * radio technology.
3796 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003797 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003798 */
3799 @Deprecated
3800 @SystemApi
3801 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3802
3803 /**
3804 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3805 * radio technology.
3806 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003807 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003808 */
3809 @Deprecated
3810 @SystemApi
3811 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3812
3813 /**
3814 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3815 * support on CDMA network.
3816 * Will be {@code true} if support, {@code false} otherwise.
3817 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003818 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003819 */
3820 @Deprecated
3821 @SystemApi
3822 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3823
3824 /**
3825 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3826 * id. {@code Integer.MAX_VALUE} if unknown.
3827 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003828 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003829 */
3830 @Deprecated
3831 @SystemApi
3832 public static final String EXTRA_NETWORK_ID = "networkId";
3833
3834 /**
3835 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3836 * {@code Integer.MAX_VALUE} if unknown.
3837 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003838 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003839 */
3840 @Deprecated
3841 @SystemApi
3842 public static final String EXTRA_SYSTEM_ID = "systemId";
3843
3844 /**
3845 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3846 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3847 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003848 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003849 */
3850 @Deprecated
3851 @SystemApi
3852 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3853
3854 /**
3855 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3856 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3857 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003858 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003859 */
3860 @Deprecated
3861 @SystemApi
3862 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3863
3864 /**
3865 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3866 * only mode.
3867 * {@code true} if in emergency only mode, {@code false} otherwise.
3868 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003869 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003870 */
3871 @Deprecated
3872 @SystemApi
3873 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3874
3875 /**
3876 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3877 * registration state is roaming.
3878 * {@code true} if registration indicates roaming, {@code false} otherwise
3879 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003880 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003881 */
3882 @Deprecated
3883 @SystemApi
3884 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
3885 "isDataRoamingFromRegistration";
3886
3887 /**
3888 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
3889 * aggregation is in use.
3890 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
3891 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003892 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003893 */
3894 @Deprecated
3895 @SystemApi
3896 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
3897
3898 /**
3899 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
3900 * is reduced from the rsrp threshold while calculating signal strength level.
3901 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003902 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003903 */
3904 @Deprecated
3905 @SystemApi
3906 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
3907
3908 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003909 * The name of the extra used to define the text to be processed, as a
3910 * CharSequence. Note that this may be a styled CharSequence, so you must use
3911 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003912 */
3913 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3914 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003915 * 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 +00003916 */
3917 public static final String EXTRA_PROCESS_TEXT_READONLY =
3918 "android.intent.extra.PROCESS_TEXT_READONLY";
3919
Bryce Leebc58f592015-09-25 16:43:01 -07003920 /**
3921 * Broadcast action: reports when a new thermal event has been reached. When the device
3922 * is reaching its maximum temperatue, the thermal level reported
3923 * {@hide}
3924 */
3925 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3926 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3927
3928 /** {@hide} */
3929 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3930
3931 /**
3932 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003933 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003934 * {@hide}
3935 */
3936 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3937
3938 /**
3939 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003940 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003941 * {@hide}
3942 */
3943 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3944
3945 /**
3946 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003947 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003948 * {@hide}
3949 */
3950 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3951
3952
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003953 // ---------------------------------------------------------------------
3954 // ---------------------------------------------------------------------
3955 // Standard intent categories (see addCategory()).
3956
3957 /**
3958 * Set if the activity should be an option for the default action
3959 * (center press) to perform on a piece of data. Setting this will
3960 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003961 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003962 * Intent when initiating an action -- it is for use in intent filters
3963 * specified in packages.
3964 */
3965 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3966 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3967 /**
3968 * Activities that can be safely invoked from a browser must support this
3969 * category. For example, if the user is viewing a web page or an e-mail
3970 * and clicks on a link in the text, the Intent generated execute that
3971 * link will require the BROWSABLE category, so that only activities
3972 * supporting this category will be considered as possible actions. By
3973 * supporting this category, you are promising that there is nothing
3974 * damaging (without user intervention) that can happen by invoking any
3975 * matching Intent.
3976 */
3977 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3978 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3979 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003980 * Categories for activities that can participate in voice interaction.
3981 * An activity that supports this category must be prepared to run with
3982 * no UI shown at all (though in some case it may have a UI shown), and
3983 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3984 */
3985 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3986 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3987 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003988 * Set if the activity should be considered as an alternative action to
3989 * the data the user is currently viewing. See also
3990 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3991 * applies to the selection in a list of items.
3992 *
3993 * <p>Supporting this category means that you would like your activity to be
3994 * displayed in the set of alternative things the user can do, usually as
3995 * part of the current activity's options menu. You will usually want to
3996 * include a specific label in the &lt;intent-filter&gt; of this action
3997 * describing to the user what it does.
3998 *
3999 * <p>The action of IntentFilter with this category is important in that it
4000 * describes the specific action the target will perform. This generally
4001 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
4002 * a specific name such as "com.android.camera.action.CROP. Only one
4003 * alternative of any particular action will be shown to the user, so using
4004 * a specific action like this makes sure that your alternative will be
4005 * displayed while also allowing other applications to provide their own
4006 * overrides of that particular action.
4007 */
4008 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4009 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
4010 /**
4011 * Set if the activity should be considered as an alternative selection
4012 * action to the data the user has currently selected. This is like
4013 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
4014 * of items from which the user can select, giving them alternatives to the
4015 * default action that will be performed on it.
4016 */
4017 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4018 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
4019 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004020 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004021 */
4022 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4023 public static final String CATEGORY_TAB = "android.intent.category.TAB";
4024 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004025 * Should be displayed in the top-level launcher.
4026 */
4027 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4028 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
4029 /**
Jose Lima38b75b62014-03-11 10:41:39 -07004030 * Indicates an activity optimized for Leanback mode, and that should
4031 * be displayed in the Leanback launcher.
4032 */
4033 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4034 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
4035 /**
Roberto Perez7ee1a7a2017-12-04 17:14:33 -08004036 * Indicates the preferred entry-point activity when an application is launched from a Car
4037 * launcher. If not present, Car launcher can optionally use {@link #CATEGORY_LAUNCHER} as a
4038 * fallback, or exclude the application entirely.
4039 * @hide
4040 */
4041 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4042 public static final String CATEGORY_CAR_LAUNCHER = "android.intent.category.CAR_LAUNCHER";
4043 /**
Jose Lima73915cf2014-07-29 17:16:31 -07004044 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
4045 * @hide
4046 */
4047 @SystemApi
4048 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
4049 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004050 * Provides information about the package it is in; typically used if
4051 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
4052 * a front-door to the user without having to be shown in the all apps list.
4053 */
4054 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4055 public static final String CATEGORY_INFO = "android.intent.category.INFO";
4056 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004057 * This is the home activity, that is the first activity that is displayed
4058 * when the device boots.
4059 */
4060 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4061 public static final String CATEGORY_HOME = "android.intent.category.HOME";
4062 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07004063 * This is the home activity that is displayed when the device is finished setting up and ready
4064 * for use.
4065 * @hide
4066 */
4067 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4068 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
4069 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07004070 * This is the setup wizard activity, that is the first activity that is displayed
4071 * when the user sets up the device for the first time.
4072 * @hide
4073 */
4074 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4075 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
4076 /**
Svet Ganov5bb6bc62017-08-28 12:39:35 -07004077 * This is the home activity, that is the activity that serves as the launcher app
4078 * from there the user can start other apps. Often components with lower/higher
4079 * priority intent filters handle the home intent, for example SetupWizard, to
4080 * setup the device and we need to be able to distinguish the home app from these
4081 * setup helpers.
4082 * @hide
4083 */
4084 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4085 public static final String CATEGORY_LAUNCHER_APP = "android.intent.category.LAUNCHER_APP";
4086 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004087 * This activity is a preference panel.
4088 */
4089 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4090 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
4091 /**
4092 * This activity is a development preference panel.
4093 */
4094 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4095 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
4096 /**
4097 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004098 */
4099 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4100 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
4101 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07004102 * This activity allows the user to browse and download new applications.
4103 */
4104 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4105 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
4106 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004107 * This activity may be exercised by the monkey or other automated test tools.
4108 */
4109 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4110 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
4111 /**
4112 * To be used as a test (not part of the normal user experience).
4113 */
4114 public static final String CATEGORY_TEST = "android.intent.category.TEST";
4115 /**
4116 * To be used as a unit test (run through the Test Harness).
4117 */
4118 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
4119 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004120 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004121 * experience).
4122 */
4123 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004124
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004125 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004126 * Used to indicate that an intent only wants URIs that can be opened with
4127 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
4128 * must support at least the columns defined in {@link OpenableColumns} when
4129 * queried.
4130 *
4131 * @see #ACTION_GET_CONTENT
4132 * @see #ACTION_OPEN_DOCUMENT
4133 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004134 */
4135 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4136 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
4137
4138 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09004139 * Used to indicate that an intent filter can accept files which are not necessarily
4140 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
4141 * at least streamable via
4142 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
4143 * using one of the stream types exposed via
4144 * {@link ContentResolver#getStreamTypes(Uri, String)}.
4145 *
4146 * @see #ACTION_SEND
4147 * @see #ACTION_SEND_MULTIPLE
4148 */
4149 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4150 public static final String CATEGORY_TYPED_OPENABLE =
4151 "android.intent.category.TYPED_OPENABLE";
4152
4153 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004154 * To be used as code under test for framework instrumentation tests.
4155 */
4156 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
4157 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04004158 /**
4159 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004160 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4161 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004162 */
4163 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4164 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
4165 /**
4166 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004167 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4168 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004169 */
4170 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4171 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004172 /**
4173 * An activity to run when device is inserted into a analog (low end) dock.
4174 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4175 * information, see {@link android.app.UiModeManager}.
4176 */
4177 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4178 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
4179
4180 /**
4181 * An activity to run when device is inserted into a digital (high end) dock.
4182 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4183 * information, see {@link android.app.UiModeManager}.
4184 */
4185 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4186 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004187
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004188 /**
4189 * Used to indicate that the activity can be used in a car environment.
4190 */
4191 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4192 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4193
Zak Cohendb6ca492017-01-26 14:09:00 -08004194 /**
4195 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4196 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4197 * information, see {@link android.app.UiModeManager}.
4198 */
4199 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4200 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004201 // ---------------------------------------------------------------------
4202 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004203 // Application launch intent categories (see addCategory()).
4204
4205 /**
4206 * Used with {@link #ACTION_MAIN} to launch the browser application.
4207 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004208 * <p>NOTE: This should not be used as the primary key of an Intent,
4209 * since it will not result in the app launching with the correct
4210 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004211 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004212 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004213 */
4214 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4215 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4216
4217 /**
4218 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4219 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004220 * <p>NOTE: This should not be used as the primary key of an Intent,
4221 * since it will not result in the app launching with the correct
4222 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004223 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004224 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004225 */
4226 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4227 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4228
4229 /**
4230 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4231 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004232 * <p>NOTE: This should not be used as the primary key of an Intent,
4233 * since it will not result in the app launching with the correct
4234 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004235 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004236 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004237 */
4238 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4239 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4240
4241 /**
4242 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4243 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004244 * <p>NOTE: This should not be used as the primary key of an Intent,
4245 * since it will not result in the app launching with the correct
4246 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004247 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004248 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004249 */
4250 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4251 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4252
4253 /**
4254 * Used with {@link #ACTION_MAIN} to launch the email application.
4255 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004256 * <p>NOTE: This should not be used as the primary key of an Intent,
4257 * since it will not result in the app launching with the correct
4258 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004259 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004260 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004261 */
4262 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4263 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4264
4265 /**
4266 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4267 * The activity should be able to view and manipulate image and video files
4268 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004269 * <p>NOTE: This should not be used as the primary key of an Intent,
4270 * since it will not result in the app launching with the correct
4271 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004272 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004273 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004274 */
4275 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4276 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4277
4278 /**
4279 * Used with {@link #ACTION_MAIN} to launch the maps application.
4280 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004281 * <p>NOTE: This should not be used as the primary key of an Intent,
4282 * since it will not result in the app launching with the correct
4283 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004284 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004285 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004286 */
4287 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4288 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4289
4290 /**
4291 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4292 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004293 * <p>NOTE: This should not be used as the primary key of an Intent,
4294 * since it will not result in the app launching with the correct
4295 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004296 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004297 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004298 */
4299 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4300 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4301
4302 /**
4303 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004304 * The activity should be able to play, browse, or manipulate music files
4305 * stored on the device.
4306 * <p>NOTE: This should not be used as the primary key of an Intent,
4307 * since it will not result in the app launching with the correct
4308 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004309 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004310 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004311 */
4312 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4313 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4314
4315 // ---------------------------------------------------------------------
4316 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004317 // Standard extra data keys.
4318
4319 /**
4320 * The initial data to place in a newly created record. Use with
4321 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4322 * fields as would be given to the underlying ContentProvider.insert()
4323 * call.
4324 */
4325 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4326
4327 /**
4328 * A constant CharSequence that is associated with the Intent, used with
4329 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4330 * this may be a styled CharSequence, so you must use
4331 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4332 * retrieve it.
4333 */
4334 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4335
4336 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004337 * A constant String that is associated with the Intent, used with
4338 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4339 * as HTML formatted text. Note that you <em>must</em> also supply
4340 * {@link #EXTRA_TEXT}.
4341 */
4342 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4343
4344 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004345 * A content: URI holding a stream of data associated with the Intent,
4346 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004347 */
4348 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4349
4350 /**
4351 * A String[] holding e-mail addresses that should be delivered to.
4352 */
4353 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4354
4355 /**
4356 * A String[] holding e-mail addresses that should be carbon copied.
4357 */
4358 public static final String EXTRA_CC = "android.intent.extra.CC";
4359
4360 /**
4361 * A String[] holding e-mail addresses that should be blind carbon copied.
4362 */
4363 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4364
4365 /**
4366 * A constant string holding the desired subject line of a message.
4367 */
4368 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4369
4370 /**
4371 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004372 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004373 */
4374 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4375
4376 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004377 * An int representing the user id to be used.
4378 *
4379 * @hide
4380 */
4381 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4382
4383 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004384 * An int representing the task id to be retrieved. This is used when a launch from recents is
4385 * intercepted by another action such as credentials confirmation to remember which task should
4386 * be resumed when complete.
4387 *
4388 * @hide
4389 */
4390 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4391
4392 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004393 * An Intent[] describing additional, alternate choices you would like shown with
4394 * {@link #ACTION_CHOOSER}.
4395 *
4396 * <p>An app may be capable of providing several different payload types to complete a
4397 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4398 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4399 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4400 * photo data or a hosted link where the photos can be viewed.</p>
4401 *
4402 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4403 * first/primary/preferred intent in the set. Additional intents specified in
4404 * this extra are ordered; by default intents that appear earlier in the array will be
4405 * preferred over intents that appear later in the array as matches for the same
4406 * target component. To alter this preference, a calling app may also supply
4407 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4408 */
4409 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4410
4411 /**
Adam Powell52c39212016-04-07 15:14:18 -07004412 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4413 * and omitted from a list of components presented to the user.
4414 *
4415 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4416 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4417 * from your own package or other apps from your organization if the idea of sending to those
4418 * targets would be redundant with other app functionality. Filtered components will not
4419 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4420 */
4421 public static final String EXTRA_EXCLUDE_COMPONENTS
4422 = "android.intent.extra.EXCLUDE_COMPONENTS";
4423
4424 /**
4425 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4426 * describing additional high-priority deep-link targets for the chooser to present to the user.
4427 *
4428 * <p>Targets provided in this way will be presented inline with all other targets provided
4429 * by services from other apps. They will be prioritized before other service targets, but
4430 * after those targets provided by sources that the user has manually pinned to the front.</p>
4431 *
4432 * @see #ACTION_CHOOSER
4433 */
4434 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4435
4436 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004437 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4438 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4439 *
4440 * <p>An app preparing an action for another app to complete may wish to allow the user to
4441 * disambiguate between several options for completing the action based on the chosen target
4442 * or otherwise refine the action before it is invoked.
4443 * </p>
4444 *
4445 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4446 * <ul>
4447 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4448 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4449 * chosen target beyond the first</li>
4450 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4451 * should fill in and send once the disambiguation is complete</li>
4452 * </ul>
4453 */
4454 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4455 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4456
4457 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004458 * An {@code ArrayList} of {@code String} annotations describing content for
4459 * {@link #ACTION_CHOOSER}.
4460 *
4461 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4462 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4463 *
4464 * <p>Annotations should describe the major components or topics of the content. It is up to
4465 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4466 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004467 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4468 * character. Performance on customized annotations can suffer, if they are rarely used for
4469 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4470 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004471 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004472 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004473 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004474 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004475 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004476 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004477 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004478 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004479 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004480 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4481 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4482 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4483 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4484 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004485 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004486 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4487 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004488 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004489 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004490 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004491 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004492 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004493 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004494 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004495 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004496 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004497 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004498 * Christmas and Thanksgiving.</li>
4499 * </ul>
4500 */
4501 public static final String EXTRA_CONTENT_ANNOTATIONS
4502 = "android.intent.extra.CONTENT_ANNOTATIONS";
4503
4504 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004505 * A {@link ResultReceiver} used to return data back to the sender.
4506 *
4507 * <p>Used to complete an app-specific
4508 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4509 *
4510 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4511 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4512 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4513 * when the user selects a target component from the chooser. It is up to the recipient
4514 * to send a result to this ResultReceiver to signal that disambiguation is complete
4515 * and that the chooser should invoke the user's choice.</p>
4516 *
4517 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4518 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4519 * to match and fill in the final Intent or ChooserTarget before starting it.
4520 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4521 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4522 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4523 *
4524 * <p>The result code passed to the ResultReceiver should be
4525 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4526 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4527 * the chooser should finish without starting a target.</p>
4528 */
4529 public static final String EXTRA_RESULT_RECEIVER
4530 = "android.intent.extra.RESULT_RECEIVER";
4531
4532 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004533 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004534 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004535 */
4536 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4537
4538 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004539 * A Parcelable[] of {@link Intent} or
4540 * {@link android.content.pm.LabeledIntent} objects as set with
4541 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4542 * a the front of the list of choices, when shown to the user with a
4543 * {@link #ACTION_CHOOSER}.
4544 */
4545 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4546
4547 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004548 * A {@link IntentSender} to start after ephemeral installation success.
Patrick Baumann159cd022018-01-11 13:25:05 -08004549 * @deprecated Use {@link #EXTRA_INSTANT_APP_SUCCESS).
4550 * @removed
Todd Kennedy7440f172015-12-09 14:31:22 -08004551 * @hide
4552 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004553 @Deprecated
Todd Kennedy7440f172015-12-09 14:31:22 -08004554 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4555
4556 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004557 * A {@link IntentSender} to start after instant app installation success.
Todd Kennedy7440f172015-12-09 14:31:22 -08004558 * @hide
4559 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004560 @SystemApi
4561 public static final String EXTRA_INSTANT_APP_SUCCESS =
4562 "android.intent.extra.INSTANT_APP_SUCCESS";
4563
4564 /**
4565 * A {@link IntentSender} to start after ephemeral installation failure.
4566 * @deprecated Use {@link #EXTRA_INSTANT_APP_FAILURE).
4567 * @removed
4568 * @hide
4569 */
4570 @Deprecated
Todd Kennedy7440f172015-12-09 14:31:22 -08004571 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4572
4573 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004574 * A {@link IntentSender} to start after instant app installation failure.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004575 * @hide
4576 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004577 @SystemApi
4578 public static final String EXTRA_INSTANT_APP_FAILURE =
4579 "android.intent.extra.INSTANT_APP_FAILURE";
4580
4581 /**
4582 * The host name that triggered an ephemeral resolution.
4583 * @deprecated Use {@link #EXTRA_INSTANT_APP_HOSTNAME).
4584 * @removed
4585 * @hide
4586 */
4587 @Deprecated
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004588 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4589
4590 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004591 * The host name that triggered an instant app resolution.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004592 * @hide
4593 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004594 @SystemApi
4595 public static final String EXTRA_INSTANT_APP_HOSTNAME =
4596 "android.intent.extra.INSTANT_APP_HOSTNAME";
4597
4598 /**
4599 * An opaque token to track ephemeral resolution.
4600 * @deprecated Use {@link #EXTRA_INSTANT_APP_TOKEN).
4601 * @removed
4602 * @hide
4603 */
4604 @Deprecated
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004605 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4606
4607 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004608 * An opaque token to track instant app resolution.
4609 * @hide
4610 */
4611 @SystemApi
4612 public static final String EXTRA_INSTANT_APP_TOKEN =
4613 "android.intent.extra.INSTANT_APP_TOKEN";
4614
4615 /**
Patrick Baumannb4165d72017-12-04 11:29:24 -08004616 * The action that triggered an instant application resolution.
4617 * @hide
4618 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004619 @SystemApi
Patrick Baumannb4165d72017-12-04 11:29:24 -08004620 public static final String EXTRA_INSTANT_APP_ACTION = "android.intent.extra.INSTANT_APP_ACTION";
4621
4622 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004623 * An array of {@link Bundle}s containing details about resolved instant apps..
4624 * @hide
4625 */
4626 @SystemApi
4627 public static final String EXTRA_INSTANT_APP_BUNDLES =
4628 "android.intent.extra.INSTANT_APP_BUNDLES";
4629
4630 /**
4631 * A {@link Bundle} of metadata that describes the instant application that needs to be
Patrick Baumann709ee152017-12-04 16:12:52 -08004632 * installed. This data is populated from the response to
4633 * {@link android.content.pm.InstantAppResolveInfo#getExtras()} as provided by the registered
4634 * instant application resolver.
4635 * @hide
4636 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004637 @SystemApi
Patrick Baumann709ee152017-12-04 16:12:52 -08004638 public static final String EXTRA_INSTANT_APP_EXTRAS =
4639 "android.intent.extra.INSTANT_APP_EXTRAS";
4640
4641 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004642 * A boolean value indicating that the instant app resolver was unable to state with certainty
4643 * that it did or did not have an app for the sanitized {@link Intent} defined at
4644 * {@link #EXTRA_INTENT}.
4645 * @hide
4646 */
4647 @SystemApi
4648 public static final String EXTRA_UNKNOWN_INSTANT_APP =
4649 "android.intent.extra.UNKNOWN_INSTANT_APP";
4650
4651 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004652 * The version code of the app to install components from.
Dianne Hackborn3accca02013-09-20 09:32:11 -07004653 * @deprecated Use {@link #EXTRA_LONG_VERSION_CODE).
Todd Kennedy316c2f22017-01-23 15:40:07 -08004654 * @hide
4655 */
Dianne Hackborn3accca02013-09-20 09:32:11 -07004656 @Deprecated
Todd Kennedy316c2f22017-01-23 15:40:07 -08004657 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4658
4659 /**
Dianne Hackborn3accca02013-09-20 09:32:11 -07004660 * The version code of the app to install components from.
4661 * @hide
4662 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004663 @SystemApi
Dianne Hackborn3accca02013-09-20 09:32:11 -07004664 public static final String EXTRA_LONG_VERSION_CODE = "android.intent.extra.LONG_VERSION_CODE";
4665
4666 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004667 * The app that triggered the instant app installation.
Chad Brubaker06068612017-04-06 09:43:47 -07004668 * @hide
4669 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004670 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004671 public static final String EXTRA_CALLING_PACKAGE
4672 = "android.intent.extra.CALLING_PACKAGE";
4673
4674 /**
4675 * Optional calling app provided bundle containing additional launch information the
4676 * installer may use.
4677 * @hide
4678 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004679 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004680 public static final String EXTRA_VERIFICATION_BUNDLE
4681 = "android.intent.extra.VERIFICATION_BUNDLE";
4682
4683 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004684 * A Bundle forming a mapping of potential target package names to different extras Bundles
4685 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4686 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4687 * be currently installed on the device.
4688 *
4689 * <p>An application may choose to provide alternate extras for the case where a user
4690 * selects an activity from a predetermined set of target packages. If the activity
4691 * the user selects from the chooser belongs to a package with its package name as
4692 * a key in this bundle, the corresponding extras for that package will be merged with
4693 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4694 * extra has the same key as an extra already present in the intent it will overwrite
4695 * the extra from the intent.</p>
4696 *
4697 * <p><em>Examples:</em>
4698 * <ul>
4699 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4700 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4701 * parameters for that target.</li>
4702 * <li>An application may offer additional metadata for known targets of a given intent
4703 * to pass along information only relevant to that target such as account or content
4704 * identifiers already known to that application.</li>
4705 * </ul></p>
4706 */
4707 public static final String EXTRA_REPLACEMENT_EXTRAS =
4708 "android.intent.extra.REPLACEMENT_EXTRAS";
4709
4710 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004711 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4712 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4713 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4714 * {@link ComponentName} of the chosen component.
4715 *
4716 * <p>In some situations this callback may never come, for example if the user abandons
4717 * the chooser, switches to another task or any number of other reasons. Apps should not
4718 * be written assuming that this callback will always occur.</p>
4719 */
4720 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4721 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4722
4723 /**
4724 * The {@link ComponentName} chosen by the user to complete an action.
4725 *
4726 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4727 */
4728 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4729
4730 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004731 * A {@link android.view.KeyEvent} object containing the event that
4732 * triggered the creation of the Intent it is in.
4733 */
4734 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4735
4736 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004737 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4738 * before shutting down.
4739 *
4740 * {@hide}
4741 */
4742 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4743
4744 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004745 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4746 * requested by the user.
4747 *
4748 * {@hide}
4749 */
4750 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4751 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4752
4753 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004754 * 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 -07004755 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4756 * of restarting the application.
4757 */
4758 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4759
4760 /**
4761 * A String holding the phone number originally entered in
4762 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4763 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4764 */
4765 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004766
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004767 /**
4768 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4769 * intents to supply the uid the package had been assigned. Also an optional
4770 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4771 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4772 * purpose.
4773 */
4774 public static final String EXTRA_UID = "android.intent.extra.UID";
4775
4776 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004777 * @hide String array of package names.
4778 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004779 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004780 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4781
4782 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004783 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4784 * intents to indicate whether this represents a full uninstall (removing
4785 * both the code and its data) or a partial uninstall (leaving its data,
4786 * implying that this is an update).
4787 */
4788 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004789
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004790 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004791 * @hide
4792 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4793 * intents to indicate that at this point the package has been removed for
4794 * all users on the device.
4795 */
4796 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4797 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4798
4799 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004800 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4801 * intents to indicate that this is a replacement of the package, so this
4802 * broadcast will immediately be followed by an add broadcast for a
4803 * different version of the same package.
4804 */
4805 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004806
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004807 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004808 * Used as an int extra field in {@link android.app.AlarmManager} intents
4809 * to tell the application being invoked how many pending alarms are being
4810 * delievered with the intent. For one-shot alarms this will always be 1.
4811 * For recurring alarms, this might be greater than 1 if the device was
4812 * asleep or powered off at the time an earlier alarm would have been
4813 * delivered.
4814 */
4815 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004816
Jacek Surazski86b6c532009-05-13 14:38:28 +02004817 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004818 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4819 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004820 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4821 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004822 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4823 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4824 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004825 */
4826 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4827
4828 /**
4829 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4830 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004831 */
4832 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4833
4834 /**
4835 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4836 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004837 */
4838 public static final int EXTRA_DOCK_STATE_DESK = 1;
4839
4840 /**
4841 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4842 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004843 */
4844 public static final int EXTRA_DOCK_STATE_CAR = 2;
4845
4846 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004847 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4848 * to represent that the phone is in a analog (low end) dock.
4849 */
4850 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4851
4852 /**
4853 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4854 * to represent that the phone is in a digital (high end) dock.
4855 */
4856 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4857
4858 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004859 * Boolean that can be supplied as meta-data with a dock activity, to
4860 * indicate that the dock should take over the home key when it is active.
4861 */
4862 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004863
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004864 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004865 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4866 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004867 */
4868 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4869
4870 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004871 * Used in the extra field in the remote intent. It's astring token passed with the
4872 * remote intent.
4873 */
4874 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4875 "android.intent.extra.remote_intent_token";
4876
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004877 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004878 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004879 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004880 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004881 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004882 "android.intent.extra.changed_component_name";
4883
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004884 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004885 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004886 * and contains a string array of all of the components that have changed. If
4887 * the state of the overall package has changed, then it will contain an entry
4888 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004889 */
4890 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4891 "android.intent.extra.changed_component_name_list";
4892
4893 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004894 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004895 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004896 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4897 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4898 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004899 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004900 */
4901 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4902 "android.intent.extra.changed_package_list";
4903
4904 /**
4905 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004906 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4907 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004908 * and contains an integer array of uids of all of the components
4909 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004910 */
4911 public static final String EXTRA_CHANGED_UID_LIST =
4912 "android.intent.extra.changed_uid_list";
4913
4914 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004915 * @hide
4916 * Magic extra system code can use when binding, to give a label for
4917 * who it is that has bound to a service. This is an integer giving
4918 * a framework string resource that can be displayed to the user.
4919 */
4920 public static final String EXTRA_CLIENT_LABEL =
4921 "android.intent.extra.client_label";
4922
4923 /**
4924 * @hide
4925 * Magic extra system code can use when binding, to give a PendingIntent object
4926 * that can be launched for the user to disable the system's use of this
4927 * service.
4928 */
4929 public static final String EXTRA_CLIENT_INTENT =
4930 "android.intent.extra.client_intent";
4931
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004932 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004933 * Extra used to indicate that an intent should only return data that is on
4934 * the local device. This is a boolean extra; the default is false. If true,
4935 * an implementation should only allow the user to select data that is
4936 * already on the device, not requiring it be downloaded from a remote
4937 * service when opened.
4938 *
4939 * @see #ACTION_GET_CONTENT
4940 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004941 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004942 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004943 */
4944 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004945 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004946
Amith Yamasani13593602012-03-22 16:16:17 -07004947 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004948 * Extra used to indicate that an intent can allow the user to select and
4949 * return multiple items. This is a boolean extra; the default is false. If
4950 * true, an implementation is allowed to present the user with a UI where
4951 * they can pick multiple items that are all returned to the caller. When
4952 * this happens, they should be returned as the {@link #getClipData()} part
4953 * of the result Intent.
4954 *
4955 * @see #ACTION_GET_CONTENT
4956 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004957 */
4958 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004959 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004960
4961 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004962 * The integer userHandle carried with broadcast intents related to addition, removal and
4963 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4964 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4965 *
Amith Yamasani13593602012-03-22 16:16:17 -07004966 * @hide
4967 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004968 public static final String EXTRA_USER_HANDLE =
4969 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004970
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004971 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004972 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4973 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4974 */
4975 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004976 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004977
4978 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004979 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004980 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4981 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004982 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004983 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4984
4985 /**
4986 * Extra sent in the intent to the BroadcastReceiver that handles
4987 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4988 * the restrictions as key/value pairs.
4989 */
4990 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4991 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004992
Amith Yamasani86118ba2013-03-28 14:33:16 -07004993 /**
4994 * Extra used in the response from a BroadcastReceiver that handles
4995 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4996 */
4997 public static final String EXTRA_RESTRICTIONS_INTENT =
4998 "android.intent.extra.restrictions_intent";
4999
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07005000 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005001 * Extra used to communicate a set of acceptable MIME types. The type of the
5002 * extra is {@code String[]}. Values may be a combination of concrete MIME
5003 * types (such as "image/png") and/or partial MIME types (such as
5004 * "audio/*").
5005 *
5006 * @see #ACTION_GET_CONTENT
5007 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07005008 */
5009 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
5010
Dianne Hackborn57a7f592013-07-22 18:21:32 -07005011 /**
5012 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
5013 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07005014 * When this is true, hardware devices can use this information to determine that
5015 * they shouldn't do a complete shutdown of their device since this is not a
5016 * complete shutdown down to the kernel, but only user space restarting.
5017 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07005018 */
5019 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
5020 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
5021
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005022 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00005023 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
5024 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
5025 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
5026 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005027 *
5028 * @hide for internal use only.
5029 */
5030 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
5031 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00005032 /** @hide */
5033 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
5034 /** @hide */
5035 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
5036 /** @hide */
5037 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005038
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07005039 /**
5040 * Intent extra: the reason that the operation associated with this intent is being performed.
5041 *
5042 * <p>Type: String
5043 * @hide
5044 */
5045 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07005046 public static final String EXTRA_REASON = "android.intent.extra.REASON";
5047
qingxi240c2bb2017-04-12 17:31:18 -07005048 /**
5049 * {@hide}
5050 * This extra will be send together with {@link #ACTION_FACTORY_RESET}
5051 */
Rubin Xue8490f12015-06-25 12:17:48 +01005052 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
5053
Santos Cordon15a13782015-03-31 18:32:31 -07005054 /**
qingxi240c2bb2017-04-12 17:31:18 -07005055 * {@hide}
5056 * This extra will be set to true when the user choose to wipe the data on eSIM during factory
5057 * reset for the device with eSIM. This extra will be sent together with
5058 * {@link #ACTION_FACTORY_RESET}
5059 */
5060 public static final String EXTRA_WIPE_ESIMS = "com.android.internal.intent.extra.WIPE_ESIMS";
5061
5062 /**
Santos Cordon15a13782015-03-31 18:32:31 -07005063 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
5064 * activation request.
5065 * TODO: Add information about the structure and response data used with the pending intent.
5066 * @hide
5067 */
5068 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
5069 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
5070
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09005071 /**
5072 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09005073 *
5074 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07005075 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09005076 */
Steve McKay6eaf38632015-08-04 10:11:01 -07005077 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
5078
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005079 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09005080 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
5081 * such as opening in other apps, sharing, opening, editing, printing, deleting,
5082 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005083 *
5084 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07005085 * @see #ACTION_QUICK_VIEW
5086 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005087 */
Garfield Tance1d0e92017-03-23 10:52:48 -07005088 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09005089 public static final String EXTRA_QUICK_VIEW_ADVANCED =
5090 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005091
5092 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07005093 * An optional extra of {@code String[]} indicating which quick view features should be made
5094 * available to the user in the quick view UI while handing a
5095 * {@link Intent#ACTION_QUICK_VIEW} intent.
5096 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
5097 * Quick viewer can implement features not listed below.
5098 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
Geoffrey Pitschbc02b772017-12-06 11:24:15 -05005099 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DELETE},
5100 * {@link QuickViewConstants#FEATURE_DOWNLOAD}, {@link QuickViewConstants#FEATURE_SEND},
5101 * {@link QuickViewConstants#FEATURE_PRINT}.
Garfield Tance1d0e92017-03-23 10:52:48 -07005102 * <p>
5103 * Requirements:
5104 * <li>Quick viewer shouldn't show a feature if the feature is absent in
5105 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
5106 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
5107 * internal policies.
5108 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
5109 * requirement that the feature be shown. Quick viewer may, according to its own policies,
5110 * disable or hide features.
5111 *
5112 * @see #ACTION_QUICK_VIEW
5113 */
5114 public static final String EXTRA_QUICK_VIEW_FEATURES =
5115 "android.intent.extra.QUICK_VIEW_FEATURES";
5116
5117 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005118 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01005119 * When a profile goes into quiet mode, all apps in the profile are killed and the
5120 * profile user is stopped. Widgets originating from the profile are masked, and app
5121 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005122 */
5123 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005124
5125 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005126 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005127 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005128 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
5129 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005130 *
5131 * @hide
5132 */
5133 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
5134 "android.intent.extra.MEDIA_RESOURCE_TYPE";
5135
5136 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07005137 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
5138 * whether to show the chooser or not when there is only one application available
5139 * to choose from.
5140 *
5141 * @hide
5142 */
5143 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
5144 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
5145
5146 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005147 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005148 * to represent that a video codec is allowed to use.
5149 *
5150 * @hide
5151 */
5152 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
5153
5154 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005155 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005156 * to represent that a audio codec is allowed to use.
5157 *
5158 * @hide
5159 */
5160 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
5161
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005162 // ---------------------------------------------------------------------
5163 // ---------------------------------------------------------------------
5164 // Intent flags (see mFlags variable).
5165
Tor Norbyed9273d62013-05-30 15:59:53 -07005166 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005167 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005168 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
5169 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07005170 @Retention(RetentionPolicy.SOURCE)
5171 public @interface GrantUriMode {}
5172
Jeff Sharkey846318a2014-04-04 12:12:41 -07005173 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005174 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005175 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
5176 @Retention(RetentionPolicy.SOURCE)
5177 public @interface AccessUriMode {}
5178
5179 /**
5180 * Test if given mode flags specify an access mode, which must be at least
5181 * read and/or write.
5182 *
5183 * @hide
5184 */
5185 public static boolean isAccessUriMode(int modeFlags) {
5186 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
5187 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
5188 }
5189
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005190 /** @hide */
5191 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5192 FLAG_GRANT_READ_URI_PERMISSION,
5193 FLAG_GRANT_WRITE_URI_PERMISSION,
5194 FLAG_FROM_BACKGROUND,
5195 FLAG_DEBUG_LOG_RESOLUTION,
5196 FLAG_EXCLUDE_STOPPED_PACKAGES,
5197 FLAG_INCLUDE_STOPPED_PACKAGES,
5198 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
5199 FLAG_GRANT_PREFIX_URI_PERMISSION,
5200 FLAG_DEBUG_TRIAGED_MISSING,
5201 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005202 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005203 FLAG_ACTIVITY_NO_HISTORY,
5204 FLAG_ACTIVITY_SINGLE_TOP,
5205 FLAG_ACTIVITY_NEW_TASK,
5206 FLAG_ACTIVITY_MULTIPLE_TASK,
5207 FLAG_ACTIVITY_CLEAR_TOP,
5208 FLAG_ACTIVITY_FORWARD_RESULT,
5209 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5210 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5211 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5212 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5213 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5214 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5215 FLAG_ACTIVITY_NEW_DOCUMENT,
5216 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5217 FLAG_ACTIVITY_NO_USER_ACTION,
5218 FLAG_ACTIVITY_REORDER_TO_FRONT,
5219 FLAG_ACTIVITY_NO_ANIMATION,
5220 FLAG_ACTIVITY_CLEAR_TASK,
5221 FLAG_ACTIVITY_TASK_ON_HOME,
5222 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5223 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5224 FLAG_RECEIVER_REGISTERED_ONLY,
5225 FLAG_RECEIVER_REPLACE_PENDING,
5226 FLAG_RECEIVER_FOREGROUND,
5227 FLAG_RECEIVER_NO_ABORT,
5228 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5229 FLAG_RECEIVER_BOOT_UPGRADE,
5230 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5231 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5232 FLAG_RECEIVER_FROM_SHELL,
5233 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5234 })
5235 @Retention(RetentionPolicy.SOURCE)
5236 public @interface Flags {}
5237
5238 /** @hide */
5239 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5240 FLAG_FROM_BACKGROUND,
5241 FLAG_DEBUG_LOG_RESOLUTION,
5242 FLAG_EXCLUDE_STOPPED_PACKAGES,
5243 FLAG_INCLUDE_STOPPED_PACKAGES,
5244 FLAG_DEBUG_TRIAGED_MISSING,
5245 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005246 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005247 FLAG_ACTIVITY_NO_HISTORY,
5248 FLAG_ACTIVITY_SINGLE_TOP,
5249 FLAG_ACTIVITY_NEW_TASK,
5250 FLAG_ACTIVITY_MULTIPLE_TASK,
5251 FLAG_ACTIVITY_CLEAR_TOP,
5252 FLAG_ACTIVITY_FORWARD_RESULT,
5253 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5254 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5255 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5256 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5257 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5258 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5259 FLAG_ACTIVITY_NEW_DOCUMENT,
5260 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5261 FLAG_ACTIVITY_NO_USER_ACTION,
5262 FLAG_ACTIVITY_REORDER_TO_FRONT,
5263 FLAG_ACTIVITY_NO_ANIMATION,
5264 FLAG_ACTIVITY_CLEAR_TASK,
5265 FLAG_ACTIVITY_TASK_ON_HOME,
5266 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5267 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5268 FLAG_RECEIVER_REGISTERED_ONLY,
5269 FLAG_RECEIVER_REPLACE_PENDING,
5270 FLAG_RECEIVER_FOREGROUND,
5271 FLAG_RECEIVER_NO_ABORT,
5272 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5273 FLAG_RECEIVER_BOOT_UPGRADE,
5274 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5275 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5276 FLAG_RECEIVER_FROM_SHELL,
5277 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5278 })
5279 @Retention(RetentionPolicy.SOURCE)
5280 public @interface MutableFlags {}
5281
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005282 /**
5283 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005284 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005285 * specified in its ClipData. When applying to an Intent's ClipData,
5286 * all URIs as well as recursive traversals through data or other ClipData
5287 * in Intent items will be granted; only the grant flags of the top-level
5288 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005289 */
5290 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5291 /**
5292 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005293 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005294 * specified in its ClipData. When applying to an Intent's ClipData,
5295 * all URIs as well as recursive traversals through data or other ClipData
5296 * in Intent items will be granted; only the grant flags of the top-level
5297 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005298 */
5299 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5300 /**
5301 * Can be set by the caller to indicate that this Intent is coming from
5302 * a background operation, not from direct user interaction.
5303 */
5304 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5305 /**
5306 * A flag you can enable for debugging: when set, log messages will be
5307 * printed during the resolution of this intent to show you what has
5308 * been found to create the final resolved list.
5309 */
5310 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005311 /**
5312 * If set, this intent will not match any components in packages that
5313 * are currently stopped. If this is not set, then the default behavior
5314 * is to include such applications in the result.
5315 */
5316 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5317 /**
5318 * If set, this intent will always match any components in packages that
5319 * are currently stopped. This is the default behavior when
5320 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5321 * flags are set, this one wins (it allows overriding of exclude for
5322 * places where the framework may automatically set the exclude flag).
5323 */
5324 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005325
5326 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005327 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005328 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005329 * persisted across device reboots until explicitly revoked with
5330 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5331 * grant for possible persisting; the receiving application must call
5332 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5333 * actually persist.
5334 *
5335 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5336 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5337 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005338 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005339 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005340 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005341
5342 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005343 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5344 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5345 * applies to any URI that is a prefix match against the original granted
5346 * URI. (Without this flag, the URI must match exactly for access to be
5347 * granted.) Another URI is considered a prefix match only when scheme,
5348 * authority, and all path segments defined by the prefix are an exact
5349 * match.
5350 */
5351 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5352
5353 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005354 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005355 * homework and verified that they correctly handle packages and components
5356 * that come and go over time. In particular:
5357 * <ul>
5358 * <li>Apps installed on external storage, which will appear to be
5359 * uninstalled while the the device is ejected.
5360 * <li>Apps with encryption unaware components, which will appear to not
5361 * exist while the device is locked.
5362 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005363 *
5364 * @hide
5365 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005366 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005367
5368 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005369 * Internal flag used to indicate ephemeral applications should not be
5370 * considered when resolving the intent.
5371 *
5372 * @hide
5373 */
5374 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5375
5376 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005377 * If set, the new activity is not kept in the history stack. As soon as
5378 * the user navigates away from it, the activity is finished. This may also
5379 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5380 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005381 *
5382 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5383 * is never invoked when the current activity starts a new activity which
5384 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005385 */
5386 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5387 /**
5388 * If set, the activity will not be launched if it is already running
5389 * at the top of the history stack.
5390 */
5391 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5392 /**
5393 * If set, this activity will become the start of a new task on this
5394 * history stack. A task (from the activity that started it to the
5395 * next task activity) defines an atomic group of activities that the
5396 * user can move to. Tasks can be moved to the foreground and background;
5397 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005398 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005399 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5400 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005401 *
5402 * <p>This flag is generally used by activities that want
5403 * to present a "launcher" style behavior: they give the user a list of
5404 * separate things that can be done, which otherwise run completely
5405 * independently of the activity launching them.
5406 *
5407 * <p>When using this flag, if a task is already running for the activity
5408 * you are now starting, then a new activity will not be started; instead,
5409 * the current task will simply be brought to the front of the screen with
5410 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5411 * to disable this behavior.
5412 *
5413 * <p>This flag can not be used when the caller is requesting a result from
5414 * the activity being launched.
5415 */
5416 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5417 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005418 * This flag is used to create a new task and launch an activity into it.
5419 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5420 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5421 * search through existing tasks for ones matching this Intent. Only if no such
5422 * task is found would a new task be created. When paired with
5423 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5424 * the search for a matching task and unconditionally start a new task.
5425 *
5426 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5427 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005428 * top-level application launcher.</strong> Used in conjunction with
5429 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5430 * behavior of bringing an existing task to the foreground. When set,
5431 * a new task is <em>always</em> started to host the Activity for the
5432 * Intent, regardless of whether there is already an existing task running
5433 * the same thing.
5434 *
5435 * <p><strong>Because the default system does not include graphical task management,
5436 * you should not use this flag unless you provide some way for a user to
5437 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005438 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005439 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5440 * creating new document tasks.
5441 *
5442 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005443 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005444 *
Scott Main7aee61f2011-02-08 11:25:01 -08005445 * <p>See
5446 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5447 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005448 *
5449 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5450 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005451 */
5452 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5453 /**
5454 * If set, and the activity being launched is already running in the
5455 * current task, then instead of launching a new instance of that activity,
5456 * all of the other activities on top of it will be closed and this Intent
5457 * will be delivered to the (now on top) old activity as a new Intent.
5458 *
5459 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5460 * If D calls startActivity() with an Intent that resolves to the component
5461 * of activity B, then C and D will be finished and B receive the given
5462 * Intent, resulting in the stack now being: A, B.
5463 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005464 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005465 * either receive the new intent you are starting here in its
5466 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005467 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005468 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5469 * the same intent, then it will be finished and re-created; for all other
5470 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5471 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005472 *
5473 * <p>This launch mode can also be used to good effect in conjunction with
5474 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5475 * of a task, it will bring any currently running instance of that task
5476 * to the foreground, and then clear it to its root state. This is
5477 * especially useful, for example, when launching an activity from the
5478 * notification manager.
5479 *
Scott Main7aee61f2011-02-08 11:25:01 -08005480 * <p>See
5481 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5482 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005483 */
5484 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5485 /**
5486 * If set and this intent is being used to launch a new activity from an
5487 * existing one, then the reply target of the existing activity will be
5488 * transfered to the new activity. This way the new activity can call
5489 * {@link android.app.Activity#setResult} and have that result sent back to
5490 * the reply target of the original activity.
5491 */
5492 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5493 /**
5494 * If set and this intent is being used to launch a new activity from an
5495 * existing one, the current activity will not be counted as the top
5496 * activity for deciding whether the new intent should be delivered to
5497 * the top instead of starting a new one. The previous activity will
5498 * be used as the top, with the assumption being that the current activity
5499 * will finish itself immediately.
5500 */
5501 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5502 /**
5503 * If set, the new activity is not kept in the list of recently launched
5504 * activities.
5505 */
5506 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5507 /**
5508 * This flag is not normally set by application code, but set for you by
5509 * the system as described in the
5510 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5511 * launchMode} documentation for the singleTask mode.
5512 */
5513 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5514 /**
5515 * If set, and this activity is either being started in a new task or
5516 * bringing to the top an existing task, then it will be launched as
5517 * the front door of the task. This will result in the application of
5518 * any affinities needed to have that task in the proper state (either
5519 * moving activities to or from it), or simply resetting that task to
5520 * its initial state if needed.
5521 */
5522 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5523 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005524 * This flag is not normally set by application code, but set for you by
5525 * the system if this activity is being launched from history
5526 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005527 */
5528 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005529 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005530 * @deprecated As of API 21 this performs identically to
5531 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005532 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005533 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005534 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005535 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005536 * This flag is used to open a document into a new task rooted at the activity launched
5537 * by this Intent. Through the use of this flag, or its equivalent attribute,
5538 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005539 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005540 *
Craig Mautner026596b2014-05-21 15:35:44 -07005541 * <p>The use of the activity attribute form of this,
5542 * {@link android.R.attr#documentLaunchMode}, is
5543 * preferred over the Intent flag described here. The attribute form allows the
5544 * Activity to specify multiple document behavior for all launchers of the Activity
5545 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005546 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005547 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5548 * it is kept after the activity is finished is different than the use of
5549 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5550 * this flag is being used to create a new recents entry, then by default that entry
5551 * will be removed once the activity is finished. You can modify this behavior with
5552 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5553 *
Craig Mautner026596b2014-05-21 15:35:44 -07005554 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5555 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5556 * equivalent of the Activity manifest specifying {@link
5557 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5558 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5559 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005560 *
Craig Mautner026596b2014-05-21 15:35:44 -07005561 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005562 *
Craig Mautner026596b2014-05-21 15:35:44 -07005563 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005564 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5565 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005566 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005567 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005568 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005569 * callback from occurring on the current frontmost activity before it is
5570 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005571 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005572 * <p>Typically, an activity can rely on that callback to indicate that an
5573 * explicit user action has caused their activity to be moved out of the
5574 * foreground. The callback marks an appropriate point in the activity's
5575 * lifecycle for it to dismiss any notifications that it intends to display
5576 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005577 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005578 * <p>If an activity is ever started via any non-user-driven events such as
5579 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5580 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005581 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005582 */
5583 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005584 /**
5585 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5586 * this flag will cause the launched activity to be brought to the front of its
5587 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005588 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005589 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5590 * If D calls startActivity() with an Intent that resolves to the component
5591 * of activity B, then B will be brought to the front of the history stack,
5592 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005593 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005594 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005595 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005596 */
5597 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005598 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005599 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5600 * this flag will prevent the system from applying an activity transition
5601 * animation to go to the next activity state. This doesn't mean an
5602 * animation will never run -- if another activity change happens that doesn't
5603 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005604 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005605 * when you are going to do a series of activity operations but the
5606 * animation seen by the user shouldn't be driven by the first activity
5607 * change but rather a later one.
5608 */
5609 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5610 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005611 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5612 * this flag will cause any existing task that would be associated with the
5613 * activity to be cleared before the activity is started. That is, the activity
5614 * becomes the new root of an otherwise empty task, and any old activities
5615 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5616 */
5617 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5618 /**
5619 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5620 * this flag will cause a newly launching task to be placed on top of the current
5621 * home activity task (if there is one). That is, pressing back from the task
5622 * will always return the user to home even if that was not the last activity they
5623 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5624 */
5625 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5626 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005627 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5628 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005629 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005630 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005631 * this flag. When set and the task's activity is finished, the recents
5632 * entry will remain in the interface for the user to re-launch it, like a
5633 * recents entry for a top-level application.
5634 * <p>
5635 * The receiving activity can override this request with
5636 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5637 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005638 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005639 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005640 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005641
5642 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005643 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5644 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005645 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5646 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005647 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005648 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005649
Patrick Baumann577d4022018-01-31 16:55:10 +00005650
5651 /**
5652 * If set, resolution of this intent may take place via an instant app not
5653 * yet on the device if there does not yet exist an app on device to
5654 * resolve it.
5655 */
5656 public static final int FLAG_ACTIVITY_MATCH_EXTERNAL = 0x00000800;
5657
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005658 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005659 * If set, when sending a broadcast only registered receivers will be
5660 * called -- no BroadcastReceiver components will be launched.
5661 */
5662 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005663 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005664 * If set, when sending a broadcast the new broadcast will replace
5665 * any existing pending broadcast that matches it. Matching is defined
5666 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5667 * true for the intents of the two broadcasts. When a match is found,
5668 * the new broadcast (and receivers associated with it) will replace the
5669 * existing one in the pending broadcast list, remaining at the same
5670 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005671 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005672 * <p>This flag is most typically used with sticky broadcasts, which
5673 * only care about delivering the most recent values of the broadcast
5674 * to their receivers.
5675 */
5676 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5677 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005678 * If set, when sending a broadcast the recipient is allowed to run at
5679 * foreground priority, with a shorter timeout interval. During normal
5680 * broadcasts the receivers are not automatically hoisted out of the
5681 * background priority class.
5682 */
5683 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5684 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005685 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5686 * They can still propagate results through to later receivers, but they can not prevent
5687 * later receivers from seeing the broadcast.
5688 */
5689 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5690 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005691 * If set, when sending a broadcast <i>before boot has completed</i> only
5692 * registered receivers will be called -- no BroadcastReceiver components
5693 * will be launched. Sticky intent state will be recorded properly even
5694 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5695 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005696 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005697 * <p>This flag is only for use by system sevices as a convenience to
5698 * avoid having to implement a more complex mechanism around detection
5699 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005700 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005701 * @hide
5702 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005703 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005704 /**
5705 * Set when this broadcast is for a boot upgrade, a special mode that
5706 * allows the broadcast to be sent before the system is ready and launches
5707 * the app process with no providers running in it.
5708 * @hide
5709 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005710 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005711 /**
5712 * If set, the broadcast will always go to manifest receivers in background (cached
5713 * or not running) apps, regardless of whether that would be done by default. By
5714 * default they will only receive broadcasts if the broadcast has specified an
5715 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005716 *
5717 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5718 * the broadcast code there must also be changed to match.
5719 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005720 * @hide
5721 */
5722 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5723 /**
5724 * If set, the broadcast will never go to manifest receivers in background (cached
5725 * or not running) apps, regardless of whether that would be done by default. By
5726 * default they will receive broadcasts if the broadcast has specified an
5727 * explicit component or package name.
5728 * @hide
5729 */
5730 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005731 /**
5732 * If set, this broadcast is being sent from the shell.
5733 * @hide
5734 */
5735 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005736
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005737 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005738 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5739 * will not receive broadcasts.
5740 *
5741 * <em>This flag has no effect when used by an Instant App.</em>
5742 */
5743 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5744
5745 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005746 * @hide Flags that can't be changed with PendingIntent.
5747 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005748 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5749 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5750 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005751
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005752 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005753 // ---------------------------------------------------------------------
5754 // toUri() and parseUri() options.
5755
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005756 /** @hide */
5757 @IntDef(flag = true, prefix = { "URI_" }, value = {
5758 URI_ALLOW_UNSAFE,
5759 URI_ANDROID_APP_SCHEME,
5760 URI_INTENT_SCHEME,
5761 })
5762 @Retention(RetentionPolicy.SOURCE)
5763 public @interface UriFlags {}
5764
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005765 /**
5766 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5767 * always has the "intent:" scheme. This syntax can be used when you want
5768 * to later disambiguate between URIs that are intended to describe an
5769 * Intent vs. all others that should be treated as raw URIs. When used
5770 * with {@link #parseUri}, any other scheme will result in a generic
5771 * VIEW action for that raw URI.
5772 */
5773 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005774
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005775 /**
5776 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5777 * always has the "android-app:" scheme. This is a variation of
5778 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5779 * http/https URI being delivered to a specific package name. The format
5780 * is:
5781 *
5782 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005783 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005784 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005785 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5786 * you must also include a scheme; including a path also requires both a host and a scheme.
5787 * The final #Intent; fragment can be used without a scheme, host, or path.
5788 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005789 * used with intents that have a {@link #setSelector}, since the base intent
5790 * will always have an explicit package name.</p>
5791 *
5792 * <p>Some examples of how this scheme maps to Intent objects:</p>
5793 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5794 * <colgroup align="left" />
5795 * <colgroup align="left" />
5796 * <thead>
5797 * <tr><th>URI</th> <th>Intent</th></tr>
5798 * </thead>
5799 *
5800 * <tbody>
5801 * <tr><td><code>android-app://com.example.app</code></td>
5802 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5803 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5804 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5805 * </table></td>
5806 * </tr>
5807 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5808 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5809 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5810 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5811 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5812 * </table></td>
5813 * </tr>
5814 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5815 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5816 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5817 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5818 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5819 * </table></td>
5820 * </tr>
5821 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5822 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5823 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5824 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5825 * </table></td>
5826 * </tr>
5827 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5828 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5829 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5830 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5831 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5832 * </table></td>
5833 * </tr>
5834 * <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>
5835 * <td><table border="" style="margin:0" >
5836 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5837 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5838 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5839 * </table></td>
5840 * </tr>
5841 * </tbody>
5842 * </table>
5843 */
5844 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5845
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005846 /**
5847 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5848 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5849 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5850 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5851 * generated Intent can not cause unexpected data access to happen.
5852 *
5853 * <p>If you do not trust the source of the URI being parsed, you should still do further
5854 * processing to protect yourself from it. In particular, when using it to start an
5855 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5856 * that can handle it.</p>
5857 */
5858 public static final int URI_ALLOW_UNSAFE = 1<<2;
5859
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005860 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005861
5862 private String mAction;
5863 private Uri mData;
5864 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005865 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005866 private ComponentName mComponent;
5867 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005868 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005869 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005870 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005871 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005872 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005873 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005874 /** Token to track instant app launches. Local only; do not copy cross-process. */
5875 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005876
5877 // ---------------------------------------------------------------------
5878
Makoto Onuki97f82f22017-05-31 16:20:21 -07005879 private static final int COPY_MODE_ALL = 0;
5880 private static final int COPY_MODE_FILTER = 1;
5881 private static final int COPY_MODE_HISTORY = 2;
5882
5883 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07005884 @IntDef(prefix = { "COPY_MODE_" }, value = {
5885 COPY_MODE_ALL,
5886 COPY_MODE_FILTER,
5887 COPY_MODE_HISTORY
5888 })
Makoto Onuki97f82f22017-05-31 16:20:21 -07005889 @Retention(RetentionPolicy.SOURCE)
5890 public @interface CopyMode {}
5891
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005892 /**
5893 * Create an empty intent.
5894 */
5895 public Intent() {
5896 }
5897
5898 /**
5899 * Copy constructor.
5900 */
5901 public Intent(Intent o) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005902 this(o, COPY_MODE_ALL);
5903 }
5904
5905 private Intent(Intent o, @CopyMode int copyMode) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005906 this.mAction = o.mAction;
5907 this.mData = o.mData;
5908 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005909 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005910 this.mComponent = o.mComponent;
Makoto Onuki97f82f22017-05-31 16:20:21 -07005911
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005912 if (o.mCategories != null) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005913 this.mCategories = new ArraySet<>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005914 }
Makoto Onuki97f82f22017-05-31 16:20:21 -07005915
5916 if (copyMode != COPY_MODE_FILTER) {
5917 this.mFlags = o.mFlags;
5918 this.mContentUserHint = o.mContentUserHint;
5919 this.mLaunchToken = o.mLaunchToken;
5920 if (o.mSourceBounds != null) {
5921 this.mSourceBounds = new Rect(o.mSourceBounds);
5922 }
5923 if (o.mSelector != null) {
5924 this.mSelector = new Intent(o.mSelector);
5925 }
5926
5927 if (copyMode != COPY_MODE_HISTORY) {
5928 if (o.mExtras != null) {
5929 this.mExtras = new Bundle(o.mExtras);
5930 }
5931 if (o.mClipData != null) {
5932 this.mClipData = new ClipData(o.mClipData);
5933 }
5934 } else {
5935 if (o.mExtras != null && !o.mExtras.maybeIsEmpty()) {
5936 this.mExtras = Bundle.STRIPPED;
5937 }
5938
5939 // Also set "stripped" clip data when we ever log mClipData in the (broadcast)
5940 // history.
5941 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005942 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005943 }
5944
5945 @Override
5946 public Object clone() {
5947 return new Intent(this);
5948 }
5949
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005950 /**
5951 * Make a clone of only the parts of the Intent that are relevant for
5952 * filter matching: the action, data, type, component, and categories.
5953 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005954 public @NonNull Intent cloneFilter() {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005955 return new Intent(this, COPY_MODE_FILTER);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005956 }
5957
5958 /**
5959 * Create an intent with a given action. All other fields (data, type,
5960 * class) are null. Note that the action <em>must</em> be in a
5961 * namespace because Intents are used globally in the system -- for
5962 * example the system VIEW action is android.intent.action.VIEW; an
5963 * application's custom action would be something like
5964 * com.google.app.myapp.CUSTOM_ACTION.
5965 *
5966 * @param action The Intent action, such as ACTION_VIEW.
5967 */
5968 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005969 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005970 }
5971
5972 /**
5973 * Create an intent with a given action and for a given data url. Note
5974 * that the action <em>must</em> be in a namespace because Intents are
5975 * used globally in the system -- for example the system VIEW action is
5976 * android.intent.action.VIEW; an application's custom action would be
5977 * something like com.google.app.myapp.CUSTOM_ACTION.
5978 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005979 * <p><em>Note: scheme and host name matching in the Android framework is
5980 * case-sensitive, unlike the formal RFC. As a result,
5981 * you should always ensure that you write your Uri with these elements
5982 * using lower case letters, and normalize any Uris you receive from
5983 * outside of Android to ensure the scheme and host is lower case.</em></p>
5984 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005985 * @param action The Intent action, such as ACTION_VIEW.
5986 * @param uri The Intent data URI.
5987 */
5988 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005989 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005990 mData = uri;
5991 }
5992
5993 /**
5994 * Create an intent for a specific component. All other fields (action, data,
5995 * type, class) are null, though they can be modified later with explicit
5996 * calls. This provides a convenient way to create an intent that is
5997 * intended to execute a hard-coded class name, rather than relying on the
5998 * system to find an appropriate class for you; see {@link #setComponent}
5999 * for more information on the repercussions of this.
6000 *
6001 * @param packageContext A Context of the application package implementing
6002 * this class.
6003 * @param cls The component class that is to be used for the intent.
6004 *
6005 * @see #setClass
6006 * @see #setComponent
6007 * @see #Intent(String, android.net.Uri , Context, Class)
6008 */
6009 public Intent(Context packageContext, Class<?> cls) {
6010 mComponent = new ComponentName(packageContext, cls);
6011 }
6012
6013 /**
6014 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07006015 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006016 * construct the Intent and then calling {@link #setClass} to set its
6017 * class.
6018 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006019 * <p><em>Note: scheme and host name matching in the Android framework is
6020 * case-sensitive, unlike the formal RFC. As a result,
6021 * you should always ensure that you write your Uri with these elements
6022 * using lower case letters, and normalize any Uris you receive from
6023 * outside of Android to ensure the scheme and host is lower case.</em></p>
6024 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006025 * @param action The Intent action, such as ACTION_VIEW.
6026 * @param uri The Intent data URI.
6027 * @param packageContext A Context of the application package implementing
6028 * this class.
6029 * @param cls The component class that is to be used for the intent.
6030 *
6031 * @see #Intent(String, android.net.Uri)
6032 * @see #Intent(Context, Class)
6033 * @see #setClass
6034 * @see #setComponent
6035 */
6036 public Intent(String action, Uri uri,
6037 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006038 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006039 mData = uri;
6040 mComponent = new ComponentName(packageContext, cls);
6041 }
6042
6043 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08006044 * Create an intent to launch the main (root) activity of a task. This
6045 * is the Intent that is started when the application's is launched from
6046 * Home. For anything else that wants to launch an application in the
6047 * same way, it is important that they use an Intent structured the same
6048 * way, and can use this function to ensure this is the case.
6049 *
6050 * <p>The returned Intent has the given Activity component as its explicit
6051 * component, {@link #ACTION_MAIN} as its action, and includes the
6052 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
6053 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
6054 * to do that through {@link #addFlags(int)} on the returned Intent.
6055 *
6056 * @param mainActivity The main activity component that this Intent will
6057 * launch.
6058 * @return Returns a newly created Intent that can be used to launch the
6059 * activity as a main application entry.
6060 *
6061 * @see #setClass
6062 * @see #setComponent
6063 */
6064 public static Intent makeMainActivity(ComponentName mainActivity) {
6065 Intent intent = new Intent(ACTION_MAIN);
6066 intent.setComponent(mainActivity);
6067 intent.addCategory(CATEGORY_LAUNCHER);
6068 return intent;
6069 }
6070
6071 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006072 * Make an Intent for the main activity of an application, without
6073 * specifying a specific activity to run but giving a selector to find
6074 * the activity. This results in a final Intent that is structured
6075 * the same as when the application is launched from
6076 * Home. For anything else that wants to launch an application in the
6077 * same way, it is important that they use an Intent structured the same
6078 * way, and can use this function to ensure this is the case.
6079 *
6080 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
6081 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
6082 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
6083 * to do that through {@link #addFlags(int)} on the returned Intent.
6084 *
6085 * @param selectorAction The action name of the Intent's selector.
6086 * @param selectorCategory The name of a category to add to the Intent's
6087 * selector.
6088 * @return Returns a newly created Intent that can be used to launch the
6089 * activity as a main application entry.
6090 *
6091 * @see #setSelector(Intent)
6092 */
6093 public static Intent makeMainSelectorActivity(String selectorAction,
6094 String selectorCategory) {
6095 Intent intent = new Intent(ACTION_MAIN);
6096 intent.addCategory(CATEGORY_LAUNCHER);
6097 Intent selector = new Intent();
6098 selector.setAction(selectorAction);
6099 selector.addCategory(selectorCategory);
6100 intent.setSelector(selector);
6101 return intent;
6102 }
6103
6104 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08006105 * Make an Intent that can be used to re-launch an application's task
6106 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
6107 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
6108 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
6109 *
6110 * @param mainActivity The activity component that is the root of the
6111 * task; this is the activity that has been published in the application's
6112 * manifest as the main launcher icon.
6113 *
6114 * @return Returns a newly created Intent that can be used to relaunch the
6115 * activity's task in its root state.
6116 */
6117 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
6118 Intent intent = makeMainActivity(mainActivity);
6119 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
6120 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
6121 return intent;
6122 }
6123
6124 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006125 * Call {@link #parseUri} with 0 flags.
6126 * @deprecated Use {@link #parseUri} instead.
6127 */
6128 @Deprecated
6129 public static Intent getIntent(String uri) throws URISyntaxException {
6130 return parseUri(uri, 0);
6131 }
Tom Taylord4a47292009-12-21 13:59:18 -08006132
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006133 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006134 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006135 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07006136 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006137 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006138 *
6139 * <p>The URI given here must not be relative -- that is, it must include
6140 * the scheme and full path.
6141 *
6142 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006143 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006144 *
6145 * @return Intent The newly created Intent object.
6146 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006147 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
6148 * it bad (as parsed by the Uri class) or the Intent data within the
6149 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08006150 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006151 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006152 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006153 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006154 int i = 0;
6155 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006156 final boolean androidApp = uri.startsWith("android-app:");
6157
6158 // Validate intent scheme if requested.
6159 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
6160 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006161 Intent intent = new Intent(ACTION_VIEW);
6162 try {
6163 intent.setData(Uri.parse(uri));
6164 } catch (IllegalArgumentException e) {
6165 throw new URISyntaxException(uri, e.getMessage());
6166 }
6167 return intent;
6168 }
6169 }
Tom Taylord4a47292009-12-21 13:59:18 -08006170
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006171 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006172 // simple case
6173 if (i == -1) {
6174 if (!androidApp) {
6175 return new Intent(ACTION_VIEW, Uri.parse(uri));
6176 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006177
6178 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006179 } else if (!uri.startsWith("#Intent;", i)) {
6180 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006181 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006182 } else {
6183 i = -1;
6184 }
6185 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006186
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006187 // new format
6188 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006189 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006190 boolean explicitAction = false;
6191 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006192
6193 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006194 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006195 String data;
6196 if (i >= 0) {
6197 data = uri.substring(0, i);
6198 i += 8; // length of "#Intent;"
6199 } else {
6200 data = uri;
6201 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006202
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006203 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006204 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006205 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006206 if (eq < 0) eq = i-1;
6207 int semi = uri.indexOf(';', i);
6208 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006209
6210 // action
6211 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006212 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006213 if (!inSelector) {
6214 explicitAction = true;
6215 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006216 }
6217
6218 // categories
6219 else if (uri.startsWith("category=", i)) {
6220 intent.addCategory(value);
6221 }
6222
6223 // type
6224 else if (uri.startsWith("type=", i)) {
6225 intent.mType = value;
6226 }
6227
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006228 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006229 else if (uri.startsWith("launchFlags=", i)) {
6230 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006231 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6232 intent.mFlags &= ~IMMUTABLE_FLAGS;
6233 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006234 }
6235
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006236 // package
6237 else if (uri.startsWith("package=", i)) {
6238 intent.mPackage = value;
6239 }
6240
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006241 // component
6242 else if (uri.startsWith("component=", i)) {
6243 intent.mComponent = ComponentName.unflattenFromString(value);
6244 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006245
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006246 // scheme
6247 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006248 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006249 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006250 } else {
6251 scheme = value;
6252 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006253 }
6254
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006255 // source bounds
6256 else if (uri.startsWith("sourceBounds=", i)) {
6257 intent.mSourceBounds = Rect.unflattenFromString(value);
6258 }
6259
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006260 // selector
6261 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
6262 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006263 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006264 }
6265
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006266 // extra
6267 else {
6268 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006269 // create Bundle if it doesn't already exist
6270 if (intent.mExtras == null) intent.mExtras = new Bundle();
6271 Bundle b = intent.mExtras;
6272 // add EXTRA
6273 if (uri.startsWith("S.", i)) b.putString(key, value);
6274 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
6275 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
6276 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
6277 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
6278 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
6279 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
6280 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
6281 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
6282 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
6283 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006284
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006285 // move to the next item
6286 i = semi + 1;
6287 }
6288
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006289 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006290 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006291 if (baseIntent.mPackage == null) {
6292 baseIntent.setSelector(intent);
6293 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006294 intent = baseIntent;
6295 }
6296
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006297 if (data != null) {
6298 if (data.startsWith("intent:")) {
6299 data = data.substring(7);
6300 if (scheme != null) {
6301 data = scheme + ':' + data;
6302 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006303 } else if (data.startsWith("android-app:")) {
6304 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
6305 // Correctly formed android-app, first part is package name.
6306 int end = data.indexOf('/', 14);
6307 if (end < 0) {
6308 // All we have is a package name.
6309 intent.mPackage = data.substring(14);
6310 if (!explicitAction) {
6311 intent.setAction(ACTION_MAIN);
6312 }
6313 data = "";
6314 } else {
6315 // Target the Intent at the given package name always.
6316 String authority = null;
6317 intent.mPackage = data.substring(14, end);
6318 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006319 if ((end+1) < data.length()) {
6320 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6321 // Found a scheme, remember it.
6322 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006323 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006324 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6325 // Found a authority, remember it.
6326 authority = data.substring(end+1, newEnd);
6327 end = newEnd;
6328 }
6329 } else {
6330 // All we have is a scheme.
6331 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006332 }
6333 }
6334 if (scheme == null) {
6335 // If there was no scheme, then this just targets the package.
6336 if (!explicitAction) {
6337 intent.setAction(ACTION_MAIN);
6338 }
6339 data = "";
6340 } else if (authority == null) {
6341 data = scheme + ":";
6342 } else {
6343 data = scheme + "://" + authority + data.substring(end);
6344 }
6345 }
6346 } else {
6347 data = "";
6348 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006349 }
Tom Taylord4a47292009-12-21 13:59:18 -08006350
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006351 if (data.length() > 0) {
6352 try {
6353 intent.mData = Uri.parse(data);
6354 } catch (IllegalArgumentException e) {
6355 throw new URISyntaxException(uri, e.getMessage());
6356 }
6357 }
6358 }
Tom Taylord4a47292009-12-21 13:59:18 -08006359
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006360 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006361
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006362 } catch (IndexOutOfBoundsException e) {
6363 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6364 }
6365 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006366
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006367 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006368 return getIntentOld(uri, 0);
6369 }
6370
6371 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006372 Intent intent;
6373
6374 int i = uri.lastIndexOf('#');
6375 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006376 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006377 final int intentFragmentStart = i;
6378 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006379
6380 i++;
6381
6382 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006383 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006384 i += 7;
6385 int j = uri.indexOf(')', i);
6386 action = uri.substring(i, j);
6387 i = j + 1;
6388 }
6389
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006390 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006391
6392 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006393 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006394 i += 11;
6395 int j = uri.indexOf(')', i);
6396 while (i < j) {
6397 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006398 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006399 if (i < sep) {
6400 intent.addCategory(uri.substring(i, sep));
6401 }
6402 i = sep + 1;
6403 }
6404 i = j + 1;
6405 }
6406
6407 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006408 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006409 i += 5;
6410 int j = uri.indexOf(')', i);
6411 intent.mType = uri.substring(i, j);
6412 i = j + 1;
6413 }
6414
6415 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006416 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006417 i += 12;
6418 int j = uri.indexOf(')', i);
6419 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006420 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6421 intent.mFlags &= ~IMMUTABLE_FLAGS;
6422 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006423 i = j + 1;
6424 }
6425
6426 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006427 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006428 i += 10;
6429 int j = uri.indexOf(')', i);
6430 int sep = uri.indexOf('!', i);
6431 if (sep >= 0 && sep < j) {
6432 String pkg = uri.substring(i, sep);
6433 String cls = uri.substring(sep + 1, j);
6434 intent.mComponent = new ComponentName(pkg, cls);
6435 }
6436 i = j + 1;
6437 }
6438
6439 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006440 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006441 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006442
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006443 final int closeParen = uri.indexOf(')', i);
6444 if (closeParen == -1) throw new URISyntaxException(uri,
6445 "EXTRA missing trailing ')'", i);
6446
6447 while (i < closeParen) {
6448 // fetch the key value
6449 int j = uri.indexOf('=', i);
6450 if (j <= i + 1 || i >= closeParen) {
6451 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6452 }
6453 char type = uri.charAt(i);
6454 i++;
6455 String key = uri.substring(i, j);
6456 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006457
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006458 // get type-value
6459 j = uri.indexOf('!', i);
6460 if (j == -1 || j >= closeParen) j = closeParen;
6461 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6462 String value = uri.substring(i, j);
6463 i = j;
6464
6465 // create Bundle if it doesn't already exist
6466 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006467
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006468 // add item to bundle
6469 try {
6470 switch (type) {
6471 case 'S':
6472 intent.mExtras.putString(key, Uri.decode(value));
6473 break;
6474 case 'B':
6475 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6476 break;
6477 case 'b':
6478 intent.mExtras.putByte(key, Byte.parseByte(value));
6479 break;
6480 case 'c':
6481 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6482 break;
6483 case 'd':
6484 intent.mExtras.putDouble(key, Double.parseDouble(value));
6485 break;
6486 case 'f':
6487 intent.mExtras.putFloat(key, Float.parseFloat(value));
6488 break;
6489 case 'i':
6490 intent.mExtras.putInt(key, Integer.parseInt(value));
6491 break;
6492 case 'l':
6493 intent.mExtras.putLong(key, Long.parseLong(value));
6494 break;
6495 case 's':
6496 intent.mExtras.putShort(key, Short.parseShort(value));
6497 break;
6498 default:
6499 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6500 }
6501 } catch (NumberFormatException e) {
6502 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6503 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006504
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006505 char ch = uri.charAt(i);
6506 if (ch == ')') break;
6507 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6508 i++;
6509 }
6510 }
6511
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006512 if (isIntentFragment) {
6513 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6514 } else {
6515 intent.mData = Uri.parse(uri);
6516 }
Tom Taylord4a47292009-12-21 13:59:18 -08006517
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006518 if (intent.mAction == null) {
6519 // By default, if no action is specified, then use VIEW.
6520 intent.mAction = ACTION_VIEW;
6521 }
6522
6523 } else {
6524 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6525 }
6526
6527 return intent;
6528 }
6529
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006530 /** @hide */
6531 public interface CommandOptionHandler {
6532 boolean handleOption(String opt, ShellCommand cmd);
6533 }
6534
6535 /** @hide */
6536 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6537 throws URISyntaxException {
6538 Intent intent = new Intent();
6539 Intent baseIntent = intent;
6540 boolean hasIntentInfo = false;
6541
6542 Uri data = null;
6543 String type = null;
6544
6545 String opt;
6546 while ((opt=cmd.getNextOption()) != null) {
6547 switch (opt) {
6548 case "-a":
6549 intent.setAction(cmd.getNextArgRequired());
6550 if (intent == baseIntent) {
6551 hasIntentInfo = true;
6552 }
6553 break;
6554 case "-d":
6555 data = Uri.parse(cmd.getNextArgRequired());
6556 if (intent == baseIntent) {
6557 hasIntentInfo = true;
6558 }
6559 break;
6560 case "-t":
6561 type = cmd.getNextArgRequired();
6562 if (intent == baseIntent) {
6563 hasIntentInfo = true;
6564 }
6565 break;
6566 case "-c":
6567 intent.addCategory(cmd.getNextArgRequired());
6568 if (intent == baseIntent) {
6569 hasIntentInfo = true;
6570 }
6571 break;
6572 case "-e":
6573 case "--es": {
6574 String key = cmd.getNextArgRequired();
6575 String value = cmd.getNextArgRequired();
6576 intent.putExtra(key, value);
6577 }
6578 break;
6579 case "--esn": {
6580 String key = cmd.getNextArgRequired();
6581 intent.putExtra(key, (String) null);
6582 }
6583 break;
6584 case "--ei": {
6585 String key = cmd.getNextArgRequired();
6586 String value = cmd.getNextArgRequired();
6587 intent.putExtra(key, Integer.decode(value));
6588 }
6589 break;
6590 case "--eu": {
6591 String key = cmd.getNextArgRequired();
6592 String value = cmd.getNextArgRequired();
6593 intent.putExtra(key, Uri.parse(value));
6594 }
6595 break;
6596 case "--ecn": {
6597 String key = cmd.getNextArgRequired();
6598 String value = cmd.getNextArgRequired();
6599 ComponentName cn = ComponentName.unflattenFromString(value);
6600 if (cn == null)
6601 throw new IllegalArgumentException("Bad component name: " + value);
6602 intent.putExtra(key, cn);
6603 }
6604 break;
6605 case "--eia": {
6606 String key = cmd.getNextArgRequired();
6607 String value = cmd.getNextArgRequired();
6608 String[] strings = value.split(",");
6609 int[] list = new int[strings.length];
6610 for (int i = 0; i < strings.length; i++) {
6611 list[i] = Integer.decode(strings[i]);
6612 }
6613 intent.putExtra(key, list);
6614 }
6615 break;
6616 case "--eial": {
6617 String key = cmd.getNextArgRequired();
6618 String value = cmd.getNextArgRequired();
6619 String[] strings = value.split(",");
6620 ArrayList<Integer> list = new ArrayList<>(strings.length);
6621 for (int i = 0; i < strings.length; i++) {
6622 list.add(Integer.decode(strings[i]));
6623 }
6624 intent.putExtra(key, list);
6625 }
6626 break;
6627 case "--el": {
6628 String key = cmd.getNextArgRequired();
6629 String value = cmd.getNextArgRequired();
6630 intent.putExtra(key, Long.valueOf(value));
6631 }
6632 break;
6633 case "--ela": {
6634 String key = cmd.getNextArgRequired();
6635 String value = cmd.getNextArgRequired();
6636 String[] strings = value.split(",");
6637 long[] list = new long[strings.length];
6638 for (int i = 0; i < strings.length; i++) {
6639 list[i] = Long.valueOf(strings[i]);
6640 }
6641 intent.putExtra(key, list);
6642 hasIntentInfo = true;
6643 }
6644 break;
6645 case "--elal": {
6646 String key = cmd.getNextArgRequired();
6647 String value = cmd.getNextArgRequired();
6648 String[] strings = value.split(",");
6649 ArrayList<Long> list = new ArrayList<>(strings.length);
6650 for (int i = 0; i < strings.length; i++) {
6651 list.add(Long.valueOf(strings[i]));
6652 }
6653 intent.putExtra(key, list);
6654 hasIntentInfo = true;
6655 }
6656 break;
6657 case "--ef": {
6658 String key = cmd.getNextArgRequired();
6659 String value = cmd.getNextArgRequired();
6660 intent.putExtra(key, Float.valueOf(value));
6661 hasIntentInfo = true;
6662 }
6663 break;
6664 case "--efa": {
6665 String key = cmd.getNextArgRequired();
6666 String value = cmd.getNextArgRequired();
6667 String[] strings = value.split(",");
6668 float[] list = new float[strings.length];
6669 for (int i = 0; i < strings.length; i++) {
6670 list[i] = Float.valueOf(strings[i]);
6671 }
6672 intent.putExtra(key, list);
6673 hasIntentInfo = true;
6674 }
6675 break;
6676 case "--efal": {
6677 String key = cmd.getNextArgRequired();
6678 String value = cmd.getNextArgRequired();
6679 String[] strings = value.split(",");
6680 ArrayList<Float> list = new ArrayList<>(strings.length);
6681 for (int i = 0; i < strings.length; i++) {
6682 list.add(Float.valueOf(strings[i]));
6683 }
6684 intent.putExtra(key, list);
6685 hasIntentInfo = true;
6686 }
6687 break;
6688 case "--esa": {
6689 String key = cmd.getNextArgRequired();
6690 String value = cmd.getNextArgRequired();
6691 // Split on commas unless they are preceeded by an escape.
6692 // The escape character must be escaped for the string and
6693 // again for the regex, thus four escape characters become one.
6694 String[] strings = value.split("(?<!\\\\),");
6695 intent.putExtra(key, strings);
6696 hasIntentInfo = true;
6697 }
6698 break;
6699 case "--esal": {
6700 String key = cmd.getNextArgRequired();
6701 String value = cmd.getNextArgRequired();
6702 // Split on commas unless they are preceeded by an escape.
6703 // The escape character must be escaped for the string and
6704 // again for the regex, thus four escape characters become one.
6705 String[] strings = value.split("(?<!\\\\),");
6706 ArrayList<String> list = new ArrayList<>(strings.length);
6707 for (int i = 0; i < strings.length; i++) {
6708 list.add(strings[i]);
6709 }
6710 intent.putExtra(key, list);
6711 hasIntentInfo = true;
6712 }
6713 break;
6714 case "--ez": {
6715 String key = cmd.getNextArgRequired();
6716 String value = cmd.getNextArgRequired().toLowerCase();
6717 // Boolean.valueOf() results in false for anything that is not "true", which is
6718 // error-prone in shell commands
6719 boolean arg;
6720 if ("true".equals(value) || "t".equals(value)) {
6721 arg = true;
6722 } else if ("false".equals(value) || "f".equals(value)) {
6723 arg = false;
6724 } else {
6725 try {
6726 arg = Integer.decode(value) != 0;
6727 } catch (NumberFormatException ex) {
6728 throw new IllegalArgumentException("Invalid boolean value: " + value);
6729 }
6730 }
6731
6732 intent.putExtra(key, arg);
6733 }
6734 break;
6735 case "-n": {
6736 String str = cmd.getNextArgRequired();
6737 ComponentName cn = ComponentName.unflattenFromString(str);
6738 if (cn == null)
6739 throw new IllegalArgumentException("Bad component name: " + str);
6740 intent.setComponent(cn);
6741 if (intent == baseIntent) {
6742 hasIntentInfo = true;
6743 }
6744 }
6745 break;
6746 case "-p": {
6747 String str = cmd.getNextArgRequired();
6748 intent.setPackage(str);
6749 if (intent == baseIntent) {
6750 hasIntentInfo = true;
6751 }
6752 }
6753 break;
6754 case "-f":
6755 String str = cmd.getNextArgRequired();
6756 intent.setFlags(Integer.decode(str).intValue());
6757 break;
6758 case "--grant-read-uri-permission":
6759 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6760 break;
6761 case "--grant-write-uri-permission":
6762 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6763 break;
6764 case "--grant-persistable-uri-permission":
6765 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6766 break;
6767 case "--grant-prefix-uri-permission":
6768 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6769 break;
6770 case "--exclude-stopped-packages":
6771 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6772 break;
6773 case "--include-stopped-packages":
6774 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6775 break;
6776 case "--debug-log-resolution":
6777 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6778 break;
6779 case "--activity-brought-to-front":
6780 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6781 break;
6782 case "--activity-clear-top":
6783 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6784 break;
6785 case "--activity-clear-when-task-reset":
6786 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6787 break;
6788 case "--activity-exclude-from-recents":
6789 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6790 break;
6791 case "--activity-launched-from-history":
6792 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6793 break;
6794 case "--activity-multiple-task":
6795 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6796 break;
6797 case "--activity-no-animation":
6798 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6799 break;
6800 case "--activity-no-history":
6801 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6802 break;
6803 case "--activity-no-user-action":
6804 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6805 break;
6806 case "--activity-previous-is-top":
6807 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6808 break;
6809 case "--activity-reorder-to-front":
6810 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6811 break;
6812 case "--activity-reset-task-if-needed":
6813 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6814 break;
6815 case "--activity-single-top":
6816 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6817 break;
6818 case "--activity-clear-task":
6819 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6820 break;
6821 case "--activity-task-on-home":
6822 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6823 break;
Patrick Baumann229141f2018-04-06 13:53:25 -07006824 case "--activity-match-external":
6825 intent.addFlags(Intent.FLAG_ACTIVITY_MATCH_EXTERNAL);
6826 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006827 case "--receiver-registered-only":
6828 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6829 break;
6830 case "--receiver-replace-pending":
6831 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6832 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006833 case "--receiver-foreground":
6834 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6835 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006836 case "--receiver-no-abort":
6837 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6838 break;
6839 case "--receiver-include-background":
6840 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6841 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006842 case "--selector":
6843 intent.setDataAndType(data, type);
6844 intent = new Intent();
6845 break;
6846 default:
6847 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6848 // Okay, caller handled this option.
6849 } else {
6850 throw new IllegalArgumentException("Unknown option: " + opt);
6851 }
6852 break;
6853 }
6854 }
6855 intent.setDataAndType(data, type);
6856
6857 final boolean hasSelector = intent != baseIntent;
6858 if (hasSelector) {
6859 // A selector was specified; fix up.
6860 baseIntent.setSelector(intent);
6861 intent = baseIntent;
6862 }
6863
6864 String arg = cmd.getNextArg();
6865 baseIntent = null;
6866 if (arg == null) {
6867 if (hasSelector) {
6868 // If a selector has been specified, and no arguments
6869 // have been supplied for the main Intent, then we can
6870 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6871 // need to have a component name specified yet, the
6872 // selector will take care of that.
6873 baseIntent = new Intent(Intent.ACTION_MAIN);
6874 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6875 }
6876 } else if (arg.indexOf(':') >= 0) {
6877 // The argument is a URI. Fully parse it, and use that result
6878 // to fill in any data not specified so far.
6879 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6880 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6881 } else if (arg.indexOf('/') >= 0) {
6882 // The argument is a component name. Build an Intent to launch
6883 // it.
6884 baseIntent = new Intent(Intent.ACTION_MAIN);
6885 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6886 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6887 } else {
6888 // Assume the argument is a package name.
6889 baseIntent = new Intent(Intent.ACTION_MAIN);
6890 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6891 baseIntent.setPackage(arg);
6892 }
6893 if (baseIntent != null) {
6894 Bundle extras = intent.getExtras();
6895 intent.replaceExtras((Bundle)null);
6896 Bundle uriExtras = baseIntent.getExtras();
6897 baseIntent.replaceExtras((Bundle)null);
6898 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6899 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6900 for (String c : cats) {
6901 baseIntent.removeCategory(c);
6902 }
6903 }
6904 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6905 if (extras == null) {
6906 extras = uriExtras;
6907 } else if (uriExtras != null) {
6908 uriExtras.putAll(extras);
6909 extras = uriExtras;
6910 }
6911 intent.replaceExtras(extras);
6912 hasIntentInfo = true;
6913 }
6914
6915 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6916 return intent;
6917 }
6918
6919 /** @hide */
6920 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6921 final String[] lines = new String[] {
6922 "<INTENT> specifications include these flags and arguments:",
6923 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6924 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6925 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6926 " [--esn <EXTRA_KEY> ...]",
6927 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6928 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6929 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6930 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6931 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6932 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6933 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6934 " (mutiple extras passed as Integer[])",
6935 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6936 " (mutiple extras passed as List<Integer>)",
6937 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6938 " (mutiple extras passed as Long[])",
6939 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6940 " (mutiple extras passed as List<Long>)",
6941 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6942 " (mutiple extras passed as Float[])",
6943 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6944 " (mutiple extras passed as List<Float>)",
6945 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6946 " (mutiple extras passed as String[]; to embed a comma into a string,",
6947 " escape it using \"\\,\")",
6948 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6949 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6950 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006951 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006952 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6953 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6954 " [--debug-log-resolution] [--exclude-stopped-packages]",
6955 " [--include-stopped-packages]",
6956 " [--activity-brought-to-front] [--activity-clear-top]",
6957 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6958 " [--activity-launched-from-history] [--activity-multiple-task]",
6959 " [--activity-no-animation] [--activity-no-history]",
6960 " [--activity-no-user-action] [--activity-previous-is-top]",
6961 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6962 " [--activity-single-top] [--activity-clear-task]",
Patrick Baumann229141f2018-04-06 13:53:25 -07006963 " [--activity-task-on-home] [--activity-match-external]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006964 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08006965 " [--receiver-foreground] [--receiver-no-abort]",
6966 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006967 " [--selector]",
6968 " [<URI> | <PACKAGE> | <COMPONENT>]"
6969 };
6970 for (String line : lines) {
6971 pw.print(prefix);
6972 pw.println(line);
6973 }
6974 }
6975
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006976 /**
6977 * Retrieve the general action to be performed, such as
6978 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6979 * the information in the intent should be interpreted -- most importantly,
6980 * what to do with the data returned by {@link #getData}.
6981 *
6982 * @return The action of this intent or null if none is specified.
6983 *
6984 * @see #setAction
6985 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006986 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006987 return mAction;
6988 }
6989
6990 /**
6991 * Retrieve data this intent is operating on. This URI specifies the name
6992 * of the data; often it uses the content: scheme, specifying data in a
6993 * content provider. Other schemes may be handled by specific activities,
6994 * such as http: by the web browser.
6995 *
6996 * @return The URI of the data this intent is targeting or null.
6997 *
6998 * @see #getScheme
6999 * @see #setData
7000 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007001 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007002 return mData;
7003 }
7004
7005 /**
7006 * The same as {@link #getData()}, but returns the URI as an encoded
7007 * String.
7008 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007009 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007010 return mData != null ? mData.toString() : null;
7011 }
7012
7013 /**
7014 * Return the scheme portion of the intent's data. If the data is null or
7015 * does not include a scheme, null is returned. Otherwise, the scheme
7016 * prefix without the final ':' is returned, i.e. "http".
7017 *
7018 * <p>This is the same as calling getData().getScheme() (and checking for
7019 * null data).
7020 *
7021 * @return The scheme of this intent.
7022 *
7023 * @see #getData
7024 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007025 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007026 return mData != null ? mData.getScheme() : null;
7027 }
7028
7029 /**
7030 * Retrieve any explicit MIME type included in the intent. This is usually
7031 * null, as the type is determined by the intent data.
7032 *
7033 * @return If a type was manually set, it is returned; else null is
7034 * returned.
7035 *
7036 * @see #resolveType(ContentResolver)
7037 * @see #setType
7038 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007039 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007040 return mType;
7041 }
7042
7043 /**
7044 * Return the MIME data type of this intent. If the type field is
7045 * explicitly set, that is simply returned. Otherwise, if the data is set,
7046 * the type of that data is returned. If neither fields are set, a null is
7047 * returned.
7048 *
7049 * @return The MIME type of this intent.
7050 *
7051 * @see #getType
7052 * @see #resolveType(ContentResolver)
7053 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007054 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007055 return resolveType(context.getContentResolver());
7056 }
7057
7058 /**
7059 * Return the MIME data type of this intent. If the type field is
7060 * explicitly set, that is simply returned. Otherwise, if the data is set,
7061 * the type of that data is returned. If neither fields are set, a null is
7062 * returned.
7063 *
7064 * @param resolver A ContentResolver that can be used to determine the MIME
7065 * type of the intent's data.
7066 *
7067 * @return The MIME type of this intent.
7068 *
7069 * @see #getType
7070 * @see #resolveType(Context)
7071 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007072 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007073 if (mType != null) {
7074 return mType;
7075 }
7076 if (mData != null) {
7077 if ("content".equals(mData.getScheme())) {
7078 return resolver.getType(mData);
7079 }
7080 }
7081 return null;
7082 }
7083
7084 /**
7085 * Return the MIME data type of this intent, only if it will be needed for
7086 * intent resolution. This is not generally useful for application code;
7087 * it is used by the frameworks for communicating with back-end system
7088 * services.
7089 *
7090 * @param resolver A ContentResolver that can be used to determine the MIME
7091 * type of the intent's data.
7092 *
7093 * @return The MIME type of this intent, or null if it is unknown or not
7094 * needed.
7095 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007096 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007097 if (mComponent != null) {
7098 return mType;
7099 }
7100 return resolveType(resolver);
7101 }
7102
7103 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007104 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007105 *
7106 * @param category The category to check.
7107 *
7108 * @return boolean True if the intent contains the category, else false.
7109 *
7110 * @see #getCategories
7111 * @see #addCategory
7112 */
7113 public boolean hasCategory(String category) {
7114 return mCategories != null && mCategories.contains(category);
7115 }
7116
7117 /**
7118 * Return the set of all categories in the intent. If there are no categories,
7119 * returns NULL.
7120 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007121 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007122 *
7123 * @see #hasCategory
7124 * @see #addCategory
7125 */
7126 public Set<String> getCategories() {
7127 return mCategories;
7128 }
7129
7130 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007131 * Return the specific selector associated with this Intent. If there is
7132 * none, returns null. See {@link #setSelector} for more information.
7133 *
7134 * @see #setSelector
7135 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007136 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007137 return mSelector;
7138 }
7139
7140 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007141 * Return the {@link ClipData} associated with this Intent. If there is
7142 * none, returns null. See {@link #setClipData} for more information.
7143 *
John Spurlock125d1332013-11-25 11:58:37 -05007144 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007145 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007146 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007147 return mClipData;
7148 }
7149
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007150 /** @hide */
7151 public int getContentUserHint() {
7152 return mContentUserHint;
7153 }
7154
Todd Kennedyb3b431302017-03-20 16:05:48 -07007155 /** @hide */
7156 public String getLaunchToken() {
7157 return mLaunchToken;
7158 }
7159
7160 /** @hide */
7161 public void setLaunchToken(String launchToken) {
7162 mLaunchToken = launchToken;
7163 }
7164
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007165 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007166 * Sets the ClassLoader that will be used when unmarshalling
7167 * any Parcelable values from the extras of this Intent.
7168 *
7169 * @param loader a ClassLoader, or null to use the default loader
7170 * at the time of unmarshalling.
7171 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007172 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007173 if (mExtras != null) {
7174 mExtras.setClassLoader(loader);
7175 }
7176 }
7177
7178 /**
7179 * Returns true if an extra value is associated with the given name.
7180 * @param name the extra's name
7181 * @return true if the given extra is present.
7182 */
7183 public boolean hasExtra(String name) {
7184 return mExtras != null && mExtras.containsKey(name);
7185 }
7186
7187 /**
7188 * Returns true if the Intent's extras contain a parcelled file descriptor.
7189 * @return true if the Intent contains a parcelled file descriptor.
7190 */
7191 public boolean hasFileDescriptors() {
7192 return mExtras != null && mExtras.hasFileDescriptors();
7193 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007194
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007195 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04007196 public void setAllowFds(boolean allowFds) {
7197 if (mExtras != null) {
7198 mExtras.setAllowFds(allowFds);
7199 }
7200 }
7201
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007202 /** {@hide} */
7203 public void setDefusable(boolean defusable) {
7204 if (mExtras != null) {
7205 mExtras.setDefusable(defusable);
7206 }
7207 }
7208
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007209 /**
7210 * Retrieve extended data from the intent.
7211 *
7212 * @param name The name of the desired item.
7213 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007214 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007215 * or null if none was found.
7216 *
7217 * @deprecated
7218 * @hide
7219 */
7220 @Deprecated
7221 public Object getExtra(String name) {
7222 return getExtra(name, null);
7223 }
7224
7225 /**
7226 * Retrieve extended data from the intent.
7227 *
7228 * @param name The name of the desired item.
7229 * @param defaultValue the value to be returned if no value of the desired
7230 * type is stored with the given name.
7231 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007232 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007233 * or the default value if none was found.
7234 *
7235 * @see #putExtra(String, boolean)
7236 */
7237 public boolean getBooleanExtra(String name, boolean defaultValue) {
7238 return mExtras == null ? defaultValue :
7239 mExtras.getBoolean(name, defaultValue);
7240 }
7241
7242 /**
7243 * Retrieve extended data from the intent.
7244 *
7245 * @param name The name of the desired item.
7246 * @param defaultValue the value to be returned if no value of the desired
7247 * type is stored with the given name.
7248 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007249 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007250 * or the default value if none was found.
7251 *
7252 * @see #putExtra(String, byte)
7253 */
7254 public byte getByteExtra(String name, byte defaultValue) {
7255 return mExtras == null ? defaultValue :
7256 mExtras.getByte(name, defaultValue);
7257 }
7258
7259 /**
7260 * Retrieve extended data from the intent.
7261 *
7262 * @param name The name of the desired item.
7263 * @param defaultValue the value to be returned if no value of the desired
7264 * type is stored with the given name.
7265 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007266 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007267 * or the default value if none was found.
7268 *
7269 * @see #putExtra(String, short)
7270 */
7271 public short getShortExtra(String name, short defaultValue) {
7272 return mExtras == null ? defaultValue :
7273 mExtras.getShort(name, defaultValue);
7274 }
7275
7276 /**
7277 * Retrieve extended data from the intent.
7278 *
7279 * @param name The name of the desired item.
7280 * @param defaultValue the value to be returned if no value of the desired
7281 * type is stored with the given name.
7282 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007283 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007284 * or the default value if none was found.
7285 *
7286 * @see #putExtra(String, char)
7287 */
7288 public char getCharExtra(String name, char defaultValue) {
7289 return mExtras == null ? defaultValue :
7290 mExtras.getChar(name, defaultValue);
7291 }
7292
7293 /**
7294 * Retrieve extended data from the intent.
7295 *
7296 * @param name The name of the desired item.
7297 * @param defaultValue the value to be returned if no value of the desired
7298 * type is stored with the given name.
7299 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007300 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007301 * or the default value if none was found.
7302 *
7303 * @see #putExtra(String, int)
7304 */
7305 public int getIntExtra(String name, int defaultValue) {
7306 return mExtras == null ? defaultValue :
7307 mExtras.getInt(name, defaultValue);
7308 }
7309
7310 /**
7311 * Retrieve extended data from the intent.
7312 *
7313 * @param name The name of the desired item.
7314 * @param defaultValue the value to be returned if no value of the desired
7315 * type is stored with the given name.
7316 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007317 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007318 * or the default value if none was found.
7319 *
7320 * @see #putExtra(String, long)
7321 */
7322 public long getLongExtra(String name, long defaultValue) {
7323 return mExtras == null ? defaultValue :
7324 mExtras.getLong(name, defaultValue);
7325 }
7326
7327 /**
7328 * Retrieve extended data from the intent.
7329 *
7330 * @param name The name of the desired item.
7331 * @param defaultValue the value to be returned if no value of the desired
7332 * type is stored with the given name.
7333 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007334 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007335 * or the default value if no such item is present
7336 *
7337 * @see #putExtra(String, float)
7338 */
7339 public float getFloatExtra(String name, float defaultValue) {
7340 return mExtras == null ? defaultValue :
7341 mExtras.getFloat(name, defaultValue);
7342 }
7343
7344 /**
7345 * Retrieve extended data from the intent.
7346 *
7347 * @param name The name of the desired item.
7348 * @param defaultValue the value to be returned if no value of the desired
7349 * type is stored with the given name.
7350 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007351 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007352 * or the default value if none was found.
7353 *
7354 * @see #putExtra(String, double)
7355 */
7356 public double getDoubleExtra(String name, double defaultValue) {
7357 return mExtras == null ? defaultValue :
7358 mExtras.getDouble(name, defaultValue);
7359 }
7360
7361 /**
7362 * Retrieve extended data from the intent.
7363 *
7364 * @param name The name of the desired item.
7365 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007366 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007367 * or null if no String value was found.
7368 *
7369 * @see #putExtra(String, String)
7370 */
7371 public String getStringExtra(String name) {
7372 return mExtras == null ? null : mExtras.getString(name);
7373 }
7374
7375 /**
7376 * Retrieve extended data from the intent.
7377 *
7378 * @param name The name of the desired item.
7379 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007380 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007381 * or null if no CharSequence value was found.
7382 *
7383 * @see #putExtra(String, CharSequence)
7384 */
7385 public CharSequence getCharSequenceExtra(String name) {
7386 return mExtras == null ? null : mExtras.getCharSequence(name);
7387 }
7388
7389 /**
7390 * Retrieve extended data from the intent.
7391 *
7392 * @param name The name of the desired item.
7393 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007394 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007395 * or null if no Parcelable value was found.
7396 *
7397 * @see #putExtra(String, Parcelable)
7398 */
7399 public <T extends Parcelable> T getParcelableExtra(String name) {
7400 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7401 }
7402
7403 /**
7404 * Retrieve extended data from the intent.
7405 *
7406 * @param name The name of the desired item.
7407 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007408 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007409 * or null if no Parcelable[] value was found.
7410 *
7411 * @see #putExtra(String, Parcelable[])
7412 */
7413 public Parcelable[] getParcelableArrayExtra(String name) {
7414 return mExtras == null ? null : mExtras.getParcelableArray(name);
7415 }
7416
7417 /**
7418 * Retrieve extended data from the intent.
7419 *
7420 * @param name The name of the desired item.
7421 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007422 * @return the value of an item previously added with
7423 * putParcelableArrayListExtra(), or null if no
7424 * ArrayList<Parcelable> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007425 *
7426 * @see #putParcelableArrayListExtra(String, ArrayList)
7427 */
7428 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
7429 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7430 }
7431
7432 /**
7433 * Retrieve extended data from the intent.
7434 *
7435 * @param name The name of the desired item.
7436 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007437 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007438 * or null if no Serializable value was found.
7439 *
7440 * @see #putExtra(String, Serializable)
7441 */
7442 public Serializable getSerializableExtra(String name) {
7443 return mExtras == null ? null : mExtras.getSerializable(name);
7444 }
7445
7446 /**
7447 * Retrieve extended data from the intent.
7448 *
7449 * @param name The name of the desired item.
7450 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007451 * @return the value of an item previously added with
7452 * putIntegerArrayListExtra(), or null if no
7453 * ArrayList<Integer> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007454 *
7455 * @see #putIntegerArrayListExtra(String, ArrayList)
7456 */
7457 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
7458 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7459 }
7460
7461 /**
7462 * Retrieve extended data from the intent.
7463 *
7464 * @param name The name of the desired item.
7465 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007466 * @return the value of an item previously added with
7467 * putStringArrayListExtra(), or null if no
7468 * ArrayList<String> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007469 *
7470 * @see #putStringArrayListExtra(String, ArrayList)
7471 */
7472 public ArrayList<String> getStringArrayListExtra(String name) {
7473 return mExtras == null ? null : mExtras.getStringArrayList(name);
7474 }
7475
7476 /**
7477 * Retrieve extended data from the intent.
7478 *
7479 * @param name The name of the desired item.
7480 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007481 * @return the value of an item previously added with
7482 * putCharSequenceArrayListExtra, or null if no
7483 * ArrayList<CharSequence> value was found.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007484 *
7485 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7486 */
7487 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
7488 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7489 }
7490
7491 /**
7492 * Retrieve extended data from the intent.
7493 *
7494 * @param name The name of the desired item.
7495 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007496 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007497 * or null if no boolean array value was found.
7498 *
7499 * @see #putExtra(String, boolean[])
7500 */
7501 public boolean[] getBooleanArrayExtra(String name) {
7502 return mExtras == null ? null : mExtras.getBooleanArray(name);
7503 }
7504
7505 /**
7506 * Retrieve extended data from the intent.
7507 *
7508 * @param name The name of the desired item.
7509 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007510 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007511 * or null if no byte array value was found.
7512 *
7513 * @see #putExtra(String, byte[])
7514 */
7515 public byte[] getByteArrayExtra(String name) {
7516 return mExtras == null ? null : mExtras.getByteArray(name);
7517 }
7518
7519 /**
7520 * Retrieve extended data from the intent.
7521 *
7522 * @param name The name of the desired item.
7523 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007524 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007525 * or null if no short array value was found.
7526 *
7527 * @see #putExtra(String, short[])
7528 */
7529 public short[] getShortArrayExtra(String name) {
7530 return mExtras == null ? null : mExtras.getShortArray(name);
7531 }
7532
7533 /**
7534 * Retrieve extended data from the intent.
7535 *
7536 * @param name The name of the desired item.
7537 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007538 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007539 * or null if no char array value was found.
7540 *
7541 * @see #putExtra(String, char[])
7542 */
7543 public char[] getCharArrayExtra(String name) {
7544 return mExtras == null ? null : mExtras.getCharArray(name);
7545 }
7546
7547 /**
7548 * Retrieve extended data from the intent.
7549 *
7550 * @param name The name of the desired item.
7551 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007552 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007553 * or null if no int array value was found.
7554 *
7555 * @see #putExtra(String, int[])
7556 */
7557 public int[] getIntArrayExtra(String name) {
7558 return mExtras == null ? null : mExtras.getIntArray(name);
7559 }
7560
7561 /**
7562 * Retrieve extended data from the intent.
7563 *
7564 * @param name The name of the desired item.
7565 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007566 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007567 * or null if no long array value was found.
7568 *
7569 * @see #putExtra(String, long[])
7570 */
7571 public long[] getLongArrayExtra(String name) {
7572 return mExtras == null ? null : mExtras.getLongArray(name);
7573 }
7574
7575 /**
7576 * Retrieve extended data from the intent.
7577 *
7578 * @param name The name of the desired item.
7579 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007580 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007581 * or null if no float array value was found.
7582 *
7583 * @see #putExtra(String, float[])
7584 */
7585 public float[] getFloatArrayExtra(String name) {
7586 return mExtras == null ? null : mExtras.getFloatArray(name);
7587 }
7588
7589 /**
7590 * Retrieve extended data from the intent.
7591 *
7592 * @param name The name of the desired item.
7593 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007594 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007595 * or null if no double array value was found.
7596 *
7597 * @see #putExtra(String, double[])
7598 */
7599 public double[] getDoubleArrayExtra(String name) {
7600 return mExtras == null ? null : mExtras.getDoubleArray(name);
7601 }
7602
7603 /**
7604 * Retrieve extended data from the intent.
7605 *
7606 * @param name The name of the desired item.
7607 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007608 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007609 * or null if no String array value was found.
7610 *
7611 * @see #putExtra(String, String[])
7612 */
7613 public String[] getStringArrayExtra(String name) {
7614 return mExtras == null ? null : mExtras.getStringArray(name);
7615 }
7616
7617 /**
7618 * Retrieve extended data from the intent.
7619 *
7620 * @param name The name of the desired item.
7621 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007622 * @return the value of an item previously added with putExtra(),
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007623 * or null if no CharSequence array value was found.
7624 *
7625 * @see #putExtra(String, CharSequence[])
7626 */
7627 public CharSequence[] getCharSequenceArrayExtra(String name) {
7628 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7629 }
7630
7631 /**
7632 * Retrieve extended data from the intent.
7633 *
7634 * @param name The name of the desired item.
7635 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007636 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007637 * or null if no Bundle value was found.
7638 *
7639 * @see #putExtra(String, Bundle)
7640 */
7641 public Bundle getBundleExtra(String name) {
7642 return mExtras == null ? null : mExtras.getBundle(name);
7643 }
7644
7645 /**
7646 * Retrieve extended data from the intent.
7647 *
7648 * @param name The name of the desired item.
7649 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007650 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007651 * or null if no IBinder value was found.
7652 *
7653 * @see #putExtra(String, IBinder)
7654 *
7655 * @deprecated
7656 * @hide
7657 */
7658 @Deprecated
7659 public IBinder getIBinderExtra(String name) {
7660 return mExtras == null ? null : mExtras.getIBinder(name);
7661 }
7662
7663 /**
7664 * Retrieve extended data from the intent.
7665 *
7666 * @param name The name of the desired item.
7667 * @param defaultValue The default value to return in case no item is
7668 * associated with the key 'name'
7669 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007670 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007671 * or defaultValue if none was found.
7672 *
7673 * @see #putExtra
7674 *
7675 * @deprecated
7676 * @hide
7677 */
7678 @Deprecated
7679 public Object getExtra(String name, Object defaultValue) {
7680 Object result = defaultValue;
7681 if (mExtras != null) {
7682 Object result2 = mExtras.get(name);
7683 if (result2 != null) {
7684 result = result2;
7685 }
7686 }
7687
7688 return result;
7689 }
7690
7691 /**
7692 * Retrieves a map of extended data from the intent.
7693 *
7694 * @return the map of all extras previously added with putExtra(),
7695 * or null if none have been added.
7696 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007697 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007698 return (mExtras != null)
7699 ? new Bundle(mExtras)
7700 : null;
7701 }
7702
7703 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007704 * Filter extras to only basic types.
7705 * @hide
7706 */
7707 public void removeUnsafeExtras() {
7708 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007709 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007710 }
7711 }
7712
7713 /**
Makoto Onuki97f82f22017-05-31 16:20:21 -07007714 * @return Whether {@link #maybeStripForHistory} will return an lightened intent or
7715 * return itself as-is.
7716 * @hide
7717 */
7718 public boolean canStripForHistory() {
7719 return ((mExtras != null) && mExtras.isParcelled()) || (mClipData != null);
7720 }
7721
7722 /**
7723 * Call it when the system needs to keep an intent for logging purposes to remove fields
7724 * that are not needed for logging.
7725 * @hide
7726 */
7727 public Intent maybeStripForHistory() {
7728 // TODO Scan and remove possibly heavy instances like Bitmaps from unparcelled extras?
7729
7730 if (!canStripForHistory()) {
7731 return this;
7732 }
7733 return new Intent(this, COPY_MODE_HISTORY);
7734 }
7735
7736 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007737 * Retrieve any special flags associated with this intent. You will
7738 * normally just set them with {@link #setFlags} and let the system
7739 * take the appropriate action with them.
7740 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007741 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007742 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007743 * @see #addFlags
7744 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007745 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007746 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007747 return mFlags;
7748 }
7749
Dianne Hackborne7f97212011-02-24 14:40:20 -08007750 /** @hide */
7751 public boolean isExcludingStopped() {
7752 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7753 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7754 }
7755
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007756 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007757 * Retrieve the application package name this Intent is limited to. When
7758 * resolving an Intent, if non-null this limits the resolution to only
7759 * components in the given application package.
7760 *
7761 * @return The name of the application package for the Intent.
7762 *
7763 * @see #resolveActivity
7764 * @see #setPackage
7765 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007766 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007767 return mPackage;
7768 }
7769
7770 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007771 * Retrieve the concrete component associated with the intent. When receiving
7772 * an intent, this is the component that was found to best handle it (that is,
7773 * yourself) and will always be non-null; in all other cases it will be
7774 * null unless explicitly set.
7775 *
7776 * @return The name of the application component to handle the intent.
7777 *
7778 * @see #resolveActivity
7779 * @see #setComponent
7780 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007781 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007782 return mComponent;
7783 }
7784
7785 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007786 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7787 * used as a hint to the receiver for animations and the like. Null means that there
7788 * is no source bounds.
7789 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007790 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007791 return mSourceBounds;
7792 }
7793
7794 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007795 * Return the Activity component that should be used to handle this intent.
7796 * The appropriate component is determined based on the information in the
7797 * intent, evaluated as follows:
7798 *
7799 * <p>If {@link #getComponent} returns an explicit class, that is returned
7800 * without any further consideration.
7801 *
7802 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7803 * category to be considered.
7804 *
7805 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7806 * action.
7807 *
7808 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7809 * this type.
7810 *
7811 * <p>If {@link #addCategory} has added any categories, the activity must
7812 * handle ALL of the categories specified.
7813 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007814 * <p>If {@link #getPackage} is non-NULL, only activity components in
7815 * that application package will be considered.
7816 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007817 * <p>If there are no activities that satisfy all of these conditions, a
7818 * null string is returned.
7819 *
7820 * <p>If multiple activities are found to satisfy the intent, the one with
7821 * the highest priority will be used. If there are multiple activities
7822 * with the same priority, the system will either pick the best activity
7823 * based on user preference, or resolve to a system class that will allow
7824 * the user to pick an activity and forward from there.
7825 *
7826 * <p>This method is implemented simply by calling
7827 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7828 * true.</p>
7829 * <p> This API is called for you as part of starting an activity from an
7830 * intent. You do not normally need to call it yourself.</p>
7831 *
7832 * @param pm The package manager with which to resolve the Intent.
7833 *
7834 * @return Name of the component implementing an activity that can
7835 * display the intent.
7836 *
7837 * @see #setComponent
7838 * @see #getComponent
7839 * @see #resolveActivityInfo
7840 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007841 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007842 if (mComponent != null) {
7843 return mComponent;
7844 }
7845
7846 ResolveInfo info = pm.resolveActivity(
7847 this, PackageManager.MATCH_DEFAULT_ONLY);
7848 if (info != null) {
7849 return new ComponentName(
7850 info.activityInfo.applicationInfo.packageName,
7851 info.activityInfo.name);
7852 }
7853
7854 return null;
7855 }
7856
7857 /**
7858 * Resolve the Intent into an {@link ActivityInfo}
7859 * describing the activity that should execute the intent. Resolution
7860 * follows the same rules as described for {@link #resolveActivity}, but
7861 * you get back the completely information about the resolved activity
7862 * instead of just its class name.
7863 *
7864 * @param pm The package manager with which to resolve the Intent.
7865 * @param flags Addition information to retrieve as per
7866 * {@link PackageManager#getActivityInfo(ComponentName, int)
7867 * PackageManager.getActivityInfo()}.
7868 *
7869 * @return PackageManager.ActivityInfo
7870 *
7871 * @see #resolveActivity
7872 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007873 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
7874 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007875 ActivityInfo ai = null;
7876 if (mComponent != null) {
7877 try {
7878 ai = pm.getActivityInfo(mComponent, flags);
7879 } catch (PackageManager.NameNotFoundException e) {
7880 // ignore
7881 }
7882 } else {
7883 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007884 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007885 if (info != null) {
7886 ai = info.activityInfo;
7887 }
7888 }
7889
7890 return ai;
7891 }
7892
7893 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007894 * Special function for use by the system to resolve service
7895 * intents to system apps. Throws an exception if there are
7896 * multiple potential matches to the Intent. Returns null if
7897 * there are no matches.
7898 * @hide
7899 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007900 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
7901 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07007902 if (mComponent != null) {
7903 return mComponent;
7904 }
7905
7906 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7907 if (results == null) {
7908 return null;
7909 }
7910 ComponentName comp = null;
7911 for (int i=0; i<results.size(); i++) {
7912 ResolveInfo ri = results.get(i);
7913 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7914 continue;
7915 }
7916 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7917 ri.serviceInfo.name);
7918 if (comp != null) {
7919 throw new IllegalStateException("Multiple system services handle " + this
7920 + ": " + comp + ", " + foundComp);
7921 }
7922 comp = foundComp;
7923 }
7924 return comp;
7925 }
7926
7927 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007928 * Set the general action to be performed.
7929 *
7930 * @param action An action name, such as ACTION_VIEW. Application-specific
7931 * actions should be prefixed with the vendor's package name.
7932 *
7933 * @return Returns the same Intent object, for chaining multiple calls
7934 * into a single statement.
7935 *
7936 * @see #getAction
7937 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007938 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007939 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007940 return this;
7941 }
7942
7943 /**
7944 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007945 * clears any type that was previously set by {@link #setType} or
7946 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007947 *
Nick Pellyccae4122012-01-09 14:12:58 -08007948 * <p><em>Note: scheme matching in the Android framework is
7949 * case-sensitive, unlike the formal RFC. As a result,
7950 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007951 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007952 * {@link #setDataAndNormalize}
7953 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007954 *
Nick Pellyccae4122012-01-09 14:12:58 -08007955 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007956 *
7957 * @return Returns the same Intent object, for chaining multiple calls
7958 * into a single statement.
7959 *
7960 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007961 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007962 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007963 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007964 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007965 mData = data;
7966 mType = null;
7967 return this;
7968 }
7969
7970 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007971 * Normalize and set the data this intent is operating on.
7972 *
7973 * <p>This method automatically clears any type that was
7974 * previously set (for example, by {@link #setType}).
7975 *
7976 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007977 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007978 * so really this is just a convenience method for
7979 * <pre>
7980 * setData(data.normalize())
7981 * </pre>
7982 *
7983 * @param data The Uri of the data this intent is now targeting.
7984 *
7985 * @return Returns the same Intent object, for chaining multiple calls
7986 * into a single statement.
7987 *
7988 * @see #getData
7989 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007990 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007991 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007992 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007993 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007994 }
7995
7996 /**
7997 * Set an explicit MIME data type.
7998 *
7999 * <p>This is used to create intents that only specify a type and not data,
8000 * for example to indicate the type of data to return.
8001 *
8002 * <p>This method automatically clears any data that was
8003 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07008004 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008005 * <p><em>Note: MIME type matching in the Android framework is
8006 * case-sensitive, unlike formal RFC MIME types. As a result,
8007 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08008008 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
8009 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008010 *
8011 * @param type The MIME type of the data being handled by this intent.
8012 *
8013 * @return Returns the same Intent object, for chaining multiple calls
8014 * into a single statement.
8015 *
8016 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08008017 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008018 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08008019 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008020 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008021 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008022 mData = null;
8023 mType = type;
8024 return this;
8025 }
8026
8027 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008028 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008029 *
Nick Pellyccae4122012-01-09 14:12:58 -08008030 * <p>This is used to create intents that only specify a type and not data,
8031 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008032 *
Nick Pellyccae4122012-01-09 14:12:58 -08008033 * <p>This method automatically clears any data that was
8034 * previously set (for example by {@link #setData}).
8035 *
8036 * <p>The MIME type is normalized using
8037 * {@link #normalizeMimeType} before it is set,
8038 * so really this is just a convenience method for
8039 * <pre>
8040 * setType(Intent.normalizeMimeType(type))
8041 * </pre>
8042 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008043 * @param type The MIME type of the data being handled by this intent.
8044 *
8045 * @return Returns the same Intent object, for chaining multiple calls
8046 * into a single statement.
8047 *
Nick Pellyccae4122012-01-09 14:12:58 -08008048 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008049 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08008050 * @see #normalizeMimeType
8051 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008052 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08008053 return setType(normalizeMimeType(type));
8054 }
8055
8056 /**
8057 * (Usually optional) Set the data for the intent along with an explicit
8058 * MIME data type. This method should very rarely be used -- it allows you
8059 * to override the MIME type that would ordinarily be inferred from the
8060 * data with your own type given here.
8061 *
8062 * <p><em>Note: MIME type and Uri scheme matching in the
8063 * Android framework is case-sensitive, unlike the formal RFC definitions.
8064 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008065 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08008066 * {@link #setDataAndTypeAndNormalize}
8067 * to ensure that they are converted to lower case.</em>
8068 *
8069 * @param data The Uri of the data this intent is now targeting.
8070 * @param type The MIME type of the data being handled by this intent.
8071 *
8072 * @return Returns the same Intent object, for chaining multiple calls
8073 * into a single statement.
8074 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008075 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08008076 * @see #setData
8077 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008078 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008079 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008080 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008081 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008082 mData = data;
8083 mType = type;
8084 return this;
8085 }
8086
8087 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008088 * (Usually optional) Normalize and set both the data Uri and an explicit
8089 * MIME data type. This method should very rarely be used -- it allows you
8090 * to override the MIME type that would ordinarily be inferred from the
8091 * data with your own type given here.
8092 *
8093 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008094 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08008095 * before they are set, so really this is just a convenience method for
8096 * <pre>
8097 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
8098 * </pre>
8099 *
8100 * @param data The Uri of the data this intent is now targeting.
8101 * @param type The MIME type of the data being handled by this intent.
8102 *
8103 * @return Returns the same Intent object, for chaining multiple calls
8104 * into a single statement.
8105 *
8106 * @see #setType
8107 * @see #setData
8108 * @see #setDataAndType
8109 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008110 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008111 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008112 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008113 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08008114 }
8115
8116 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008117 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008118 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008119 * activities that provide <em>all</em> of the requested categories will be
8120 * used.
8121 *
8122 * @param category The desired category. This can be either one of the
8123 * predefined Intent categories, or a custom category in your own
8124 * namespace.
8125 *
8126 * @return Returns the same Intent object, for chaining multiple calls
8127 * into a single statement.
8128 *
8129 * @see #hasCategory
8130 * @see #removeCategory
8131 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008132 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008133 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008134 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008135 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08008136 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008137 return this;
8138 }
8139
8140 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008141 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008142 *
8143 * @param category The category to remove.
8144 *
8145 * @see #addCategory
8146 */
8147 public void removeCategory(String category) {
8148 if (mCategories != null) {
8149 mCategories.remove(category);
8150 if (mCategories.size() == 0) {
8151 mCategories = null;
8152 }
8153 }
8154 }
8155
8156 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008157 * Set a selector for this Intent. This is a modification to the kinds of
8158 * things the Intent will match. If the selector is set, it will be used
8159 * when trying to find entities that can handle the Intent, instead of the
8160 * main contents of the Intent. This allows you build an Intent containing
8161 * a generic protocol while targeting it more specifically.
8162 *
8163 * <p>An example of where this may be used is with things like
8164 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
8165 * Intent that will launch the Browser application. However, the correct
8166 * main entry point of an application is actually {@link #ACTION_MAIN}
8167 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
8168 * used to specify the actual Activity to launch. If you launch the browser
8169 * with something different, undesired behavior may happen if the user has
8170 * previously or later launches it the normal way, since they do not match.
8171 * Instead, you can build an Intent with the MAIN action (but no ComponentName
8172 * yet specified) and set a selector with {@link #ACTION_MAIN} and
8173 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
8174 *
8175 * <p>Setting a selector does not impact the behavior of
8176 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
8177 * desired behavior of a selector -- it does not impact the base meaning
8178 * of the Intent, just what kinds of things will be matched against it
8179 * when determining who can handle it.</p>
8180 *
8181 * <p>You can not use both a selector and {@link #setPackage(String)} on
8182 * the same base Intent.</p>
8183 *
8184 * @param selector The desired selector Intent; set to null to not use
8185 * a special selector.
8186 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008187 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008188 if (selector == this) {
8189 throw new IllegalArgumentException(
8190 "Intent being set as a selector of itself");
8191 }
8192 if (selector != null && mPackage != null) {
8193 throw new IllegalArgumentException(
8194 "Can't set selector when package name is already set");
8195 }
8196 mSelector = selector;
8197 }
8198
8199 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008200 * Set a {@link ClipData} associated with this Intent. This replaces any
8201 * previously set ClipData.
8202 *
8203 * <p>The ClipData in an intent is not used for Intent matching or other
8204 * such operations. Semantically it is like extras, used to transmit
8205 * additional data with the Intent. The main feature of using this over
8206 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
8207 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
8208 * items included in the clip data. This is useful, in particular, if
8209 * you want to transmit an Intent containing multiple <code>content:</code>
8210 * URIs for which the recipient may not have global permission to access the
8211 * content provider.
8212 *
8213 * <p>If the ClipData contains items that are themselves Intents, any
8214 * grant flags in those Intents will be ignored. Only the top-level flags
8215 * of the main Intent are respected, and will be applied to all Uri or
8216 * Intent items in the clip (or sub-items of the clip).
8217 *
8218 * <p>The MIME type, label, and icon in the ClipData object are not
8219 * directly used by Intent. Applications should generally rely on the
8220 * MIME type of the Intent itself, not what it may find in the ClipData.
8221 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05008222 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008223 *
8224 * @param clip The new clip to set. May be null to clear the current clip.
8225 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008226 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008227 mClipData = clip;
8228 }
8229
8230 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008231 * This is NOT a secure mechanism to identify the user who sent the intent.
8232 * When the intent is sent to a different user, it is used to fix uris by adding the userId
8233 * who sent the intent.
8234 * @hide
8235 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01008236 public void prepareToLeaveUser(int userId) {
8237 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
8238 // We want mContentUserHint to refer to the original user, so don't do anything.
8239 if (mContentUserHint == UserHandle.USER_CURRENT) {
8240 mContentUserHint = userId;
8241 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008242 }
8243
8244 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008245 * Add extended data to the intent. The name must include a package
8246 * prefix, for example the app com.android.contacts would use names
8247 * like "com.android.contacts.ShowAll".
8248 *
8249 * @param name The name of the extra data, with package prefix.
8250 * @param value The boolean data value.
8251 *
8252 * @return Returns the same Intent object, for chaining multiple calls
8253 * into a single statement.
8254 *
8255 * @see #putExtras
8256 * @see #removeExtra
8257 * @see #getBooleanExtra(String, boolean)
8258 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008259 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008260 if (mExtras == null) {
8261 mExtras = new Bundle();
8262 }
8263 mExtras.putBoolean(name, value);
8264 return this;
8265 }
8266
8267 /**
8268 * Add extended data to the intent. The name must include a package
8269 * prefix, for example the app com.android.contacts would use names
8270 * like "com.android.contacts.ShowAll".
8271 *
8272 * @param name The name of the extra data, with package prefix.
8273 * @param value The byte data value.
8274 *
8275 * @return Returns the same Intent object, for chaining multiple calls
8276 * into a single statement.
8277 *
8278 * @see #putExtras
8279 * @see #removeExtra
8280 * @see #getByteExtra(String, byte)
8281 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008282 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008283 if (mExtras == null) {
8284 mExtras = new Bundle();
8285 }
8286 mExtras.putByte(name, value);
8287 return this;
8288 }
8289
8290 /**
8291 * Add extended data to the intent. The name must include a package
8292 * prefix, for example the app com.android.contacts would use names
8293 * like "com.android.contacts.ShowAll".
8294 *
8295 * @param name The name of the extra data, with package prefix.
8296 * @param value The char data value.
8297 *
8298 * @return Returns the same Intent object, for chaining multiple calls
8299 * into a single statement.
8300 *
8301 * @see #putExtras
8302 * @see #removeExtra
8303 * @see #getCharExtra(String, char)
8304 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008305 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008306 if (mExtras == null) {
8307 mExtras = new Bundle();
8308 }
8309 mExtras.putChar(name, value);
8310 return this;
8311 }
8312
8313 /**
8314 * Add extended data to the intent. The name must include a package
8315 * prefix, for example the app com.android.contacts would use names
8316 * like "com.android.contacts.ShowAll".
8317 *
8318 * @param name The name of the extra data, with package prefix.
8319 * @param value The short data value.
8320 *
8321 * @return Returns the same Intent object, for chaining multiple calls
8322 * into a single statement.
8323 *
8324 * @see #putExtras
8325 * @see #removeExtra
8326 * @see #getShortExtra(String, short)
8327 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008328 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008329 if (mExtras == null) {
8330 mExtras = new Bundle();
8331 }
8332 mExtras.putShort(name, value);
8333 return this;
8334 }
8335
8336 /**
8337 * Add extended data to the intent. The name must include a package
8338 * prefix, for example the app com.android.contacts would use names
8339 * like "com.android.contacts.ShowAll".
8340 *
8341 * @param name The name of the extra data, with package prefix.
8342 * @param value The integer data value.
8343 *
8344 * @return Returns the same Intent object, for chaining multiple calls
8345 * into a single statement.
8346 *
8347 * @see #putExtras
8348 * @see #removeExtra
8349 * @see #getIntExtra(String, int)
8350 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008351 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008352 if (mExtras == null) {
8353 mExtras = new Bundle();
8354 }
8355 mExtras.putInt(name, value);
8356 return this;
8357 }
8358
8359 /**
8360 * Add extended data to the intent. The name must include a package
8361 * prefix, for example the app com.android.contacts would use names
8362 * like "com.android.contacts.ShowAll".
8363 *
8364 * @param name The name of the extra data, with package prefix.
8365 * @param value The long data value.
8366 *
8367 * @return Returns the same Intent object, for chaining multiple calls
8368 * into a single statement.
8369 *
8370 * @see #putExtras
8371 * @see #removeExtra
8372 * @see #getLongExtra(String, long)
8373 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008374 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008375 if (mExtras == null) {
8376 mExtras = new Bundle();
8377 }
8378 mExtras.putLong(name, value);
8379 return this;
8380 }
8381
8382 /**
8383 * Add extended data to the intent. The name must include a package
8384 * prefix, for example the app com.android.contacts would use names
8385 * like "com.android.contacts.ShowAll".
8386 *
8387 * @param name The name of the extra data, with package prefix.
8388 * @param value The float data value.
8389 *
8390 * @return Returns the same Intent object, for chaining multiple calls
8391 * into a single statement.
8392 *
8393 * @see #putExtras
8394 * @see #removeExtra
8395 * @see #getFloatExtra(String, float)
8396 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008397 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008398 if (mExtras == null) {
8399 mExtras = new Bundle();
8400 }
8401 mExtras.putFloat(name, value);
8402 return this;
8403 }
8404
8405 /**
8406 * Add extended data to the intent. The name must include a package
8407 * prefix, for example the app com.android.contacts would use names
8408 * like "com.android.contacts.ShowAll".
8409 *
8410 * @param name The name of the extra data, with package prefix.
8411 * @param value The double data value.
8412 *
8413 * @return Returns the same Intent object, for chaining multiple calls
8414 * into a single statement.
8415 *
8416 * @see #putExtras
8417 * @see #removeExtra
8418 * @see #getDoubleExtra(String, double)
8419 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008420 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008421 if (mExtras == null) {
8422 mExtras = new Bundle();
8423 }
8424 mExtras.putDouble(name, value);
8425 return this;
8426 }
8427
8428 /**
8429 * Add extended data to the intent. The name must include a package
8430 * prefix, for example the app com.android.contacts would use names
8431 * like "com.android.contacts.ShowAll".
8432 *
8433 * @param name The name of the extra data, with package prefix.
8434 * @param value The String data value.
8435 *
8436 * @return Returns the same Intent object, for chaining multiple calls
8437 * into a single statement.
8438 *
8439 * @see #putExtras
8440 * @see #removeExtra
8441 * @see #getStringExtra(String)
8442 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008443 public @NonNull Intent putExtra(String name, String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008444 if (mExtras == null) {
8445 mExtras = new Bundle();
8446 }
8447 mExtras.putString(name, value);
8448 return this;
8449 }
8450
8451 /**
8452 * Add extended data to the intent. The name must include a package
8453 * prefix, for example the app com.android.contacts would use names
8454 * like "com.android.contacts.ShowAll".
8455 *
8456 * @param name The name of the extra data, with package prefix.
8457 * @param value The CharSequence data value.
8458 *
8459 * @return Returns the same Intent object, for chaining multiple calls
8460 * into a single statement.
8461 *
8462 * @see #putExtras
8463 * @see #removeExtra
8464 * @see #getCharSequenceExtra(String)
8465 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008466 public @NonNull Intent putExtra(String name, CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008467 if (mExtras == null) {
8468 mExtras = new Bundle();
8469 }
8470 mExtras.putCharSequence(name, value);
8471 return this;
8472 }
8473
8474 /**
8475 * Add extended data to the intent. The name must include a package
8476 * prefix, for example the app com.android.contacts would use names
8477 * like "com.android.contacts.ShowAll".
8478 *
8479 * @param name The name of the extra data, with package prefix.
8480 * @param value The Parcelable data value.
8481 *
8482 * @return Returns the same Intent object, for chaining multiple calls
8483 * into a single statement.
8484 *
8485 * @see #putExtras
8486 * @see #removeExtra
8487 * @see #getParcelableExtra(String)
8488 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008489 public @NonNull Intent putExtra(String name, Parcelable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008490 if (mExtras == null) {
8491 mExtras = new Bundle();
8492 }
8493 mExtras.putParcelable(name, value);
8494 return this;
8495 }
8496
8497 /**
8498 * Add extended data to the intent. The name must include a package
8499 * prefix, for example the app com.android.contacts would use names
8500 * like "com.android.contacts.ShowAll".
8501 *
8502 * @param name The name of the extra data, with package prefix.
8503 * @param value The Parcelable[] data value.
8504 *
8505 * @return Returns the same Intent object, for chaining multiple calls
8506 * into a single statement.
8507 *
8508 * @see #putExtras
8509 * @see #removeExtra
8510 * @see #getParcelableArrayExtra(String)
8511 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008512 public @NonNull Intent putExtra(String name, Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008513 if (mExtras == null) {
8514 mExtras = new Bundle();
8515 }
8516 mExtras.putParcelableArray(name, value);
8517 return this;
8518 }
8519
8520 /**
8521 * Add extended data to the intent. The name must include a package
8522 * prefix, for example the app com.android.contacts would use names
8523 * like "com.android.contacts.ShowAll".
8524 *
8525 * @param name The name of the extra data, with package prefix.
8526 * @param value The ArrayList<Parcelable> data value.
8527 *
8528 * @return Returns the same Intent object, for chaining multiple calls
8529 * into a single statement.
8530 *
8531 * @see #putExtras
8532 * @see #removeExtra
8533 * @see #getParcelableArrayListExtra(String)
8534 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008535 public @NonNull Intent putParcelableArrayListExtra(String name,
8536 ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008537 if (mExtras == null) {
8538 mExtras = new Bundle();
8539 }
8540 mExtras.putParcelableArrayList(name, value);
8541 return this;
8542 }
8543
8544 /**
8545 * Add extended data to the intent. The name must include a package
8546 * prefix, for example the app com.android.contacts would use names
8547 * like "com.android.contacts.ShowAll".
8548 *
8549 * @param name The name of the extra data, with package prefix.
8550 * @param value The ArrayList<Integer> data value.
8551 *
8552 * @return Returns the same Intent object, for chaining multiple calls
8553 * into a single statement.
8554 *
8555 * @see #putExtras
8556 * @see #removeExtra
8557 * @see #getIntegerArrayListExtra(String)
8558 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008559 public @NonNull Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008560 if (mExtras == null) {
8561 mExtras = new Bundle();
8562 }
8563 mExtras.putIntegerArrayList(name, value);
8564 return this;
8565 }
8566
8567 /**
8568 * Add extended data to the intent. The name must include a package
8569 * prefix, for example the app com.android.contacts would use names
8570 * like "com.android.contacts.ShowAll".
8571 *
8572 * @param name The name of the extra data, with package prefix.
8573 * @param value The ArrayList<String> data value.
8574 *
8575 * @return Returns the same Intent object, for chaining multiple calls
8576 * into a single statement.
8577 *
8578 * @see #putExtras
8579 * @see #removeExtra
8580 * @see #getStringArrayListExtra(String)
8581 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008582 public @NonNull Intent putStringArrayListExtra(String name, ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008583 if (mExtras == null) {
8584 mExtras = new Bundle();
8585 }
8586 mExtras.putStringArrayList(name, value);
8587 return this;
8588 }
8589
8590 /**
8591 * Add extended data to the intent. The name must include a package
8592 * prefix, for example the app com.android.contacts would use names
8593 * like "com.android.contacts.ShowAll".
8594 *
8595 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008596 * @param value The ArrayList<CharSequence> data value.
8597 *
8598 * @return Returns the same Intent object, for chaining multiple calls
8599 * into a single statement.
8600 *
8601 * @see #putExtras
8602 * @see #removeExtra
8603 * @see #getCharSequenceArrayListExtra(String)
8604 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008605 public @NonNull Intent putCharSequenceArrayListExtra(String name,
8606 ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008607 if (mExtras == null) {
8608 mExtras = new Bundle();
8609 }
8610 mExtras.putCharSequenceArrayList(name, value);
8611 return this;
8612 }
8613
8614 /**
8615 * Add extended data to the intent. The name must include a package
8616 * prefix, for example the app com.android.contacts would use names
8617 * like "com.android.contacts.ShowAll".
8618 *
8619 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008620 * @param value The Serializable data value.
8621 *
8622 * @return Returns the same Intent object, for chaining multiple calls
8623 * into a single statement.
8624 *
8625 * @see #putExtras
8626 * @see #removeExtra
8627 * @see #getSerializableExtra(String)
8628 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008629 public @NonNull Intent putExtra(String name, Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008630 if (mExtras == null) {
8631 mExtras = new Bundle();
8632 }
8633 mExtras.putSerializable(name, value);
8634 return this;
8635 }
8636
8637 /**
8638 * Add extended data to the intent. The name must include a package
8639 * prefix, for example the app com.android.contacts would use names
8640 * like "com.android.contacts.ShowAll".
8641 *
8642 * @param name The name of the extra data, with package prefix.
8643 * @param value The boolean array data value.
8644 *
8645 * @return Returns the same Intent object, for chaining multiple calls
8646 * into a single statement.
8647 *
8648 * @see #putExtras
8649 * @see #removeExtra
8650 * @see #getBooleanArrayExtra(String)
8651 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008652 public @NonNull Intent putExtra(String name, boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008653 if (mExtras == null) {
8654 mExtras = new Bundle();
8655 }
8656 mExtras.putBooleanArray(name, value);
8657 return this;
8658 }
8659
8660 /**
8661 * Add extended data to the intent. The name must include a package
8662 * prefix, for example the app com.android.contacts would use names
8663 * like "com.android.contacts.ShowAll".
8664 *
8665 * @param name The name of the extra data, with package prefix.
8666 * @param value The byte array data value.
8667 *
8668 * @return Returns the same Intent object, for chaining multiple calls
8669 * into a single statement.
8670 *
8671 * @see #putExtras
8672 * @see #removeExtra
8673 * @see #getByteArrayExtra(String)
8674 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008675 public @NonNull Intent putExtra(String name, byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008676 if (mExtras == null) {
8677 mExtras = new Bundle();
8678 }
8679 mExtras.putByteArray(name, value);
8680 return this;
8681 }
8682
8683 /**
8684 * Add extended data to the intent. The name must include a package
8685 * prefix, for example the app com.android.contacts would use names
8686 * like "com.android.contacts.ShowAll".
8687 *
8688 * @param name The name of the extra data, with package prefix.
8689 * @param value The short array data value.
8690 *
8691 * @return Returns the same Intent object, for chaining multiple calls
8692 * into a single statement.
8693 *
8694 * @see #putExtras
8695 * @see #removeExtra
8696 * @see #getShortArrayExtra(String)
8697 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008698 public @NonNull Intent putExtra(String name, short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008699 if (mExtras == null) {
8700 mExtras = new Bundle();
8701 }
8702 mExtras.putShortArray(name, value);
8703 return this;
8704 }
8705
8706 /**
8707 * Add extended data to the intent. The name 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 name The name of the extra data, with package prefix.
8712 * @param value The char array data value.
8713 *
8714 * @return Returns the same Intent object, for chaining multiple calls
8715 * into a single statement.
8716 *
8717 * @see #putExtras
8718 * @see #removeExtra
8719 * @see #getCharArrayExtra(String)
8720 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008721 public @NonNull Intent putExtra(String name, char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008722 if (mExtras == null) {
8723 mExtras = new Bundle();
8724 }
8725 mExtras.putCharArray(name, value);
8726 return this;
8727 }
8728
8729 /**
8730 * Add extended data to the intent. The name must include a package
8731 * prefix, for example the app com.android.contacts would use names
8732 * like "com.android.contacts.ShowAll".
8733 *
8734 * @param name The name of the extra data, with package prefix.
8735 * @param value The int array data value.
8736 *
8737 * @return Returns the same Intent object, for chaining multiple calls
8738 * into a single statement.
8739 *
8740 * @see #putExtras
8741 * @see #removeExtra
8742 * @see #getIntArrayExtra(String)
8743 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008744 public @NonNull Intent putExtra(String name, int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008745 if (mExtras == null) {
8746 mExtras = new Bundle();
8747 }
8748 mExtras.putIntArray(name, value);
8749 return this;
8750 }
8751
8752 /**
8753 * Add extended data to the intent. The name must include a package
8754 * prefix, for example the app com.android.contacts would use names
8755 * like "com.android.contacts.ShowAll".
8756 *
8757 * @param name The name of the extra data, with package prefix.
8758 * @param value The byte array data value.
8759 *
8760 * @return Returns the same Intent object, for chaining multiple calls
8761 * into a single statement.
8762 *
8763 * @see #putExtras
8764 * @see #removeExtra
8765 * @see #getLongArrayExtra(String)
8766 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008767 public @NonNull Intent putExtra(String name, long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008768 if (mExtras == null) {
8769 mExtras = new Bundle();
8770 }
8771 mExtras.putLongArray(name, value);
8772 return this;
8773 }
8774
8775 /**
8776 * Add extended data to the intent. The name must include a package
8777 * prefix, for example the app com.android.contacts would use names
8778 * like "com.android.contacts.ShowAll".
8779 *
8780 * @param name The name of the extra data, with package prefix.
8781 * @param value The float array data value.
8782 *
8783 * @return Returns the same Intent object, for chaining multiple calls
8784 * into a single statement.
8785 *
8786 * @see #putExtras
8787 * @see #removeExtra
8788 * @see #getFloatArrayExtra(String)
8789 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008790 public @NonNull Intent putExtra(String name, float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008791 if (mExtras == null) {
8792 mExtras = new Bundle();
8793 }
8794 mExtras.putFloatArray(name, value);
8795 return this;
8796 }
8797
8798 /**
8799 * Add extended data to the intent. The name must include a package
8800 * prefix, for example the app com.android.contacts would use names
8801 * like "com.android.contacts.ShowAll".
8802 *
8803 * @param name The name of the extra data, with package prefix.
8804 * @param value The double array data value.
8805 *
8806 * @return Returns the same Intent object, for chaining multiple calls
8807 * into a single statement.
8808 *
8809 * @see #putExtras
8810 * @see #removeExtra
8811 * @see #getDoubleArrayExtra(String)
8812 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008813 public @NonNull Intent putExtra(String name, double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008814 if (mExtras == null) {
8815 mExtras = new Bundle();
8816 }
8817 mExtras.putDoubleArray(name, value);
8818 return this;
8819 }
8820
8821 /**
8822 * Add extended data to the intent. The name must include a package
8823 * prefix, for example the app com.android.contacts would use names
8824 * like "com.android.contacts.ShowAll".
8825 *
8826 * @param name The name of the extra data, with package prefix.
8827 * @param value The String array data value.
8828 *
8829 * @return Returns the same Intent object, for chaining multiple calls
8830 * into a single statement.
8831 *
8832 * @see #putExtras
8833 * @see #removeExtra
8834 * @see #getStringArrayExtra(String)
8835 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008836 public @NonNull Intent putExtra(String name, String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008837 if (mExtras == null) {
8838 mExtras = new Bundle();
8839 }
8840 mExtras.putStringArray(name, value);
8841 return this;
8842 }
8843
8844 /**
8845 * Add extended data to the intent. The name must include a package
8846 * prefix, for example the app com.android.contacts would use names
8847 * like "com.android.contacts.ShowAll".
8848 *
8849 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008850 * @param value The CharSequence array data value.
8851 *
8852 * @return Returns the same Intent object, for chaining multiple calls
8853 * into a single statement.
8854 *
8855 * @see #putExtras
8856 * @see #removeExtra
8857 * @see #getCharSequenceArrayExtra(String)
8858 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008859 public @NonNull Intent putExtra(String name, CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008860 if (mExtras == null) {
8861 mExtras = new Bundle();
8862 }
8863 mExtras.putCharSequenceArray(name, value);
8864 return this;
8865 }
8866
8867 /**
8868 * Add extended data to the intent. The name must include a package
8869 * prefix, for example the app com.android.contacts would use names
8870 * like "com.android.contacts.ShowAll".
8871 *
8872 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008873 * @param value The Bundle data value.
8874 *
8875 * @return Returns the same Intent object, for chaining multiple calls
8876 * into a single statement.
8877 *
8878 * @see #putExtras
8879 * @see #removeExtra
8880 * @see #getBundleExtra(String)
8881 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008882 public @NonNull Intent putExtra(String name, Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008883 if (mExtras == null) {
8884 mExtras = new Bundle();
8885 }
8886 mExtras.putBundle(name, value);
8887 return this;
8888 }
8889
8890 /**
8891 * Add extended data to the intent. The name must include a package
8892 * prefix, for example the app com.android.contacts would use names
8893 * like "com.android.contacts.ShowAll".
8894 *
8895 * @param name The name of the extra data, with package prefix.
8896 * @param value The IBinder data value.
8897 *
8898 * @return Returns the same Intent object, for chaining multiple calls
8899 * into a single statement.
8900 *
8901 * @see #putExtras
8902 * @see #removeExtra
8903 * @see #getIBinderExtra(String)
8904 *
8905 * @deprecated
8906 * @hide
8907 */
8908 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008909 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008910 if (mExtras == null) {
8911 mExtras = new Bundle();
8912 }
8913 mExtras.putIBinder(name, value);
8914 return this;
8915 }
8916
8917 /**
8918 * Copy all extras in 'src' in to this intent.
8919 *
8920 * @param src Contains the extras to copy.
8921 *
8922 * @see #putExtra
8923 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008924 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008925 if (src.mExtras != null) {
8926 if (mExtras == null) {
8927 mExtras = new Bundle(src.mExtras);
8928 } else {
8929 mExtras.putAll(src.mExtras);
8930 }
8931 }
8932 return this;
8933 }
8934
8935 /**
8936 * Add a set of extended data to the intent. The keys must include a package
8937 * prefix, for example the app com.android.contacts would use names
8938 * like "com.android.contacts.ShowAll".
8939 *
8940 * @param extras The Bundle of extras to add to this intent.
8941 *
8942 * @see #putExtra
8943 * @see #removeExtra
8944 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008945 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008946 if (mExtras == null) {
8947 mExtras = new Bundle();
8948 }
8949 mExtras.putAll(extras);
8950 return this;
8951 }
8952
8953 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008954 * Completely replace the extras in the Intent with the extras in the
8955 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008956 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008957 * @param src The exact extras contained in this Intent are copied
8958 * into the target intent, replacing any that were previously there.
8959 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008960 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008961 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8962 return this;
8963 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008964
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008965 /**
8966 * Completely replace the extras in the Intent with the given Bundle of
8967 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008968 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008969 * @param extras The new set of extras in the Intent, or null to erase
8970 * all extras.
8971 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008972 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008973 mExtras = extras != null ? new Bundle(extras) : null;
8974 return this;
8975 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008976
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008977 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008978 * Remove extended data from the intent.
8979 *
8980 * @see #putExtra
8981 */
8982 public void removeExtra(String name) {
8983 if (mExtras != null) {
8984 mExtras.remove(name);
8985 if (mExtras.size() == 0) {
8986 mExtras = null;
8987 }
8988 }
8989 }
8990
8991 /**
8992 * Set special flags controlling how this intent is handled. Most values
8993 * here depend on the type of component being executed by the Intent,
8994 * specifically the FLAG_ACTIVITY_* flags are all for use with
8995 * {@link Context#startActivity Context.startActivity()} and the
8996 * FLAG_RECEIVER_* flags are all for use with
8997 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8998 *
Scott Main7aee61f2011-02-08 11:25:01 -08008999 * <p>See the
9000 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
9001 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009002 * the behavior of your application.
9003 *
9004 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009005 * @return Returns the same Intent object, for chaining multiple calls
9006 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009007 * @see #getFlags
9008 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009009 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009010 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009011 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009012 mFlags = flags;
9013 return this;
9014 }
9015
9016 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009017 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009018 *
9019 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009020 * @return Returns the same Intent object, for chaining multiple calls into
9021 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009022 * @see #setFlags
9023 * @see #getFlags
9024 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009025 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009026 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009027 mFlags |= flags;
9028 return this;
9029 }
9030
9031 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009032 * Remove these flags from the intent.
9033 *
9034 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009035 * @see #setFlags
9036 * @see #getFlags
9037 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009038 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009039 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009040 mFlags &= ~flags;
9041 }
9042
9043 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009044 * (Usually optional) Set an explicit application package name that limits
9045 * the components this Intent will resolve to. If left to the default
9046 * value of null, all components in all applications will considered.
9047 * If non-null, the Intent can only match the components in the given
9048 * application package.
9049 *
9050 * @param packageName The name of the application package to handle the
9051 * intent, or null to allow any application package.
9052 *
9053 * @return Returns the same Intent object, for chaining multiple calls
9054 * into a single statement.
9055 *
9056 * @see #getPackage
9057 * @see #resolveActivity
9058 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009059 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009060 if (packageName != null && mSelector != null) {
9061 throw new IllegalArgumentException(
9062 "Can't set package name when selector is already set");
9063 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009064 mPackage = packageName;
9065 return this;
9066 }
9067
9068 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009069 * (Usually optional) Explicitly set the component to handle the intent.
9070 * If left with the default value of null, the system will determine the
9071 * appropriate class to use based on the other fields (action, data,
9072 * type, categories) in the Intent. If this class is defined, the
9073 * specified class will always be used regardless of the other fields. You
9074 * should only set this value when you know you absolutely want a specific
9075 * class to be used; otherwise it is better to let the system find the
9076 * appropriate class so that you will respect the installed applications
9077 * and user preferences.
9078 *
9079 * @param component The name of the application component to handle the
9080 * intent, or null to let the system find one for you.
9081 *
9082 * @return Returns the same Intent object, for chaining multiple calls
9083 * into a single statement.
9084 *
9085 * @see #setClass
9086 * @see #setClassName(Context, String)
9087 * @see #setClassName(String, String)
9088 * @see #getComponent
9089 * @see #resolveActivity
9090 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009091 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009092 mComponent = component;
9093 return this;
9094 }
9095
9096 /**
9097 * Convenience for calling {@link #setComponent} with an
9098 * explicit class name.
9099 *
9100 * @param packageContext A Context of the application package implementing
9101 * this class.
9102 * @param className The name of a class inside of the application package
9103 * that will be used as the component for this Intent.
9104 *
9105 * @return Returns the same Intent object, for chaining multiple calls
9106 * into a single statement.
9107 *
9108 * @see #setComponent
9109 * @see #setClass
9110 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009111 public @NonNull Intent setClassName(@NonNull Context packageContext,
9112 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009113 mComponent = new ComponentName(packageContext, className);
9114 return this;
9115 }
9116
9117 /**
9118 * Convenience for calling {@link #setComponent} with an
9119 * explicit application package name and class name.
9120 *
9121 * @param packageName The name of the package implementing the desired
9122 * component.
9123 * @param className The name of a class inside of the application package
9124 * that will be used as the component for this Intent.
9125 *
9126 * @return Returns the same Intent object, for chaining multiple calls
9127 * into a single statement.
9128 *
9129 * @see #setComponent
9130 * @see #setClass
9131 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009132 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009133 mComponent = new ComponentName(packageName, className);
9134 return this;
9135 }
9136
9137 /**
9138 * Convenience for calling {@link #setComponent(ComponentName)} with the
9139 * name returned by a {@link Class} object.
9140 *
9141 * @param packageContext A Context of the application package implementing
9142 * this class.
9143 * @param cls The class name to set, equivalent to
9144 * <code>setClassName(context, cls.getName())</code>.
9145 *
9146 * @return Returns the same Intent object, for chaining multiple calls
9147 * into a single statement.
9148 *
9149 * @see #setComponent
9150 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009151 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009152 mComponent = new ComponentName(packageContext, cls);
9153 return this;
9154 }
9155
9156 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009157 * Set the bounds of the sender of this intent, in screen coordinates. This can be
9158 * used as a hint to the receiver for animations and the like. Null means that there
9159 * is no source bounds.
9160 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009161 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009162 if (r != null) {
9163 mSourceBounds = new Rect(r);
9164 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07009165 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009166 }
9167 }
9168
Tor Norbyed9273d62013-05-30 15:59:53 -07009169 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07009170 @IntDef(flag = true, prefix = { "FILL_IN_" }, value = {
9171 FILL_IN_ACTION,
9172 FILL_IN_DATA,
9173 FILL_IN_CATEGORIES,
9174 FILL_IN_COMPONENT,
9175 FILL_IN_PACKAGE,
9176 FILL_IN_SOURCE_BOUNDS,
9177 FILL_IN_SELECTOR,
9178 FILL_IN_CLIP_DATA
9179 })
Tor Norbyed9273d62013-05-30 15:59:53 -07009180 @Retention(RetentionPolicy.SOURCE)
9181 public @interface FillInFlags {}
9182
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009183 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009184 * Use with {@link #fillIn} to allow the current action value to be
9185 * overwritten, even if it is already set.
9186 */
9187 public static final int FILL_IN_ACTION = 1<<0;
9188
9189 /**
9190 * Use with {@link #fillIn} to allow the current data or type value
9191 * overwritten, even if it is already set.
9192 */
9193 public static final int FILL_IN_DATA = 1<<1;
9194
9195 /**
9196 * Use with {@link #fillIn} to allow the current categories to be
9197 * overwritten, even if they are already set.
9198 */
9199 public static final int FILL_IN_CATEGORIES = 1<<2;
9200
9201 /**
9202 * Use with {@link #fillIn} to allow the current component value to be
9203 * overwritten, even if it is already set.
9204 */
9205 public static final int FILL_IN_COMPONENT = 1<<3;
9206
9207 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009208 * Use with {@link #fillIn} to allow the current package value to be
9209 * overwritten, even if it is already set.
9210 */
9211 public static final int FILL_IN_PACKAGE = 1<<4;
9212
9213 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009214 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009215 * overwritten, even if it is already set.
9216 */
9217 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
9218
9219 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009220 * Use with {@link #fillIn} to allow the current selector to be
9221 * overwritten, even if it is already set.
9222 */
9223 public static final int FILL_IN_SELECTOR = 1<<6;
9224
9225 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009226 * Use with {@link #fillIn} to allow the current ClipData to be
9227 * overwritten, even if it is already set.
9228 */
9229 public static final int FILL_IN_CLIP_DATA = 1<<7;
9230
9231 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009232 * Copy the contents of <var>other</var> in to this object, but only
9233 * where fields are not defined by this object. For purposes of a field
9234 * being defined, the following pieces of data in the Intent are
9235 * considered to be separate fields:
9236 *
9237 * <ul>
9238 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08009239 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009240 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
9241 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009242 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009243 * <li> component, as set by {@link #setComponent(ComponentName)} or
9244 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009245 * <li> source bounds, as set by {@link #setSourceBounds}.
9246 * <li> selector, as set by {@link #setSelector(Intent)}.
9247 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009248 * <li> each top-level name in the associated extras.
9249 * </ul>
9250 *
9251 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009252 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009253 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
9254 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
9255 * the restriction where the corresponding field will not be replaced if
9256 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009257 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009258 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
9259 * is explicitly specified. The selector will only be copied if
9260 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07009261 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009262 * <p>For example, consider Intent A with {data="foo", categories="bar"}
9263 * and Intent B with {action="gotit", data-type="some/thing",
9264 * categories="one","two"}.
9265 *
9266 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
9267 * containing: {action="gotit", data-type="some/thing",
9268 * categories="bar"}.
9269 *
9270 * @param other Another Intent whose values are to be used to fill in
9271 * the current one.
9272 * @param flags Options to control which fields can be filled in.
9273 *
9274 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009275 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07009276 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08009277 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07009278 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009279 */
Tor Norbyed9273d62013-05-30 15:59:53 -07009280 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009281 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009282 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009283 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009284 if (other.mAction != null
9285 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009286 mAction = other.mAction;
9287 changes |= FILL_IN_ACTION;
9288 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009289 if ((other.mData != null || other.mType != null)
9290 && ((mData == null && mType == null)
9291 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009292 mData = other.mData;
9293 mType = other.mType;
9294 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009295 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009296 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009297 if (other.mCategories != null
9298 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009299 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009300 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009301 }
9302 changes |= FILL_IN_CATEGORIES;
9303 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009304 if (other.mPackage != null
9305 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009306 // Only do this if mSelector is not set.
9307 if (mSelector == null) {
9308 mPackage = other.mPackage;
9309 changes |= FILL_IN_PACKAGE;
9310 }
9311 }
9312 // Selector is special: it can only be set if explicitly allowed,
9313 // for the same reason as the component name.
9314 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
9315 if (mPackage == null) {
9316 mSelector = new Intent(other.mSelector);
9317 mPackage = null;
9318 changes |= FILL_IN_SELECTOR;
9319 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009320 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009321 if (other.mClipData != null
9322 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
9323 mClipData = other.mClipData;
9324 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009325 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009326 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009327 // Component is special: it can -only- be set if explicitly allowed,
9328 // since otherwise the sender could force the intent somewhere the
9329 // originator didn't intend.
9330 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009331 mComponent = other.mComponent;
9332 changes |= FILL_IN_COMPONENT;
9333 }
9334 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009335 if (other.mSourceBounds != null
9336 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
9337 mSourceBounds = new Rect(other.mSourceBounds);
9338 changes |= FILL_IN_SOURCE_BOUNDS;
9339 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009340 if (mExtras == null) {
9341 if (other.mExtras != null) {
9342 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009343 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009344 }
9345 } else if (other.mExtras != null) {
9346 try {
9347 Bundle newb = new Bundle(other.mExtras);
9348 newb.putAll(mExtras);
9349 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009350 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009351 } catch (RuntimeException e) {
9352 // Modifying the extras can cause us to unparcel the contents
9353 // of the bundle, and if we do this in the system process that
9354 // may fail. We really should handle this (i.e., the Bundle
9355 // impl shouldn't be on top of a plain map), but for now just
9356 // ignore it and keep the original contents. :(
9357 Log.w("Intent", "Failure filling in extras", e);
9358 }
9359 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009360 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9361 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9362 mContentUserHint = other.mContentUserHint;
9363 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009364 return changes;
9365 }
9366
9367 /**
9368 * Wrapper class holding an Intent and implementing comparisons on it for
9369 * the purpose of filtering. The class implements its
9370 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9371 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9372 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9373 * on the wrapped Intent.
9374 */
9375 public static final class FilterComparison {
9376 private final Intent mIntent;
9377 private final int mHashCode;
9378
9379 public FilterComparison(Intent intent) {
9380 mIntent = intent;
9381 mHashCode = intent.filterHashCode();
9382 }
9383
9384 /**
9385 * Return the Intent that this FilterComparison represents.
9386 * @return Returns the Intent held by the FilterComparison. Do
9387 * not modify!
9388 */
9389 public Intent getIntent() {
9390 return mIntent;
9391 }
9392
9393 @Override
9394 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009395 if (obj instanceof FilterComparison) {
9396 Intent other = ((FilterComparison)obj).mIntent;
9397 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009398 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009399 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009400 }
9401
9402 @Override
9403 public int hashCode() {
9404 return mHashCode;
9405 }
9406 }
9407
9408 /**
9409 * Determine if two intents are the same for the purposes of intent
9410 * resolution (filtering). That is, if their action, data, type,
9411 * class, and categories are the same. This does <em>not</em> compare
9412 * any extra data included in the intents.
9413 *
9414 * @param other The other Intent to compare against.
9415 *
9416 * @return Returns true if action, data, type, class, and categories
9417 * are the same.
9418 */
9419 public boolean filterEquals(Intent other) {
9420 if (other == null) {
9421 return false;
9422 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009423 if (!Objects.equals(this.mAction, other.mAction)) return false;
9424 if (!Objects.equals(this.mData, other.mData)) return false;
9425 if (!Objects.equals(this.mType, other.mType)) return false;
9426 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9427 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9428 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009429
9430 return true;
9431 }
9432
9433 /**
9434 * Generate hash code that matches semantics of filterEquals().
9435 *
9436 * @return Returns the hash value of the action, data, type, class, and
9437 * categories.
9438 *
9439 * @see #filterEquals
9440 */
9441 public int filterHashCode() {
9442 int code = 0;
9443 if (mAction != null) {
9444 code += mAction.hashCode();
9445 }
9446 if (mData != null) {
9447 code += mData.hashCode();
9448 }
9449 if (mType != null) {
9450 code += mType.hashCode();
9451 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009452 if (mPackage != null) {
9453 code += mPackage.hashCode();
9454 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009455 if (mComponent != null) {
9456 code += mComponent.hashCode();
9457 }
9458 if (mCategories != null) {
9459 code += mCategories.hashCode();
9460 }
9461 return code;
9462 }
9463
9464 @Override
9465 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009466 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009467
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009468 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009469 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009470 b.append(" }");
9471
9472 return b.toString();
9473 }
9474
9475 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009476 public String toInsecureString() {
9477 StringBuilder b = new StringBuilder(128);
9478
9479 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009480 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009481 b.append(" }");
9482
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009483 return b.toString();
9484 }
Romain Guy4969af72009-06-17 10:53:19 -07009485
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009486 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009487 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009488 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009489
9490 b.append("Intent { ");
9491 toShortString(b, false, true, true, true);
9492 b.append(" }");
9493
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009494 return b.toString();
9495 }
9496
9497 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009498 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9499 StringBuilder b = new StringBuilder(128);
9500 toShortString(b, secure, comp, extras, clip);
9501 return b.toString();
9502 }
9503
9504 /** @hide */
9505 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9506 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009507 boolean first = true;
9508 if (mAction != null) {
9509 b.append("act=").append(mAction);
9510 first = false;
9511 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009512 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009513 if (!first) {
9514 b.append(' ');
9515 }
9516 first = false;
9517 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009518 for (int i=0; i<mCategories.size(); i++) {
9519 if (i > 0) b.append(',');
9520 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009521 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009522 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009523 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009524 if (mData != null) {
9525 if (!first) {
9526 b.append(' ');
9527 }
9528 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009529 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009530 if (secure) {
9531 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009532 } else {
9533 b.append(mData);
9534 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009535 }
9536 if (mType != null) {
9537 if (!first) {
9538 b.append(' ');
9539 }
9540 first = false;
9541 b.append("typ=").append(mType);
9542 }
9543 if (mFlags != 0) {
9544 if (!first) {
9545 b.append(' ');
9546 }
9547 first = false;
9548 b.append("flg=0x").append(Integer.toHexString(mFlags));
9549 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009550 if (mPackage != null) {
9551 if (!first) {
9552 b.append(' ');
9553 }
9554 first = false;
9555 b.append("pkg=").append(mPackage);
9556 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009557 if (comp && mComponent != null) {
9558 if (!first) {
9559 b.append(' ');
9560 }
9561 first = false;
9562 b.append("cmp=").append(mComponent.flattenToShortString());
9563 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009564 if (mSourceBounds != null) {
9565 if (!first) {
9566 b.append(' ');
9567 }
9568 first = false;
9569 b.append("bnds=").append(mSourceBounds.toShortString());
9570 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009571 if (mClipData != null) {
9572 if (!first) {
9573 b.append(' ');
9574 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009575 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009576 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009577 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009578 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009579 if (mClipData.getDescription() != null) {
9580 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9581 } else {
9582 first = true;
9583 }
9584 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009585 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009586 first = false;
9587 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009588 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009589 if (extras && mExtras != null) {
9590 if (!first) {
9591 b.append(' ');
9592 }
9593 first = false;
9594 b.append("(has extras)");
9595 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009596 if (mContentUserHint != UserHandle.USER_CURRENT) {
9597 if (!first) {
9598 b.append(' ');
9599 }
9600 first = false;
9601 b.append("u=").append(mContentUserHint);
9602 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009603 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009604 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009605 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009606 b.append("}");
9607 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009608 }
9609
Yi Jin129fc6c2017-09-28 15:48:38 -07009610 /** @hide */
Kweku Adams85f2fbc2017-12-18 12:04:12 -08009611 public void writeToProto(ProtoOutputStream proto, long fieldId) {
9612 // Same input parameters that toString() gives to toShortString().
9613 writeToProto(proto, fieldId, true, true, true, false);
9614 }
9615
9616 /** @hide */
Yi Jin129fc6c2017-09-28 15:48:38 -07009617 public void writeToProto(ProtoOutputStream proto, long fieldId, boolean secure, boolean comp,
9618 boolean extras, boolean clip) {
9619 long token = proto.start(fieldId);
9620 if (mAction != null) {
9621 proto.write(IntentProto.ACTION, mAction);
9622 }
9623 if (mCategories != null) {
9624 for (String category : mCategories) {
9625 proto.write(IntentProto.CATEGORIES, category);
9626 }
9627 }
9628 if (mData != null) {
9629 proto.write(IntentProto.DATA, secure ? mData.toSafeString() : mData.toString());
9630 }
9631 if (mType != null) {
9632 proto.write(IntentProto.TYPE, mType);
9633 }
9634 if (mFlags != 0) {
9635 proto.write(IntentProto.FLAG, "0x" + Integer.toHexString(mFlags));
9636 }
9637 if (mPackage != null) {
9638 proto.write(IntentProto.PACKAGE, mPackage);
9639 }
9640 if (comp && mComponent != null) {
Yi Jin676d1ac2018-01-25 15:40:28 -08009641 mComponent.writeToProto(proto, IntentProto.COMPONENT);
Yi Jin129fc6c2017-09-28 15:48:38 -07009642 }
9643 if (mSourceBounds != null) {
9644 proto.write(IntentProto.SOURCE_BOUNDS, mSourceBounds.toShortString());
9645 }
9646 if (mClipData != null) {
9647 StringBuilder b = new StringBuilder();
9648 if (clip) {
9649 mClipData.toShortString(b);
9650 } else {
9651 mClipData.toShortStringShortItems(b, false);
9652 }
9653 proto.write(IntentProto.CLIP_DATA, b.toString());
9654 }
9655 if (extras && mExtras != null) {
9656 proto.write(IntentProto.EXTRAS, mExtras.toShortString());
9657 }
9658 if (mContentUserHint != 0) {
9659 proto.write(IntentProto.CONTENT_USER_HINT, mContentUserHint);
9660 }
9661 if (mSelector != null) {
9662 proto.write(IntentProto.SELECTOR, mSelector.toShortString(secure, comp, extras, clip));
9663 }
9664 proto.end(token);
9665 }
9666
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009667 /**
9668 * Call {@link #toUri} with 0 flags.
9669 * @deprecated Use {@link #toUri} instead.
9670 */
9671 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009672 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009673 return toUri(0);
9674 }
9675
9676 /**
9677 * Convert this Intent into a String holding a URI representation of it.
9678 * The returned URI string has been properly URI encoded, so it can be
9679 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9680 * Intent's data as the base URI, with an additional fragment describing
9681 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009682 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009683 * <p>You can convert the returned string back to an Intent with
9684 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009685 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009686 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009687 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009688 * @return Returns a URI encoding URI string describing the entire contents
9689 * of the Intent.
9690 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009691 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009692 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009693 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9694 if (mPackage == null) {
9695 throw new IllegalArgumentException(
9696 "Intent must include an explicit package name to build an android-app: "
9697 + this);
9698 }
9699 uri.append("android-app://");
9700 uri.append(mPackage);
9701 String scheme = null;
9702 if (mData != null) {
9703 scheme = mData.getScheme();
9704 if (scheme != null) {
9705 uri.append('/');
9706 uri.append(scheme);
9707 String authority = mData.getEncodedAuthority();
9708 if (authority != null) {
9709 uri.append('/');
9710 uri.append(authority);
9711 String path = mData.getEncodedPath();
9712 if (path != null) {
9713 uri.append(path);
9714 }
9715 String queryParams = mData.getEncodedQuery();
9716 if (queryParams != null) {
9717 uri.append('?');
9718 uri.append(queryParams);
9719 }
9720 String fragment = mData.getEncodedFragment();
9721 if (fragment != null) {
9722 uri.append('#');
9723 uri.append(fragment);
9724 }
9725 }
9726 }
9727 }
9728 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9729 mPackage, flags);
9730 return uri.toString();
9731 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009732 String scheme = null;
9733 if (mData != null) {
9734 String data = mData.toString();
9735 if ((flags&URI_INTENT_SCHEME) != 0) {
9736 final int N = data.length();
9737 for (int i=0; i<N; i++) {
9738 char c = data.charAt(i);
9739 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
Christopher Schuster42c3a6e2017-07-21 14:53:52 -07009740 || (c >= '0' && c <= '9') || c == '.' || c == '-' || c == '+') {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009741 continue;
9742 }
9743 if (c == ':' && i > 0) {
9744 // Valid scheme.
9745 scheme = data.substring(0, i);
9746 uri.append("intent:");
9747 data = data.substring(i+1);
9748 break;
9749 }
Tom Taylord4a47292009-12-21 13:59:18 -08009750
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009751 // No scheme.
9752 break;
9753 }
9754 }
9755 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009756
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009757 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9758 uri.append("intent:");
9759 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009760
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009761 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009762
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009763 return uri.toString();
9764 }
9765
9766 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9767 String defPackage, int flags) {
9768 StringBuilder frag = new StringBuilder(128);
9769
9770 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009771 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009772 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009773 // Note that for now we are not going to try to handle the
9774 // data part; not clear how to represent this as a URI, and
9775 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009776 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9777 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009778 }
9779
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009780 if (frag.length() > 0) {
9781 uri.append("#Intent;");
9782 uri.append(frag);
9783 uri.append("end");
9784 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009785 }
9786
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009787 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9788 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009789 if (scheme != null) {
9790 uri.append("scheme=").append(scheme).append(';');
9791 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009792 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009793 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009794 }
9795 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009796 for (int i=0; i<mCategories.size(); i++) {
9797 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009798 }
9799 }
9800 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009801 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009802 }
9803 if (mFlags != 0) {
9804 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9805 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009806 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009807 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9808 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009809 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009810 uri.append("component=").append(Uri.encode(
9811 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009812 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009813 if (mSourceBounds != null) {
9814 uri.append("sourceBounds=")
9815 .append(Uri.encode(mSourceBounds.flattenToString()))
9816 .append(';');
9817 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009818 if (mExtras != null) {
9819 for (String key : mExtras.keySet()) {
9820 final Object value = mExtras.get(key);
9821 char entryType =
9822 value instanceof String ? 'S' :
9823 value instanceof Boolean ? 'B' :
9824 value instanceof Byte ? 'b' :
9825 value instanceof Character ? 'c' :
9826 value instanceof Double ? 'd' :
9827 value instanceof Float ? 'f' :
9828 value instanceof Integer ? 'i' :
9829 value instanceof Long ? 'l' :
9830 value instanceof Short ? 's' :
9831 '\0';
9832
9833 if (entryType != '\0') {
9834 uri.append(entryType);
9835 uri.append('.');
9836 uri.append(Uri.encode(key));
9837 uri.append('=');
9838 uri.append(Uri.encode(value.toString()));
9839 uri.append(';');
9840 }
9841 }
9842 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009843 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009844
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009845 public int describeContents() {
9846 return (mExtras != null) ? mExtras.describeContents() : 0;
9847 }
9848
9849 public void writeToParcel(Parcel out, int flags) {
9850 out.writeString(mAction);
9851 Uri.writeToParcel(out, mData);
9852 out.writeString(mType);
9853 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009854 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009855 ComponentName.writeToParcel(mComponent, out);
9856
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009857 if (mSourceBounds != null) {
9858 out.writeInt(1);
9859 mSourceBounds.writeToParcel(out, flags);
9860 } else {
9861 out.writeInt(0);
9862 }
9863
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009864 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009865 final int N = mCategories.size();
9866 out.writeInt(N);
9867 for (int i=0; i<N; i++) {
9868 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009869 }
9870 } else {
9871 out.writeInt(0);
9872 }
9873
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009874 if (mSelector != null) {
9875 out.writeInt(1);
9876 mSelector.writeToParcel(out, flags);
9877 } else {
9878 out.writeInt(0);
9879 }
9880
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009881 if (mClipData != null) {
9882 out.writeInt(1);
9883 mClipData.writeToParcel(out, flags);
9884 } else {
9885 out.writeInt(0);
9886 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009887 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009888 out.writeBundle(mExtras);
9889 }
9890
9891 public static final Parcelable.Creator<Intent> CREATOR
9892 = new Parcelable.Creator<Intent>() {
9893 public Intent createFromParcel(Parcel in) {
9894 return new Intent(in);
9895 }
9896 public Intent[] newArray(int size) {
9897 return new Intent[size];
9898 }
9899 };
9900
Dianne Hackborneb034652009-09-07 00:49:58 -07009901 /** @hide */
9902 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009903 readFromParcel(in);
9904 }
9905
9906 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009907 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009908 mData = Uri.CREATOR.createFromParcel(in);
9909 mType = in.readString();
9910 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009911 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009912 mComponent = ComponentName.readFromParcel(in);
9913
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009914 if (in.readInt() != 0) {
9915 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9916 }
9917
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009918 int N = in.readInt();
9919 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009920 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009921 int i;
9922 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009923 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009924 }
9925 } else {
9926 mCategories = null;
9927 }
9928
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009929 if (in.readInt() != 0) {
9930 mSelector = new Intent(in);
9931 }
9932
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009933 if (in.readInt() != 0) {
9934 mClipData = new ClipData(in);
9935 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009936 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009937 mExtras = in.readBundle();
9938 }
9939
9940 /**
9941 * Parses the "intent" element (and its children) from XML and instantiates
9942 * an Intent object. The given XML parser should be located at the tag
9943 * where parsing should start (often named "intent"), from which the
9944 * basic action, data, type, and package and class name will be
9945 * retrieved. The function will then parse in to any child elements,
9946 * looking for <category android:name="xxx"> tags to add categories and
9947 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9948 * to the intent.
9949 *
9950 * @param resources The Resources to use when inflating resources.
9951 * @param parser The XML parser pointing at an "intent" tag.
9952 * @param attrs The AttributeSet interface for retrieving extended
9953 * attribute data at the current <var>parser</var> location.
9954 * @return An Intent object matching the XML data.
9955 * @throws XmlPullParserException If there was an XML parsing error.
9956 * @throws IOException If there was an I/O error.
9957 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009958 public static @NonNull Intent parseIntent(@NonNull Resources resources,
9959 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009960 throws XmlPullParserException, IOException {
9961 Intent intent = new Intent();
9962
9963 TypedArray sa = resources.obtainAttributes(attrs,
9964 com.android.internal.R.styleable.Intent);
9965
9966 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9967
9968 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9969 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9970 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9971
9972 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9973 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9974 if (packageName != null && className != null) {
9975 intent.setComponent(new ComponentName(packageName, className));
9976 }
9977
9978 sa.recycle();
9979
9980 int outerDepth = parser.getDepth();
9981 int type;
9982 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9983 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9984 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9985 continue;
9986 }
9987
9988 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009989 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009990 sa = resources.obtainAttributes(attrs,
9991 com.android.internal.R.styleable.IntentCategory);
9992 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9993 sa.recycle();
9994
9995 if (cat != null) {
9996 intent.addCategory(cat);
9997 }
9998 XmlUtils.skipCurrentTag(parser);
9999
Craig Mautner21d24a22014-04-23 11:45:37 -070010000 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -080010001 if (intent.mExtras == null) {
10002 intent.mExtras = new Bundle();
10003 }
Craig Mautner21d24a22014-04-23 11:45:37 -070010004 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -080010005 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010006
10007 } else {
10008 XmlUtils.skipCurrentTag(parser);
10009 }
10010 }
10011
10012 return intent;
10013 }
Nick Pellyccae4122012-01-09 14:12:58 -080010014
Craig Mautner21d24a22014-04-23 11:45:37 -070010015 /** @hide */
10016 public void saveToXml(XmlSerializer out) throws IOException {
10017 if (mAction != null) {
10018 out.attribute(null, ATTR_ACTION, mAction);
10019 }
10020 if (mData != null) {
10021 out.attribute(null, ATTR_DATA, mData.toString());
10022 }
10023 if (mType != null) {
10024 out.attribute(null, ATTR_TYPE, mType);
10025 }
10026 if (mComponent != null) {
10027 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
10028 }
10029 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
10030
10031 if (mCategories != null) {
10032 out.startTag(null, TAG_CATEGORIES);
10033 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
10034 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
10035 }
Craig Mautner43e52ed2014-06-16 17:18:52 -070010036 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -070010037 }
10038 }
10039
10040 /** @hide */
10041 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
10042 XmlPullParserException {
10043 Intent intent = new Intent();
10044 final int outerDepth = in.getDepth();
10045
10046 int attrCount = in.getAttributeCount();
10047 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
10048 final String attrName = in.getAttributeName(attrNdx);
10049 final String attrValue = in.getAttributeValue(attrNdx);
10050 if (ATTR_ACTION.equals(attrName)) {
10051 intent.setAction(attrValue);
10052 } else if (ATTR_DATA.equals(attrName)) {
10053 intent.setData(Uri.parse(attrValue));
10054 } else if (ATTR_TYPE.equals(attrName)) {
10055 intent.setType(attrValue);
10056 } else if (ATTR_COMPONENT.equals(attrName)) {
10057 intent.setComponent(ComponentName.unflattenFromString(attrValue));
10058 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +010010059 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -070010060 } else {
10061 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
10062 }
10063 }
10064
10065 int event;
10066 String name;
10067 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
10068 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
10069 if (event == XmlPullParser.START_TAG) {
10070 name = in.getName();
10071 if (TAG_CATEGORIES.equals(name)) {
10072 attrCount = in.getAttributeCount();
10073 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
10074 intent.addCategory(in.getAttributeValue(attrNdx));
10075 }
10076 } else {
10077 Log.w("Intent", "restoreFromXml: unknown name=" + name);
10078 XmlUtils.skipCurrentTag(in);
10079 }
10080 }
10081 }
10082
10083 return intent;
10084 }
10085
Nick Pellyccae4122012-01-09 14:12:58 -080010086 /**
10087 * Normalize a MIME data type.
10088 *
10089 * <p>A normalized MIME type has white-space trimmed,
10090 * content-type parameters removed, and is lower-case.
10091 * This aligns the type with Android best practices for
10092 * intent filtering.
10093 *
10094 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
10095 * "text/x-vCard" becomes "text/x-vcard".
10096 *
10097 * <p>All MIME types received from outside Android (such as user input,
10098 * or external sources like Bluetooth, NFC, or the Internet) should
10099 * be normalized before they are used to create an Intent.
10100 *
10101 * @param type MIME data type to normalize
10102 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -050010103 * @see #setType
10104 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -080010105 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060010106 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -080010107 if (type == null) {
10108 return null;
10109 }
10110
Elliott Hughescb64d432013-08-02 10:00:44 -070010111 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -080010112
10113 final int semicolonIndex = type.indexOf(';');
10114 if (semicolonIndex != -1) {
10115 type = type.substring(0, semicolonIndex);
10116 }
10117 return type;
10118 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010119
10120 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010121 * Prepare this {@link Intent} to leave an app process.
10122 *
10123 * @hide
10124 */
Jeff Sharkey344744b2016-01-28 19:03:30 -070010125 public void prepareToLeaveProcess(Context context) {
10126 final boolean leavingPackage = (mComponent == null)
10127 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
10128 prepareToLeaveProcess(leavingPackage);
10129 }
10130
10131 /**
10132 * Prepare this {@link Intent} to leave an app process.
10133 *
10134 * @hide
10135 */
10136 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010137 setAllowFds(false);
10138
10139 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010140 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010141 }
10142 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010143 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010144 }
10145
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -070010146 if (mExtras != null && !mExtras.isParcelled()) {
10147 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
10148 if (intent instanceof Intent) {
10149 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
10150 }
10151 }
10152
Jeff Sharkeya8b42782016-01-30 17:58:09 -070010153 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
10154 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010155 switch (mAction) {
10156 case ACTION_MEDIA_REMOVED:
10157 case ACTION_MEDIA_UNMOUNTED:
10158 case ACTION_MEDIA_CHECKING:
10159 case ACTION_MEDIA_NOFS:
10160 case ACTION_MEDIA_MOUNTED:
10161 case ACTION_MEDIA_SHARED:
10162 case ACTION_MEDIA_UNSHARED:
10163 case ACTION_MEDIA_BAD_REMOVAL:
10164 case ACTION_MEDIA_UNMOUNTABLE:
10165 case ACTION_MEDIA_EJECT:
10166 case ACTION_MEDIA_SCANNER_STARTED:
10167 case ACTION_MEDIA_SCANNER_FINISHED:
10168 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -070010169 case ACTION_PACKAGE_NEEDS_VERIFICATION:
10170 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -070010171 // Ignore legacy actions
10172 break;
10173 default:
10174 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010175 }
10176 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010177
10178 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
10179 && leavingPackage) {
10180 switch (mAction) {
10181 case ACTION_PROVIDER_CHANGED:
Makoto Onuki7d1911f2017-06-09 12:30:09 -070010182 case QuickContact.ACTION_QUICK_CONTACT:
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010183 // Ignore actions that don't need to grant
10184 break;
10185 default:
10186 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
10187 }
10188 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010189 }
10190
10191 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010192 * @hide
10193 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010194 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -070010195 // We just entered destination process, so we should be able to read all
10196 // parcelables inside.
10197 setDefusable(true);
10198
10199 if (mSelector != null) {
10200 mSelector.prepareToEnterProcess();
10201 }
10202 if (mClipData != null) {
10203 mClipData.prepareToEnterProcess();
10204 }
10205
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010206 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000010207 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
10208 fixUris(mContentUserHint);
10209 mContentUserHint = UserHandle.USER_CURRENT;
10210 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010211 }
10212 }
10213
Patrick Baumann577d4022018-01-31 16:55:10 +000010214 /** @hide */
10215 public boolean hasWebURI() {
10216 if (getData() == null) {
10217 return false;
10218 }
10219 final String scheme = getScheme();
10220 if (TextUtils.isEmpty(scheme)) {
10221 return false;
10222 }
10223 return scheme.equals(IntentFilter.SCHEME_HTTP) || scheme.equals(IntentFilter.SCHEME_HTTPS);
10224 }
10225
10226 /** @hide */
Patrick Baumann0da85372018-02-02 16:07:35 -080010227 public boolean isWebIntent() {
Patrick Baumann577d4022018-01-31 16:55:10 +000010228 return ACTION_VIEW.equals(mAction)
Patrick Baumann577d4022018-01-31 16:55:10 +000010229 && hasWebURI();
10230 }
10231
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010232 /**
10233 * @hide
10234 */
10235 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010236 Uri data = getData();
10237 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010238 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010239 }
10240 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010241 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010242 }
10243 String action = getAction();
10244 if (ACTION_SEND.equals(action)) {
10245 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10246 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010247 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010248 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010249 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010250 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10251 if (streams != null) {
10252 ArrayList<Uri> newStreams = new ArrayList<Uri>();
10253 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010254 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010255 }
10256 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
10257 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010258 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10259 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10260 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10261 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10262 if (output != null) {
10263 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
10264 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010265 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010266 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010267
10268 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010269 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010270 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
10271 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010272 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010273 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010274 * @hide
10275 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010276 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010277 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010278 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010279
10280 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010281 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010282
10283 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010284 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010285 // Inspect contained intents to see if we need to migrate extras. We
10286 // don't promote ClipData to the parent, since ChooserActivity will
10287 // already start the picked item as the caller, and we can't combine
10288 // the flags in a safe way.
10289
10290 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -070010291 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010292 final Intent intent = getParcelableExtra(EXTRA_INTENT);
10293 if (intent != null) {
10294 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -070010295 }
10296 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010297 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010298 try {
10299 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
10300 if (intents != null) {
10301 for (int i = 0; i < intents.length; i++) {
10302 final Intent intent = (Intent) intents[i];
10303 if (intent != null) {
10304 migrated |= intent.migrateExtraStreamToClipData();
10305 }
10306 }
10307 }
10308 } catch (ClassCastException e) {
10309 }
10310 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010311
10312 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010313 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010314 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10315 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
10316 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
10317 if (stream != null || text != null || htmlText != null) {
10318 final ClipData clipData = new ClipData(
10319 null, new String[] { getType() },
10320 new ClipData.Item(text, htmlText, null, stream));
10321 setClipData(clipData);
10322 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010323 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010324 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010325 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010326 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010327
10328 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010329 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010330 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10331 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
10332 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
10333 int num = -1;
10334 if (streams != null) {
10335 num = streams.size();
10336 }
10337 if (texts != null) {
10338 if (num >= 0 && num != texts.size()) {
10339 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010340 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010341 }
10342 num = texts.size();
10343 }
10344 if (htmlTexts != null) {
10345 if (num >= 0 && num != htmlTexts.size()) {
10346 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010347 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010348 }
10349 num = htmlTexts.size();
10350 }
10351 if (num > 0) {
10352 final ClipData clipData = new ClipData(
10353 null, new String[] { getType() },
10354 makeClipItem(streams, texts, htmlTexts, 0));
10355
10356 for (int i = 1; i < num; i++) {
10357 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
10358 }
10359
10360 setClipData(clipData);
10361 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010362 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010363 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010364 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010365 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010366 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10367 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10368 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10369 final Uri output;
10370 try {
10371 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10372 } catch (ClassCastException e) {
10373 return false;
10374 }
10375 if (output != null) {
10376 setClipData(ClipData.newRawUri("", output));
10377 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
10378 return true;
10379 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010380 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010381
10382 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010383 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010384
Michael Wright19859762017-09-18 20:57:58 +010010385 /**
10386 * Convert the dock state to a human readable format.
10387 * @hide
10388 */
10389 public static String dockStateToString(int dock) {
10390 switch (dock) {
10391 case EXTRA_DOCK_STATE_HE_DESK:
10392 return "EXTRA_DOCK_STATE_HE_DESK";
10393 case EXTRA_DOCK_STATE_LE_DESK:
10394 return "EXTRA_DOCK_STATE_LE_DESK";
10395 case EXTRA_DOCK_STATE_CAR:
10396 return "EXTRA_DOCK_STATE_CAR";
10397 case EXTRA_DOCK_STATE_DESK:
10398 return "EXTRA_DOCK_STATE_DESK";
10399 case EXTRA_DOCK_STATE_UNDOCKED:
10400 return "EXTRA_DOCK_STATE_UNDOCKED";
10401 default:
10402 return Integer.toString(dock);
10403 }
10404 }
10405
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010406 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
10407 ArrayList<String> htmlTexts, int which) {
10408 Uri uri = streams != null ? streams.get(which) : null;
10409 CharSequence text = texts != null ? texts.get(which) : null;
10410 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
10411 return new ClipData.Item(text, htmlText, null, uri);
10412 }
Craig Mautnerd00f4742014-03-12 14:17:26 -070010413
10414 /** @hide */
10415 public boolean isDocument() {
10416 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
10417 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010418}