blob: 7682835f15eec643ffc2b7f14ad4965281bc88ac [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Makoto Onuki7d1911f2017-06-09 12:30:09 -070019import static android.content.ContentProvider.maybeAddUserId;
20
Tor Norbye7b9c9122013-05-30 16:48:33 -070021import android.annotation.AnyRes;
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -070022import android.annotation.BroadcastBehavior;
Tor Norbyed9273d62013-05-30 15:59:53 -070023import android.annotation.IntDef;
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060024import android.annotation.NonNull;
25import android.annotation.Nullable;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070026import android.annotation.SdkConstant;
27import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050028import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070029import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050030import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060031import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.content.pm.PackageManager;
33import android.content.pm.ResolveInfo;
34import android.content.res.Resources;
35import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080036import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070037import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060038import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039import android.os.Bundle;
40import android.os.IBinder;
41import android.os.Parcel;
42import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000043import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050044import android.os.ResultReceiver;
45import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070046import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010047import android.os.UserHandle;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070048import android.provider.ContactsContract.QuickContact;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070049import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070050import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050051import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070052import android.provider.OpenableColumns;
Patrick Baumann577d4022018-01-31 16:55:10 +000053import android.text.TextUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050054import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070055import android.util.AttributeSet;
56import android.util.Log;
Yi Jin129fc6c2017-09-28 15:48:38 -070057import android.util.proto.ProtoOutputStream;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070058
Dianne Hackborn2269d1572010-02-24 19:54:22 -080059import com.android.internal.util.XmlUtils;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070060
Jason Monk2f68e8a2016-02-23 17:57:28 -050061import org.xmlpull.v1.XmlPullParser;
62import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070063import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070064
65import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080066import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070067import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070068import java.lang.annotation.Retention;
69import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070070import java.net.URISyntaxException;
71import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080072import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070073import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080074import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070075import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070076import java.util.Set;
77
78/**
79 * An intent is an abstract description of an operation to be performed. It
80 * can be used with {@link Context#startActivity(Intent) startActivity} to
81 * launch an {@link android.app.Activity},
82 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
83 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
84 * and {@link android.content.Context#startService} or
85 * {@link android.content.Context#bindService} to communicate with a
86 * background {@link android.app.Service}.
87 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070088 * <p>An Intent provides a facility for performing late runtime binding between the code in
89 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070090 * can be thought of as the glue between activities. It is basically a passive data structure
91 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070092 *
93 * <div class="special reference">
94 * <h3>Developer Guides</h3>
95 * <p>For information about how to create and resolve intents, read the
96 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
97 * developer guide.</p>
98 * </div>
99 *
100 * <a name="IntentStructure"></a>
101 * <h3>Intent Structure</h3>
102 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700103 *
104 * <ul>
105 * <li> <p><b>action</b> -- The general action to be performed, such as
106 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
107 * etc.</p>
108 * </li>
109 * <li> <p><b>data</b> -- The data to operate on, such as a person record
110 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
111 * </li>
112 * </ul>
113 *
114 *
115 * <p>Some examples of action/data pairs are:</p>
116 *
117 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700118 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700119 * information about the person whose identifier is "1".</p>
120 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700121 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700122 * the phone dialer with the person filled in.</p>
123 * </li>
124 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
125 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700126 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700127 * a particular URI.</p>
128 * </li>
129 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
130 * the phone dialer with the given number filled in.</p>
131 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700132 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700133 * information about the person whose identifier is "1".</p>
134 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700135 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700136 * a list of people, which the user can browse through. This example is a
137 * typical top-level entry into the Contacts application, showing you the
138 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700139 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700140 * being used to start an activity to display that person.</p>
141 * </li>
142 * </ul>
143 *
144 * <p>In addition to these primary attributes, there are a number of secondary
145 * attributes that you can also include with an intent:</p>
146 *
147 * <ul>
148 * <li> <p><b>category</b> -- Gives additional information about the action
149 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
150 * appear in the Launcher as a top-level application, while
151 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
152 * of alternative actions the user can perform on a piece of data.</p>
153 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
154 * intent data. Normally the type is inferred from the data itself.
155 * By setting this attribute, you disable that evaluation and force
156 * an explicit type.</p>
157 * <li> <p><b>component</b> -- Specifies an explicit name of a component
158 * class to use for the intent. Normally this is determined by looking
159 * at the other information in the intent (the action, data/type, and
160 * categories) and matching that with a component that can handle it.
161 * If this attribute is set then none of the evaluation is performed,
162 * and this component is used exactly as is. By specifying this attribute,
163 * all of the other Intent attributes become optional.</p>
164 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
165 * This can be used to provide extended information to the component.
166 * For example, if we have a action to send an e-mail message, we could
167 * also include extra pieces of data here to supply a subject, body,
168 * etc.</p>
169 * </ul>
170 *
171 * <p>Here are some examples of other operations you can specify as intents
172 * using these additional parameters:</p>
173 *
174 * <ul>
175 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
176 * Launch the home screen.</p>
177 * </li>
178 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
179 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
180 * vnd.android.cursor.item/phone}</i></b>
181 * -- Display the list of people's phone numbers, allowing the user to
182 * browse through them and pick one and return it to the parent activity.</p>
183 * </li>
184 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
185 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
186 * -- Display all pickers for data that can be opened with
187 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
188 * allowing the user to pick one of them and then some data inside of it
189 * and returning the resulting URI to the caller. This can be used,
190 * for example, in an e-mail application to allow the user to pick some
191 * data to include as an attachment.</p>
192 * </li>
193 * </ul>
194 *
195 * <p>There are a variety of standard Intent action and category constants
196 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700197 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700198 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700199 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700200 *
201 * <p>Put together, the set of actions, data types, categories, and extra data
202 * defines a language for the system allowing for the expression of phrases
203 * such as "call john smith's cell". As applications are added to the system,
204 * they can extend this language by adding new actions, types, and categories, or
205 * they can modify the behavior of existing phrases by supplying their own
206 * activities that handle them.</p>
207 *
208 * <a name="IntentResolution"></a>
209 * <h3>Intent Resolution</h3>
210 *
211 * <p>There are two primary forms of intents you will use.
212 *
213 * <ul>
214 * <li> <p><b>Explicit Intents</b> have specified a component (via
215 * {@link #setComponent} or {@link #setClass}), which provides the exact
216 * class to be run. Often these will not include any other information,
217 * simply being a way for an application to launch various internal
218 * activities it has as the user interacts with the application.
219 *
220 * <li> <p><b>Implicit Intents</b> have not specified a component;
221 * instead, they must include enough information for the system to
222 * determine which of the available components is best to run for that
223 * intent.
224 * </ul>
225 *
226 * <p>When using implicit intents, given such an arbitrary intent we need to
227 * know what to do with it. This is handled by the process of <em>Intent
228 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
229 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
230 * more activities/receivers) that can handle it.</p>
231 *
232 * <p>The intent resolution mechanism basically revolves around matching an
233 * Intent against all of the &lt;intent-filter&gt; descriptions in the
234 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
235 * objects explicitly registered with {@link Context#registerReceiver}.) More
236 * details on this can be found in the documentation on the {@link
237 * IntentFilter} class.</p>
238 *
239 * <p>There are three pieces of information in the Intent that are used for
240 * resolution: the action, type, and category. Using this information, a query
241 * is done on the {@link PackageManager} for a component that can handle the
242 * intent. The appropriate component is determined based on the intent
243 * information supplied in the <code>AndroidManifest.xml</code> file as
244 * follows:</p>
245 *
246 * <ul>
247 * <li> <p>The <b>action</b>, if given, must be listed by the component as
248 * one it handles.</p>
249 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
250 * already supplied in the Intent. Like the action, if a type is
251 * included in the intent (either explicitly or implicitly in its
252 * data), then this must be listed by the component as one it handles.</p>
253 * <li> For data that is not a <code>content:</code> URI and where no explicit
254 * type is included in the Intent, instead the <b>scheme</b> of the
255 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
256 * considered. Again like the action, if we are matching a scheme it
257 * must be listed by the component as one it can handle.
258 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
259 * by the activity as categories it handles. That is, if you include
260 * the categories {@link #CATEGORY_LAUNCHER} and
261 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
262 * with an intent that lists <em>both</em> of those categories.
263 * Activities will very often need to support the
264 * {@link #CATEGORY_DEFAULT} so that they can be found by
265 * {@link Context#startActivity Context.startActivity()}.</p>
266 * </ul>
267 *
268 * <p>For example, consider the Note Pad sample application that
269 * allows user to browse through a list of notes data and view details about
270 * individual items. Text in italics indicate places were you would replace a
271 * name with one specific to your own package.</p>
272 *
273 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
274 * package="<i>com.android.notepad</i>"&gt;
275 * &lt;application android:icon="@drawable/app_notes"
276 * android:label="@string/app_name"&gt;
277 *
278 * &lt;provider class=".NotePadProvider"
279 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
280 *
281 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
282 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700283 * &lt;action android:name="android.intent.action.MAIN" /&gt;
284 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700285 * &lt;/intent-filter&gt;
286 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700287 * &lt;action android:name="android.intent.action.VIEW" /&gt;
288 * &lt;action android:name="android.intent.action.EDIT" /&gt;
289 * &lt;action android:name="android.intent.action.PICK" /&gt;
290 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
291 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700292 * &lt;/intent-filter&gt;
293 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700294 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
295 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
296 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700297 * &lt;/intent-filter&gt;
298 * &lt;/activity&gt;
299 *
300 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
301 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700302 * &lt;action android:name="android.intent.action.VIEW" /&gt;
303 * &lt;action android:name="android.intent.action.EDIT" /&gt;
304 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
305 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700306 * &lt;/intent-filter&gt;
307 *
308 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700309 * &lt;action android:name="android.intent.action.INSERT" /&gt;
310 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
311 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700312 * &lt;/intent-filter&gt;
313 *
314 * &lt;/activity&gt;
315 *
316 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
317 * android:theme="@android:style/Theme.Dialog"&gt;
318 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700319 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
320 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
321 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
322 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
323 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700324 * &lt;/intent-filter&gt;
325 * &lt;/activity&gt;
326 *
327 * &lt;/application&gt;
328 * &lt;/manifest&gt;</pre>
329 *
330 * <p>The first activity,
331 * <code>com.android.notepad.NotesList</code>, serves as our main
332 * entry into the app. It can do three things as described by its three intent
333 * templates:
334 * <ol>
335 * <li><pre>
336 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700337 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
338 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700339 * &lt;/intent-filter&gt;</pre>
340 * <p>This provides a top-level entry into the NotePad application: the standard
341 * MAIN action is a main entry point (not requiring any other information in
342 * the Intent), and the LAUNCHER category says that this entry point should be
343 * listed in the application launcher.</p>
344 * <li><pre>
345 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700346 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
347 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
348 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
349 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700350 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700351 * &lt;/intent-filter&gt;</pre>
352 * <p>This declares the things that the activity can do on a directory of
353 * notes. The type being supported is given with the &lt;type&gt; tag, where
354 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
355 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
356 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
357 * The activity allows the user to view or edit the directory of data (via
358 * the VIEW and EDIT actions), or to pick a particular note and return it
359 * to the caller (via the PICK action). Note also the DEFAULT category
360 * supplied here: this is <em>required</em> for the
361 * {@link Context#startActivity Context.startActivity} method to resolve your
362 * activity when its component name is not explicitly specified.</p>
363 * <li><pre>
364 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700365 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
366 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
367 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700368 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700369 * <p>This filter describes the ability to return to the caller a note selected by
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700370 * the user without needing to know where it came from. The data type
371 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
372 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
373 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
374 * The GET_CONTENT action is similar to the PICK action, where the activity
375 * will return to its caller a piece of data selected by the user. Here,
376 * however, the caller specifies the type of data they desire instead of
377 * the type of data the user will be picking from.</p>
378 * </ol>
379 *
380 * <p>Given these capabilities, the following intents will resolve to the
381 * NotesList activity:</p>
382 *
383 * <ul>
384 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
385 * activities that can be used as top-level entry points into an
386 * application.</p>
387 * <li> <p><b>{ action=android.app.action.MAIN,
388 * category=android.app.category.LAUNCHER }</b> is the actual intent
389 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700390 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700391 * data=content://com.google.provider.NotePad/notes }</b>
392 * displays a list of all the notes under
393 * "content://com.google.provider.NotePad/notes", which
394 * the user can browse through and see the details on.</p>
395 * <li> <p><b>{ action=android.app.action.PICK
396 * data=content://com.google.provider.NotePad/notes }</b>
397 * provides a list of the notes under
398 * "content://com.google.provider.NotePad/notes", from which
399 * the user can pick a note whose data URL is returned back to the caller.</p>
400 * <li> <p><b>{ action=android.app.action.GET_CONTENT
401 * type=vnd.android.cursor.item/vnd.google.note }</b>
402 * is similar to the pick action, but allows the caller to specify the
403 * kind of data they want back so that the system can find the appropriate
404 * activity to pick something of that data type.</p>
405 * </ul>
406 *
407 * <p>The second activity,
408 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
409 * note entry and allows them to edit it. It can do two things as described
410 * by its two intent templates:
411 * <ol>
412 * <li><pre>
413 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700414 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
415 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
416 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
417 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700418 * &lt;/intent-filter&gt;</pre>
419 * <p>The first, primary, purpose of this activity is to let the user interact
420 * with a single note, as decribed by the MIME type
421 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
422 * either VIEW a note or allow the user to EDIT it. Again we support the
423 * DEFAULT category to allow the activity to be launched without explicitly
424 * specifying its component.</p>
425 * <li><pre>
426 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700427 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
428 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
429 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700430 * &lt;/intent-filter&gt;</pre>
431 * <p>The secondary use of this activity is to insert a new note entry into
432 * an existing directory of notes. This is used when the user creates a new
433 * note: the INSERT action is executed on the directory of notes, causing
434 * this activity to run and have the user create the new note data which
435 * it then adds to the content provider.</p>
436 * </ol>
437 *
438 * <p>Given these capabilities, the following intents will resolve to the
439 * NoteEditor activity:</p>
440 *
441 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700442 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700443 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
444 * shows the user the content of note <var>{ID}</var>.</p>
445 * <li> <p><b>{ action=android.app.action.EDIT
446 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
447 * allows the user to edit the content of note <var>{ID}</var>.</p>
448 * <li> <p><b>{ action=android.app.action.INSERT
449 * data=content://com.google.provider.NotePad/notes }</b>
450 * creates a new, empty note in the notes list at
451 * "content://com.google.provider.NotePad/notes"
452 * and allows the user to edit it. If they keep their changes, the URI
453 * of the newly created note is returned to the caller.</p>
454 * </ul>
455 *
456 * <p>The last activity,
457 * <code>com.android.notepad.TitleEditor</code>, allows the user to
458 * edit the title of a note. This could be implemented as a class that the
459 * application directly invokes (by explicitly setting its component in
460 * the Intent), but here we show a way you can publish alternative
461 * operations on existing data:</p>
462 *
463 * <pre>
464 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700465 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
466 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
467 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
468 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
469 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700470 * &lt;/intent-filter&gt;</pre>
471 *
472 * <p>In the single intent template here, we
473 * have created our own private action called
474 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
475 * edit the title of a note. It must be invoked on a specific note
476 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
477 * view and edit actions, but here displays and edits the title contained
478 * in the note data.
479 *
480 * <p>In addition to supporting the default category as usual, our title editor
481 * also supports two other standard categories: ALTERNATIVE and
482 * SELECTED_ALTERNATIVE. Implementing
483 * these categories allows others to find the special action it provides
484 * without directly knowing about it, through the
485 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
486 * more often to build dynamic menu items with
487 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
488 * template here was also supply an explicit name for the template
489 * (via <code>android:label="@string/resolve_title"</code>) to better control
490 * what the user sees when presented with this activity as an alternative
491 * action to the data they are viewing.
492 *
493 * <p>Given these capabilities, the following intent will resolve to the
494 * TitleEditor activity:</p>
495 *
496 * <ul>
497 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
498 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
499 * displays and allows the user to edit the title associated
500 * with note <var>{ID}</var>.</p>
501 * </ul>
502 *
503 * <h3>Standard Activity Actions</h3>
504 *
505 * <p>These are the current standard actions that Intent defines for launching
506 * activities (usually through {@link Context#startActivity}. The most
507 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
508 * {@link #ACTION_EDIT}.
509 *
510 * <ul>
511 * <li> {@link #ACTION_MAIN}
512 * <li> {@link #ACTION_VIEW}
513 * <li> {@link #ACTION_ATTACH_DATA}
514 * <li> {@link #ACTION_EDIT}
515 * <li> {@link #ACTION_PICK}
516 * <li> {@link #ACTION_CHOOSER}
517 * <li> {@link #ACTION_GET_CONTENT}
518 * <li> {@link #ACTION_DIAL}
519 * <li> {@link #ACTION_CALL}
520 * <li> {@link #ACTION_SEND}
521 * <li> {@link #ACTION_SENDTO}
522 * <li> {@link #ACTION_ANSWER}
523 * <li> {@link #ACTION_INSERT}
524 * <li> {@link #ACTION_DELETE}
525 * <li> {@link #ACTION_RUN}
526 * <li> {@link #ACTION_SYNC}
527 * <li> {@link #ACTION_PICK_ACTIVITY}
528 * <li> {@link #ACTION_SEARCH}
529 * <li> {@link #ACTION_WEB_SEARCH}
530 * <li> {@link #ACTION_FACTORY_TEST}
531 * </ul>
532 *
533 * <h3>Standard Broadcast Actions</h3>
534 *
535 * <p>These are the current standard actions that Intent defines for receiving
536 * broadcasts (usually through {@link Context#registerReceiver} or a
537 * &lt;receiver&gt; tag in a manifest).
538 *
539 * <ul>
540 * <li> {@link #ACTION_TIME_TICK}
541 * <li> {@link #ACTION_TIME_CHANGED}
542 * <li> {@link #ACTION_TIMEZONE_CHANGED}
543 * <li> {@link #ACTION_BOOT_COMPLETED}
544 * <li> {@link #ACTION_PACKAGE_ADDED}
545 * <li> {@link #ACTION_PACKAGE_CHANGED}
546 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800547 * <li> {@link #ACTION_PACKAGE_RESTARTED}
548 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000549 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
550 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700551 * <li> {@link #ACTION_UID_REMOVED}
552 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700553 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700554 * <li> {@link #ACTION_POWER_DISCONNECTED}
555 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700556 * </ul>
557 *
558 * <h3>Standard Categories</h3>
559 *
560 * <p>These are the current standard categories that can be used to further
561 * clarify an Intent via {@link #addCategory}.
562 *
563 * <ul>
564 * <li> {@link #CATEGORY_DEFAULT}
565 * <li> {@link #CATEGORY_BROWSABLE}
566 * <li> {@link #CATEGORY_TAB}
567 * <li> {@link #CATEGORY_ALTERNATIVE}
568 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
569 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800570 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * <li> {@link #CATEGORY_HOME}
572 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700573 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400574 * <li> {@link #CATEGORY_CAR_DOCK}
575 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500576 * <li> {@link #CATEGORY_LE_DESK_DOCK}
577 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200578 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700579 * <li> {@link #CATEGORY_APP_MARKET}
Zak Cohendb6ca492017-01-26 14:09:00 -0800580 * <li> {@link #CATEGORY_VR_HOME}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700581 * </ul>
582 *
583 * <h3>Standard Extra Data</h3>
584 *
585 * <p>These are the current standard fields that can be used as extra data via
586 * {@link #putExtra}.
587 *
588 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800589 * <li> {@link #EXTRA_ALARM_COUNT}
590 * <li> {@link #EXTRA_BCC}
591 * <li> {@link #EXTRA_CC}
592 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
593 * <li> {@link #EXTRA_DATA_REMOVED}
594 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500595 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
596 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800597 * <li> {@link #EXTRA_DOCK_STATE_CAR}
598 * <li> {@link #EXTRA_DOCK_STATE_DESK}
599 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
600 * <li> {@link #EXTRA_DONT_KILL_APP}
601 * <li> {@link #EXTRA_EMAIL}
602 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700603 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800604 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700605 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800606 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700607 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800608 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
609 * <li> {@link #EXTRA_REPLACING}
610 * <li> {@link #EXTRA_SHORTCUT_ICON}
611 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
612 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700613 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800614 * <li> {@link #EXTRA_SHORTCUT_NAME}
615 * <li> {@link #EXTRA_SUBJECT}
616 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700617 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800618 * <li> {@link #EXTRA_TITLE}
619 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700620 * </ul>
621 *
622 * <h3>Flags</h3>
623 *
624 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800625 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
626 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700627 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800628public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700629 private static final String ATTR_ACTION = "action";
630 private static final String TAG_CATEGORIES = "categories";
631 private static final String ATTR_CATEGORY = "category";
632 private static final String TAG_EXTRA = "extra";
633 private static final String ATTR_TYPE = "type";
634 private static final String ATTR_COMPONENT = "component";
635 private static final String ATTR_DATA = "data";
636 private static final String ATTR_FLAGS = "flags";
637
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700638 // ---------------------------------------------------------------------
639 // ---------------------------------------------------------------------
640 // Standard intent activity actions (see action variable).
641
642 /**
643 * Activity Action: Start as a main entry point, does not expect to
644 * receive data.
645 * <p>Input: nothing
646 * <p>Output: nothing
647 */
648 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
649 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800650
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700651 /**
652 * Activity Action: Display the data to the user. This is the most common
653 * action performed on data -- it is the generic action you can use on
654 * a piece of data to get the most reasonable thing to occur. For example,
655 * when used on a contacts entry it will view the entry; when used on a
656 * mailto: URI it will bring up a compose window filled with the information
657 * supplied by the URI; when used with a tel: URI it will invoke the
658 * dialer.
659 * <p>Input: {@link #getData} is URI from which to retrieve data.
660 * <p>Output: nothing.
661 */
662 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
663 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800664
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700665 /**
Dianne Hackborna320f012017-04-07 13:57:48 -0700666 * Extra that can be included on activity intents coming from the storage UI
667 * when it launches sub-activities to manage various types of storage. For example,
668 * it may use {@link #ACTION_VIEW} with a "image/*" MIME type to have an app show
669 * the images on the device, and in that case also include this extra to tell the
670 * app it is coming from the storage UI so should help the user manage storage of
671 * this type.
672 */
673 public static final String EXTRA_FROM_STORAGE = "android.intent.extra.FROM_STORAGE";
674
675 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700676 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
677 * performed on a piece of data.
678 */
679 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800680
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700681 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900682 * Activity Action: Quick view the data. Launches a quick viewer for
683 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900684 * <p>Activities handling this intent action should handle the vast majority of
685 * MIME types rather than only specific ones.
Garfield Tance1d0e92017-03-23 10:52:48 -0700686 * <p>Quick viewers must render the quick view image locally, and must not send
687 * file content outside current device.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900688 * <p>Input: {@link #getData} is a mandatory content URI of the item to
689 * preview. {@link #getClipData} contains an optional list of content URIs
690 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
691 * optional index of the URI in the clip data to show first.
Garfield Tance1d0e92017-03-23 10:52:48 -0700692 * {@link #EXTRA_QUICK_VIEW_FEATURES} is an optional extra indicating the features
693 * that can be shown in the quick view UI.
Steve McKayc78bcb82015-07-31 14:35:22 -0700694 * <p>Output: nothing.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900695 * @see #EXTRA_INDEX
Garfield Tance1d0e92017-03-23 10:52:48 -0700696 * @see #EXTRA_QUICK_VIEW_FEATURES
Steve McKayc78bcb82015-07-31 14:35:22 -0700697 */
698 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
699 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
700
701 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700702 * Used to indicate that some piece of data should be attached to some other
703 * place. For example, image data could be attached to a contact. It is up
704 * to the recipient to decide where the data should be attached; the intent
705 * does not specify the ultimate destination.
706 * <p>Input: {@link #getData} is URI of data to be attached.
707 * <p>Output: nothing.
708 */
709 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
710 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800711
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700712 /**
713 * Activity Action: Provide explicit editable access to the given data.
714 * <p>Input: {@link #getData} is URI of data to be edited.
715 * <p>Output: nothing.
716 */
717 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
718 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800719
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700720 /**
721 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
722 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
723 * The extras can contain type specific data to pass through to the editing/creating
724 * activity.
725 * <p>Output: The URI of the item that was picked. This must be a content:
726 * URI so that any receiver can access it.
727 */
728 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
729 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800730
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700731 /**
732 * Activity Action: Pick an item from the data, returning what was selected.
733 * <p>Input: {@link #getData} is URI containing a directory of data
734 * (vnd.android.cursor.dir/*) from which to pick an item.
735 * <p>Output: The URI of the item that was picked.
736 */
737 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
738 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800739
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700740 /**
741 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800742 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800743 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
744 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700745 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
746 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800747 * (value: ShortcutIconResource).</p>
748 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800749 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700750 * @see #EXTRA_SHORTCUT_INTENT
751 * @see #EXTRA_SHORTCUT_NAME
752 * @see #EXTRA_SHORTCUT_ICON
753 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
754 * @see android.content.Intent.ShortcutIconResource
755 */
756 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
757 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
758
759 /**
760 * The name of the extra used to define the Intent of a shortcut.
761 *
762 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800763 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700764 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800765 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700766 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
767 /**
768 * The name of the extra used to define the name of a shortcut.
769 *
770 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800771 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700772 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800773 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700774 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
775 /**
776 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
777 *
778 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800779 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700780 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800781 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700782 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
783 /**
784 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
785 *
786 * @see #ACTION_CREATE_SHORTCUT
787 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800788 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700789 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800790 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700791 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
792 "android.intent.extra.shortcut.ICON_RESOURCE";
793
794 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500795 * An activity that provides a user interface for adjusting application preferences.
796 * Optional but recommended settings for all applications which have settings.
797 */
798 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
799 public static final String ACTION_APPLICATION_PREFERENCES
800 = "android.intent.action.APPLICATION_PREFERENCES";
801
802 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700803 * Activity Action: Launch an activity showing the app information.
804 * For applications which install other applications (such as app stores), it is recommended
805 * to handle this action for providing the app information to the user.
806 *
807 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
808 * to be displayed.
809 * <p>Output: Nothing.
810 */
811 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
812 public static final String ACTION_SHOW_APP_INFO
813 = "android.intent.action.SHOW_APP_INFO";
814
815 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800816 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700817 *
818 * @see Intent#ACTION_CREATE_SHORTCUT
819 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800820 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
821 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700822 */
823 public static class ShortcutIconResource implements Parcelable {
824 /**
825 * The package name of the application containing the icon.
826 */
827 public String packageName;
828
829 /**
830 * The resource name of the icon, including package, name and type.
831 */
832 public String resourceName;
833
834 /**
835 * Creates a new ShortcutIconResource for the specified context and resource
836 * identifier.
837 *
838 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700839 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700840 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700841 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700842 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700843 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700844 ShortcutIconResource icon = new ShortcutIconResource();
845 icon.packageName = context.getPackageName();
846 icon.resourceName = context.getResources().getResourceName(resourceId);
847 return icon;
848 }
849
850 /**
851 * Used to read a ShortcutIconResource from a Parcel.
852 */
853 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
854 new Parcelable.Creator<ShortcutIconResource>() {
855
856 public ShortcutIconResource createFromParcel(Parcel source) {
857 ShortcutIconResource icon = new ShortcutIconResource();
858 icon.packageName = source.readString();
859 icon.resourceName = source.readString();
860 return icon;
861 }
862
863 public ShortcutIconResource[] newArray(int size) {
864 return new ShortcutIconResource[size];
865 }
866 };
867
868 /**
869 * No special parcel contents.
870 */
871 public int describeContents() {
872 return 0;
873 }
874
875 public void writeToParcel(Parcel dest, int flags) {
876 dest.writeString(packageName);
877 dest.writeString(resourceName);
878 }
879
880 @Override
881 public String toString() {
882 return resourceName;
883 }
884 }
885
886 /**
887 * Activity Action: Display an activity chooser, allowing the user to pick
888 * what they want to before proceeding. This can be used as an alternative
889 * to the standard activity picker that is displayed by the system when
890 * you try to start an activity with multiple possible matches, with these
891 * differences in behavior:
892 * <ul>
893 * <li>You can specify the title that will appear in the activity chooser.
894 * <li>The user does not have the option to make one of the matching
895 * activities a preferred activity, and all possible activities will
896 * always be shown even if one of them is currently marked as the
897 * preferred activity.
898 * </ul>
899 * <p>
900 * This action should be used when the user will naturally expect to
901 * select an activity in order to proceed. An example if when not to use
902 * it is when the user clicks on a "mailto:" link. They would naturally
903 * expect to go directly to their mail app, so startActivity() should be
904 * called directly: it will
905 * either launch the current preferred app, or put up a dialog allowing the
906 * user to pick an app to use and optionally marking that as preferred.
907 * <p>
908 * In contrast, if the user is selecting a menu item to send a picture
909 * they are viewing to someone else, there are many different things they
910 * may want to do at this point: send it through e-mail, upload it to a
911 * web service, etc. In this case the CHOOSER action should be used, to
912 * always present to the user a list of the things they can do, with a
913 * nice title given by the caller such as "Send this photo with:".
914 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700915 * If you need to grant URI permissions through a chooser, you must specify
916 * the permissions to be granted on the ACTION_CHOOSER Intent
917 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
918 * {@link #setClipData} to specify the URIs to be granted as well as
919 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
920 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
921 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700922 * As a convenience, an Intent of this form can be created with the
923 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700924 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700925 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700926 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
927 * and can optionally have a {@link #EXTRA_TITLE} field containing the
928 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700929 * <p>
930 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700931 */
932 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
933 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
934
935 /**
936 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
937 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700938 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
939 * target intent, also optionally supplying a title. If the target
940 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
941 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
942 * set in the returned chooser intent, with its ClipData set appropriately:
943 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500944 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700945 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700946 * @param target The Intent that the user will be selecting an activity
947 * to perform.
948 * @param title Optional title that will be displayed in the chooser.
949 * @return Return a new Intent object that you can hand to
950 * {@link Context#startActivity(Intent) Context.startActivity()} and
951 * related methods.
952 */
953 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700954 return createChooser(target, title, null);
955 }
956
957 /**
958 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
959 *
960 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
961 * target intent, also optionally supplying a title. If the target
962 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
963 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
964 * set in the returned chooser intent, with its ClipData set appropriately:
965 * either a direct reflection of {@link #getClipData()} if that is non-null,
966 * or a new ClipData built from {@link #getData()}.</p>
967 *
968 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
969 * when the user makes a choice. This can be useful if the calling application wants
970 * to remember the last chosen target and surface it as a more prominent or one-touch
971 * affordance elsewhere in the UI for next time.</p>
972 *
973 * @param target The Intent that the user will be selecting an activity
974 * to perform.
975 * @param title Optional title that will be displayed in the chooser.
976 * @param sender Optional IntentSender to be called when a choice is made.
977 * @return Return a new Intent object that you can hand to
978 * {@link Context#startActivity(Intent) Context.startActivity()} and
979 * related methods.
980 */
981 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700982 Intent intent = new Intent(ACTION_CHOOSER);
983 intent.putExtra(EXTRA_INTENT, target);
984 if (title != null) {
985 intent.putExtra(EXTRA_TITLE, title);
986 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700987
Adam Powell0b3c1122014-10-09 12:50:14 -0700988 if (sender != null) {
989 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
990 }
991
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700992 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700993 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
994 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
995 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700996 if (permFlags != 0) {
997 ClipData targetClipData = target.getClipData();
998 if (targetClipData == null && target.getData() != null) {
999 ClipData.Item item = new ClipData.Item(target.getData());
1000 String[] mimeTypes;
1001 if (target.getType() != null) {
1002 mimeTypes = new String[] { target.getType() };
1003 } else {
1004 mimeTypes = new String[] { };
1005 }
1006 targetClipData = new ClipData(null, mimeTypes, item);
1007 }
1008 if (targetClipData != null) {
1009 intent.setClipData(targetClipData);
1010 intent.addFlags(permFlags);
1011 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001012 }
Dianne Hackborne302a162012-05-15 14:58:32 -07001013
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001014 return intent;
1015 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001016
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001017 /**
1018 * Activity Action: Allow the user to select a particular kind of data and
1019 * return it. This is different than {@link #ACTION_PICK} in that here we
1020 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001021 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001022 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001023 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001024 * etc.
1025 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001026 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001027 * of data, such as a person contact, you set the MIME type to the kind of
1028 * data you want and launch it with {@link Context#startActivity(Intent)}.
1029 * The system will then launch the best application to select that kind
1030 * of data for you.
1031 * <p>
1032 * You may also be interested in any of a set of types of content the user
1033 * can pick. For example, an e-mail application that wants to allow the
1034 * user to add an attachment to an e-mail message can use this action to
1035 * bring up a list of all of the types of content the user can attach.
1036 * <p>
1037 * In this case, you should wrap the GET_CONTENT intent with a chooser
1038 * (through {@link #createChooser}), which will give the proper interface
1039 * for the user to pick how to send your data and allow you to specify
1040 * a prompt indicating what they are doing. You will usually specify a
1041 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1042 * broad range of content types the user can select from.
1043 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001044 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001045 * only pick from data that can be represented as a stream. This is
1046 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1047 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001048 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001049 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001050 * is locally available on the device. For example, if this extra is set
1051 * to true then an image picker should not show any pictures that are available
1052 * from a remote server but not already on the local device (thus requiring
1053 * they be downloaded when opened).
1054 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001055 * If the caller can handle multiple returned items (the user performing
1056 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1057 * to indicate this.
1058 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001059 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1060 * that no URI is supplied in the intent, as there are no constraints on
1061 * where the returned data originally comes from. You may also include the
1062 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001063 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001064 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1065 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001066 * <p>
1067 * Output: The URI of the item that was picked. This must be a content:
1068 * URI so that any receiver can access it.
1069 */
1070 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1071 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1072 /**
1073 * Activity Action: Dial a number as specified by the data. This shows a
1074 * UI with the number being dialed, allowing the user to explicitly
1075 * initiate the call.
1076 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1077 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1078 * number.
1079 * <p>Output: nothing.
1080 */
1081 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1082 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1083 /**
1084 * Activity Action: Perform a call to someone specified by the data.
1085 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1086 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1087 * number.
1088 * <p>Output: nothing.
1089 *
1090 * <p>Note: there will be restrictions on which applications can initiate a
1091 * call; most applications should use the {@link #ACTION_DIAL}.
1092 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1093 * numbers. Applications can <strong>dial</strong> emergency numbers using
1094 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001095 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001096 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001097 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001098 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001099 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001100 */
1101 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1102 public static final String ACTION_CALL = "android.intent.action.CALL";
1103 /**
1104 * Activity Action: Perform a call to an emergency number specified by the
1105 * data.
1106 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1107 * tel: URI of an explicit phone number.
1108 * <p>Output: nothing.
1109 * @hide
1110 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001111 @SystemApi
1112 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001113 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1114 /**
1115 * Activity action: Perform a call to any number (emergency or not)
1116 * specified by the data.
1117 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1118 * tel: URI of an explicit phone number.
1119 * <p>Output: nothing.
1120 * @hide
1121 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001122 @SystemApi
1123 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001124 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
fionaxu77a744c2017-03-17 14:35:39 -07001125
Santos Cordon15a13782015-03-31 18:32:31 -07001126 /**
fionaxuadfe7002017-02-17 17:20:46 -08001127 * Activity Action: Main entry point for carrier setup apps.
1128 * <p>Carrier apps that provide an implementation for this action may be invoked to configure
1129 * carrier service and typically require
1130 * {@link android.telephony.TelephonyManager#hasCarrierPrivileges() carrier privileges} to
1131 * fulfill their duties.
1132 */
1133 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1134 public static final String ACTION_CARRIER_SETUP = "android.intent.action.CARRIER_SETUP";
1135 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001136 * Activity Action: Send a message to someone specified by the data.
1137 * <p>Input: {@link #getData} is URI describing the target.
1138 * <p>Output: nothing.
1139 */
1140 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1141 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1142 /**
1143 * Activity Action: Deliver some data to someone else. Who the data is
1144 * being delivered to is not specified; it is up to the receiver of this
1145 * action to ask the user where the data should be sent.
1146 * <p>
1147 * When launching a SEND intent, you should usually wrap it in a chooser
1148 * (through {@link #createChooser}), which will give the proper interface
1149 * for the user to pick how to send your data and allow you to specify
1150 * a prompt indicating what they are doing.
1151 * <p>
1152 * Input: {@link #getType} is the MIME type of the data being sent.
1153 * get*Extra can have either a {@link #EXTRA_TEXT}
1154 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1155 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1156 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1157 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001158 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1159 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1160 * your text with HTML formatting.
1161 * <p>
1162 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1163 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1164 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1165 * content: URIs and other advanced features of {@link ClipData}. If
1166 * using this approach, you still must supply the same data through the
1167 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1168 * for compatibility with old applications. If you don't set a ClipData,
1169 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001170 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001171 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1172 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1173 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1174 * be openable only as asset typed files using
1175 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1176 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001177 * Optional standard extras, which may be interpreted by some recipients as
1178 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1179 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1180 * <p>
1181 * Output: nothing.
1182 */
1183 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1184 public static final String ACTION_SEND = "android.intent.action.SEND";
1185 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001186 * Activity Action: Deliver multiple data to someone else.
1187 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001188 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001189 * <p>
1190 * Input: {@link #getType} is the MIME type of the data being sent.
1191 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001192 * #EXTRA_STREAM} field, containing the data to be sent. If using
1193 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1194 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001195 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001196 * Multiple types are supported, and receivers should handle mixed types
1197 * whenever possible. The right way for the receiver to check them is to
1198 * use the content resolver on each URI. The intent sender should try to
1199 * put the most concrete mime type in the intent type, but it can fall
1200 * back to {@literal <type>/*} or {@literal *}/* as needed.
1201 * <p>
1202 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1203 * be image/jpg, but if you are sending image/jpg and image/png, then the
1204 * intent's type should be image/*.
1205 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001206 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1207 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1208 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1209 * content: URIs and other advanced features of {@link ClipData}. If
1210 * using this approach, you still must supply the same data through the
1211 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1212 * for compatibility with old applications. If you don't set a ClipData,
1213 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1214 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001215 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1216 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1217 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1218 * be openable only as asset typed files using
1219 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1220 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001221 * Optional standard extras, which may be interpreted by some recipients as
1222 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1223 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1224 * <p>
1225 * Output: nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1229 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001230 * Activity Action: Handle an incoming phone call.
1231 * <p>Input: nothing.
1232 * <p>Output: nothing.
1233 */
1234 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1235 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1236 /**
1237 * Activity Action: Insert an empty item into the given container.
1238 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1239 * in which to place the data.
1240 * <p>Output: URI of the new data that was created.
1241 */
1242 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1243 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1244 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001245 * Activity Action: Create a new item in the given container, initializing it
1246 * from the current contents of the clipboard.
1247 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1248 * in which to place the data.
1249 * <p>Output: URI of the new data that was created.
1250 */
1251 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1252 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1253 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001254 * Activity Action: Delete the given data from its container.
1255 * <p>Input: {@link #getData} is URI of data to be deleted.
1256 * <p>Output: nothing.
1257 */
1258 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1259 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1260 /**
1261 * Activity Action: Run the data, whatever that means.
1262 * <p>Input: ? (Note: this is currently specific to the test harness.)
1263 * <p>Output: nothing.
1264 */
1265 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1266 public static final String ACTION_RUN = "android.intent.action.RUN";
1267 /**
1268 * Activity Action: Perform a data synchronization.
1269 * <p>Input: ?
1270 * <p>Output: ?
1271 */
1272 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1273 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1274 /**
1275 * Activity Action: Pick an activity given an intent, returning the class
1276 * selected.
1277 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1278 * used with {@link PackageManager#queryIntentActivities} to determine the
1279 * set of activities from which to pick.
1280 * <p>Output: Class name of the activity that was selected.
1281 */
1282 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1283 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1284 /**
1285 * Activity Action: Perform a search.
1286 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1287 * is the text to search for. If empty, simply
1288 * enter your search results Activity with the search UI activated.
1289 * <p>Output: nothing.
1290 */
1291 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1292 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1293 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001294 * Activity Action: Start the platform-defined tutorial
1295 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1296 * is the text to search for. If empty, simply
1297 * enter your search results Activity with the search UI activated.
1298 * <p>Output: nothing.
1299 */
1300 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1301 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1302 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001303 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001304 * <p>
1305 * Input: {@link android.app.SearchManager#QUERY
1306 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1307 * a url starts with http or https, the site will be opened. If it is plain
1308 * text, Google search will be applied.
1309 * <p>
1310 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001311 */
1312 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1313 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001314
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001315 /**
Jim Miller07994402012-05-02 14:22:27 -07001316 * Activity Action: Perform assist action.
1317 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001318 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1319 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001320 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1321 * information.
Jim Miller07994402012-05-02 14:22:27 -07001322 * Output: nothing.
1323 */
1324 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1325 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001326
1327 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001328 * Activity Action: Perform voice assist action.
1329 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001330 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1331 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001332 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001333 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001334 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001335 */
Amith Yamasani16452032017-03-03 10:15:57 -08001336 @SystemApi
Bjorn Bringertbc086862013-03-01 12:59:24 +00001337 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1338 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1339
1340 /**
Adam Skory7140a252013-09-11 12:04:58 +01001341 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1342 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001343 */
1344 public static final String EXTRA_ASSIST_PACKAGE
1345 = "android.intent.extra.ASSIST_PACKAGE";
1346
1347 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001348 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1349 * application package at the time the assist was invoked.
1350 */
1351 public static final String EXTRA_ASSIST_UID
1352 = "android.intent.extra.ASSIST_UID";
1353
1354 /**
Adam Skory7140a252013-09-11 12:04:58 +01001355 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1356 * information supplied by the current foreground app at the time of the assist request.
1357 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001358 */
1359 public static final String EXTRA_ASSIST_CONTEXT
1360 = "android.intent.extra.ASSIST_CONTEXT";
1361
Jim Miller07994402012-05-02 14:22:27 -07001362 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001363 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1364 * keyboard as the primary input device for assistance.
1365 */
1366 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1367 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1368
1369 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001370 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1371 * that was used to invoke the assist.
1372 */
1373 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1374 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1375
1376 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001377 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001378 * <p>Input: Nothing.
1379 * <p>Output: nothing.
1380 */
1381 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1382 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1383 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001384 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001385 * <p>Input: Nothing.
1386 * <p>Output: Nothing.
1387 */
1388 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1389 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1390
1391 /**
1392 * Activity Action: Show activity for reporting a bug.
1393 * <p>Input: Nothing.
1394 * <p>Output: Nothing.
1395 */
1396 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1397 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1398
1399 /**
1400 * Activity Action: Main entry point for factory tests. Only used when
1401 * the device is booting in factory test node. The implementing package
1402 * must be installed in the system image.
1403 * <p>Input: nothing
1404 * <p>Output: nothing
1405 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06001406 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001407 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1408
1409 /**
1410 * Activity Action: The user pressed the "call" button to go to the dialer
1411 * or other appropriate UI for placing a call.
1412 * <p>Input: Nothing.
1413 * <p>Output: Nothing.
1414 */
1415 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1416 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1417
1418 /**
1419 * Activity Action: Start Voice Command.
1420 * <p>Input: Nothing.
1421 * <p>Output: Nothing.
1422 */
1423 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1424 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001425
1426 /**
1427 * Activity Action: Start action associated with long pressing on the
1428 * search key.
1429 * <p>Input: Nothing.
1430 * <p>Output: Nothing.
1431 */
1432 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1433 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001434
Jacek Surazski86b6c532009-05-13 14:38:28 +02001435 /**
1436 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1437 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001438 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001439 * <p>Input: No data is specified. The bug report is passed in using
1440 * an {@link #EXTRA_BUG_REPORT} field.
1441 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001442 *
1443 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001444 */
1445 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1446 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001447
1448 /**
1449 * Activity Action: Show power usage information to the user.
1450 * <p>Input: Nothing.
1451 * <p>Output: Nothing.
1452 */
1453 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1454 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001455
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001456 /**
Russell Brenner4cd32e52017-02-24 11:11:47 -08001457 * Activity Action: Setup wizard action provided for OTA provisioning to determine if it needs
1458 * to run.
1459 * <p>Input: Nothing.
1460 * <p>Output: Nothing.
1461 * @deprecated As of {@link android.os.Build.VERSION_CODES#M}, setup wizard can be identified
1462 * using {@link #ACTION_MAIN} and {@link #CATEGORY_SETUP_WIZARD}
1463 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001464 * @removed
Russell Brenner4cd32e52017-02-24 11:11:47 -08001465 */
1466 @Deprecated
1467 @SystemApi
1468 public static final String ACTION_DEVICE_INITIALIZATION_WIZARD =
1469 "android.intent.action.DEVICE_INITIALIZATION_WIZARD";
1470
1471 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001472 * Activity Action: Setup wizard to launch after a platform update. This
1473 * activity should have a string meta-data field associated with it,
1474 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1475 * the platform for setup. The activity will be launched only if
1476 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1477 * same value.
1478 * <p>Input: Nothing.
1479 * <p>Output: Nothing.
1480 * @hide
1481 */
Russell Brenner4cd32e52017-02-24 11:11:47 -08001482 @SystemApi
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001483 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1484 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001485
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001486 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001487 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1488 * <p>Input: Nothing.
1489 * <p>Output: Nothing.
1490 * @hide
1491 */
1492 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1493 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001494 "com.android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001495
1496 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001497 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1498 * <p>Input: Nothing.
1499 * <p>Output: Nothing.
1500 * @hide
1501 */
1502 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1503 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001504 "com.android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001505
1506 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001507 * Activity Action: Show settings for managing network data usage of a
1508 * specific application. Applications should define an activity that offers
1509 * options to control data usage.
1510 */
1511 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1512 public static final String ACTION_MANAGE_NETWORK_USAGE =
1513 "android.intent.action.MANAGE_NETWORK_USAGE";
1514
1515 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001516 * Activity Action: Launch application installer.
1517 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001518 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001519 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1520 * you can also use "package:<package-name>" to install an application for the
1521 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001522 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1523 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1524 * <p>
1525 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1526 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001527 * <p>
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001528 * <strong>Note:</strong>If your app is targeting API level higher than 25 you
Svet Ganov86877e42015-05-28 08:19:48 -07001529 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1530 * in order to launch the application installer.
1531 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001532 *
1533 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1534 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1535 * @see #EXTRA_RETURN_RESULT
1536 */
1537 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1538 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1539
1540 /**
Todd Kennedyd0084f72017-07-28 13:56:14 -07001541 * Activity Action: Activity to handle split installation failures.
1542 * <p>Splits may be installed dynamically. This happens when an Activity is launched,
1543 * but the split that contains the application isn't installed. When a split is
1544 * installed in this manner, the containing package usually doesn't know this is
1545 * happening. However, if an error occurs during installation, the containing
1546 * package can define a single activity handling this action to deal with such
1547 * failures.
1548 * <p>The activity handling this action must be in the base package.
1549 * <p>
1550 * Input: {@link #EXTRA_INTENT} the original intent that started split installation.
1551 * {@link #EXTRA_SPLIT_NAME} the name of the split that failed to be installed.
1552 */
1553 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1554 public static final String ACTION_INSTALL_FAILURE = "android.intent.action.INSTALL_FAILURE";
1555
1556 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001557 * Activity Action: Launch instant application installer.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001558 * <p class="note">
1559 * This is a protected intent that can only be sent by the system.
1560 * </p>
1561 *
1562 * @hide
1563 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001564 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001565 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001566 public static final String ACTION_INSTALL_INSTANT_APP_PACKAGE
1567 = "android.intent.action.INSTALL_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001568
1569 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001570 * Service Action: Resolve instant application.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001571 * <p>
1572 * The system will have a persistent connection to this service.
1573 * This is a protected intent that can only be sent by the system.
1574 * </p>
1575 *
1576 * @hide
1577 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001578 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001579 @SdkConstant(SdkConstantType.SERVICE_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001580 public static final String ACTION_RESOLVE_INSTANT_APP_PACKAGE
1581 = "android.intent.action.RESOLVE_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001582
1583 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001584 * Activity Action: Launch instant app settings.
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001585 *
1586 * <p class="note">
1587 * This is a protected intent that can only be sent by the system.
1588 * </p>
1589 *
1590 * @hide
1591 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001592 @SystemApi
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001593 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001594 public static final String ACTION_INSTANT_APP_RESOLVER_SETTINGS
1595 = "android.intent.action.INSTANT_APP_RESOLVER_SETTINGS";
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001596
1597 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001598 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1599 * package. Specifies the installer package name; this package will receive the
1600 * {@link #ACTION_APP_ERROR} intent.
1601 */
1602 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1603 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1604
1605 /**
1606 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1607 * package. Specifies that the application being installed should not be
1608 * treated as coming from an unknown source, but as coming from the app
1609 * invoking the Intent. For this to work you must start the installer with
1610 * startActivityForResult().
1611 */
1612 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1613 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1614
1615 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001616 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1617 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001618 * data field originated from.
1619 */
rich cannings706e8ba2012-08-20 13:20:14 -07001620 public static final String EXTRA_ORIGINATING_URI
1621 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001622
1623 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001624 * This extra can be used with any Intent used to launch an activity, supplying information
1625 * about who is launching that activity. This field contains a {@link android.net.Uri}
1626 * object, typically an http: or https: URI of the web site that the referral came from;
1627 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1628 * a native application that it came from.
1629 *
1630 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1631 * instead of directly retrieving the extra. It is also valid for applications to
1632 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1633 * a string, not a Uri; the field here, if supplied, will always take precedence,
1634 * however.</p>
1635 *
1636 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001637 */
1638 public static final String EXTRA_REFERRER
1639 = "android.intent.extra.REFERRER";
1640
1641 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001642 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1643 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1644 * not be created, in particular when Intent extras are supplied through the
1645 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1646 * schemes.
1647 *
1648 * @see #EXTRA_REFERRER
1649 */
1650 public static final String EXTRA_REFERRER_NAME
1651 = "android.intent.extra.REFERRER_NAME";
1652
1653 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001654 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001655 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001656 * Currently only a system app that hosts the provider authority "downloads" or holds the
1657 * permission {@link android.Manifest.permission.MANAGE_DOCUMENTS} can use this.
Ben Gruver37d83a32012-09-27 13:02:06 -07001658 * @hide
1659 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001660 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001661 public static final String EXTRA_ORIGINATING_UID
1662 = "android.intent.extra.ORIGINATING_UID";
1663
1664 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001665 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1666 * package. Tells the installer UI to skip the confirmation with the user
1667 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001668 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1669 * will no longer show an interstitial message about updating existing
1670 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001671 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001672 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001673 public static final String EXTRA_ALLOW_REPLACE
1674 = "android.intent.extra.ALLOW_REPLACE";
1675
1676 /**
1677 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1678 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1679 * return to the application the result code of the install/uninstall. The returned result
1680 * code will be {@link android.app.Activity#RESULT_OK} on success or
1681 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1682 */
1683 public static final String EXTRA_RETURN_RESULT
1684 = "android.intent.extra.RETURN_RESULT";
1685
1686 /**
1687 * Package manager install result code. @hide because result codes are not
1688 * yet ready to be exposed.
1689 */
1690 public static final String EXTRA_INSTALL_RESULT
1691 = "android.intent.extra.INSTALL_RESULT";
1692
1693 /**
1694 * Activity Action: Launch application uninstaller.
1695 * <p>
1696 * Input: The data must be a package: URI whose scheme specific part is
1697 * the package name of the current installed package to be uninstalled.
1698 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1699 * <p>
1700 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1701 * succeeded.
Philip P. Moltmannd9bb39a2017-09-05 12:41:15 -07001702 * <p>
1703 * Requires {@link android.Manifest.permission#REQUEST_DELETE_PACKAGES}
1704 * since {@link Build.VERSION_CODES#P}.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001705 */
1706 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1707 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1708
1709 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001710 * Specify whether the package should be uninstalled for all users.
1711 * @hide because these should not be part of normal application flow.
1712 */
1713 public static final String EXTRA_UNINSTALL_ALL_USERS
1714 = "android.intent.extra.UNINSTALL_ALL_USERS";
1715
1716 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001717 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1718 * describing the last run version of the platform that was setup.
1719 * @hide
1720 */
1721 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1722
Svet Ganov3695b8a2015-03-24 16:30:25 -07001723 /**
1724 * Activity action: Launch UI to manage the permissions of an app.
1725 * <p>
1726 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1727 * will be managed by the launched UI.
1728 * </p>
1729 * <p>
1730 * Output: Nothing.
1731 * </p>
1732 *
1733 * @see #EXTRA_PACKAGE_NAME
1734 *
1735 * @hide
1736 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001737 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001738 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1739 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1740 "android.intent.action.MANAGE_APP_PERMISSIONS";
1741
1742 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001743 * Activity action: Launch UI to manage permissions.
1744 * <p>
1745 * Input: Nothing.
1746 * </p>
1747 * <p>
1748 * Output: Nothing.
1749 * </p>
1750 *
1751 * @hide
1752 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001753 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001754 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1755 public static final String ACTION_MANAGE_PERMISSIONS =
1756 "android.intent.action.MANAGE_PERMISSIONS";
1757
1758 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001759 * Activity action: Launch UI to review permissions for an app.
1760 * The system uses this intent if permission review for apps not
1761 * supporting the new runtime permissions model is enabled. In
1762 * this mode a permission review is required before any of the
1763 * app components can run.
1764 * <p>
1765 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1766 * permissions will be reviewed (mandatory).
1767 * </p>
1768 * <p>
1769 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1770 * be fired after the permission review (optional).
1771 * </p>
1772 * <p>
1773 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1774 * be invoked after the permission review (optional).
1775 * </p>
1776 * <p>
1777 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1778 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1779 * </p>
1780 * <p>
1781 * Output: Nothing.
1782 * </p>
1783 *
1784 * @see #EXTRA_PACKAGE_NAME
1785 * @see #EXTRA_INTENT
1786 * @see #EXTRA_REMOTE_CALLBACK
1787 * @see #EXTRA_RESULT_NEEDED
1788 *
1789 * @hide
1790 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001791 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001792 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1793 public static final String ACTION_REVIEW_PERMISSIONS =
1794 "android.intent.action.REVIEW_PERMISSIONS";
1795
1796 /**
1797 * Intent extra: A callback for reporting remote result as a bundle.
1798 * <p>
1799 * Type: IRemoteCallback
1800 * </p>
1801 *
1802 * @hide
1803 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001804 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001805 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1806
1807 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001808 * Intent extra: An app package name.
1809 * <p>
1810 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001811 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001812 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001813 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001814 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1815
1816 /**
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07001817 * Intent extra: A {@link Bundle} of extras for a package being suspended. Will be sent with
1818 * {@link #ACTION_MY_PACKAGE_SUSPENDED}.
1819 *
1820 * @see #ACTION_MY_PACKAGE_SUSPENDED
1821 * @see #ACTION_MY_PACKAGE_UNSUSPENDED
1822 * @see PackageManager#isPackageSuspended()
1823 * @see PackageManager#getSuspendedPackageAppExtras()
1824 */
1825 public static final String EXTRA_SUSPENDED_PACKAGE_EXTRAS = "android.intent.extra.SUSPENDED_PACKAGE_EXTRAS";
1826
1827 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001828 * Intent extra: An app split name.
1829 * <p>
1830 * Type: String
1831 * </p>
Todd Kennedye5195dd2016-10-19 15:29:19 -07001832 */
Todd Kennedye5195dd2016-10-19 15:29:19 -07001833 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1834
1835 /**
Jeff Sharkey1a749422017-04-28 14:19:50 -06001836 * Intent extra: A {@link ComponentName} value.
1837 * <p>
1838 * Type: String
1839 * </p>
1840 */
1841 public static final String EXTRA_COMPONENT_NAME = "android.intent.extra.COMPONENT_NAME";
1842
1843 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001844 * Intent extra: An extra for specifying whether a result is needed.
1845 * <p>
1846 * Type: boolean
1847 * </p>
1848 *
1849 * @hide
1850 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001851 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001852 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1853
1854 /**
Suprabh Shukla19b41f32018-03-26 22:35:13 -07001855 * Intent extra: A {@link Bundle} of extras supplied for the launcher when any packages on
1856 * device are suspended. Will be sent with {@link #ACTION_PACKAGES_SUSPENDED}.
1857 *
1858 * @see PackageManager#isPackageSuspended()
1859 * @see #ACTION_PACKAGES_SUSPENDED
1860 *
1861 * @hide
1862 */
1863 public static final String EXTRA_LAUNCHER_EXTRAS = "android.intent.extra.LAUNCHER_EXTRAS";
1864
1865 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001866 * Activity action: Launch UI to manage which apps have a given permission.
1867 * <p>
1868 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1869 * to which will be managed by the launched UI.
1870 * </p>
1871 * <p>
1872 * Output: Nothing.
1873 * </p>
1874 *
1875 * @see #EXTRA_PERMISSION_NAME
1876 *
1877 * @hide
1878 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001879 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001880 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1881 public static final String ACTION_MANAGE_PERMISSION_APPS =
1882 "android.intent.action.MANAGE_PERMISSION_APPS";
1883
1884 /**
1885 * Intent extra: The name of a permission.
1886 * <p>
1887 * Type: String
1888 * </p>
1889 *
1890 * @hide
1891 */
1892 @SystemApi
1893 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1894
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001895 // ---------------------------------------------------------------------
1896 // ---------------------------------------------------------------------
1897 // Standard intent broadcast actions (see action variable).
1898
1899 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001900 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1901 * <p>
1902 * For historical reasons, the name of this broadcast action refers to the power
1903 * state of the screen but it is actually sent in response to changes in the
1904 * overall interactive state of the device.
1905 * </p><p>
1906 * This broadcast is sent when the device becomes non-interactive which may have
1907 * nothing to do with the screen turning off. To determine the
1908 * actual state of the screen, use {@link android.view.Display#getState}.
1909 * </p><p>
1910 * See {@link android.os.PowerManager#isInteractive} for details.
1911 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001912 * You <em>cannot</em> receive this through components declared in
1913 * manifests, only by explicitly registering for it with
1914 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1915 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001916 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001917 * <p class="note">This is a protected intent that can only be sent
1918 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001919 */
1920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1921 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001922
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001923 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001924 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1925 * <p>
1926 * For historical reasons, the name of this broadcast action refers to the power
1927 * state of the screen but it is actually sent in response to changes in the
1928 * overall interactive state of the device.
1929 * </p><p>
1930 * This broadcast is sent when the device becomes interactive which may have
1931 * nothing to do with the screen turning on. To determine the
1932 * actual state of the screen, use {@link android.view.Display#getState}.
1933 * </p><p>
1934 * See {@link android.os.PowerManager#isInteractive} for details.
1935 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001936 * You <em>cannot</em> receive this through components declared in
1937 * manifests, only by explicitly registering for it with
1938 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1939 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001940 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001941 * <p class="note">This is a protected intent that can only be sent
1942 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001943 */
1944 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1945 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001946
1947 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001948 * Broadcast Action: Sent after the system stops dreaming.
1949 *
1950 * <p class="note">This is a protected intent that can only be sent by the system.
1951 * It is only sent to registered receivers.</p>
1952 */
1953 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1954 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1955
1956 /**
1957 * Broadcast Action: Sent after the system starts dreaming.
1958 *
1959 * <p class="note">This is a protected intent that can only be sent by the system.
1960 * It is only sent to registered receivers.</p>
1961 */
1962 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1963 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1964
1965 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001966 * 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 -07001967 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001968 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001969 * <p class="note">This is a protected intent that can only be sent
1970 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001971 */
1972 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001973 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001974
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001975 /**
1976 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001977 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001978 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001979 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1980 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001981 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001982 * <p class="note">This is a protected intent that can only be sent
1983 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001984 */
1985 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1986 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1987 /**
1988 * Broadcast Action: The time was set.
1989 */
1990 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1991 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1992 /**
1993 * Broadcast Action: The date has changed.
1994 */
1995 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1996 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1997 /**
1998 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1999 * <ul>
2000 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
2001 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002002 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002003 * <p class="note">This is a protected intent that can only be sent
2004 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002005 */
2006 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2007 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
2008 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07002009 * Clear DNS Cache Action: This is broadcast when networks have changed and old
2010 * DNS entries should be tossed.
2011 * @hide
2012 */
2013 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2014 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
2015 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002016 * Alarm Changed Action: This is broadcast when the AlarmClock
2017 * application's alarm is set or unset. It is used by the
2018 * AlarmClock application and the StatusBar service.
2019 * @hide
2020 */
2021 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2022 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002023
2024 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002025 * Broadcast Action: This is broadcast once, after the user has finished
2026 * booting, but while still in the "locked" state. It can be used to perform
2027 * application-specific initialization, such as installing alarms. You must
2028 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
2029 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002030 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002031 * This broadcast is sent immediately at boot by all devices (regardless of
2032 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
2033 * higher. Upon receipt of this broadcast, the user is still locked and only
2034 * device-protected storage can be accessed safely. If you want to access
2035 * credential-protected storage, you need to wait for the user to be
2036 * unlocked (typically by entering their lock pattern or PIN for the first
2037 * time), after which the {@link #ACTION_USER_UNLOCKED} and
2038 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
2039 * <p>
2040 * To receive this broadcast, your receiver component must be marked as
2041 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002042 * <p class="note">
2043 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002044 *
2045 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002046 */
2047 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2048 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2049
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002050 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002051 * Broadcast Action: This is broadcast once, after the user has finished
2052 * booting. It can be used to perform application-specific initialization,
2053 * such as installing alarms. You must hold the
2054 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2055 * order to receive this broadcast.
2056 * <p>
2057 * This broadcast is sent at boot by all devices (both with and without
2058 * direct boot support). Upon receipt of this broadcast, the user is
2059 * unlocked and both device-protected and credential-protected storage can
2060 * accessed safely.
2061 * <p>
2062 * If you need to run while the user is still locked (before they've entered
2063 * their lock pattern or PIN for the first time), you can listen for the
2064 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2065 * <p class="note">
2066 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002067 */
2068 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002069 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002070 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002071
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002072 /**
2073 * Broadcast Action: This is broadcast when a user action should request a
2074 * temporary system dialog to dismiss. Some examples of temporary system
2075 * dialogs are the notification window-shade and the recent tasks dialog.
2076 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002077 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002078 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2079 /**
2080 * Broadcast Action: Trigger the download and eventual installation
2081 * of a package.
2082 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002083 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002084 * <p class="note">This is a protected intent that can only be sent
2085 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002086 *
2087 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002088 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002089 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002090 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2091 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2092 /**
Christopher Tate94b91db2017-04-19 15:49:17 -07002093 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002094 * device. The data contains the name of the package. Note that the
2095 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002096 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002097 * <ul>
Christopher Tate94b91db2017-04-19 15:49:17 -07002098 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2099 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002100 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2101 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002102 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002103 * <p class="note">This is a protected intent that can only be sent
2104 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002105 */
2106 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2107 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2108 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002109 * Broadcast Action: A new version of an application package has been
2110 * installed, replacing an existing version that was previously installed.
2111 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002112 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002113 * <ul>
2114 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2115 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002116 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002117 * <p class="note">This is a protected intent that can only be sent
2118 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002119 */
2120 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2121 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2122 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002123 * Broadcast Action: A new version of your application has been installed
2124 * over an existing one. This is only sent to the application that was
2125 * replaced. It does not contain any additional data; to receive it, just
2126 * use an intent filter for this action.
2127 *
2128 * <p class="note">This is a protected intent that can only be sent
2129 * by the system.
2130 */
2131 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2132 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2133 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002134 * Broadcast Action: An existing application package has been removed from
2135 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002136 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002137 * <ul>
2138 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2139 * to the package.
2140 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2141 * application -- data and code -- is being removed.
2142 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2143 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2144 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002145 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002146 * <p class="note">This is a protected intent that can only be sent
2147 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002148 */
2149 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2150 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2151 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002152 * Broadcast Action: An existing application package has been completely
2153 * removed from the device. The data contains the name of the package.
2154 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2155 * {@link #EXTRA_DATA_REMOVED} is true and
2156 * {@link #EXTRA_REPLACING} is false of that broadcast.
2157 *
2158 * <ul>
2159 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2160 * to the package.
2161 * </ul>
2162 *
2163 * <p class="note">This is a protected intent that can only be sent
2164 * by the system.
2165 */
2166 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2167 public static final String ACTION_PACKAGE_FULLY_REMOVED
2168 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2169 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002170 * Broadcast Action: An existing application package has been changed (for
2171 * example, a component has been enabled or disabled). The data contains
2172 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002173 * <ul>
2174 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002175 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002176 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002177 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2178 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002179 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002180 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002181 * <p class="note">This is a protected intent that can only be sent
2182 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002183 */
2184 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2185 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2186 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002187 * @hide
2188 * Broadcast Action: Ask system services if there is any reason to
2189 * restart the given package. The data contains the name of the
2190 * package.
2191 * <ul>
2192 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2193 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2194 * </ul>
2195 *
2196 * <p class="note">This is a protected intent that can only be sent
2197 * by the system.
2198 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002199 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002200 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2201 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2202 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002203 * Broadcast Action: The user has restarted a package, and all of its
2204 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002205 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002206 * be removed. Note that the restarted package does <em>not</em>
2207 * receive this broadcast.
2208 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002209 * <ul>
2210 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2211 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002212 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002213 * <p class="note">This is a protected intent that can only be sent
2214 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002215 */
2216 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2217 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2218 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002219 * Broadcast Action: The user has cleared the data of a package. This should
2220 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002221 * its persistent data is erased and this broadcast sent.
2222 * Note that the cleared package does <em>not</em>
2223 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002224 * <ul>
Svet Ganovf935a702017-08-22 12:15:58 -07002225 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package. If the
2226 * package whose data was cleared is an uninstalled instant app, then the UID
2227 * will be -1. The platform keeps some meta-data associated with instant apps
2228 * after they are uninstalled.
2229 * <li> {@link #EXTRA_PACKAGE_NAME} containing the package name only if the cleared
2230 * data was for an instant app.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002231 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002232 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002233 * <p class="note">This is a protected intent that can only be sent
2234 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002235 */
2236 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2237 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2238 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002239 * Broadcast Action: Packages have been suspended.
2240 * <p>Includes the following extras:
2241 * <ul>
2242 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2243 * </ul>
2244 *
2245 * <p class="note">This is a protected intent that can only be sent
2246 * by the system. It is only sent to registered receivers.
2247 */
2248 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2249 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2250 /**
2251 * Broadcast Action: Packages have been unsuspended.
2252 * <p>Includes the following extras:
2253 * <ul>
2254 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2255 * </ul>
2256 *
2257 * <p class="note">This is a protected intent that can only be sent
2258 * by the system. It is only sent to registered receivers.
2259 */
2260 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2261 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002262
2263 /**
2264 * Broadcast Action: Sent to a package that has been suspended by the system. This is sent
Suprabh Shukla19b41f32018-03-26 22:35:13 -07002265 * whenever a package is put into a suspended state or any of its app extras change while in the
2266 * suspended state.
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002267 * <p> Optionally includes the following extras:
2268 * <ul>
2269 * <li> {@link #EXTRA_SUSPENDED_PACKAGE_EXTRAS} which is a {@link Bundle} which will contain
2270 * useful information for the app being suspended.
2271 * </ul>
2272 * <p class="note">This is a protected intent that can only be sent
2273 * by the system. <em>This will be delivered to {@link BroadcastReceiver} components declared in
2274 * the manifest.</em>
2275 *
2276 * @see #ACTION_MY_PACKAGE_UNSUSPENDED
2277 * @see #EXTRA_SUSPENDED_PACKAGE_EXTRAS
2278 * @see PackageManager#isPackageSuspended()
2279 * @see PackageManager#getSuspendedPackageAppExtras()
2280 */
2281 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2282 public static final String ACTION_MY_PACKAGE_SUSPENDED = "android.intent.action.MY_PACKAGE_SUSPENDED";
2283
2284 /**
2285 * Broadcast Action: Sent to a package that has been unsuspended.
2286 *
2287 * <p class="note">This is a protected intent that can only be sent
2288 * by the system. <em>This will be delivered to {@link BroadcastReceiver} components declared in
2289 * the manifest.</em>
2290 *
2291 * @see #ACTION_MY_PACKAGE_SUSPENDED
2292 * @see #EXTRA_SUSPENDED_PACKAGE_EXTRAS
2293 * @see PackageManager#isPackageSuspended()
2294 * @see PackageManager#getSuspendedPackageAppExtras()
2295 */
2296 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2297 public static final String ACTION_MY_PACKAGE_UNSUSPENDED = "android.intent.action.MY_PACKAGE_UNSUSPENDED";
2298
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002299 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002300 * Broadcast Action: A user ID has been removed from the system. The user
2301 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002302 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002303 * <p class="note">This is a protected intent that can only be sent
2304 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002305 */
2306 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2307 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002308
2309 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002310 * Broadcast Action: Sent to the installer package of an application when
2311 * that application is first launched (that is the first time it is moved
2312 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002313 *
2314 * <p class="note">This is a protected intent that can only be sent
2315 * by the system.
2316 */
2317 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2318 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2319
2320 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002321 * Broadcast Action: Sent to the system package verifier when a package
2322 * needs to be verified. The data contains the package URI.
2323 * <p class="note">
2324 * This is a protected intent that can only be sent by the system.
2325 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002326 */
2327 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2328 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2329
2330 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002331 * Broadcast Action: Sent to the system package verifier when a package is
2332 * verified. The data contains the package URI.
2333 * <p class="note">
2334 * This is a protected intent that can only be sent by the system.
2335 */
2336 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2337 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2338
2339 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002340 * Broadcast Action: Sent to the system intent filter verifier when an
2341 * intent filter needs to be verified. The data contains the filter data
2342 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002343 * <p class="note">
2344 * This is a protected intent that can only be sent by the system.
2345 * </p>
2346 *
2347 * @hide
2348 */
2349 @SystemApi
2350 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2351 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2352
2353 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002354 * Broadcast Action: Resources for a set of packages (which were
2355 * previously unavailable) are currently
2356 * available since the media on which they exist is available.
2357 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2358 * list of packages whose availability changed.
2359 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2360 * list of uids of packages whose availability changed.
2361 * Note that the
2362 * packages in this list do <em>not</em> receive this broadcast.
2363 * The specified set of packages are now available on the system.
2364 * <p>Includes the following extras:
2365 * <ul>
2366 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2367 * whose resources(were previously unavailable) are currently available.
2368 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2369 * packages whose resources(were previously unavailable)
2370 * are currently available.
2371 * </ul>
2372 *
2373 * <p class="note">This is a protected intent that can only be sent
2374 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002375 */
2376 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002377 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2378 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002379
2380 /**
2381 * Broadcast Action: Resources for a set of packages are currently
2382 * unavailable since the media on which they exist is unavailable.
2383 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2384 * list of packages whose availability changed.
2385 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2386 * list of uids of packages whose availability changed.
2387 * The specified set of packages can no longer be
2388 * launched and are practically unavailable on the system.
2389 * <p>Inclues the following extras:
2390 * <ul>
2391 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2392 * whose resources are no longer available.
2393 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2394 * whose resources are no longer available.
2395 * </ul>
2396 *
2397 * <p class="note">This is a protected intent that can only be sent
2398 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002399 */
2400 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002401 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002402 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002403
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002404 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002405 * Broadcast Action: preferred activities have changed *explicitly*.
2406 *
2407 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2408 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2409 * be sent.
2410 *
2411 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2412 *
2413 * @hide
2414 */
2415 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2416 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2417 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2418
2419
2420 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002421 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002422 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002423 * This should <em>only</em> be used to determine when the wallpaper
2424 * has changed to show the new wallpaper to the user. You should certainly
2425 * never, in response to this, change the wallpaper or other attributes of
2426 * it such as the suggested size. That would be crazy, right? You'd cause
2427 * all kinds of loops, especially if other apps are doing similar things,
2428 * right? Of course. So please don't do this.
2429 *
2430 * @deprecated Modern applications should use
2431 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2432 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2433 * shown behind their UI, rather than watching for this broadcast and
2434 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002435 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002436 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002437 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2438 /**
2439 * Broadcast Action: The current device {@link android.content.res.Configuration}
2440 * (orientation, locale, etc) has changed. When such a change happens, the
2441 * UIs (view hierarchy) will need to be rebuilt based on this new
2442 * information; for the most part, applications don't need to worry about
2443 * this, because the system will take care of stopping and restarting the
2444 * application to make sure it sees the new changes. Some system code that
2445 * can not be restarted will need to watch for this action and handle it
2446 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002447 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002448 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002449 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002450 * in manifests, only by explicitly registering for it with
2451 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2452 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002453 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002454 * <p class="note">This is a protected intent that can only be sent
2455 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002456 *
2457 * @see android.content.res.Configuration
2458 */
2459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2460 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
Adam Lesinski57fccd62018-01-25 13:03:57 -08002461
2462 /**
2463 * Broadcast Action: The current device {@link android.content.res.Configuration} has changed
2464 * such that the device may be eligible for the installation of additional configuration splits.
2465 * Configuration properties that can trigger this broadcast include locale and display density.
2466 *
2467 * <p class="note">
2468 * Unlike {@link #ACTION_CONFIGURATION_CHANGED}, you <em>can</em> receive this through
2469 * components declared in manifests. However, the receiver <em>must</em> hold the
2470 * {@link android.Manifest.permission#INSTALL_PACKAGES} permission.
2471 *
2472 * <p class="note">
2473 * This is a protected intent that can only be sent by the system.
2474 *
2475 * @hide
2476 */
2477 @SystemApi
2478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2479 public static final String ACTION_SPLIT_CONFIGURATION_CHANGED =
2480 "android.intent.action.SPLIT_CONFIGURATION_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002481 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002482 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002483 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002484 * <p class="note">This is a protected intent that can only be sent
2485 * by the system.
2486 */
2487 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2488 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2489 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002490 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2491 * charging state, level, and other information about the battery.
2492 * See {@link android.os.BatteryManager} for documentation on the
2493 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002494 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002495 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002496 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002497 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002498 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002499 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2500 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2501 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2502 * broadcasts that are sent and can be received through manifest
2503 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002504 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002505 * <p class="note">This is a protected intent that can only be sent
2506 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002507 */
2508 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2509 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
Fyodor Kupolov70e75432018-03-01 18:29:06 -08002510
2511
2512 /**
2513 * Broadcast Action: Sent when the current battery level changes.
2514 *
2515 * It has {@link android.os.BatteryManager#EXTRA_EVENTS} that carries a list of {@link Bundle}
2516 * instances representing individual battery level changes with associated
2517 * extras from {@link #ACTION_BATTERY_CHANGED}.
2518 *
2519 * <p class="note">
2520 * This broadcast requires {@link android.Manifest.permission#BATTERY_STATS} permission.
2521 *
2522 * @hide
2523 */
2524 @SystemApi
2525 public static final String ACTION_BATTERY_LEVEL_CHANGED =
2526 "android.intent.action.BATTERY_LEVEL_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002527 /**
2528 * Broadcast Action: Indicates low battery condition on the device.
2529 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002530 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002531 * <p class="note">This is a protected intent that can only be sent
2532 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002533 */
2534 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2535 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2536 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002537 * Broadcast Action: Indicates the battery is now okay after being low.
2538 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2539 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002540 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002541 * <p class="note">This is a protected intent that can only be sent
2542 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002543 */
2544 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2545 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2546 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002547 * Broadcast Action: External power has been connected to the device.
2548 * This is intended for applications that wish to register specifically to this notification.
2549 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2550 * stay active to receive this notification. This action can be used to implement actions
2551 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002552 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002553 * <p class="note">This is a protected intent that can only be sent
2554 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002555 */
2556 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002557 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002558 /**
2559 * Broadcast Action: External power has been removed from the device.
2560 * This is intended for applications that wish to register specifically to this notification.
2561 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2562 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002563 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002564 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002565 * <p class="note">This is a protected intent that can only be sent
2566 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002567 */
2568 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002569 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002570 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002571 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002572 * Broadcast Action: Device is shutting down.
2573 * This is broadcast when the device is being shut down (completely turned
2574 * off, not sleeping). Once the broadcast is complete, the final shutdown
2575 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002576 * to handle this, since the foreground activity will be paused as well.
Fyodor Kupolov1fc62602018-02-01 15:48:53 -08002577 * <p>As of {@link Build.VERSION_CODES#P} this broadcast is only sent to receivers registered
2578 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2579 * Context.registerReceiver}.
Tom Taylord4a47292009-12-21 13:59:18 -08002580 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002581 * <p class="note">This is a protected intent that can only be sent
2582 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002583 * <p>May include the following extras:
2584 * <ul>
2585 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2586 * shutdown is only for userspace processes. If not set, assumed to be false.
2587 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002588 */
2589 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002590 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002591 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002592 * Activity Action: Start this activity to request system shutdown.
2593 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002594 * to request confirmation from the user before shutting down. The optional boolean
2595 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2596 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002597 *
2598 * <p class="note">This is a protected intent that can only be sent
2599 * by the system.
2600 *
2601 * {@hide}
2602 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002603 public static final String ACTION_REQUEST_SHUTDOWN
2604 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002605 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002606 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002607 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002608 * <p class="note">
2609 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002610 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002611 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2612 * or above, this broadcast will no longer be delivered to any
2613 * {@link BroadcastReceiver} defined in your manifest. Instead,
2614 * apps are strongly encouraged to use the improved
2615 * {@link Context#getCacheDir()} behavior so the system can
2616 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002617 */
2618 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002619 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002620 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2621 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002622 * Broadcast Action: Indicates low storage space condition on the device no
2623 * longer exists
2624 * <p class="note">
2625 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002626 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002627 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2628 * or above, this broadcast will no longer be delivered to any
2629 * {@link BroadcastReceiver} defined in your manifest. Instead,
2630 * apps are strongly encouraged to use the improved
2631 * {@link Context#getCacheDir()} behavior so the system can
2632 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002633 */
2634 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002635 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002636 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2637 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002638 * Broadcast Action: A sticky broadcast that indicates a storage space full
2639 * condition on the device. This is intended for activities that want to be
2640 * able to fill the data partition completely, leaving only enough free
2641 * space to prevent system-wide SQLite failures.
2642 * <p class="note">
2643 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002644 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002645 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2646 * or above, this broadcast will no longer be delivered to any
2647 * {@link BroadcastReceiver} defined in your manifest. Instead,
2648 * apps are strongly encouraged to use the improved
2649 * {@link Context#getCacheDir()} behavior so the system can
2650 * automatically free up storage when needed.
2651 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002652 */
2653 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002654 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002655 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2656 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002657 * Broadcast Action: Indicates storage space full condition on the device no
2658 * longer exists.
2659 * <p class="note">
2660 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002661 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002662 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2663 * or above, this broadcast will no longer be delivered to any
2664 * {@link BroadcastReceiver} defined in your manifest. Instead,
2665 * apps are strongly encouraged to use the improved
2666 * {@link Context#getCacheDir()} behavior so the system can
2667 * automatically free up storage when needed.
2668 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002669 */
2670 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002671 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002672 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2673 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002674 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2675 * and package management should be started.
2676 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2677 * notification.
2678 */
2679 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2680 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2681 /**
2682 * Broadcast Action: The device has entered USB Mass Storage mode.
2683 * This is used mainly for the USB Settings panel.
2684 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2685 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002686 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002687 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002688 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002689 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002690 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2691
2692 /**
2693 * Broadcast Action: The device has exited USB Mass Storage mode.
2694 * This is used mainly for the USB Settings panel.
2695 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2696 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002697 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002698 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002699 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002700 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002701 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2702
2703 /**
2704 * Broadcast Action: External media has been removed.
2705 * The path to the mount point for the removed media is contained in the Intent.mData field.
2706 */
2707 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2708 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2709
2710 /**
2711 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002712 * 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 -07002713 */
2714 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2715 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2716
2717 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002718 * Broadcast Action: External media is present, and being disk-checked
2719 * 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 -08002720 */
2721 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2722 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2723
2724 /**
2725 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2726 * 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 -08002727 */
2728 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2729 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2730
2731 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002732 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002733 * 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 -07002734 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2735 * media was mounted read only.
2736 */
2737 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2738 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2739
2740 /**
2741 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002742 * 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 -07002743 */
2744 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2745 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2746
2747 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002748 * Broadcast Action: External media is no longer being shared via USB mass storage.
2749 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2750 *
2751 * @hide
2752 */
2753 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2754
2755 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002756 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2757 * The path to the mount point for the removed media is contained in the Intent.mData field.
2758 */
2759 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2760 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2761
2762 /**
2763 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002764 * 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 -07002765 */
2766 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2767 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2768
2769 /**
2770 * Broadcast Action: User has expressed the desire to remove the external storage media.
2771 * Applications should close all files they have open within the mount point when they receive this intent.
2772 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2773 */
2774 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2775 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2776
2777 /**
2778 * Broadcast Action: The media scanner has started scanning a directory.
2779 * The path to the directory being scanned is contained in the Intent.mData field.
2780 */
2781 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2782 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2783
2784 /**
2785 * Broadcast Action: The media scanner has finished scanning a directory.
2786 * The path to the scanned directory is contained in the Intent.mData field.
2787 */
2788 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2789 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2790
2791 /**
2792 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2793 * The path to the file is contained in the Intent.mData field.
2794 */
2795 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2796 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2797
2798 /**
2799 * Broadcast Action: The "Media Button" was pressed. Includes a single
2800 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2801 * caused the broadcast.
2802 */
2803 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2804 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2805
2806 /**
2807 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2808 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2809 * caused the broadcast.
2810 */
2811 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2812 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2813
2814 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2815 // location; they are not general-purpose actions.
2816
2817 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002818 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002819 */
2820 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2821 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2822 "android.intent.action.GTALK_CONNECTED";
2823
2824 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002825 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002826 */
2827 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2828 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2829 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002830
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002831 /**
2832 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002833 */
2834 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2835 public static final String ACTION_INPUT_METHOD_CHANGED =
2836 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002837
2838 /**
2839 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2840 * more radios have been turned off or on. The intent will have the following extra value:</p>
2841 * <ul>
2842 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2843 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2844 * turned off</li>
2845 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002846 *
Peng Xua35b5532016-01-20 00:05:45 -08002847 * <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 -07002848 */
2849 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2850 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2851
2852 /**
2853 * Broadcast Action: Some content providers have parts of their namespace
2854 * where they publish new events or items that the user may be especially
2855 * interested in. For these things, they may broadcast this action when the
2856 * set of interesting items change.
2857 *
2858 * For example, GmailProvider sends this notification when the set of unread
2859 * mail in the inbox changes.
2860 *
2861 * <p>The data of the intent identifies which part of which provider
2862 * changed. When queried through the content resolver, the data URI will
2863 * return the data set in question.
2864 *
2865 * <p>The intent will have the following extra values:
2866 * <ul>
2867 * <li><em>count</em> - The number of items in the data set. This is the
2868 * same as the number of items in the cursor returned by querying the
2869 * data URI. </li>
2870 * </ul>
2871 *
2872 * This intent will be sent at boot (if the count is non-zero) and when the
2873 * data set changes. It is possible for the data set to change without the
2874 * count changing (for example, if a new unread message arrives in the same
2875 * sync operation in which a message is archived). The phone should still
2876 * ring/vibrate/etc as normal in this case.
2877 */
2878 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2879 public static final String ACTION_PROVIDER_CHANGED =
2880 "android.intent.action.PROVIDER_CHANGED";
2881
2882 /**
2883 * Broadcast Action: Wired Headset plugged in or unplugged.
2884 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002885 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2886 * and documentation.
2887 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002888 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002889 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002890 */
2891 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002892 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002893
2894 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002895 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2896 * <ul>
2897 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2898 * </ul>
2899 *
2900 * <p class="note">This is a protected intent that can only be sent
2901 * by the system.
2902 *
2903 * @hide
2904 */
2905 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2906 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2907 = "android.intent.action.ADVANCED_SETTINGS";
2908
2909 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002910 * Broadcast Action: Sent after application restrictions are changed.
2911 *
2912 * <p class="note">This is a protected intent that can only be sent
2913 * by the system.</p>
2914 */
2915 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2916 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2917 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2918
2919 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002920 * Broadcast Action: An outgoing call is about to be placed.
2921 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002922 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002923 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002924 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002925 * the phone number originally intended to be dialed.</li>
2926 * </ul>
2927 * <p>Once the broadcast is finished, the resultData is used as the actual
2928 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002929 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002930 * outgoing call in turn: for example, a parental control application
2931 * might verify that the user is authorized to place the call at that
2932 * time, then a number-rewriting application might add an area code if
2933 * one was not specified.</p>
2934 * <p>For consistency, any receiver whose purpose is to prohibit phone
2935 * calls should have a priority of 0, to ensure it will see the final
2936 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002937 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002938 * should have a positive priority.
2939 * Negative priorities are reserved for the system for this broadcast;
2940 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002941 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2942 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002943 * <p>Emergency calls cannot be intercepted using this mechanism, and
2944 * other calls cannot be modified to call emergency numbers using this
2945 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002946 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2947 * call to use their own service instead. Those apps should first prevent
2948 * the call from being placed by setting resultData to <code>null</code>
2949 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002950 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002951 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2952 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002953 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002954 * <p class="note">This is a protected intent that can only be sent
2955 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002956 */
2957 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2958 public static final String ACTION_NEW_OUTGOING_CALL =
2959 "android.intent.action.NEW_OUTGOING_CALL";
2960
2961 /**
2962 * Broadcast Action: Have the device reboot. This is only for use by
2963 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002964 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002965 * <p class="note">This is a protected intent that can only be sent
2966 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002967 */
2968 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2969 public static final String ACTION_REBOOT =
2970 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002971
Wei Huang97ecc9c2009-05-11 17:44:20 -07002972 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002973 * Broadcast Action: A sticky broadcast for changes in the physical
2974 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002975 *
2976 * <p>The intent will have the following extra values:
2977 * <ul>
2978 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002979 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002980 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002981 * <p>This is intended for monitoring the current physical dock state.
2982 * See {@link android.app.UiModeManager} for the normal API dealing with
2983 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002984 */
2985 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2986 public static final String ACTION_DOCK_EVENT =
2987 "android.intent.action.DOCK_EVENT";
2988
2989 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002990 * Broadcast Action: A broadcast when idle maintenance can be started.
2991 * This means that the user is not interacting with the device and is
2992 * not expected to do so soon. Typical use of the idle maintenance is
2993 * to perform somehow expensive tasks that can be postponed at a moment
2994 * when they will not degrade user experience.
2995 * <p>
2996 * <p class="note">In order to keep the device responsive in case of an
2997 * unexpected user interaction, implementations of a maintenance task
2998 * should be interruptible. In such a scenario a broadcast with action
2999 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
3000 * should not do the maintenance work in
3001 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
3002 * maintenance service by {@link Context#startService(Intent)}. Also
3003 * you should hold a wake lock while your maintenance service is running
3004 * to prevent the device going to sleep.
3005 * </p>
3006 * <p>
3007 * <p class="note">This is a protected intent that can only be sent by
3008 * the system.
3009 * </p>
3010 *
3011 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07003012 *
3013 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08003014 */
3015 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3016 public static final String ACTION_IDLE_MAINTENANCE_START =
3017 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
3018
3019 /**
3020 * Broadcast Action: A broadcast when idle maintenance should be stopped.
3021 * This means that the user was not interacting with the device as a result
3022 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
3023 * was sent and now the user started interacting with the device. Typical
3024 * use of the idle maintenance is to perform somehow expensive tasks that
3025 * can be postponed at a moment when they will not degrade user experience.
3026 * <p>
3027 * <p class="note">In order to keep the device responsive in case of an
3028 * unexpected user interaction, implementations of a maintenance task
3029 * should be interruptible. Hence, on receiving a broadcast with this
3030 * action, the maintenance task should be interrupted as soon as possible.
3031 * In other words, you should not do the maintenance work in
3032 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
3033 * maintenance service that was started on receiving of
3034 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
3035 * lock you acquired when your maintenance service started.
3036 * </p>
3037 * <p class="note">This is a protected intent that can only be sent
3038 * by the system.
3039 *
3040 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07003041 *
3042 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08003043 */
3044 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3045 public static final String ACTION_IDLE_MAINTENANCE_END =
3046 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
3047
3048 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003049 * Broadcast Action: a remote intent is to be broadcasted.
3050 *
3051 * A remote intent is used for remote RPC between devices. The remote intent
3052 * is serialized and sent from one device to another device. The receiving
3053 * device parses the remote intent and broadcasts it. Note that anyone can
3054 * broadcast a remote intent. However, if the intent receiver of the remote intent
3055 * does not trust intent broadcasts from arbitrary intent senders, it should require
3056 * the sender to hold certain permissions so only trusted sender's broadcast will be
3057 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07003058 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07003059 */
3060 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07003061 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07003062
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003063 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06003064 * Broadcast Action: This is broadcast once when the user is booting after a
3065 * system update. It can be used to perform cleanup or upgrades after a
3066 * system update.
3067 * <p>
3068 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
3069 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
3070 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
3071 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003072 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003073 * @hide
3074 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003075 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003076 public static final String ACTION_PRE_BOOT_COMPLETED =
3077 "android.intent.action.PRE_BOOT_COMPLETED";
3078
Amith Yamasani13593602012-03-22 16:16:17 -07003079 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003080 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003081 * on restricted users. The broadcast intent contains an extra
3082 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
3083 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
3084 * String[] depending on the restriction type.<p/>
3085 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07003086 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
3087 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
3088 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003089 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
3090 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003091 * @see RestrictionEntry
3092 */
3093 public static final String ACTION_GET_RESTRICTION_ENTRIES =
3094 "android.intent.action.GET_RESTRICTION_ENTRIES";
3095
3096 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003097 * Sent the first time a user is starting, to allow system apps to
3098 * perform one time initialization. (This will not be seen by third
3099 * party applications because a newly initialized user does not have any
3100 * third party applications installed for it.) This is sent early in
3101 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003102 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3103 * broadcast, since it is part of a visible user interaction; be as quick
3104 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003105 */
3106 public static final String ACTION_USER_INITIALIZE =
3107 "android.intent.action.USER_INITIALIZE";
3108
3109 /**
3110 * Sent when a user switch is happening, causing the process's user to be
3111 * brought to the foreground. This is only sent to receivers registered
3112 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3113 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003114 * foreground. This is sent as a foreground
3115 * broadcast, since it is part of a visible user interaction; be as quick
3116 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003117 */
3118 public static final String ACTION_USER_FOREGROUND =
3119 "android.intent.action.USER_FOREGROUND";
3120
3121 /**
3122 * Sent when a user switch is happening, causing the process's user to be
3123 * sent to the background. This is only sent to receivers registered
3124 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3125 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003126 * background. This is sent as a foreground
3127 * broadcast, since it is part of a visible user interaction; be as quick
3128 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003129 */
3130 public static final String ACTION_USER_BACKGROUND =
3131 "android.intent.action.USER_BACKGROUND";
3132
3133 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003134 * Broadcast sent to the system when a user is added. Carries an extra
3135 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3136 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003137 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003138 * @hide
3139 */
3140 public static final String ACTION_USER_ADDED =
3141 "android.intent.action.USER_ADDED";
3142
3143 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003144 * Broadcast sent by the system when a user is started. Carries an extra
3145 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003146 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003147 * that has been started. 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 * @hide
3151 */
3152 public static final String ACTION_USER_STARTED =
3153 "android.intent.action.USER_STARTED";
3154
3155 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003156 * Broadcast sent when a user is in the process of starting. Carries an extra
3157 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3158 * sent to registered receivers, not manifest receivers. It is sent to all
3159 * users (including the one that is being started). You must hold
3160 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3161 * this broadcast. This is sent as a background broadcast, since
3162 * its result is not part of the primary UX flow; to safely keep track of
3163 * started/stopped state of a user you can use this in conjunction with
3164 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3165 * other user state broadcasts since those are foreground broadcasts so can
3166 * execute in a different order.
3167 * @hide
3168 */
3169 public static final String ACTION_USER_STARTING =
3170 "android.intent.action.USER_STARTING";
3171
3172 /**
3173 * Broadcast sent when a user is going to be stopped. Carries an extra
3174 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3175 * sent to registered receivers, not manifest receivers. It is sent to all
3176 * users (including the one that is being stopped). You must hold
3177 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3178 * this broadcast. The user will not stop until all receivers have
3179 * handled the broadcast. This is sent as a background broadcast, since
3180 * its result is not part of the primary UX flow; to safely keep track of
3181 * started/stopped state of a user you can use this in conjunction with
3182 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3183 * other user state broadcasts since those are foreground broadcasts so can
3184 * execute in a different order.
3185 * @hide
3186 */
3187 public static final String ACTION_USER_STOPPING =
3188 "android.intent.action.USER_STOPPING";
3189
3190 /**
3191 * Broadcast sent to the system when a user is stopped. Carries an extra
3192 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3193 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3194 * specific package. This is only sent to registered receivers, not manifest
3195 * receivers. It is sent to all running users <em>except</em> the one that
3196 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003197 * @hide
3198 */
3199 public static final String ACTION_USER_STOPPED =
3200 "android.intent.action.USER_STOPPED";
3201
3202 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003203 * 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 -07003204 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003205 * one that has been removed. The user will not be completely removed until all receivers have
3206 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003207 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003208 * @hide
3209 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003210 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003211 public static final String ACTION_USER_REMOVED =
3212 "android.intent.action.USER_REMOVED";
3213
3214 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003215 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003216 * the userHandle of the user to become the current one. This is only sent to
3217 * registered receivers, not manifest receivers. It is sent to all running users.
3218 * You must hold
3219 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003220 * @hide
3221 */
3222 public static final String ACTION_USER_SWITCHED =
3223 "android.intent.action.USER_SWITCHED";
3224
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003225 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003226 * Broadcast Action: Sent when the credential-encrypted private storage has
3227 * become unlocked for the target user. This is only sent to registered
3228 * receivers, not manifest receivers.
3229 */
3230 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3231 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3232
3233 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003234 * Broadcast sent to the system when a user's information changes. Carries an extra
3235 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003236 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003237 * @hide
3238 */
3239 public static final String ACTION_USER_INFO_CHANGED =
3240 "android.intent.action.USER_INFO_CHANGED";
3241
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003242 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003243 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3244 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003245 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3246 * that need to display merged content across both primary and managed profiles need to
3247 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003248 * not manifest receivers.
3249 */
3250 public static final String ACTION_MANAGED_PROFILE_ADDED =
3251 "android.intent.action.MANAGED_PROFILE_ADDED";
3252
3253 /**
3254 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003255 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3256 * Only applications (for example Launchers) that need to display merged content across both
3257 * primary and managed profiles need to worry about this broadcast. This is only sent to
3258 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003259 */
3260 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3261 "android.intent.action.MANAGED_PROFILE_REMOVED";
3262
3263 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003264 * Broadcast sent to the primary user when the credential-encrypted private storage for
3265 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3266 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3267 * Launchers) that need to display merged content across both primary and managed profiles
3268 * need to worry about this broadcast. This is only sent to registered receivers,
3269 * not manifest receivers.
3270 */
3271 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3272 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3273
3274 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003275 * Broadcast sent to the primary user when an associated managed profile has become available.
3276 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003277 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3278 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3279 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003280 */
Rubin Xue95057a2016-04-01 16:49:25 +01003281 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3282 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3283
3284 /**
3285 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3286 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3287 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3288 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3289 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3290 */
3291 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3292 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003293
3294 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003295 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3296 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3297 * the device was locked or unlocked.
3298 *
3299 * This is only sent to registered receivers.
3300 *
3301 * @hide
3302 */
3303 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3304 "android.intent.action.DEVICE_LOCKED_CHANGED";
3305
3306 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003307 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3308 */
3309 public static final String ACTION_QUICK_CLOCK =
3310 "android.intent.action.QUICK_CLOCK";
3311
Michael Wright0087a142013-02-05 16:29:39 -08003312 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003313 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003314 * @hide
3315 */
3316 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003317 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003318
Justin Kohd378ad72013-04-01 12:18:26 -07003319 /**
3320 * Broadcast Action: A global button was pressed. Includes a single
3321 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3322 * caused the broadcast.
3323 * @hide
3324 */
Sujith Ramakrishnan48e19c82017-04-24 15:57:58 -07003325 @SystemApi
Justin Kohd378ad72013-04-01 12:18:26 -07003326 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3327
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003328 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003329 * Broadcast Action: Sent when media resource is granted.
3330 * <p>
3331 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3332 * granted.
3333 * </p>
3334 * <p class="note">
3335 * This is a protected intent that can only be sent by the system.
3336 * </p>
3337 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003338 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003339 * </p>
3340 *
3341 * @hide
3342 */
3343 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3344 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3345
3346 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003347 * Broadcast Action: An overlay package has changed. The data contains the
3348 * name of the overlay package which has changed. This is broadcast on all
3349 * changes to the OverlayInfo returned by {@link
3350 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3351 * most common change is a state change that will change whether the
3352 * overlay is enabled or not.
3353 * @hide
3354 */
3355 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3356
3357 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003358 * Activity Action: Allow the user to select and return one or more existing
3359 * documents. When invoked, the system will display the various
3360 * {@link DocumentsProvider} instances installed on the device, letting the
3361 * user interactively navigate through them. These documents include local
3362 * media, such as photos and video, and documents provided by installed
3363 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003364 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003365 * Each document is represented as a {@code content://} URI backed by a
3366 * {@link DocumentsProvider}, which can be opened as a stream with
3367 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3368 * {@link android.provider.DocumentsContract.Document} metadata.
3369 * <p>
3370 * All selected documents are returned to the calling application with
3371 * persistable read and write permission grants. If you want to maintain
3372 * access to the documents across device reboots, you need to explicitly
3373 * take the persistable permissions using
3374 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3375 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003376 * Callers must indicate the acceptable document MIME types through
3377 * {@link #setType(String)}. For example, to select photos, use
3378 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3379 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3380 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003381 * <p>
3382 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003383 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3384 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003385 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003386 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3387 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003388 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003389 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003390 * Callers can set a document URI through
3391 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3392 * location of documents navigator. System will do its best to launch the
3393 * navigator in the specified document if it's a folder, or the folder that
3394 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003395 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003396 * Output: The URI of the item that was picked, returned in
3397 * {@link #getData()}. This must be a {@code content://} URI so that any
3398 * receiver can access it. If multiple documents were selected, they are
3399 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003400 *
3401 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003402 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003403 * @see #ACTION_CREATE_DOCUMENT
3404 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003405 */
3406 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3407 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3408
3409 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003410 * Activity Action: Allow the user to create a new document. When invoked,
3411 * the system will display the various {@link DocumentsProvider} instances
3412 * installed on the device, letting the user navigate through them. The
3413 * returned document may be a newly created document with no content, or it
3414 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003415 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003416 * Each document is represented as a {@code content://} URI backed by a
3417 * {@link DocumentsProvider}, which can be opened as a stream with
3418 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3419 * {@link android.provider.DocumentsContract.Document} metadata.
3420 * <p>
3421 * Callers must indicate the concrete MIME type of the document being
3422 * created by setting {@link #setType(String)}. This MIME type cannot be
3423 * changed after the document is created.
3424 * <p>
3425 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3426 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003427 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003428 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3429 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003430 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003431 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003432 * Callers can set a document URI through
3433 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3434 * location of documents navigator. System will do its best to launch the
3435 * navigator in the specified document if it's a folder, or the folder that
3436 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003437 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003438 * Output: The URI of the item that was created. This must be a
3439 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003440 *
3441 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003442 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003443 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003444 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003445 */
3446 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3447 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3448
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003449 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003450 * Activity Action: Allow the user to pick a directory subtree. When
3451 * invoked, the system will display the various {@link DocumentsProvider}
3452 * instances installed on the device, letting the user navigate through
3453 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003454 * <p>
3455 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003456 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3457 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3458 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003459 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003460 * Callers can set a document URI through
3461 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3462 * location of documents navigator. System will do its best to launch the
3463 * navigator in the specified document if it's a folder, or the folder that
3464 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003465 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003466 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003467 *
3468 * @see DocumentsContract
3469 */
3470 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003471 public static final String
3472 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003473
Felipe Lemec7b1f892016-01-15 15:02:31 -08003474 /**
Peng Xua35b5532016-01-20 00:05:45 -08003475 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3476 * exisiting sensor being disconnected.
3477 *
3478 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3479 *
3480 * {@hide}
3481 */
3482 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3483 public static final String
3484 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3485
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003486 /**
Sam Line707f832017-04-13 17:00:55 -07003487 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003488 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003489 * @removed
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003490 */
3491 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003492 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003493 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3494
Christopher Tate6597e342015-02-17 12:15:25 -08003495 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003496 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3497 * is about to be performed.
3498 * @hide
3499 */
3500 @SystemApi
3501 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3502 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3503 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3504
3505 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003506 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3507 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3508 *
3509 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3510 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003511 * @hide
3512 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003513 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003514 public static final String EXTRA_FORCE_MASTER_CLEAR =
3515 "android.intent.extra.FORCE_MASTER_CLEAR";
3516
3517 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003518 * A broadcast action to trigger a factory reset.
3519 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003520 * <p>The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission. The
3521 * reason for the factory reset should be specified as {@link #EXTRA_REASON}.
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003522 *
3523 * <p>Not for use by third-party applications.
3524 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003525 * @see #EXTRA_FORCE_FACTORY_RESET
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003526 *
3527 * {@hide}
3528 */
3529 @SystemApi
3530 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3531 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3532
3533 /**
3534 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3535 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3536 *
3537 * <p>Not for use by third-party applications.
3538 *
3539 * @hide
3540 */
3541 @SystemApi
3542 public static final String EXTRA_FORCE_FACTORY_RESET =
3543 "android.intent.extra.FORCE_FACTORY_RESET";
3544
3545 /**
Michal Karpinski6135a262017-08-11 10:45:58 +01003546 * Broadcast action: report that a settings element is being restored from backup. The intent
3547 * contains four extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3548 * EXTRA_SETTING_NEW_VALUE is the value being restored, EXTRA_SETTING_PREVIOUS_VALUE
3549 * is the value of that settings entry prior to the restore operation, and
3550 * EXTRA_SETTING_RESTORED_FROM_SDK_INT is the version of the SDK that the setting has been
3551 * restored from (corresponds to {@link android.os.Build.VERSION#SDK_INT}). The first three
3552 * values are represented as strings, the fourth one as int.
Christopher Tate6597e342015-02-17 12:15:25 -08003553 *
3554 * <p>This broadcast is sent only for settings provider entries known to require special handling
3555 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3556 * the provider's backup agent implementation.
3557 *
3558 * @see #EXTRA_SETTING_NAME
3559 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3560 * @see #EXTRA_SETTING_NEW_VALUE
Michal Karpinski6135a262017-08-11 10:45:58 +01003561 * @see #EXTRA_SETTING_RESTORED_FROM_SDK_INT
Christopher Tate6597e342015-02-17 12:15:25 -08003562 * {@hide}
3563 */
3564 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3565
3566 /** {@hide} */
3567 public static final String EXTRA_SETTING_NAME = "setting_name";
3568 /** {@hide} */
3569 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3570 /** {@hide} */
3571 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
Michal Karpinski6135a262017-08-11 10:45:58 +01003572 /** {@hide} */
3573 public static final String EXTRA_SETTING_RESTORED_FROM_SDK_INT = "restored_from_sdk_int";
Christopher Tate6597e342015-02-17 12:15:25 -08003574
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003575 /**
3576 * Activity Action: Process a piece of text.
3577 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3578 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3579 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3580 */
3581 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3582 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003583
3584 /**
3585 * Broadcast Action: The sim card state has changed.
3586 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3587 * because TelephonyIntents is an internal class.
3588 * @hide
Amit Mahajan052e1e22018-01-12 17:40:29 -08003589 * @deprecated Use {@link #ACTION_SIM_CARD_STATE_CHANGED} or
3590 * {@link #ACTION_SIM_APPLICATION_STATE_CHANGED}
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003591 */
Amit Mahajan052e1e22018-01-12 17:40:29 -08003592 @Deprecated
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003593 @SystemApi
3594 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3595 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3596
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003597 /**
fionaxu90fee272017-03-31 12:45:12 -07003598 * Broadcast Action: indicate that the phone service state has changed.
3599 * The intent will have the following extra values:</p>
3600 * <p>
3601 * @see #EXTRA_VOICE_REG_STATE
3602 * @see #EXTRA_DATA_REG_STATE
3603 * @see #EXTRA_VOICE_ROAMING_TYPE
3604 * @see #EXTRA_DATA_ROAMING_TYPE
3605 * @see #EXTRA_OPERATOR_ALPHA_LONG
3606 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3607 * @see #EXTRA_OPERATOR_NUMERIC
3608 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3609 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3610 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3611 * @see #EXTRA_MANUAL
3612 * @see #EXTRA_VOICE_RADIO_TECH
3613 * @see #EXTRA_DATA_RADIO_TECH
3614 * @see #EXTRA_CSS_INDICATOR
3615 * @see #EXTRA_NETWORK_ID
3616 * @see #EXTRA_SYSTEM_ID
3617 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3618 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3619 * @see #EXTRA_EMERGENCY_ONLY
3620 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3621 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3622 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3623 *
3624 * <p class="note">
3625 * Requires the READ_PHONE_STATE permission.
3626 *
3627 * <p class="note">This is a protected intent that can only be sent by the system.
3628 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003629 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003630 */
3631 @Deprecated
3632 @SystemApi
3633 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3634 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3635
3636 /**
3637 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3638 * state.
3639 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3640 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3641 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3642 * @see android.telephony.ServiceState#STATE_POWER_OFF
3643 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003644 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003645 */
3646 @Deprecated
3647 @SystemApi
3648 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3649
3650 /**
3651 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3652 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3653 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3654 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3655 * @see android.telephony.ServiceState#STATE_POWER_OFF
3656 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003657 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003658 */
3659 @Deprecated
3660 @SystemApi
3661 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3662
3663 /**
3664 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3665 * type.
3666 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003667 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003668 */
3669 @Deprecated
3670 @SystemApi
3671 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3672
3673 /**
3674 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3675 * type.
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_DATA_ROAMING_TYPE = "dataRoamingType";
3682
3683 /**
3684 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3685 * registered voice operator name in long alphanumeric format.
3686 * {@code null} if the operator name is not known or unregistered.
3687 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003688 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003689 */
3690 @Deprecated
3691 @SystemApi
3692 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3693
3694 /**
3695 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3696 * registered voice operator name in short alphanumeric format.
3697 * {@code null} if the operator name is not known or unregistered.
3698 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003699 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003700 */
3701 @Deprecated
3702 @SystemApi
3703 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3704
3705 /**
3706 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3707 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3708 * network.
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_OPERATOR_NUMERIC = "operator-numeric";
3715
3716 /**
3717 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3718 * registered data 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_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3726
3727 /**
3728 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3729 * registered data 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_DATA_OPERATOR_ALPHA_SHORT = "data-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
3741 * data operator.
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_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3748
3749 /**
3750 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3751 * network selection mode is manual.
3752 * Will be {@code true} if manual mode, {@code false} if automatic mode.
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_MANUAL = "manual";
3759
3760 /**
3761 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3762 * radio technology.
3763 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003764 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003765 */
3766 @Deprecated
3767 @SystemApi
3768 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3769
3770 /**
3771 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3772 * radio technology.
3773 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003774 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003775 */
3776 @Deprecated
3777 @SystemApi
3778 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3779
3780 /**
3781 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3782 * support on CDMA network.
3783 * Will be {@code true} if support, {@code false} otherwise.
3784 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003785 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003786 */
3787 @Deprecated
3788 @SystemApi
3789 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3790
3791 /**
3792 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3793 * id. {@code Integer.MAX_VALUE} if unknown.
3794 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003795 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003796 */
3797 @Deprecated
3798 @SystemApi
3799 public static final String EXTRA_NETWORK_ID = "networkId";
3800
3801 /**
3802 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3803 * {@code Integer.MAX_VALUE} if unknown.
3804 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003805 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003806 */
3807 @Deprecated
3808 @SystemApi
3809 public static final String EXTRA_SYSTEM_ID = "systemId";
3810
3811 /**
3812 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3813 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3814 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003815 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003816 */
3817 @Deprecated
3818 @SystemApi
3819 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3820
3821 /**
3822 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3823 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3824 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003825 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003826 */
3827 @Deprecated
3828 @SystemApi
3829 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3830
3831 /**
3832 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3833 * only mode.
3834 * {@code true} if in emergency only mode, {@code false} otherwise.
3835 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003836 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003837 */
3838 @Deprecated
3839 @SystemApi
3840 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3841
3842 /**
3843 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3844 * registration state is roaming.
3845 * {@code true} if registration indicates roaming, {@code false} otherwise
3846 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003847 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003848 */
3849 @Deprecated
3850 @SystemApi
3851 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
3852 "isDataRoamingFromRegistration";
3853
3854 /**
3855 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
3856 * aggregation is in use.
3857 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
3858 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003859 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003860 */
3861 @Deprecated
3862 @SystemApi
3863 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
3864
3865 /**
3866 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
3867 * is reduced from the rsrp threshold while calculating signal strength level.
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_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
3874
3875 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003876 * The name of the extra used to define the text to be processed, as a
3877 * CharSequence. Note that this may be a styled CharSequence, so you must use
3878 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003879 */
3880 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3881 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003882 * 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 +00003883 */
3884 public static final String EXTRA_PROCESS_TEXT_READONLY =
3885 "android.intent.extra.PROCESS_TEXT_READONLY";
3886
Bryce Leebc58f592015-09-25 16:43:01 -07003887 /**
3888 * Broadcast action: reports when a new thermal event has been reached. When the device
3889 * is reaching its maximum temperatue, the thermal level reported
3890 * {@hide}
3891 */
3892 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3893 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3894
3895 /** {@hide} */
3896 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3897
3898 /**
3899 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003900 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003901 * {@hide}
3902 */
3903 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3904
3905 /**
3906 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003907 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003908 * {@hide}
3909 */
3910 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3911
3912 /**
3913 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003914 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003915 * {@hide}
3916 */
3917 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3918
3919
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003920 // ---------------------------------------------------------------------
3921 // ---------------------------------------------------------------------
3922 // Standard intent categories (see addCategory()).
3923
3924 /**
3925 * Set if the activity should be an option for the default action
3926 * (center press) to perform on a piece of data. Setting this will
3927 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003928 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003929 * Intent when initiating an action -- it is for use in intent filters
3930 * specified in packages.
3931 */
3932 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3933 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3934 /**
3935 * Activities that can be safely invoked from a browser must support this
3936 * category. For example, if the user is viewing a web page or an e-mail
3937 * and clicks on a link in the text, the Intent generated execute that
3938 * link will require the BROWSABLE category, so that only activities
3939 * supporting this category will be considered as possible actions. By
3940 * supporting this category, you are promising that there is nothing
3941 * damaging (without user intervention) that can happen by invoking any
3942 * matching Intent.
3943 */
3944 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3945 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3946 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003947 * Categories for activities that can participate in voice interaction.
3948 * An activity that supports this category must be prepared to run with
3949 * no UI shown at all (though in some case it may have a UI shown), and
3950 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3951 */
3952 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3953 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3954 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003955 * Set if the activity should be considered as an alternative action to
3956 * the data the user is currently viewing. See also
3957 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3958 * applies to the selection in a list of items.
3959 *
3960 * <p>Supporting this category means that you would like your activity to be
3961 * displayed in the set of alternative things the user can do, usually as
3962 * part of the current activity's options menu. You will usually want to
3963 * include a specific label in the &lt;intent-filter&gt; of this action
3964 * describing to the user what it does.
3965 *
3966 * <p>The action of IntentFilter with this category is important in that it
3967 * describes the specific action the target will perform. This generally
3968 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3969 * a specific name such as "com.android.camera.action.CROP. Only one
3970 * alternative of any particular action will be shown to the user, so using
3971 * a specific action like this makes sure that your alternative will be
3972 * displayed while also allowing other applications to provide their own
3973 * overrides of that particular action.
3974 */
3975 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3976 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3977 /**
3978 * Set if the activity should be considered as an alternative selection
3979 * action to the data the user has currently selected. This is like
3980 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3981 * of items from which the user can select, giving them alternatives to the
3982 * default action that will be performed on it.
3983 */
3984 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3985 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3986 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003987 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003988 */
3989 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3990 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3991 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003992 * Should be displayed in the top-level launcher.
3993 */
3994 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3995 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3996 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003997 * Indicates an activity optimized for Leanback mode, and that should
3998 * be displayed in the Leanback launcher.
3999 */
4000 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4001 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
4002 /**
Roberto Perez7ee1a7a2017-12-04 17:14:33 -08004003 * Indicates the preferred entry-point activity when an application is launched from a Car
4004 * launcher. If not present, Car launcher can optionally use {@link #CATEGORY_LAUNCHER} as a
4005 * fallback, or exclude the application entirely.
4006 * @hide
4007 */
4008 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4009 public static final String CATEGORY_CAR_LAUNCHER = "android.intent.category.CAR_LAUNCHER";
4010 /**
Jose Lima73915cf2014-07-29 17:16:31 -07004011 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
4012 * @hide
4013 */
4014 @SystemApi
4015 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
4016 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004017 * Provides information about the package it is in; typically used if
4018 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
4019 * a front-door to the user without having to be shown in the all apps list.
4020 */
4021 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4022 public static final String CATEGORY_INFO = "android.intent.category.INFO";
4023 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004024 * This is the home activity, that is the first activity that is displayed
4025 * when the device boots.
4026 */
4027 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4028 public static final String CATEGORY_HOME = "android.intent.category.HOME";
4029 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07004030 * This is the home activity that is displayed when the device is finished setting up and ready
4031 * for use.
4032 * @hide
4033 */
4034 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4035 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
4036 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07004037 * This is the setup wizard activity, that is the first activity that is displayed
4038 * when the user sets up the device for the first time.
4039 * @hide
4040 */
4041 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4042 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
4043 /**
Svet Ganov5bb6bc62017-08-28 12:39:35 -07004044 * This is the home activity, that is the activity that serves as the launcher app
4045 * from there the user can start other apps. Often components with lower/higher
4046 * priority intent filters handle the home intent, for example SetupWizard, to
4047 * setup the device and we need to be able to distinguish the home app from these
4048 * setup helpers.
4049 * @hide
4050 */
4051 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4052 public static final String CATEGORY_LAUNCHER_APP = "android.intent.category.LAUNCHER_APP";
4053 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004054 * This activity is a preference panel.
4055 */
4056 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4057 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
4058 /**
4059 * This activity is a development preference panel.
4060 */
4061 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4062 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
4063 /**
4064 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004065 */
4066 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4067 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
4068 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07004069 * This activity allows the user to browse and download new applications.
4070 */
4071 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4072 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
4073 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004074 * This activity may be exercised by the monkey or other automated test tools.
4075 */
4076 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4077 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
4078 /**
4079 * To be used as a test (not part of the normal user experience).
4080 */
4081 public static final String CATEGORY_TEST = "android.intent.category.TEST";
4082 /**
4083 * To be used as a unit test (run through the Test Harness).
4084 */
4085 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
4086 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004087 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004088 * experience).
4089 */
4090 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004091
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004092 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004093 * Used to indicate that an intent only wants URIs that can be opened with
4094 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
4095 * must support at least the columns defined in {@link OpenableColumns} when
4096 * queried.
4097 *
4098 * @see #ACTION_GET_CONTENT
4099 * @see #ACTION_OPEN_DOCUMENT
4100 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004101 */
4102 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4103 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
4104
4105 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09004106 * Used to indicate that an intent filter can accept files which are not necessarily
4107 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
4108 * at least streamable via
4109 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
4110 * using one of the stream types exposed via
4111 * {@link ContentResolver#getStreamTypes(Uri, String)}.
4112 *
4113 * @see #ACTION_SEND
4114 * @see #ACTION_SEND_MULTIPLE
4115 */
4116 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4117 public static final String CATEGORY_TYPED_OPENABLE =
4118 "android.intent.category.TYPED_OPENABLE";
4119
4120 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004121 * To be used as code under test for framework instrumentation tests.
4122 */
4123 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
4124 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04004125 /**
4126 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004127 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4128 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004129 */
4130 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4131 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
4132 /**
4133 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004134 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4135 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004136 */
4137 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4138 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004139 /**
4140 * An activity to run when device is inserted into a analog (low end) dock.
4141 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4142 * information, see {@link android.app.UiModeManager}.
4143 */
4144 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4145 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
4146
4147 /**
4148 * An activity to run when device is inserted into a digital (high end) dock.
4149 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4150 * information, see {@link android.app.UiModeManager}.
4151 */
4152 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4153 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004154
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004155 /**
4156 * Used to indicate that the activity can be used in a car environment.
4157 */
4158 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4159 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4160
Zak Cohendb6ca492017-01-26 14:09:00 -08004161 /**
4162 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4163 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4164 * information, see {@link android.app.UiModeManager}.
4165 */
4166 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4167 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004168 // ---------------------------------------------------------------------
4169 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004170 // Application launch intent categories (see addCategory()).
4171
4172 /**
4173 * Used with {@link #ACTION_MAIN} to launch the browser application.
4174 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004175 * <p>NOTE: This should not be used as the primary key of an Intent,
4176 * since it will not result in the app launching with the correct
4177 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004178 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004179 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004180 */
4181 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4182 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4183
4184 /**
4185 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4186 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004187 * <p>NOTE: This should not be used as the primary key of an Intent,
4188 * since it will not result in the app launching with the correct
4189 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004190 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004191 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004192 */
4193 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4194 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4195
4196 /**
4197 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4198 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004199 * <p>NOTE: This should not be used as the primary key of an Intent,
4200 * since it will not result in the app launching with the correct
4201 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004202 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004203 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004204 */
4205 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4206 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4207
4208 /**
4209 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4210 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004211 * <p>NOTE: This should not be used as the primary key of an Intent,
4212 * since it will not result in the app launching with the correct
4213 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004214 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004215 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004216 */
4217 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4218 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4219
4220 /**
4221 * Used with {@link #ACTION_MAIN} to launch the email application.
4222 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004223 * <p>NOTE: This should not be used as the primary key of an Intent,
4224 * since it will not result in the app launching with the correct
4225 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004226 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004227 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004228 */
4229 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4230 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4231
4232 /**
4233 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4234 * The activity should be able to view and manipulate image and video files
4235 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004236 * <p>NOTE: This should not be used as the primary key of an Intent,
4237 * since it will not result in the app launching with the correct
4238 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004239 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004240 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004241 */
4242 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4243 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4244
4245 /**
4246 * Used with {@link #ACTION_MAIN} to launch the maps application.
4247 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004248 * <p>NOTE: This should not be used as the primary key of an Intent,
4249 * since it will not result in the app launching with the correct
4250 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004251 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004252 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004253 */
4254 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4255 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4256
4257 /**
4258 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4259 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004260 * <p>NOTE: This should not be used as the primary key of an Intent,
4261 * since it will not result in the app launching with the correct
4262 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004263 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004264 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004265 */
4266 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4267 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4268
4269 /**
4270 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004271 * The activity should be able to play, browse, or manipulate music files
4272 * stored on the device.
4273 * <p>NOTE: This should not be used as the primary key of an Intent,
4274 * since it will not result in the app launching with the correct
4275 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004276 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004277 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004278 */
4279 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4280 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4281
4282 // ---------------------------------------------------------------------
4283 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004284 // Standard extra data keys.
4285
4286 /**
4287 * The initial data to place in a newly created record. Use with
4288 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4289 * fields as would be given to the underlying ContentProvider.insert()
4290 * call.
4291 */
4292 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4293
4294 /**
4295 * A constant CharSequence that is associated with the Intent, used with
4296 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4297 * this may be a styled CharSequence, so you must use
4298 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4299 * retrieve it.
4300 */
4301 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4302
4303 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004304 * A constant String that is associated with the Intent, used with
4305 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4306 * as HTML formatted text. Note that you <em>must</em> also supply
4307 * {@link #EXTRA_TEXT}.
4308 */
4309 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4310
4311 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004312 * A content: URI holding a stream of data associated with the Intent,
4313 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004314 */
4315 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4316
4317 /**
4318 * A String[] holding e-mail addresses that should be delivered to.
4319 */
4320 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4321
4322 /**
4323 * A String[] holding e-mail addresses that should be carbon copied.
4324 */
4325 public static final String EXTRA_CC = "android.intent.extra.CC";
4326
4327 /**
4328 * A String[] holding e-mail addresses that should be blind carbon copied.
4329 */
4330 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4331
4332 /**
4333 * A constant string holding the desired subject line of a message.
4334 */
4335 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4336
4337 /**
4338 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004339 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004340 */
4341 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4342
4343 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004344 * An int representing the user id to be used.
4345 *
4346 * @hide
4347 */
4348 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4349
4350 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004351 * An int representing the task id to be retrieved. This is used when a launch from recents is
4352 * intercepted by another action such as credentials confirmation to remember which task should
4353 * be resumed when complete.
4354 *
4355 * @hide
4356 */
4357 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4358
4359 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004360 * An Intent[] describing additional, alternate choices you would like shown with
4361 * {@link #ACTION_CHOOSER}.
4362 *
4363 * <p>An app may be capable of providing several different payload types to complete a
4364 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4365 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4366 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4367 * photo data or a hosted link where the photos can be viewed.</p>
4368 *
4369 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4370 * first/primary/preferred intent in the set. Additional intents specified in
4371 * this extra are ordered; by default intents that appear earlier in the array will be
4372 * preferred over intents that appear later in the array as matches for the same
4373 * target component. To alter this preference, a calling app may also supply
4374 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4375 */
4376 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4377
4378 /**
Adam Powell52c39212016-04-07 15:14:18 -07004379 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4380 * and omitted from a list of components presented to the user.
4381 *
4382 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4383 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4384 * from your own package or other apps from your organization if the idea of sending to those
4385 * targets would be redundant with other app functionality. Filtered components will not
4386 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4387 */
4388 public static final String EXTRA_EXCLUDE_COMPONENTS
4389 = "android.intent.extra.EXCLUDE_COMPONENTS";
4390
4391 /**
4392 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4393 * describing additional high-priority deep-link targets for the chooser to present to the user.
4394 *
4395 * <p>Targets provided in this way will be presented inline with all other targets provided
4396 * by services from other apps. They will be prioritized before other service targets, but
4397 * after those targets provided by sources that the user has manually pinned to the front.</p>
4398 *
4399 * @see #ACTION_CHOOSER
4400 */
4401 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4402
4403 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004404 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4405 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4406 *
4407 * <p>An app preparing an action for another app to complete may wish to allow the user to
4408 * disambiguate between several options for completing the action based on the chosen target
4409 * or otherwise refine the action before it is invoked.
4410 * </p>
4411 *
4412 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4413 * <ul>
4414 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4415 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4416 * chosen target beyond the first</li>
4417 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4418 * should fill in and send once the disambiguation is complete</li>
4419 * </ul>
4420 */
4421 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4422 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4423
4424 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004425 * An {@code ArrayList} of {@code String} annotations describing content for
4426 * {@link #ACTION_CHOOSER}.
4427 *
4428 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4429 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4430 *
4431 * <p>Annotations should describe the major components or topics of the content. It is up to
4432 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4433 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004434 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4435 * character. Performance on customized annotations can suffer, if they are rarely used for
4436 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4437 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004438 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004439 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004440 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004441 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004442 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004443 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004444 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004445 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004446 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004447 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4448 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4449 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4450 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4451 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004452 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004453 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4454 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004455 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004456 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004457 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004458 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004459 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004460 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004461 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004462 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004463 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004464 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004465 * Christmas and Thanksgiving.</li>
4466 * </ul>
4467 */
4468 public static final String EXTRA_CONTENT_ANNOTATIONS
4469 = "android.intent.extra.CONTENT_ANNOTATIONS";
4470
4471 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004472 * A {@link ResultReceiver} used to return data back to the sender.
4473 *
4474 * <p>Used to complete an app-specific
4475 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4476 *
4477 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4478 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4479 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4480 * when the user selects a target component from the chooser. It is up to the recipient
4481 * to send a result to this ResultReceiver to signal that disambiguation is complete
4482 * and that the chooser should invoke the user's choice.</p>
4483 *
4484 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4485 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4486 * to match and fill in the final Intent or ChooserTarget before starting it.
4487 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4488 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4489 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4490 *
4491 * <p>The result code passed to the ResultReceiver should be
4492 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4493 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4494 * the chooser should finish without starting a target.</p>
4495 */
4496 public static final String EXTRA_RESULT_RECEIVER
4497 = "android.intent.extra.RESULT_RECEIVER";
4498
4499 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004500 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004501 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004502 */
4503 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4504
4505 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004506 * A Parcelable[] of {@link Intent} or
4507 * {@link android.content.pm.LabeledIntent} objects as set with
4508 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4509 * a the front of the list of choices, when shown to the user with a
4510 * {@link #ACTION_CHOOSER}.
4511 */
4512 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4513
4514 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004515 * A {@link IntentSender} to start after ephemeral installation success.
Patrick Baumann159cd022018-01-11 13:25:05 -08004516 * @deprecated Use {@link #EXTRA_INSTANT_APP_SUCCESS).
4517 * @removed
Todd Kennedy7440f172015-12-09 14:31:22 -08004518 * @hide
4519 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004520 @Deprecated
Todd Kennedy7440f172015-12-09 14:31:22 -08004521 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4522
4523 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004524 * A {@link IntentSender} to start after instant app installation success.
Todd Kennedy7440f172015-12-09 14:31:22 -08004525 * @hide
4526 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004527 @SystemApi
4528 public static final String EXTRA_INSTANT_APP_SUCCESS =
4529 "android.intent.extra.INSTANT_APP_SUCCESS";
4530
4531 /**
4532 * A {@link IntentSender} to start after ephemeral installation failure.
4533 * @deprecated Use {@link #EXTRA_INSTANT_APP_FAILURE).
4534 * @removed
4535 * @hide
4536 */
4537 @Deprecated
Todd Kennedy7440f172015-12-09 14:31:22 -08004538 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4539
4540 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004541 * A {@link IntentSender} to start after instant app installation failure.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004542 * @hide
4543 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004544 @SystemApi
4545 public static final String EXTRA_INSTANT_APP_FAILURE =
4546 "android.intent.extra.INSTANT_APP_FAILURE";
4547
4548 /**
4549 * The host name that triggered an ephemeral resolution.
4550 * @deprecated Use {@link #EXTRA_INSTANT_APP_HOSTNAME).
4551 * @removed
4552 * @hide
4553 */
4554 @Deprecated
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004555 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4556
4557 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004558 * The host name that triggered an instant app resolution.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004559 * @hide
4560 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004561 @SystemApi
4562 public static final String EXTRA_INSTANT_APP_HOSTNAME =
4563 "android.intent.extra.INSTANT_APP_HOSTNAME";
4564
4565 /**
4566 * An opaque token to track ephemeral resolution.
4567 * @deprecated Use {@link #EXTRA_INSTANT_APP_TOKEN).
4568 * @removed
4569 * @hide
4570 */
4571 @Deprecated
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004572 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4573
4574 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004575 * An opaque token to track instant app resolution.
4576 * @hide
4577 */
4578 @SystemApi
4579 public static final String EXTRA_INSTANT_APP_TOKEN =
4580 "android.intent.extra.INSTANT_APP_TOKEN";
4581
4582 /**
Patrick Baumannb4165d72017-12-04 11:29:24 -08004583 * The action that triggered an instant application resolution.
4584 * @hide
4585 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004586 @SystemApi
Patrick Baumannb4165d72017-12-04 11:29:24 -08004587 public static final String EXTRA_INSTANT_APP_ACTION = "android.intent.extra.INSTANT_APP_ACTION";
4588
4589 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004590 * An array of {@link Bundle}s containing details about resolved instant apps..
4591 * @hide
4592 */
4593 @SystemApi
4594 public static final String EXTRA_INSTANT_APP_BUNDLES =
4595 "android.intent.extra.INSTANT_APP_BUNDLES";
4596
4597 /**
4598 * A {@link Bundle} of metadata that describes the instant application that needs to be
Patrick Baumann709ee152017-12-04 16:12:52 -08004599 * installed. This data is populated from the response to
4600 * {@link android.content.pm.InstantAppResolveInfo#getExtras()} as provided by the registered
4601 * instant application resolver.
4602 * @hide
4603 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004604 @SystemApi
Patrick Baumann709ee152017-12-04 16:12:52 -08004605 public static final String EXTRA_INSTANT_APP_EXTRAS =
4606 "android.intent.extra.INSTANT_APP_EXTRAS";
4607
4608 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004609 * A boolean value indicating that the instant app resolver was unable to state with certainty
4610 * that it did or did not have an app for the sanitized {@link Intent} defined at
4611 * {@link #EXTRA_INTENT}.
4612 * @hide
4613 */
4614 @SystemApi
4615 public static final String EXTRA_UNKNOWN_INSTANT_APP =
4616 "android.intent.extra.UNKNOWN_INSTANT_APP";
4617
4618 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004619 * The version code of the app to install components from.
Dianne Hackborn3accca02013-09-20 09:32:11 -07004620 * @deprecated Use {@link #EXTRA_LONG_VERSION_CODE).
Todd Kennedy316c2f22017-01-23 15:40:07 -08004621 * @hide
4622 */
Dianne Hackborn3accca02013-09-20 09:32:11 -07004623 @Deprecated
Todd Kennedy316c2f22017-01-23 15:40:07 -08004624 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4625
4626 /**
Dianne Hackborn3accca02013-09-20 09:32:11 -07004627 * The version code of the app to install components from.
4628 * @hide
4629 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004630 @SystemApi
Dianne Hackborn3accca02013-09-20 09:32:11 -07004631 public static final String EXTRA_LONG_VERSION_CODE = "android.intent.extra.LONG_VERSION_CODE";
4632
4633 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004634 * The app that triggered the instant app installation.
Chad Brubaker06068612017-04-06 09:43:47 -07004635 * @hide
4636 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004637 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004638 public static final String EXTRA_CALLING_PACKAGE
4639 = "android.intent.extra.CALLING_PACKAGE";
4640
4641 /**
4642 * Optional calling app provided bundle containing additional launch information the
4643 * installer may use.
4644 * @hide
4645 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004646 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004647 public static final String EXTRA_VERIFICATION_BUNDLE
4648 = "android.intent.extra.VERIFICATION_BUNDLE";
4649
4650 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004651 * A Bundle forming a mapping of potential target package names to different extras Bundles
4652 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4653 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4654 * be currently installed on the device.
4655 *
4656 * <p>An application may choose to provide alternate extras for the case where a user
4657 * selects an activity from a predetermined set of target packages. If the activity
4658 * the user selects from the chooser belongs to a package with its package name as
4659 * a key in this bundle, the corresponding extras for that package will be merged with
4660 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4661 * extra has the same key as an extra already present in the intent it will overwrite
4662 * the extra from the intent.</p>
4663 *
4664 * <p><em>Examples:</em>
4665 * <ul>
4666 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4667 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4668 * parameters for that target.</li>
4669 * <li>An application may offer additional metadata for known targets of a given intent
4670 * to pass along information only relevant to that target such as account or content
4671 * identifiers already known to that application.</li>
4672 * </ul></p>
4673 */
4674 public static final String EXTRA_REPLACEMENT_EXTRAS =
4675 "android.intent.extra.REPLACEMENT_EXTRAS";
4676
4677 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004678 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4679 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4680 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4681 * {@link ComponentName} of the chosen component.
4682 *
4683 * <p>In some situations this callback may never come, for example if the user abandons
4684 * the chooser, switches to another task or any number of other reasons. Apps should not
4685 * be written assuming that this callback will always occur.</p>
4686 */
4687 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4688 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4689
4690 /**
4691 * The {@link ComponentName} chosen by the user to complete an action.
4692 *
4693 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4694 */
4695 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4696
4697 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004698 * A {@link android.view.KeyEvent} object containing the event that
4699 * triggered the creation of the Intent it is in.
4700 */
4701 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4702
4703 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004704 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4705 * before shutting down.
4706 *
4707 * {@hide}
4708 */
4709 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4710
4711 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004712 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4713 * requested by the user.
4714 *
4715 * {@hide}
4716 */
4717 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4718 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4719
4720 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004721 * 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 -07004722 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4723 * of restarting the application.
4724 */
4725 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4726
4727 /**
4728 * A String holding the phone number originally entered in
4729 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4730 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4731 */
4732 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004733
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004734 /**
4735 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4736 * intents to supply the uid the package had been assigned. Also an optional
4737 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4738 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4739 * purpose.
4740 */
4741 public static final String EXTRA_UID = "android.intent.extra.UID";
4742
4743 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004744 * @hide String array of package names.
4745 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004746 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004747 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4748
4749 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004750 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4751 * intents to indicate whether this represents a full uninstall (removing
4752 * both the code and its data) or a partial uninstall (leaving its data,
4753 * implying that this is an update).
4754 */
4755 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004756
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004757 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004758 * @hide
4759 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4760 * intents to indicate that at this point the package has been removed for
4761 * all users on the device.
4762 */
4763 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4764 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4765
4766 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004767 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4768 * intents to indicate that this is a replacement of the package, so this
4769 * broadcast will immediately be followed by an add broadcast for a
4770 * different version of the same package.
4771 */
4772 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004773
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004774 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004775 * Used as an int extra field in {@link android.app.AlarmManager} intents
4776 * to tell the application being invoked how many pending alarms are being
4777 * delievered with the intent. For one-shot alarms this will always be 1.
4778 * For recurring alarms, this might be greater than 1 if the device was
4779 * asleep or powered off at the time an earlier alarm would have been
4780 * delivered.
4781 */
4782 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004783
Jacek Surazski86b6c532009-05-13 14:38:28 +02004784 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004785 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4786 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004787 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4788 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004789 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4790 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4791 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004792 */
4793 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4794
4795 /**
4796 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4797 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004798 */
4799 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4800
4801 /**
4802 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4803 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004804 */
4805 public static final int EXTRA_DOCK_STATE_DESK = 1;
4806
4807 /**
4808 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4809 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004810 */
4811 public static final int EXTRA_DOCK_STATE_CAR = 2;
4812
4813 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004814 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4815 * to represent that the phone is in a analog (low end) dock.
4816 */
4817 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4818
4819 /**
4820 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4821 * to represent that the phone is in a digital (high end) dock.
4822 */
4823 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4824
4825 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004826 * Boolean that can be supplied as meta-data with a dock activity, to
4827 * indicate that the dock should take over the home key when it is active.
4828 */
4829 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004830
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004831 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004832 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4833 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004834 */
4835 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4836
4837 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004838 * Used in the extra field in the remote intent. It's astring token passed with the
4839 * remote intent.
4840 */
4841 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4842 "android.intent.extra.remote_intent_token";
4843
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004844 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004845 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004846 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004847 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004848 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004849 "android.intent.extra.changed_component_name";
4850
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004851 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004852 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004853 * and contains a string array of all of the components that have changed. If
4854 * the state of the overall package has changed, then it will contain an entry
4855 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004856 */
4857 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4858 "android.intent.extra.changed_component_name_list";
4859
4860 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004861 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004862 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004863 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4864 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4865 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004866 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004867 */
4868 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4869 "android.intent.extra.changed_package_list";
4870
4871 /**
4872 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004873 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4874 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004875 * and contains an integer array of uids of all of the components
4876 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004877 */
4878 public static final String EXTRA_CHANGED_UID_LIST =
4879 "android.intent.extra.changed_uid_list";
4880
4881 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004882 * @hide
4883 * Magic extra system code can use when binding, to give a label for
4884 * who it is that has bound to a service. This is an integer giving
4885 * a framework string resource that can be displayed to the user.
4886 */
4887 public static final String EXTRA_CLIENT_LABEL =
4888 "android.intent.extra.client_label";
4889
4890 /**
4891 * @hide
4892 * Magic extra system code can use when binding, to give a PendingIntent object
4893 * that can be launched for the user to disable the system's use of this
4894 * service.
4895 */
4896 public static final String EXTRA_CLIENT_INTENT =
4897 "android.intent.extra.client_intent";
4898
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004899 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004900 * Extra used to indicate that an intent should only return data that is on
4901 * the local device. This is a boolean extra; the default is false. If true,
4902 * an implementation should only allow the user to select data that is
4903 * already on the device, not requiring it be downloaded from a remote
4904 * service when opened.
4905 *
4906 * @see #ACTION_GET_CONTENT
4907 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004908 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004909 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004910 */
4911 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004912 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004913
Amith Yamasani13593602012-03-22 16:16:17 -07004914 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004915 * Extra used to indicate that an intent can allow the user to select and
4916 * return multiple items. This is a boolean extra; the default is false. If
4917 * true, an implementation is allowed to present the user with a UI where
4918 * they can pick multiple items that are all returned to the caller. When
4919 * this happens, they should be returned as the {@link #getClipData()} part
4920 * of the result Intent.
4921 *
4922 * @see #ACTION_GET_CONTENT
4923 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004924 */
4925 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004926 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004927
4928 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004929 * The integer userHandle carried with broadcast intents related to addition, removal and
4930 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4931 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4932 *
Amith Yamasani13593602012-03-22 16:16:17 -07004933 * @hide
4934 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004935 public static final String EXTRA_USER_HANDLE =
4936 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004937
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004938 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004939 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4940 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4941 */
4942 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004943 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004944
4945 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004946 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004947 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4948 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004949 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004950 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4951
4952 /**
4953 * Extra sent in the intent to the BroadcastReceiver that handles
4954 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4955 * the restrictions as key/value pairs.
4956 */
4957 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4958 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004959
Amith Yamasani86118ba2013-03-28 14:33:16 -07004960 /**
4961 * Extra used in the response from a BroadcastReceiver that handles
4962 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4963 */
4964 public static final String EXTRA_RESTRICTIONS_INTENT =
4965 "android.intent.extra.restrictions_intent";
4966
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004967 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004968 * Extra used to communicate a set of acceptable MIME types. The type of the
4969 * extra is {@code String[]}. Values may be a combination of concrete MIME
4970 * types (such as "image/png") and/or partial MIME types (such as
4971 * "audio/*").
4972 *
4973 * @see #ACTION_GET_CONTENT
4974 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004975 */
4976 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4977
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004978 /**
4979 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4980 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004981 * When this is true, hardware devices can use this information to determine that
4982 * they shouldn't do a complete shutdown of their device since this is not a
4983 * complete shutdown down to the kernel, but only user space restarting.
4984 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004985 */
4986 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4987 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4988
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004989 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004990 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4991 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4992 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4993 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004994 *
4995 * @hide for internal use only.
4996 */
4997 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4998 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004999 /** @hide */
5000 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
5001 /** @hide */
5002 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
5003 /** @hide */
5004 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005005
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07005006 /**
5007 * Intent extra: the reason that the operation associated with this intent is being performed.
5008 *
5009 * <p>Type: String
5010 * @hide
5011 */
5012 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07005013 public static final String EXTRA_REASON = "android.intent.extra.REASON";
5014
qingxi240c2bb2017-04-12 17:31:18 -07005015 /**
5016 * {@hide}
5017 * This extra will be send together with {@link #ACTION_FACTORY_RESET}
5018 */
Rubin Xue8490f12015-06-25 12:17:48 +01005019 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
5020
Santos Cordon15a13782015-03-31 18:32:31 -07005021 /**
qingxi240c2bb2017-04-12 17:31:18 -07005022 * {@hide}
5023 * This extra will be set to true when the user choose to wipe the data on eSIM during factory
5024 * reset for the device with eSIM. This extra will be sent together with
5025 * {@link #ACTION_FACTORY_RESET}
5026 */
5027 public static final String EXTRA_WIPE_ESIMS = "com.android.internal.intent.extra.WIPE_ESIMS";
5028
5029 /**
Santos Cordon15a13782015-03-31 18:32:31 -07005030 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
5031 * activation request.
5032 * TODO: Add information about the structure and response data used with the pending intent.
5033 * @hide
5034 */
5035 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
5036 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
5037
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09005038 /**
5039 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09005040 *
5041 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07005042 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09005043 */
Steve McKay6eaf38632015-08-04 10:11:01 -07005044 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
5045
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005046 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09005047 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
5048 * such as opening in other apps, sharing, opening, editing, printing, deleting,
5049 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005050 *
5051 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07005052 * @see #ACTION_QUICK_VIEW
5053 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005054 */
Garfield Tance1d0e92017-03-23 10:52:48 -07005055 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09005056 public static final String EXTRA_QUICK_VIEW_ADVANCED =
5057 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005058
5059 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07005060 * An optional extra of {@code String[]} indicating which quick view features should be made
5061 * available to the user in the quick view UI while handing a
5062 * {@link Intent#ACTION_QUICK_VIEW} intent.
5063 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
5064 * Quick viewer can implement features not listed below.
5065 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
Geoffrey Pitschbc02b772017-12-06 11:24:15 -05005066 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DELETE},
5067 * {@link QuickViewConstants#FEATURE_DOWNLOAD}, {@link QuickViewConstants#FEATURE_SEND},
5068 * {@link QuickViewConstants#FEATURE_PRINT}.
Garfield Tance1d0e92017-03-23 10:52:48 -07005069 * <p>
5070 * Requirements:
5071 * <li>Quick viewer shouldn't show a feature if the feature is absent in
5072 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
5073 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
5074 * internal policies.
5075 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
5076 * requirement that the feature be shown. Quick viewer may, according to its own policies,
5077 * disable or hide features.
5078 *
5079 * @see #ACTION_QUICK_VIEW
5080 */
5081 public static final String EXTRA_QUICK_VIEW_FEATURES =
5082 "android.intent.extra.QUICK_VIEW_FEATURES";
5083
5084 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005085 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01005086 * When a profile goes into quiet mode, all apps in the profile are killed and the
5087 * profile user is stopped. Widgets originating from the profile are masked, and app
5088 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005089 */
5090 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005091
5092 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005093 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005094 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005095 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
5096 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005097 *
5098 * @hide
5099 */
5100 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
5101 "android.intent.extra.MEDIA_RESOURCE_TYPE";
5102
5103 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07005104 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
5105 * whether to show the chooser or not when there is only one application available
5106 * to choose from.
5107 *
5108 * @hide
5109 */
5110 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
5111 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
5112
5113 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005114 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005115 * to represent that a video codec is allowed to use.
5116 *
5117 * @hide
5118 */
5119 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
5120
5121 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005122 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005123 * to represent that a audio codec is allowed to use.
5124 *
5125 * @hide
5126 */
5127 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
5128
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005129 // ---------------------------------------------------------------------
5130 // ---------------------------------------------------------------------
5131 // Intent flags (see mFlags variable).
5132
Tor Norbyed9273d62013-05-30 15:59:53 -07005133 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005134 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005135 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
5136 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07005137 @Retention(RetentionPolicy.SOURCE)
5138 public @interface GrantUriMode {}
5139
Jeff Sharkey846318a2014-04-04 12:12:41 -07005140 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005141 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005142 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
5143 @Retention(RetentionPolicy.SOURCE)
5144 public @interface AccessUriMode {}
5145
5146 /**
5147 * Test if given mode flags specify an access mode, which must be at least
5148 * read and/or write.
5149 *
5150 * @hide
5151 */
5152 public static boolean isAccessUriMode(int modeFlags) {
5153 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
5154 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
5155 }
5156
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005157 /** @hide */
5158 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5159 FLAG_GRANT_READ_URI_PERMISSION,
5160 FLAG_GRANT_WRITE_URI_PERMISSION,
5161 FLAG_FROM_BACKGROUND,
5162 FLAG_DEBUG_LOG_RESOLUTION,
5163 FLAG_EXCLUDE_STOPPED_PACKAGES,
5164 FLAG_INCLUDE_STOPPED_PACKAGES,
5165 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
5166 FLAG_GRANT_PREFIX_URI_PERMISSION,
5167 FLAG_DEBUG_TRIAGED_MISSING,
5168 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005169 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005170 FLAG_ACTIVITY_NO_HISTORY,
5171 FLAG_ACTIVITY_SINGLE_TOP,
5172 FLAG_ACTIVITY_NEW_TASK,
5173 FLAG_ACTIVITY_MULTIPLE_TASK,
5174 FLAG_ACTIVITY_CLEAR_TOP,
5175 FLAG_ACTIVITY_FORWARD_RESULT,
5176 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5177 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5178 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5179 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5180 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5181 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5182 FLAG_ACTIVITY_NEW_DOCUMENT,
5183 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5184 FLAG_ACTIVITY_NO_USER_ACTION,
5185 FLAG_ACTIVITY_REORDER_TO_FRONT,
5186 FLAG_ACTIVITY_NO_ANIMATION,
5187 FLAG_ACTIVITY_CLEAR_TASK,
5188 FLAG_ACTIVITY_TASK_ON_HOME,
5189 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5190 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5191 FLAG_RECEIVER_REGISTERED_ONLY,
5192 FLAG_RECEIVER_REPLACE_PENDING,
5193 FLAG_RECEIVER_FOREGROUND,
5194 FLAG_RECEIVER_NO_ABORT,
5195 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5196 FLAG_RECEIVER_BOOT_UPGRADE,
5197 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5198 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5199 FLAG_RECEIVER_FROM_SHELL,
5200 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5201 })
5202 @Retention(RetentionPolicy.SOURCE)
5203 public @interface Flags {}
5204
5205 /** @hide */
5206 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5207 FLAG_FROM_BACKGROUND,
5208 FLAG_DEBUG_LOG_RESOLUTION,
5209 FLAG_EXCLUDE_STOPPED_PACKAGES,
5210 FLAG_INCLUDE_STOPPED_PACKAGES,
5211 FLAG_DEBUG_TRIAGED_MISSING,
5212 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005213 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005214 FLAG_ACTIVITY_NO_HISTORY,
5215 FLAG_ACTIVITY_SINGLE_TOP,
5216 FLAG_ACTIVITY_NEW_TASK,
5217 FLAG_ACTIVITY_MULTIPLE_TASK,
5218 FLAG_ACTIVITY_CLEAR_TOP,
5219 FLAG_ACTIVITY_FORWARD_RESULT,
5220 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5221 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5222 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5223 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5224 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5225 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5226 FLAG_ACTIVITY_NEW_DOCUMENT,
5227 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5228 FLAG_ACTIVITY_NO_USER_ACTION,
5229 FLAG_ACTIVITY_REORDER_TO_FRONT,
5230 FLAG_ACTIVITY_NO_ANIMATION,
5231 FLAG_ACTIVITY_CLEAR_TASK,
5232 FLAG_ACTIVITY_TASK_ON_HOME,
5233 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5234 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5235 FLAG_RECEIVER_REGISTERED_ONLY,
5236 FLAG_RECEIVER_REPLACE_PENDING,
5237 FLAG_RECEIVER_FOREGROUND,
5238 FLAG_RECEIVER_NO_ABORT,
5239 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5240 FLAG_RECEIVER_BOOT_UPGRADE,
5241 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5242 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5243 FLAG_RECEIVER_FROM_SHELL,
5244 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5245 })
5246 @Retention(RetentionPolicy.SOURCE)
5247 public @interface MutableFlags {}
5248
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005249 /**
5250 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005251 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005252 * specified in its ClipData. When applying to an Intent's ClipData,
5253 * all URIs as well as recursive traversals through data or other ClipData
5254 * in Intent items will be granted; only the grant flags of the top-level
5255 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005256 */
5257 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5258 /**
5259 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005260 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005261 * specified in its ClipData. When applying to an Intent's ClipData,
5262 * all URIs as well as recursive traversals through data or other ClipData
5263 * in Intent items will be granted; only the grant flags of the top-level
5264 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005265 */
5266 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5267 /**
5268 * Can be set by the caller to indicate that this Intent is coming from
5269 * a background operation, not from direct user interaction.
5270 */
5271 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5272 /**
5273 * A flag you can enable for debugging: when set, log messages will be
5274 * printed during the resolution of this intent to show you what has
5275 * been found to create the final resolved list.
5276 */
5277 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005278 /**
5279 * If set, this intent will not match any components in packages that
5280 * are currently stopped. If this is not set, then the default behavior
5281 * is to include such applications in the result.
5282 */
5283 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5284 /**
5285 * If set, this intent will always match any components in packages that
5286 * are currently stopped. This is the default behavior when
5287 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5288 * flags are set, this one wins (it allows overriding of exclude for
5289 * places where the framework may automatically set the exclude flag).
5290 */
5291 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005292
5293 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005294 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005295 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005296 * persisted across device reboots until explicitly revoked with
5297 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5298 * grant for possible persisting; the receiving application must call
5299 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5300 * actually persist.
5301 *
5302 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5303 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5304 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005305 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005306 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005307 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005308
5309 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005310 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5311 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5312 * applies to any URI that is a prefix match against the original granted
5313 * URI. (Without this flag, the URI must match exactly for access to be
5314 * granted.) Another URI is considered a prefix match only when scheme,
5315 * authority, and all path segments defined by the prefix are an exact
5316 * match.
5317 */
5318 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5319
5320 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005321 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005322 * homework and verified that they correctly handle packages and components
5323 * that come and go over time. In particular:
5324 * <ul>
5325 * <li>Apps installed on external storage, which will appear to be
5326 * uninstalled while the the device is ejected.
5327 * <li>Apps with encryption unaware components, which will appear to not
5328 * exist while the device is locked.
5329 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005330 *
5331 * @hide
5332 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005333 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005334
5335 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005336 * Internal flag used to indicate ephemeral applications should not be
5337 * considered when resolving the intent.
5338 *
5339 * @hide
5340 */
5341 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5342
5343 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005344 * If set, the new activity is not kept in the history stack. As soon as
5345 * the user navigates away from it, the activity is finished. This may also
5346 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5347 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005348 *
5349 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5350 * is never invoked when the current activity starts a new activity which
5351 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005352 */
5353 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5354 /**
5355 * If set, the activity will not be launched if it is already running
5356 * at the top of the history stack.
5357 */
5358 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5359 /**
5360 * If set, this activity will become the start of a new task on this
5361 * history stack. A task (from the activity that started it to the
5362 * next task activity) defines an atomic group of activities that the
5363 * user can move to. Tasks can be moved to the foreground and background;
5364 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005365 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005366 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5367 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005368 *
5369 * <p>This flag is generally used by activities that want
5370 * to present a "launcher" style behavior: they give the user a list of
5371 * separate things that can be done, which otherwise run completely
5372 * independently of the activity launching them.
5373 *
5374 * <p>When using this flag, if a task is already running for the activity
5375 * you are now starting, then a new activity will not be started; instead,
5376 * the current task will simply be brought to the front of the screen with
5377 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5378 * to disable this behavior.
5379 *
5380 * <p>This flag can not be used when the caller is requesting a result from
5381 * the activity being launched.
5382 */
5383 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5384 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005385 * This flag is used to create a new task and launch an activity into it.
5386 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5387 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5388 * search through existing tasks for ones matching this Intent. Only if no such
5389 * task is found would a new task be created. When paired with
5390 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5391 * the search for a matching task and unconditionally start a new task.
5392 *
5393 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5394 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005395 * top-level application launcher.</strong> Used in conjunction with
5396 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5397 * behavior of bringing an existing task to the foreground. When set,
5398 * a new task is <em>always</em> started to host the Activity for the
5399 * Intent, regardless of whether there is already an existing task running
5400 * the same thing.
5401 *
5402 * <p><strong>Because the default system does not include graphical task management,
5403 * you should not use this flag unless you provide some way for a user to
5404 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005405 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005406 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5407 * creating new document tasks.
5408 *
5409 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005410 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005411 *
Scott Main7aee61f2011-02-08 11:25:01 -08005412 * <p>See
5413 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5414 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005415 *
5416 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5417 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005418 */
5419 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5420 /**
5421 * If set, and the activity being launched is already running in the
5422 * current task, then instead of launching a new instance of that activity,
5423 * all of the other activities on top of it will be closed and this Intent
5424 * will be delivered to the (now on top) old activity as a new Intent.
5425 *
5426 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5427 * If D calls startActivity() with an Intent that resolves to the component
5428 * of activity B, then C and D will be finished and B receive the given
5429 * Intent, resulting in the stack now being: A, B.
5430 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005431 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005432 * either receive the new intent you are starting here in its
5433 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005434 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005435 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5436 * the same intent, then it will be finished and re-created; for all other
5437 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5438 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005439 *
5440 * <p>This launch mode can also be used to good effect in conjunction with
5441 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5442 * of a task, it will bring any currently running instance of that task
5443 * to the foreground, and then clear it to its root state. This is
5444 * especially useful, for example, when launching an activity from the
5445 * notification manager.
5446 *
Scott Main7aee61f2011-02-08 11:25:01 -08005447 * <p>See
5448 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5449 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005450 */
5451 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5452 /**
5453 * If set and this intent is being used to launch a new activity from an
5454 * existing one, then the reply target of the existing activity will be
5455 * transfered to the new activity. This way the new activity can call
5456 * {@link android.app.Activity#setResult} and have that result sent back to
5457 * the reply target of the original activity.
5458 */
5459 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5460 /**
5461 * If set and this intent is being used to launch a new activity from an
5462 * existing one, the current activity will not be counted as the top
5463 * activity for deciding whether the new intent should be delivered to
5464 * the top instead of starting a new one. The previous activity will
5465 * be used as the top, with the assumption being that the current activity
5466 * will finish itself immediately.
5467 */
5468 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5469 /**
5470 * If set, the new activity is not kept in the list of recently launched
5471 * activities.
5472 */
5473 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5474 /**
5475 * This flag is not normally set by application code, but set for you by
5476 * the system as described in the
5477 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5478 * launchMode} documentation for the singleTask mode.
5479 */
5480 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5481 /**
5482 * If set, and this activity is either being started in a new task or
5483 * bringing to the top an existing task, then it will be launched as
5484 * the front door of the task. This will result in the application of
5485 * any affinities needed to have that task in the proper state (either
5486 * moving activities to or from it), or simply resetting that task to
5487 * its initial state if needed.
5488 */
5489 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5490 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005491 * This flag is not normally set by application code, but set for you by
5492 * the system if this activity is being launched from history
5493 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005494 */
5495 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005496 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005497 * @deprecated As of API 21 this performs identically to
5498 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005499 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005500 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005501 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005502 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005503 * This flag is used to open a document into a new task rooted at the activity launched
5504 * by this Intent. Through the use of this flag, or its equivalent attribute,
5505 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005506 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005507 *
Craig Mautner026596b2014-05-21 15:35:44 -07005508 * <p>The use of the activity attribute form of this,
5509 * {@link android.R.attr#documentLaunchMode}, is
5510 * preferred over the Intent flag described here. The attribute form allows the
5511 * Activity to specify multiple document behavior for all launchers of the Activity
5512 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005513 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005514 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5515 * it is kept after the activity is finished is different than the use of
5516 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5517 * this flag is being used to create a new recents entry, then by default that entry
5518 * will be removed once the activity is finished. You can modify this behavior with
5519 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5520 *
Craig Mautner026596b2014-05-21 15:35:44 -07005521 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5522 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5523 * equivalent of the Activity manifest specifying {@link
5524 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5525 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5526 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005527 *
Craig Mautner026596b2014-05-21 15:35:44 -07005528 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005529 *
Craig Mautner026596b2014-05-21 15:35:44 -07005530 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005531 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5532 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005533 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005534 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005535 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005536 * callback from occurring on the current frontmost activity before it is
5537 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005538 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005539 * <p>Typically, an activity can rely on that callback to indicate that an
5540 * explicit user action has caused their activity to be moved out of the
5541 * foreground. The callback marks an appropriate point in the activity's
5542 * lifecycle for it to dismiss any notifications that it intends to display
5543 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005544 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005545 * <p>If an activity is ever started via any non-user-driven events such as
5546 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5547 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005548 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005549 */
5550 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005551 /**
5552 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5553 * this flag will cause the launched activity to be brought to the front of its
5554 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005555 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005556 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5557 * If D calls startActivity() with an Intent that resolves to the component
5558 * of activity B, then B will be brought to the front of the history stack,
5559 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005560 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005561 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005562 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005563 */
5564 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005565 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005566 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5567 * this flag will prevent the system from applying an activity transition
5568 * animation to go to the next activity state. This doesn't mean an
5569 * animation will never run -- if another activity change happens that doesn't
5570 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005571 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005572 * when you are going to do a series of activity operations but the
5573 * animation seen by the user shouldn't be driven by the first activity
5574 * change but rather a later one.
5575 */
5576 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5577 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005578 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5579 * this flag will cause any existing task that would be associated with the
5580 * activity to be cleared before the activity is started. That is, the activity
5581 * becomes the new root of an otherwise empty task, and any old activities
5582 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5583 */
5584 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5585 /**
5586 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5587 * this flag will cause a newly launching task to be placed on top of the current
5588 * home activity task (if there is one). That is, pressing back from the task
5589 * will always return the user to home even if that was not the last activity they
5590 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5591 */
5592 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5593 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005594 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5595 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005596 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005597 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005598 * this flag. When set and the task's activity is finished, the recents
5599 * entry will remain in the interface for the user to re-launch it, like a
5600 * recents entry for a top-level application.
5601 * <p>
5602 * The receiving activity can override this request with
5603 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5604 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005605 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005606 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005607 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005608
5609 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005610 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5611 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005612 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5613 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005614 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005615 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005616
Patrick Baumann577d4022018-01-31 16:55:10 +00005617
5618 /**
5619 * If set, resolution of this intent may take place via an instant app not
5620 * yet on the device if there does not yet exist an app on device to
5621 * resolve it.
5622 */
5623 public static final int FLAG_ACTIVITY_MATCH_EXTERNAL = 0x00000800;
5624
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005625 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005626 * If set, when sending a broadcast only registered receivers will be
5627 * called -- no BroadcastReceiver components will be launched.
5628 */
5629 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005630 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005631 * If set, when sending a broadcast the new broadcast will replace
5632 * any existing pending broadcast that matches it. Matching is defined
5633 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5634 * true for the intents of the two broadcasts. When a match is found,
5635 * the new broadcast (and receivers associated with it) will replace the
5636 * existing one in the pending broadcast list, remaining at the same
5637 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005638 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005639 * <p>This flag is most typically used with sticky broadcasts, which
5640 * only care about delivering the most recent values of the broadcast
5641 * to their receivers.
5642 */
5643 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5644 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005645 * If set, when sending a broadcast the recipient is allowed to run at
5646 * foreground priority, with a shorter timeout interval. During normal
5647 * broadcasts the receivers are not automatically hoisted out of the
5648 * background priority class.
5649 */
5650 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5651 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005652 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5653 * They can still propagate results through to later receivers, but they can not prevent
5654 * later receivers from seeing the broadcast.
5655 */
5656 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5657 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005658 * If set, when sending a broadcast <i>before boot has completed</i> only
5659 * registered receivers will be called -- no BroadcastReceiver components
5660 * will be launched. Sticky intent state will be recorded properly even
5661 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5662 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005663 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005664 * <p>This flag is only for use by system sevices as a convenience to
5665 * avoid having to implement a more complex mechanism around detection
5666 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005667 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005668 * @hide
5669 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005670 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005671 /**
5672 * Set when this broadcast is for a boot upgrade, a special mode that
5673 * allows the broadcast to be sent before the system is ready and launches
5674 * the app process with no providers running in it.
5675 * @hide
5676 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005677 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005678 /**
5679 * If set, the broadcast will always go to manifest receivers in background (cached
5680 * or not running) apps, regardless of whether that would be done by default. By
5681 * default they will only receive broadcasts if the broadcast has specified an
5682 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005683 *
5684 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5685 * the broadcast code there must also be changed to match.
5686 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005687 * @hide
5688 */
5689 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5690 /**
5691 * If set, the broadcast will never go to manifest receivers in background (cached
5692 * or not running) apps, regardless of whether that would be done by default. By
5693 * default they will receive broadcasts if the broadcast has specified an
5694 * explicit component or package name.
5695 * @hide
5696 */
5697 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005698 /**
5699 * If set, this broadcast is being sent from the shell.
5700 * @hide
5701 */
5702 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005703
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005704 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005705 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5706 * will not receive broadcasts.
5707 *
5708 * <em>This flag has no effect when used by an Instant App.</em>
5709 */
5710 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5711
5712 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005713 * @hide Flags that can't be changed with PendingIntent.
5714 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005715 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5716 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5717 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005718
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005719 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005720 // ---------------------------------------------------------------------
5721 // toUri() and parseUri() options.
5722
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005723 /** @hide */
5724 @IntDef(flag = true, prefix = { "URI_" }, value = {
5725 URI_ALLOW_UNSAFE,
5726 URI_ANDROID_APP_SCHEME,
5727 URI_INTENT_SCHEME,
5728 })
5729 @Retention(RetentionPolicy.SOURCE)
5730 public @interface UriFlags {}
5731
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005732 /**
5733 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5734 * always has the "intent:" scheme. This syntax can be used when you want
5735 * to later disambiguate between URIs that are intended to describe an
5736 * Intent vs. all others that should be treated as raw URIs. When used
5737 * with {@link #parseUri}, any other scheme will result in a generic
5738 * VIEW action for that raw URI.
5739 */
5740 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005741
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005742 /**
5743 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5744 * always has the "android-app:" scheme. This is a variation of
5745 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5746 * http/https URI being delivered to a specific package name. The format
5747 * is:
5748 *
5749 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005750 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005751 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005752 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5753 * you must also include a scheme; including a path also requires both a host and a scheme.
5754 * The final #Intent; fragment can be used without a scheme, host, or path.
5755 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005756 * used with intents that have a {@link #setSelector}, since the base intent
5757 * will always have an explicit package name.</p>
5758 *
5759 * <p>Some examples of how this scheme maps to Intent objects:</p>
5760 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5761 * <colgroup align="left" />
5762 * <colgroup align="left" />
5763 * <thead>
5764 * <tr><th>URI</th> <th>Intent</th></tr>
5765 * </thead>
5766 *
5767 * <tbody>
5768 * <tr><td><code>android-app://com.example.app</code></td>
5769 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5770 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5771 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5772 * </table></td>
5773 * </tr>
5774 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5775 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5776 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5777 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5778 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5779 * </table></td>
5780 * </tr>
5781 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5782 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5783 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5784 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5785 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5786 * </table></td>
5787 * </tr>
5788 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5789 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5790 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5791 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5792 * </table></td>
5793 * </tr>
5794 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5795 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5796 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5797 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5798 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5799 * </table></td>
5800 * </tr>
5801 * <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>
5802 * <td><table border="" style="margin:0" >
5803 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5804 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5805 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5806 * </table></td>
5807 * </tr>
5808 * </tbody>
5809 * </table>
5810 */
5811 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5812
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005813 /**
5814 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5815 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5816 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5817 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5818 * generated Intent can not cause unexpected data access to happen.
5819 *
5820 * <p>If you do not trust the source of the URI being parsed, you should still do further
5821 * processing to protect yourself from it. In particular, when using it to start an
5822 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5823 * that can handle it.</p>
5824 */
5825 public static final int URI_ALLOW_UNSAFE = 1<<2;
5826
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005827 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005828
5829 private String mAction;
5830 private Uri mData;
5831 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005832 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005833 private ComponentName mComponent;
5834 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005835 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005836 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005837 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005838 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005839 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005840 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005841 /** Token to track instant app launches. Local only; do not copy cross-process. */
5842 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005843
5844 // ---------------------------------------------------------------------
5845
Makoto Onuki97f82f22017-05-31 16:20:21 -07005846 private static final int COPY_MODE_ALL = 0;
5847 private static final int COPY_MODE_FILTER = 1;
5848 private static final int COPY_MODE_HISTORY = 2;
5849
5850 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07005851 @IntDef(prefix = { "COPY_MODE_" }, value = {
5852 COPY_MODE_ALL,
5853 COPY_MODE_FILTER,
5854 COPY_MODE_HISTORY
5855 })
Makoto Onuki97f82f22017-05-31 16:20:21 -07005856 @Retention(RetentionPolicy.SOURCE)
5857 public @interface CopyMode {}
5858
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005859 /**
5860 * Create an empty intent.
5861 */
5862 public Intent() {
5863 }
5864
5865 /**
5866 * Copy constructor.
5867 */
5868 public Intent(Intent o) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005869 this(o, COPY_MODE_ALL);
5870 }
5871
5872 private Intent(Intent o, @CopyMode int copyMode) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005873 this.mAction = o.mAction;
5874 this.mData = o.mData;
5875 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005876 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005877 this.mComponent = o.mComponent;
Makoto Onuki97f82f22017-05-31 16:20:21 -07005878
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005879 if (o.mCategories != null) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005880 this.mCategories = new ArraySet<>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005881 }
Makoto Onuki97f82f22017-05-31 16:20:21 -07005882
5883 if (copyMode != COPY_MODE_FILTER) {
5884 this.mFlags = o.mFlags;
5885 this.mContentUserHint = o.mContentUserHint;
5886 this.mLaunchToken = o.mLaunchToken;
5887 if (o.mSourceBounds != null) {
5888 this.mSourceBounds = new Rect(o.mSourceBounds);
5889 }
5890 if (o.mSelector != null) {
5891 this.mSelector = new Intent(o.mSelector);
5892 }
5893
5894 if (copyMode != COPY_MODE_HISTORY) {
5895 if (o.mExtras != null) {
5896 this.mExtras = new Bundle(o.mExtras);
5897 }
5898 if (o.mClipData != null) {
5899 this.mClipData = new ClipData(o.mClipData);
5900 }
5901 } else {
5902 if (o.mExtras != null && !o.mExtras.maybeIsEmpty()) {
5903 this.mExtras = Bundle.STRIPPED;
5904 }
5905
5906 // Also set "stripped" clip data when we ever log mClipData in the (broadcast)
5907 // history.
5908 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005909 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005910 }
5911
5912 @Override
5913 public Object clone() {
5914 return new Intent(this);
5915 }
5916
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005917 /**
5918 * Make a clone of only the parts of the Intent that are relevant for
5919 * filter matching: the action, data, type, component, and categories.
5920 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005921 public @NonNull Intent cloneFilter() {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005922 return new Intent(this, COPY_MODE_FILTER);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005923 }
5924
5925 /**
5926 * Create an intent with a given action. All other fields (data, type,
5927 * class) are null. Note that the action <em>must</em> be in a
5928 * namespace because Intents are used globally in the system -- for
5929 * example the system VIEW action is android.intent.action.VIEW; an
5930 * application's custom action would be something like
5931 * com.google.app.myapp.CUSTOM_ACTION.
5932 *
5933 * @param action The Intent action, such as ACTION_VIEW.
5934 */
5935 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005936 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005937 }
5938
5939 /**
5940 * Create an intent with a given action and for a given data url. Note
5941 * that the action <em>must</em> be in a namespace because Intents are
5942 * used globally in the system -- for example the system VIEW action is
5943 * android.intent.action.VIEW; an application's custom action would be
5944 * something like com.google.app.myapp.CUSTOM_ACTION.
5945 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005946 * <p><em>Note: scheme and host name matching in the Android framework is
5947 * case-sensitive, unlike the formal RFC. As a result,
5948 * you should always ensure that you write your Uri with these elements
5949 * using lower case letters, and normalize any Uris you receive from
5950 * outside of Android to ensure the scheme and host is lower case.</em></p>
5951 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005952 * @param action The Intent action, such as ACTION_VIEW.
5953 * @param uri The Intent data URI.
5954 */
5955 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005956 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005957 mData = uri;
5958 }
5959
5960 /**
5961 * Create an intent for a specific component. All other fields (action, data,
5962 * type, class) are null, though they can be modified later with explicit
5963 * calls. This provides a convenient way to create an intent that is
5964 * intended to execute a hard-coded class name, rather than relying on the
5965 * system to find an appropriate class for you; see {@link #setComponent}
5966 * for more information on the repercussions of this.
5967 *
5968 * @param packageContext A Context of the application package implementing
5969 * this class.
5970 * @param cls The component class that is to be used for the intent.
5971 *
5972 * @see #setClass
5973 * @see #setComponent
5974 * @see #Intent(String, android.net.Uri , Context, Class)
5975 */
5976 public Intent(Context packageContext, Class<?> cls) {
5977 mComponent = new ComponentName(packageContext, cls);
5978 }
5979
5980 /**
5981 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005982 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005983 * construct the Intent and then calling {@link #setClass} to set its
5984 * class.
5985 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005986 * <p><em>Note: scheme and host name matching in the Android framework is
5987 * case-sensitive, unlike the formal RFC. As a result,
5988 * you should always ensure that you write your Uri with these elements
5989 * using lower case letters, and normalize any Uris you receive from
5990 * outside of Android to ensure the scheme and host is lower case.</em></p>
5991 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005992 * @param action The Intent action, such as ACTION_VIEW.
5993 * @param uri The Intent data URI.
5994 * @param packageContext A Context of the application package implementing
5995 * this class.
5996 * @param cls The component class that is to be used for the intent.
5997 *
5998 * @see #Intent(String, android.net.Uri)
5999 * @see #Intent(Context, Class)
6000 * @see #setClass
6001 * @see #setComponent
6002 */
6003 public Intent(String action, Uri uri,
6004 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006005 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006006 mData = uri;
6007 mComponent = new ComponentName(packageContext, cls);
6008 }
6009
6010 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08006011 * Create an intent to launch the main (root) activity of a task. This
6012 * is the Intent that is started when the application's is launched from
6013 * Home. For anything else that wants to launch an application in the
6014 * same way, it is important that they use an Intent structured the same
6015 * way, and can use this function to ensure this is the case.
6016 *
6017 * <p>The returned Intent has the given Activity component as its explicit
6018 * component, {@link #ACTION_MAIN} as its action, and includes the
6019 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
6020 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
6021 * to do that through {@link #addFlags(int)} on the returned Intent.
6022 *
6023 * @param mainActivity The main activity component that this Intent will
6024 * launch.
6025 * @return Returns a newly created Intent that can be used to launch the
6026 * activity as a main application entry.
6027 *
6028 * @see #setClass
6029 * @see #setComponent
6030 */
6031 public static Intent makeMainActivity(ComponentName mainActivity) {
6032 Intent intent = new Intent(ACTION_MAIN);
6033 intent.setComponent(mainActivity);
6034 intent.addCategory(CATEGORY_LAUNCHER);
6035 return intent;
6036 }
6037
6038 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006039 * Make an Intent for the main activity of an application, without
6040 * specifying a specific activity to run but giving a selector to find
6041 * the activity. This results in a final Intent that is structured
6042 * the same as when the application is launched from
6043 * Home. For anything else that wants to launch an application in the
6044 * same way, it is important that they use an Intent structured the same
6045 * way, and can use this function to ensure this is the case.
6046 *
6047 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
6048 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
6049 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
6050 * to do that through {@link #addFlags(int)} on the returned Intent.
6051 *
6052 * @param selectorAction The action name of the Intent's selector.
6053 * @param selectorCategory The name of a category to add to the Intent's
6054 * selector.
6055 * @return Returns a newly created Intent that can be used to launch the
6056 * activity as a main application entry.
6057 *
6058 * @see #setSelector(Intent)
6059 */
6060 public static Intent makeMainSelectorActivity(String selectorAction,
6061 String selectorCategory) {
6062 Intent intent = new Intent(ACTION_MAIN);
6063 intent.addCategory(CATEGORY_LAUNCHER);
6064 Intent selector = new Intent();
6065 selector.setAction(selectorAction);
6066 selector.addCategory(selectorCategory);
6067 intent.setSelector(selector);
6068 return intent;
6069 }
6070
6071 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08006072 * Make an Intent that can be used to re-launch an application's task
6073 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
6074 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
6075 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
6076 *
6077 * @param mainActivity The activity component that is the root of the
6078 * task; this is the activity that has been published in the application's
6079 * manifest as the main launcher icon.
6080 *
6081 * @return Returns a newly created Intent that can be used to relaunch the
6082 * activity's task in its root state.
6083 */
6084 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
6085 Intent intent = makeMainActivity(mainActivity);
6086 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
6087 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
6088 return intent;
6089 }
6090
6091 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006092 * Call {@link #parseUri} with 0 flags.
6093 * @deprecated Use {@link #parseUri} instead.
6094 */
6095 @Deprecated
6096 public static Intent getIntent(String uri) throws URISyntaxException {
6097 return parseUri(uri, 0);
6098 }
Tom Taylord4a47292009-12-21 13:59:18 -08006099
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006100 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006101 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006102 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07006103 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006104 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006105 *
6106 * <p>The URI given here must not be relative -- that is, it must include
6107 * the scheme and full path.
6108 *
6109 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006110 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006111 *
6112 * @return Intent The newly created Intent object.
6113 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006114 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
6115 * it bad (as parsed by the Uri class) or the Intent data within the
6116 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08006117 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006118 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006119 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006120 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006121 int i = 0;
6122 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006123 final boolean androidApp = uri.startsWith("android-app:");
6124
6125 // Validate intent scheme if requested.
6126 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
6127 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006128 Intent intent = new Intent(ACTION_VIEW);
6129 try {
6130 intent.setData(Uri.parse(uri));
6131 } catch (IllegalArgumentException e) {
6132 throw new URISyntaxException(uri, e.getMessage());
6133 }
6134 return intent;
6135 }
6136 }
Tom Taylord4a47292009-12-21 13:59:18 -08006137
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006138 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006139 // simple case
6140 if (i == -1) {
6141 if (!androidApp) {
6142 return new Intent(ACTION_VIEW, Uri.parse(uri));
6143 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006144
6145 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006146 } else if (!uri.startsWith("#Intent;", i)) {
6147 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006148 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006149 } else {
6150 i = -1;
6151 }
6152 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006153
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006154 // new format
6155 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006156 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006157 boolean explicitAction = false;
6158 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006159
6160 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006161 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006162 String data;
6163 if (i >= 0) {
6164 data = uri.substring(0, i);
6165 i += 8; // length of "#Intent;"
6166 } else {
6167 data = uri;
6168 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006169
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006170 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006171 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006172 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006173 if (eq < 0) eq = i-1;
6174 int semi = uri.indexOf(';', i);
6175 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006176
6177 // action
6178 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006179 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006180 if (!inSelector) {
6181 explicitAction = true;
6182 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006183 }
6184
6185 // categories
6186 else if (uri.startsWith("category=", i)) {
6187 intent.addCategory(value);
6188 }
6189
6190 // type
6191 else if (uri.startsWith("type=", i)) {
6192 intent.mType = value;
6193 }
6194
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006195 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006196 else if (uri.startsWith("launchFlags=", i)) {
6197 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006198 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6199 intent.mFlags &= ~IMMUTABLE_FLAGS;
6200 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006201 }
6202
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006203 // package
6204 else if (uri.startsWith("package=", i)) {
6205 intent.mPackage = value;
6206 }
6207
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006208 // component
6209 else if (uri.startsWith("component=", i)) {
6210 intent.mComponent = ComponentName.unflattenFromString(value);
6211 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006212
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006213 // scheme
6214 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006215 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006216 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006217 } else {
6218 scheme = value;
6219 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006220 }
6221
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006222 // source bounds
6223 else if (uri.startsWith("sourceBounds=", i)) {
6224 intent.mSourceBounds = Rect.unflattenFromString(value);
6225 }
6226
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006227 // selector
6228 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
6229 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006230 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006231 }
6232
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006233 // extra
6234 else {
6235 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006236 // create Bundle if it doesn't already exist
6237 if (intent.mExtras == null) intent.mExtras = new Bundle();
6238 Bundle b = intent.mExtras;
6239 // add EXTRA
6240 if (uri.startsWith("S.", i)) b.putString(key, value);
6241 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
6242 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
6243 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
6244 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
6245 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
6246 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
6247 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
6248 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
6249 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
6250 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006251
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006252 // move to the next item
6253 i = semi + 1;
6254 }
6255
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006256 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006257 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006258 if (baseIntent.mPackage == null) {
6259 baseIntent.setSelector(intent);
6260 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006261 intent = baseIntent;
6262 }
6263
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006264 if (data != null) {
6265 if (data.startsWith("intent:")) {
6266 data = data.substring(7);
6267 if (scheme != null) {
6268 data = scheme + ':' + data;
6269 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006270 } else if (data.startsWith("android-app:")) {
6271 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
6272 // Correctly formed android-app, first part is package name.
6273 int end = data.indexOf('/', 14);
6274 if (end < 0) {
6275 // All we have is a package name.
6276 intent.mPackage = data.substring(14);
6277 if (!explicitAction) {
6278 intent.setAction(ACTION_MAIN);
6279 }
6280 data = "";
6281 } else {
6282 // Target the Intent at the given package name always.
6283 String authority = null;
6284 intent.mPackage = data.substring(14, end);
6285 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006286 if ((end+1) < data.length()) {
6287 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6288 // Found a scheme, remember it.
6289 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006290 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006291 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6292 // Found a authority, remember it.
6293 authority = data.substring(end+1, newEnd);
6294 end = newEnd;
6295 }
6296 } else {
6297 // All we have is a scheme.
6298 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006299 }
6300 }
6301 if (scheme == null) {
6302 // If there was no scheme, then this just targets the package.
6303 if (!explicitAction) {
6304 intent.setAction(ACTION_MAIN);
6305 }
6306 data = "";
6307 } else if (authority == null) {
6308 data = scheme + ":";
6309 } else {
6310 data = scheme + "://" + authority + data.substring(end);
6311 }
6312 }
6313 } else {
6314 data = "";
6315 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006316 }
Tom Taylord4a47292009-12-21 13:59:18 -08006317
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006318 if (data.length() > 0) {
6319 try {
6320 intent.mData = Uri.parse(data);
6321 } catch (IllegalArgumentException e) {
6322 throw new URISyntaxException(uri, e.getMessage());
6323 }
6324 }
6325 }
Tom Taylord4a47292009-12-21 13:59:18 -08006326
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006327 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006328
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006329 } catch (IndexOutOfBoundsException e) {
6330 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6331 }
6332 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006333
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006334 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006335 return getIntentOld(uri, 0);
6336 }
6337
6338 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006339 Intent intent;
6340
6341 int i = uri.lastIndexOf('#');
6342 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006343 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006344 final int intentFragmentStart = i;
6345 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006346
6347 i++;
6348
6349 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006350 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006351 i += 7;
6352 int j = uri.indexOf(')', i);
6353 action = uri.substring(i, j);
6354 i = j + 1;
6355 }
6356
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006357 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006358
6359 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006360 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006361 i += 11;
6362 int j = uri.indexOf(')', i);
6363 while (i < j) {
6364 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006365 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006366 if (i < sep) {
6367 intent.addCategory(uri.substring(i, sep));
6368 }
6369 i = sep + 1;
6370 }
6371 i = j + 1;
6372 }
6373
6374 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006375 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006376 i += 5;
6377 int j = uri.indexOf(')', i);
6378 intent.mType = uri.substring(i, j);
6379 i = j + 1;
6380 }
6381
6382 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006383 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006384 i += 12;
6385 int j = uri.indexOf(')', i);
6386 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006387 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6388 intent.mFlags &= ~IMMUTABLE_FLAGS;
6389 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006390 i = j + 1;
6391 }
6392
6393 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006394 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006395 i += 10;
6396 int j = uri.indexOf(')', i);
6397 int sep = uri.indexOf('!', i);
6398 if (sep >= 0 && sep < j) {
6399 String pkg = uri.substring(i, sep);
6400 String cls = uri.substring(sep + 1, j);
6401 intent.mComponent = new ComponentName(pkg, cls);
6402 }
6403 i = j + 1;
6404 }
6405
6406 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006407 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006408 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006409
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006410 final int closeParen = uri.indexOf(')', i);
6411 if (closeParen == -1) throw new URISyntaxException(uri,
6412 "EXTRA missing trailing ')'", i);
6413
6414 while (i < closeParen) {
6415 // fetch the key value
6416 int j = uri.indexOf('=', i);
6417 if (j <= i + 1 || i >= closeParen) {
6418 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6419 }
6420 char type = uri.charAt(i);
6421 i++;
6422 String key = uri.substring(i, j);
6423 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006424
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006425 // get type-value
6426 j = uri.indexOf('!', i);
6427 if (j == -1 || j >= closeParen) j = closeParen;
6428 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6429 String value = uri.substring(i, j);
6430 i = j;
6431
6432 // create Bundle if it doesn't already exist
6433 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006434
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006435 // add item to bundle
6436 try {
6437 switch (type) {
6438 case 'S':
6439 intent.mExtras.putString(key, Uri.decode(value));
6440 break;
6441 case 'B':
6442 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6443 break;
6444 case 'b':
6445 intent.mExtras.putByte(key, Byte.parseByte(value));
6446 break;
6447 case 'c':
6448 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6449 break;
6450 case 'd':
6451 intent.mExtras.putDouble(key, Double.parseDouble(value));
6452 break;
6453 case 'f':
6454 intent.mExtras.putFloat(key, Float.parseFloat(value));
6455 break;
6456 case 'i':
6457 intent.mExtras.putInt(key, Integer.parseInt(value));
6458 break;
6459 case 'l':
6460 intent.mExtras.putLong(key, Long.parseLong(value));
6461 break;
6462 case 's':
6463 intent.mExtras.putShort(key, Short.parseShort(value));
6464 break;
6465 default:
6466 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6467 }
6468 } catch (NumberFormatException e) {
6469 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6470 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006471
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006472 char ch = uri.charAt(i);
6473 if (ch == ')') break;
6474 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6475 i++;
6476 }
6477 }
6478
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006479 if (isIntentFragment) {
6480 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6481 } else {
6482 intent.mData = Uri.parse(uri);
6483 }
Tom Taylord4a47292009-12-21 13:59:18 -08006484
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006485 if (intent.mAction == null) {
6486 // By default, if no action is specified, then use VIEW.
6487 intent.mAction = ACTION_VIEW;
6488 }
6489
6490 } else {
6491 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6492 }
6493
6494 return intent;
6495 }
6496
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006497 /** @hide */
6498 public interface CommandOptionHandler {
6499 boolean handleOption(String opt, ShellCommand cmd);
6500 }
6501
6502 /** @hide */
6503 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6504 throws URISyntaxException {
6505 Intent intent = new Intent();
6506 Intent baseIntent = intent;
6507 boolean hasIntentInfo = false;
6508
6509 Uri data = null;
6510 String type = null;
6511
6512 String opt;
6513 while ((opt=cmd.getNextOption()) != null) {
6514 switch (opt) {
6515 case "-a":
6516 intent.setAction(cmd.getNextArgRequired());
6517 if (intent == baseIntent) {
6518 hasIntentInfo = true;
6519 }
6520 break;
6521 case "-d":
6522 data = Uri.parse(cmd.getNextArgRequired());
6523 if (intent == baseIntent) {
6524 hasIntentInfo = true;
6525 }
6526 break;
6527 case "-t":
6528 type = cmd.getNextArgRequired();
6529 if (intent == baseIntent) {
6530 hasIntentInfo = true;
6531 }
6532 break;
6533 case "-c":
6534 intent.addCategory(cmd.getNextArgRequired());
6535 if (intent == baseIntent) {
6536 hasIntentInfo = true;
6537 }
6538 break;
6539 case "-e":
6540 case "--es": {
6541 String key = cmd.getNextArgRequired();
6542 String value = cmd.getNextArgRequired();
6543 intent.putExtra(key, value);
6544 }
6545 break;
6546 case "--esn": {
6547 String key = cmd.getNextArgRequired();
6548 intent.putExtra(key, (String) null);
6549 }
6550 break;
6551 case "--ei": {
6552 String key = cmd.getNextArgRequired();
6553 String value = cmd.getNextArgRequired();
6554 intent.putExtra(key, Integer.decode(value));
6555 }
6556 break;
6557 case "--eu": {
6558 String key = cmd.getNextArgRequired();
6559 String value = cmd.getNextArgRequired();
6560 intent.putExtra(key, Uri.parse(value));
6561 }
6562 break;
6563 case "--ecn": {
6564 String key = cmd.getNextArgRequired();
6565 String value = cmd.getNextArgRequired();
6566 ComponentName cn = ComponentName.unflattenFromString(value);
6567 if (cn == null)
6568 throw new IllegalArgumentException("Bad component name: " + value);
6569 intent.putExtra(key, cn);
6570 }
6571 break;
6572 case "--eia": {
6573 String key = cmd.getNextArgRequired();
6574 String value = cmd.getNextArgRequired();
6575 String[] strings = value.split(",");
6576 int[] list = new int[strings.length];
6577 for (int i = 0; i < strings.length; i++) {
6578 list[i] = Integer.decode(strings[i]);
6579 }
6580 intent.putExtra(key, list);
6581 }
6582 break;
6583 case "--eial": {
6584 String key = cmd.getNextArgRequired();
6585 String value = cmd.getNextArgRequired();
6586 String[] strings = value.split(",");
6587 ArrayList<Integer> list = new ArrayList<>(strings.length);
6588 for (int i = 0; i < strings.length; i++) {
6589 list.add(Integer.decode(strings[i]));
6590 }
6591 intent.putExtra(key, list);
6592 }
6593 break;
6594 case "--el": {
6595 String key = cmd.getNextArgRequired();
6596 String value = cmd.getNextArgRequired();
6597 intent.putExtra(key, Long.valueOf(value));
6598 }
6599 break;
6600 case "--ela": {
6601 String key = cmd.getNextArgRequired();
6602 String value = cmd.getNextArgRequired();
6603 String[] strings = value.split(",");
6604 long[] list = new long[strings.length];
6605 for (int i = 0; i < strings.length; i++) {
6606 list[i] = Long.valueOf(strings[i]);
6607 }
6608 intent.putExtra(key, list);
6609 hasIntentInfo = true;
6610 }
6611 break;
6612 case "--elal": {
6613 String key = cmd.getNextArgRequired();
6614 String value = cmd.getNextArgRequired();
6615 String[] strings = value.split(",");
6616 ArrayList<Long> list = new ArrayList<>(strings.length);
6617 for (int i = 0; i < strings.length; i++) {
6618 list.add(Long.valueOf(strings[i]));
6619 }
6620 intent.putExtra(key, list);
6621 hasIntentInfo = true;
6622 }
6623 break;
6624 case "--ef": {
6625 String key = cmd.getNextArgRequired();
6626 String value = cmd.getNextArgRequired();
6627 intent.putExtra(key, Float.valueOf(value));
6628 hasIntentInfo = true;
6629 }
6630 break;
6631 case "--efa": {
6632 String key = cmd.getNextArgRequired();
6633 String value = cmd.getNextArgRequired();
6634 String[] strings = value.split(",");
6635 float[] list = new float[strings.length];
6636 for (int i = 0; i < strings.length; i++) {
6637 list[i] = Float.valueOf(strings[i]);
6638 }
6639 intent.putExtra(key, list);
6640 hasIntentInfo = true;
6641 }
6642 break;
6643 case "--efal": {
6644 String key = cmd.getNextArgRequired();
6645 String value = cmd.getNextArgRequired();
6646 String[] strings = value.split(",");
6647 ArrayList<Float> list = new ArrayList<>(strings.length);
6648 for (int i = 0; i < strings.length; i++) {
6649 list.add(Float.valueOf(strings[i]));
6650 }
6651 intent.putExtra(key, list);
6652 hasIntentInfo = true;
6653 }
6654 break;
6655 case "--esa": {
6656 String key = cmd.getNextArgRequired();
6657 String value = cmd.getNextArgRequired();
6658 // Split on commas unless they are preceeded by an escape.
6659 // The escape character must be escaped for the string and
6660 // again for the regex, thus four escape characters become one.
6661 String[] strings = value.split("(?<!\\\\),");
6662 intent.putExtra(key, strings);
6663 hasIntentInfo = true;
6664 }
6665 break;
6666 case "--esal": {
6667 String key = cmd.getNextArgRequired();
6668 String value = cmd.getNextArgRequired();
6669 // Split on commas unless they are preceeded by an escape.
6670 // The escape character must be escaped for the string and
6671 // again for the regex, thus four escape characters become one.
6672 String[] strings = value.split("(?<!\\\\),");
6673 ArrayList<String> list = new ArrayList<>(strings.length);
6674 for (int i = 0; i < strings.length; i++) {
6675 list.add(strings[i]);
6676 }
6677 intent.putExtra(key, list);
6678 hasIntentInfo = true;
6679 }
6680 break;
6681 case "--ez": {
6682 String key = cmd.getNextArgRequired();
6683 String value = cmd.getNextArgRequired().toLowerCase();
6684 // Boolean.valueOf() results in false for anything that is not "true", which is
6685 // error-prone in shell commands
6686 boolean arg;
6687 if ("true".equals(value) || "t".equals(value)) {
6688 arg = true;
6689 } else if ("false".equals(value) || "f".equals(value)) {
6690 arg = false;
6691 } else {
6692 try {
6693 arg = Integer.decode(value) != 0;
6694 } catch (NumberFormatException ex) {
6695 throw new IllegalArgumentException("Invalid boolean value: " + value);
6696 }
6697 }
6698
6699 intent.putExtra(key, arg);
6700 }
6701 break;
6702 case "-n": {
6703 String str = cmd.getNextArgRequired();
6704 ComponentName cn = ComponentName.unflattenFromString(str);
6705 if (cn == null)
6706 throw new IllegalArgumentException("Bad component name: " + str);
6707 intent.setComponent(cn);
6708 if (intent == baseIntent) {
6709 hasIntentInfo = true;
6710 }
6711 }
6712 break;
6713 case "-p": {
6714 String str = cmd.getNextArgRequired();
6715 intent.setPackage(str);
6716 if (intent == baseIntent) {
6717 hasIntentInfo = true;
6718 }
6719 }
6720 break;
6721 case "-f":
6722 String str = cmd.getNextArgRequired();
6723 intent.setFlags(Integer.decode(str).intValue());
6724 break;
6725 case "--grant-read-uri-permission":
6726 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6727 break;
6728 case "--grant-write-uri-permission":
6729 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6730 break;
6731 case "--grant-persistable-uri-permission":
6732 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6733 break;
6734 case "--grant-prefix-uri-permission":
6735 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6736 break;
6737 case "--exclude-stopped-packages":
6738 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6739 break;
6740 case "--include-stopped-packages":
6741 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6742 break;
6743 case "--debug-log-resolution":
6744 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6745 break;
6746 case "--activity-brought-to-front":
6747 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6748 break;
6749 case "--activity-clear-top":
6750 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6751 break;
6752 case "--activity-clear-when-task-reset":
6753 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6754 break;
6755 case "--activity-exclude-from-recents":
6756 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6757 break;
6758 case "--activity-launched-from-history":
6759 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6760 break;
6761 case "--activity-multiple-task":
6762 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6763 break;
6764 case "--activity-no-animation":
6765 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6766 break;
6767 case "--activity-no-history":
6768 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6769 break;
6770 case "--activity-no-user-action":
6771 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6772 break;
6773 case "--activity-previous-is-top":
6774 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6775 break;
6776 case "--activity-reorder-to-front":
6777 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6778 break;
6779 case "--activity-reset-task-if-needed":
6780 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6781 break;
6782 case "--activity-single-top":
6783 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6784 break;
6785 case "--activity-clear-task":
6786 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6787 break;
6788 case "--activity-task-on-home":
6789 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6790 break;
6791 case "--receiver-registered-only":
6792 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6793 break;
6794 case "--receiver-replace-pending":
6795 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6796 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006797 case "--receiver-foreground":
6798 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6799 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006800 case "--receiver-no-abort":
6801 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6802 break;
6803 case "--receiver-include-background":
6804 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6805 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006806 case "--selector":
6807 intent.setDataAndType(data, type);
6808 intent = new Intent();
6809 break;
6810 default:
6811 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6812 // Okay, caller handled this option.
6813 } else {
6814 throw new IllegalArgumentException("Unknown option: " + opt);
6815 }
6816 break;
6817 }
6818 }
6819 intent.setDataAndType(data, type);
6820
6821 final boolean hasSelector = intent != baseIntent;
6822 if (hasSelector) {
6823 // A selector was specified; fix up.
6824 baseIntent.setSelector(intent);
6825 intent = baseIntent;
6826 }
6827
6828 String arg = cmd.getNextArg();
6829 baseIntent = null;
6830 if (arg == null) {
6831 if (hasSelector) {
6832 // If a selector has been specified, and no arguments
6833 // have been supplied for the main Intent, then we can
6834 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6835 // need to have a component name specified yet, the
6836 // selector will take care of that.
6837 baseIntent = new Intent(Intent.ACTION_MAIN);
6838 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6839 }
6840 } else if (arg.indexOf(':') >= 0) {
6841 // The argument is a URI. Fully parse it, and use that result
6842 // to fill in any data not specified so far.
6843 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6844 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6845 } else if (arg.indexOf('/') >= 0) {
6846 // The argument is a component name. Build an Intent to launch
6847 // it.
6848 baseIntent = new Intent(Intent.ACTION_MAIN);
6849 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6850 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6851 } else {
6852 // Assume the argument is a package name.
6853 baseIntent = new Intent(Intent.ACTION_MAIN);
6854 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6855 baseIntent.setPackage(arg);
6856 }
6857 if (baseIntent != null) {
6858 Bundle extras = intent.getExtras();
6859 intent.replaceExtras((Bundle)null);
6860 Bundle uriExtras = baseIntent.getExtras();
6861 baseIntent.replaceExtras((Bundle)null);
6862 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6863 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6864 for (String c : cats) {
6865 baseIntent.removeCategory(c);
6866 }
6867 }
6868 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6869 if (extras == null) {
6870 extras = uriExtras;
6871 } else if (uriExtras != null) {
6872 uriExtras.putAll(extras);
6873 extras = uriExtras;
6874 }
6875 intent.replaceExtras(extras);
6876 hasIntentInfo = true;
6877 }
6878
6879 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6880 return intent;
6881 }
6882
6883 /** @hide */
6884 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6885 final String[] lines = new String[] {
6886 "<INTENT> specifications include these flags and arguments:",
6887 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6888 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6889 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6890 " [--esn <EXTRA_KEY> ...]",
6891 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6892 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6893 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6894 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6895 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6896 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6897 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6898 " (mutiple extras passed as Integer[])",
6899 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6900 " (mutiple extras passed as List<Integer>)",
6901 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6902 " (mutiple extras passed as Long[])",
6903 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6904 " (mutiple extras passed as List<Long>)",
6905 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6906 " (mutiple extras passed as Float[])",
6907 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6908 " (mutiple extras passed as List<Float>)",
6909 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6910 " (mutiple extras passed as String[]; to embed a comma into a string,",
6911 " escape it using \"\\,\")",
6912 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6913 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6914 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006915 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006916 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6917 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6918 " [--debug-log-resolution] [--exclude-stopped-packages]",
6919 " [--include-stopped-packages]",
6920 " [--activity-brought-to-front] [--activity-clear-top]",
6921 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6922 " [--activity-launched-from-history] [--activity-multiple-task]",
6923 " [--activity-no-animation] [--activity-no-history]",
6924 " [--activity-no-user-action] [--activity-previous-is-top]",
6925 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6926 " [--activity-single-top] [--activity-clear-task]",
6927 " [--activity-task-on-home]",
6928 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08006929 " [--receiver-foreground] [--receiver-no-abort]",
6930 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006931 " [--selector]",
6932 " [<URI> | <PACKAGE> | <COMPONENT>]"
6933 };
6934 for (String line : lines) {
6935 pw.print(prefix);
6936 pw.println(line);
6937 }
6938 }
6939
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006940 /**
6941 * Retrieve the general action to be performed, such as
6942 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6943 * the information in the intent should be interpreted -- most importantly,
6944 * what to do with the data returned by {@link #getData}.
6945 *
6946 * @return The action of this intent or null if none is specified.
6947 *
6948 * @see #setAction
6949 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006950 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006951 return mAction;
6952 }
6953
6954 /**
6955 * Retrieve data this intent is operating on. This URI specifies the name
6956 * of the data; often it uses the content: scheme, specifying data in a
6957 * content provider. Other schemes may be handled by specific activities,
6958 * such as http: by the web browser.
6959 *
6960 * @return The URI of the data this intent is targeting or null.
6961 *
6962 * @see #getScheme
6963 * @see #setData
6964 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006965 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006966 return mData;
6967 }
6968
6969 /**
6970 * The same as {@link #getData()}, but returns the URI as an encoded
6971 * String.
6972 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006973 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006974 return mData != null ? mData.toString() : null;
6975 }
6976
6977 /**
6978 * Return the scheme portion of the intent's data. If the data is null or
6979 * does not include a scheme, null is returned. Otherwise, the scheme
6980 * prefix without the final ':' is returned, i.e. "http".
6981 *
6982 * <p>This is the same as calling getData().getScheme() (and checking for
6983 * null data).
6984 *
6985 * @return The scheme of this intent.
6986 *
6987 * @see #getData
6988 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006989 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006990 return mData != null ? mData.getScheme() : null;
6991 }
6992
6993 /**
6994 * Retrieve any explicit MIME type included in the intent. This is usually
6995 * null, as the type is determined by the intent data.
6996 *
6997 * @return If a type was manually set, it is returned; else null is
6998 * returned.
6999 *
7000 * @see #resolveType(ContentResolver)
7001 * @see #setType
7002 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007003 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007004 return mType;
7005 }
7006
7007 /**
7008 * Return the MIME data type of this intent. If the type field is
7009 * explicitly set, that is simply returned. Otherwise, if the data is set,
7010 * the type of that data is returned. If neither fields are set, a null is
7011 * returned.
7012 *
7013 * @return The MIME type of this intent.
7014 *
7015 * @see #getType
7016 * @see #resolveType(ContentResolver)
7017 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007018 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007019 return resolveType(context.getContentResolver());
7020 }
7021
7022 /**
7023 * Return the MIME data type of this intent. If the type field is
7024 * explicitly set, that is simply returned. Otherwise, if the data is set,
7025 * the type of that data is returned. If neither fields are set, a null is
7026 * returned.
7027 *
7028 * @param resolver A ContentResolver that can be used to determine the MIME
7029 * type of the intent's data.
7030 *
7031 * @return The MIME type of this intent.
7032 *
7033 * @see #getType
7034 * @see #resolveType(Context)
7035 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007036 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007037 if (mType != null) {
7038 return mType;
7039 }
7040 if (mData != null) {
7041 if ("content".equals(mData.getScheme())) {
7042 return resolver.getType(mData);
7043 }
7044 }
7045 return null;
7046 }
7047
7048 /**
7049 * Return the MIME data type of this intent, only if it will be needed for
7050 * intent resolution. This is not generally useful for application code;
7051 * it is used by the frameworks for communicating with back-end system
7052 * services.
7053 *
7054 * @param resolver A ContentResolver that can be used to determine the MIME
7055 * type of the intent's data.
7056 *
7057 * @return The MIME type of this intent, or null if it is unknown or not
7058 * needed.
7059 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007060 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007061 if (mComponent != null) {
7062 return mType;
7063 }
7064 return resolveType(resolver);
7065 }
7066
7067 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007068 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007069 *
7070 * @param category The category to check.
7071 *
7072 * @return boolean True if the intent contains the category, else false.
7073 *
7074 * @see #getCategories
7075 * @see #addCategory
7076 */
7077 public boolean hasCategory(String category) {
7078 return mCategories != null && mCategories.contains(category);
7079 }
7080
7081 /**
7082 * Return the set of all categories in the intent. If there are no categories,
7083 * returns NULL.
7084 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007085 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007086 *
7087 * @see #hasCategory
7088 * @see #addCategory
7089 */
7090 public Set<String> getCategories() {
7091 return mCategories;
7092 }
7093
7094 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007095 * Return the specific selector associated with this Intent. If there is
7096 * none, returns null. See {@link #setSelector} for more information.
7097 *
7098 * @see #setSelector
7099 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007100 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007101 return mSelector;
7102 }
7103
7104 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007105 * Return the {@link ClipData} associated with this Intent. If there is
7106 * none, returns null. See {@link #setClipData} for more information.
7107 *
John Spurlock125d1332013-11-25 11:58:37 -05007108 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007109 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007110 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007111 return mClipData;
7112 }
7113
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007114 /** @hide */
7115 public int getContentUserHint() {
7116 return mContentUserHint;
7117 }
7118
Todd Kennedyb3b431302017-03-20 16:05:48 -07007119 /** @hide */
7120 public String getLaunchToken() {
7121 return mLaunchToken;
7122 }
7123
7124 /** @hide */
7125 public void setLaunchToken(String launchToken) {
7126 mLaunchToken = launchToken;
7127 }
7128
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007129 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007130 * Sets the ClassLoader that will be used when unmarshalling
7131 * any Parcelable values from the extras of this Intent.
7132 *
7133 * @param loader a ClassLoader, or null to use the default loader
7134 * at the time of unmarshalling.
7135 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007136 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007137 if (mExtras != null) {
7138 mExtras.setClassLoader(loader);
7139 }
7140 }
7141
7142 /**
7143 * Returns true if an extra value is associated with the given name.
7144 * @param name the extra's name
7145 * @return true if the given extra is present.
7146 */
7147 public boolean hasExtra(String name) {
7148 return mExtras != null && mExtras.containsKey(name);
7149 }
7150
7151 /**
7152 * Returns true if the Intent's extras contain a parcelled file descriptor.
7153 * @return true if the Intent contains a parcelled file descriptor.
7154 */
7155 public boolean hasFileDescriptors() {
7156 return mExtras != null && mExtras.hasFileDescriptors();
7157 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007158
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007159 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04007160 public void setAllowFds(boolean allowFds) {
7161 if (mExtras != null) {
7162 mExtras.setAllowFds(allowFds);
7163 }
7164 }
7165
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007166 /** {@hide} */
7167 public void setDefusable(boolean defusable) {
7168 if (mExtras != null) {
7169 mExtras.setDefusable(defusable);
7170 }
7171 }
7172
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007173 /**
7174 * Retrieve extended data from the intent.
7175 *
7176 * @param name The name of the desired item.
7177 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007178 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007179 * or null if none was found.
7180 *
7181 * @deprecated
7182 * @hide
7183 */
7184 @Deprecated
7185 public Object getExtra(String name) {
7186 return getExtra(name, null);
7187 }
7188
7189 /**
7190 * Retrieve extended data from the intent.
7191 *
7192 * @param name The name of the desired item.
7193 * @param defaultValue the value to be returned if no value of the desired
7194 * type is stored with the given name.
7195 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007196 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007197 * or the default value if none was found.
7198 *
7199 * @see #putExtra(String, boolean)
7200 */
7201 public boolean getBooleanExtra(String name, boolean defaultValue) {
7202 return mExtras == null ? defaultValue :
7203 mExtras.getBoolean(name, defaultValue);
7204 }
7205
7206 /**
7207 * Retrieve extended data from the intent.
7208 *
7209 * @param name The name of the desired item.
7210 * @param defaultValue the value to be returned if no value of the desired
7211 * type is stored with the given name.
7212 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007213 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007214 * or the default value if none was found.
7215 *
7216 * @see #putExtra(String, byte)
7217 */
7218 public byte getByteExtra(String name, byte defaultValue) {
7219 return mExtras == null ? defaultValue :
7220 mExtras.getByte(name, defaultValue);
7221 }
7222
7223 /**
7224 * Retrieve extended data from the intent.
7225 *
7226 * @param name The name of the desired item.
7227 * @param defaultValue the value to be returned if no value of the desired
7228 * type is stored with the given name.
7229 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007230 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007231 * or the default value if none was found.
7232 *
7233 * @see #putExtra(String, short)
7234 */
7235 public short getShortExtra(String name, short defaultValue) {
7236 return mExtras == null ? defaultValue :
7237 mExtras.getShort(name, defaultValue);
7238 }
7239
7240 /**
7241 * Retrieve extended data from the intent.
7242 *
7243 * @param name The name of the desired item.
7244 * @param defaultValue the value to be returned if no value of the desired
7245 * type is stored with the given name.
7246 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007247 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007248 * or the default value if none was found.
7249 *
7250 * @see #putExtra(String, char)
7251 */
7252 public char getCharExtra(String name, char defaultValue) {
7253 return mExtras == null ? defaultValue :
7254 mExtras.getChar(name, defaultValue);
7255 }
7256
7257 /**
7258 * Retrieve extended data from the intent.
7259 *
7260 * @param name The name of the desired item.
7261 * @param defaultValue the value to be returned if no value of the desired
7262 * type is stored with the given name.
7263 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007264 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007265 * or the default value if none was found.
7266 *
7267 * @see #putExtra(String, int)
7268 */
7269 public int getIntExtra(String name, int defaultValue) {
7270 return mExtras == null ? defaultValue :
7271 mExtras.getInt(name, defaultValue);
7272 }
7273
7274 /**
7275 * Retrieve extended data from the intent.
7276 *
7277 * @param name The name of the desired item.
7278 * @param defaultValue the value to be returned if no value of the desired
7279 * type is stored with the given name.
7280 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007281 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007282 * or the default value if none was found.
7283 *
7284 * @see #putExtra(String, long)
7285 */
7286 public long getLongExtra(String name, long defaultValue) {
7287 return mExtras == null ? defaultValue :
7288 mExtras.getLong(name, defaultValue);
7289 }
7290
7291 /**
7292 * Retrieve extended data from the intent.
7293 *
7294 * @param name The name of the desired item.
7295 * @param defaultValue the value to be returned if no value of the desired
7296 * type is stored with the given name.
7297 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007298 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007299 * or the default value if no such item is present
7300 *
7301 * @see #putExtra(String, float)
7302 */
7303 public float getFloatExtra(String name, float defaultValue) {
7304 return mExtras == null ? defaultValue :
7305 mExtras.getFloat(name, defaultValue);
7306 }
7307
7308 /**
7309 * Retrieve extended data from the intent.
7310 *
7311 * @param name The name of the desired item.
7312 * @param defaultValue the value to be returned if no value of the desired
7313 * type is stored with the given name.
7314 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007315 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007316 * or the default value if none was found.
7317 *
7318 * @see #putExtra(String, double)
7319 */
7320 public double getDoubleExtra(String name, double defaultValue) {
7321 return mExtras == null ? defaultValue :
7322 mExtras.getDouble(name, defaultValue);
7323 }
7324
7325 /**
7326 * Retrieve extended data from the intent.
7327 *
7328 * @param name The name of the desired item.
7329 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007330 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007331 * or null if no String value was found.
7332 *
7333 * @see #putExtra(String, String)
7334 */
7335 public String getStringExtra(String name) {
7336 return mExtras == null ? null : mExtras.getString(name);
7337 }
7338
7339 /**
7340 * Retrieve extended data from the intent.
7341 *
7342 * @param name The name of the desired item.
7343 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007344 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007345 * or null if no CharSequence value was found.
7346 *
7347 * @see #putExtra(String, CharSequence)
7348 */
7349 public CharSequence getCharSequenceExtra(String name) {
7350 return mExtras == null ? null : mExtras.getCharSequence(name);
7351 }
7352
7353 /**
7354 * Retrieve extended data from the intent.
7355 *
7356 * @param name The name of the desired item.
7357 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007358 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007359 * or null if no Parcelable value was found.
7360 *
7361 * @see #putExtra(String, Parcelable)
7362 */
7363 public <T extends Parcelable> T getParcelableExtra(String name) {
7364 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7365 }
7366
7367 /**
7368 * Retrieve extended data from the intent.
7369 *
7370 * @param name The name of the desired item.
7371 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007372 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007373 * or null if no Parcelable[] value was found.
7374 *
7375 * @see #putExtra(String, Parcelable[])
7376 */
7377 public Parcelable[] getParcelableArrayExtra(String name) {
7378 return mExtras == null ? null : mExtras.getParcelableArray(name);
7379 }
7380
7381 /**
7382 * Retrieve extended data from the intent.
7383 *
7384 * @param name The name of the desired item.
7385 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007386 * @return the value of an item previously added with
7387 * putParcelableArrayListExtra(), or null if no
7388 * ArrayList<Parcelable> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007389 *
7390 * @see #putParcelableArrayListExtra(String, ArrayList)
7391 */
7392 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
7393 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7394 }
7395
7396 /**
7397 * Retrieve extended data from the intent.
7398 *
7399 * @param name The name of the desired item.
7400 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007401 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007402 * or null if no Serializable value was found.
7403 *
7404 * @see #putExtra(String, Serializable)
7405 */
7406 public Serializable getSerializableExtra(String name) {
7407 return mExtras == null ? null : mExtras.getSerializable(name);
7408 }
7409
7410 /**
7411 * Retrieve extended data from the intent.
7412 *
7413 * @param name The name of the desired item.
7414 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007415 * @return the value of an item previously added with
7416 * putIntegerArrayListExtra(), or null if no
7417 * ArrayList<Integer> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007418 *
7419 * @see #putIntegerArrayListExtra(String, ArrayList)
7420 */
7421 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
7422 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7423 }
7424
7425 /**
7426 * Retrieve extended data from the intent.
7427 *
7428 * @param name The name of the desired item.
7429 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007430 * @return the value of an item previously added with
7431 * putStringArrayListExtra(), or null if no
7432 * ArrayList<String> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007433 *
7434 * @see #putStringArrayListExtra(String, ArrayList)
7435 */
7436 public ArrayList<String> getStringArrayListExtra(String name) {
7437 return mExtras == null ? null : mExtras.getStringArrayList(name);
7438 }
7439
7440 /**
7441 * Retrieve extended data from the intent.
7442 *
7443 * @param name The name of the desired item.
7444 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007445 * @return the value of an item previously added with
7446 * putCharSequenceArrayListExtra, or null if no
7447 * ArrayList<CharSequence> value was found.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007448 *
7449 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7450 */
7451 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
7452 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7453 }
7454
7455 /**
7456 * Retrieve extended data from the intent.
7457 *
7458 * @param name The name of the desired item.
7459 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007460 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007461 * or null if no boolean array value was found.
7462 *
7463 * @see #putExtra(String, boolean[])
7464 */
7465 public boolean[] getBooleanArrayExtra(String name) {
7466 return mExtras == null ? null : mExtras.getBooleanArray(name);
7467 }
7468
7469 /**
7470 * Retrieve extended data from the intent.
7471 *
7472 * @param name The name of the desired item.
7473 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007474 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007475 * or null if no byte array value was found.
7476 *
7477 * @see #putExtra(String, byte[])
7478 */
7479 public byte[] getByteArrayExtra(String name) {
7480 return mExtras == null ? null : mExtras.getByteArray(name);
7481 }
7482
7483 /**
7484 * Retrieve extended data from the intent.
7485 *
7486 * @param name The name of the desired item.
7487 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007488 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007489 * or null if no short array value was found.
7490 *
7491 * @see #putExtra(String, short[])
7492 */
7493 public short[] getShortArrayExtra(String name) {
7494 return mExtras == null ? null : mExtras.getShortArray(name);
7495 }
7496
7497 /**
7498 * Retrieve extended data from the intent.
7499 *
7500 * @param name The name of the desired item.
7501 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007502 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007503 * or null if no char array value was found.
7504 *
7505 * @see #putExtra(String, char[])
7506 */
7507 public char[] getCharArrayExtra(String name) {
7508 return mExtras == null ? null : mExtras.getCharArray(name);
7509 }
7510
7511 /**
7512 * Retrieve extended data from the intent.
7513 *
7514 * @param name The name of the desired item.
7515 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007516 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007517 * or null if no int array value was found.
7518 *
7519 * @see #putExtra(String, int[])
7520 */
7521 public int[] getIntArrayExtra(String name) {
7522 return mExtras == null ? null : mExtras.getIntArray(name);
7523 }
7524
7525 /**
7526 * Retrieve extended data from the intent.
7527 *
7528 * @param name The name of the desired item.
7529 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007530 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007531 * or null if no long array value was found.
7532 *
7533 * @see #putExtra(String, long[])
7534 */
7535 public long[] getLongArrayExtra(String name) {
7536 return mExtras == null ? null : mExtras.getLongArray(name);
7537 }
7538
7539 /**
7540 * Retrieve extended data from the intent.
7541 *
7542 * @param name The name of the desired item.
7543 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007544 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007545 * or null if no float array value was found.
7546 *
7547 * @see #putExtra(String, float[])
7548 */
7549 public float[] getFloatArrayExtra(String name) {
7550 return mExtras == null ? null : mExtras.getFloatArray(name);
7551 }
7552
7553 /**
7554 * Retrieve extended data from the intent.
7555 *
7556 * @param name The name of the desired item.
7557 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007558 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007559 * or null if no double array value was found.
7560 *
7561 * @see #putExtra(String, double[])
7562 */
7563 public double[] getDoubleArrayExtra(String name) {
7564 return mExtras == null ? null : mExtras.getDoubleArray(name);
7565 }
7566
7567 /**
7568 * Retrieve extended data from the intent.
7569 *
7570 * @param name The name of the desired item.
7571 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007572 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007573 * or null if no String array value was found.
7574 *
7575 * @see #putExtra(String, String[])
7576 */
7577 public String[] getStringArrayExtra(String name) {
7578 return mExtras == null ? null : mExtras.getStringArray(name);
7579 }
7580
7581 /**
7582 * Retrieve extended data from the intent.
7583 *
7584 * @param name The name of the desired item.
7585 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007586 * @return the value of an item previously added with putExtra(),
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007587 * or null if no CharSequence array value was found.
7588 *
7589 * @see #putExtra(String, CharSequence[])
7590 */
7591 public CharSequence[] getCharSequenceArrayExtra(String name) {
7592 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7593 }
7594
7595 /**
7596 * Retrieve extended data from the intent.
7597 *
7598 * @param name The name of the desired item.
7599 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007600 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007601 * or null if no Bundle value was found.
7602 *
7603 * @see #putExtra(String, Bundle)
7604 */
7605 public Bundle getBundleExtra(String name) {
7606 return mExtras == null ? null : mExtras.getBundle(name);
7607 }
7608
7609 /**
7610 * Retrieve extended data from the intent.
7611 *
7612 * @param name The name of the desired item.
7613 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007614 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007615 * or null if no IBinder value was found.
7616 *
7617 * @see #putExtra(String, IBinder)
7618 *
7619 * @deprecated
7620 * @hide
7621 */
7622 @Deprecated
7623 public IBinder getIBinderExtra(String name) {
7624 return mExtras == null ? null : mExtras.getIBinder(name);
7625 }
7626
7627 /**
7628 * Retrieve extended data from the intent.
7629 *
7630 * @param name The name of the desired item.
7631 * @param defaultValue The default value to return in case no item is
7632 * associated with the key 'name'
7633 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007634 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007635 * or defaultValue if none was found.
7636 *
7637 * @see #putExtra
7638 *
7639 * @deprecated
7640 * @hide
7641 */
7642 @Deprecated
7643 public Object getExtra(String name, Object defaultValue) {
7644 Object result = defaultValue;
7645 if (mExtras != null) {
7646 Object result2 = mExtras.get(name);
7647 if (result2 != null) {
7648 result = result2;
7649 }
7650 }
7651
7652 return result;
7653 }
7654
7655 /**
7656 * Retrieves a map of extended data from the intent.
7657 *
7658 * @return the map of all extras previously added with putExtra(),
7659 * or null if none have been added.
7660 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007661 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007662 return (mExtras != null)
7663 ? new Bundle(mExtras)
7664 : null;
7665 }
7666
7667 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007668 * Filter extras to only basic types.
7669 * @hide
7670 */
7671 public void removeUnsafeExtras() {
7672 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007673 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007674 }
7675 }
7676
7677 /**
Makoto Onuki97f82f22017-05-31 16:20:21 -07007678 * @return Whether {@link #maybeStripForHistory} will return an lightened intent or
7679 * return itself as-is.
7680 * @hide
7681 */
7682 public boolean canStripForHistory() {
7683 return ((mExtras != null) && mExtras.isParcelled()) || (mClipData != null);
7684 }
7685
7686 /**
7687 * Call it when the system needs to keep an intent for logging purposes to remove fields
7688 * that are not needed for logging.
7689 * @hide
7690 */
7691 public Intent maybeStripForHistory() {
7692 // TODO Scan and remove possibly heavy instances like Bitmaps from unparcelled extras?
7693
7694 if (!canStripForHistory()) {
7695 return this;
7696 }
7697 return new Intent(this, COPY_MODE_HISTORY);
7698 }
7699
7700 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007701 * Retrieve any special flags associated with this intent. You will
7702 * normally just set them with {@link #setFlags} and let the system
7703 * take the appropriate action with them.
7704 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007705 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007706 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007707 * @see #addFlags
7708 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007709 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007710 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007711 return mFlags;
7712 }
7713
Dianne Hackborne7f97212011-02-24 14:40:20 -08007714 /** @hide */
7715 public boolean isExcludingStopped() {
7716 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7717 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7718 }
7719
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007720 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007721 * Retrieve the application package name this Intent is limited to. When
7722 * resolving an Intent, if non-null this limits the resolution to only
7723 * components in the given application package.
7724 *
7725 * @return The name of the application package for the Intent.
7726 *
7727 * @see #resolveActivity
7728 * @see #setPackage
7729 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007730 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007731 return mPackage;
7732 }
7733
7734 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007735 * Retrieve the concrete component associated with the intent. When receiving
7736 * an intent, this is the component that was found to best handle it (that is,
7737 * yourself) and will always be non-null; in all other cases it will be
7738 * null unless explicitly set.
7739 *
7740 * @return The name of the application component to handle the intent.
7741 *
7742 * @see #resolveActivity
7743 * @see #setComponent
7744 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007745 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007746 return mComponent;
7747 }
7748
7749 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007750 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7751 * used as a hint to the receiver for animations and the like. Null means that there
7752 * is no source bounds.
7753 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007754 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007755 return mSourceBounds;
7756 }
7757
7758 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007759 * Return the Activity component that should be used to handle this intent.
7760 * The appropriate component is determined based on the information in the
7761 * intent, evaluated as follows:
7762 *
7763 * <p>If {@link #getComponent} returns an explicit class, that is returned
7764 * without any further consideration.
7765 *
7766 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7767 * category to be considered.
7768 *
7769 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7770 * action.
7771 *
7772 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7773 * this type.
7774 *
7775 * <p>If {@link #addCategory} has added any categories, the activity must
7776 * handle ALL of the categories specified.
7777 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007778 * <p>If {@link #getPackage} is non-NULL, only activity components in
7779 * that application package will be considered.
7780 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007781 * <p>If there are no activities that satisfy all of these conditions, a
7782 * null string is returned.
7783 *
7784 * <p>If multiple activities are found to satisfy the intent, the one with
7785 * the highest priority will be used. If there are multiple activities
7786 * with the same priority, the system will either pick the best activity
7787 * based on user preference, or resolve to a system class that will allow
7788 * the user to pick an activity and forward from there.
7789 *
7790 * <p>This method is implemented simply by calling
7791 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7792 * true.</p>
7793 * <p> This API is called for you as part of starting an activity from an
7794 * intent. You do not normally need to call it yourself.</p>
7795 *
7796 * @param pm The package manager with which to resolve the Intent.
7797 *
7798 * @return Name of the component implementing an activity that can
7799 * display the intent.
7800 *
7801 * @see #setComponent
7802 * @see #getComponent
7803 * @see #resolveActivityInfo
7804 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007805 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007806 if (mComponent != null) {
7807 return mComponent;
7808 }
7809
7810 ResolveInfo info = pm.resolveActivity(
7811 this, PackageManager.MATCH_DEFAULT_ONLY);
7812 if (info != null) {
7813 return new ComponentName(
7814 info.activityInfo.applicationInfo.packageName,
7815 info.activityInfo.name);
7816 }
7817
7818 return null;
7819 }
7820
7821 /**
7822 * Resolve the Intent into an {@link ActivityInfo}
7823 * describing the activity that should execute the intent. Resolution
7824 * follows the same rules as described for {@link #resolveActivity}, but
7825 * you get back the completely information about the resolved activity
7826 * instead of just its class name.
7827 *
7828 * @param pm The package manager with which to resolve the Intent.
7829 * @param flags Addition information to retrieve as per
7830 * {@link PackageManager#getActivityInfo(ComponentName, int)
7831 * PackageManager.getActivityInfo()}.
7832 *
7833 * @return PackageManager.ActivityInfo
7834 *
7835 * @see #resolveActivity
7836 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007837 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
7838 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007839 ActivityInfo ai = null;
7840 if (mComponent != null) {
7841 try {
7842 ai = pm.getActivityInfo(mComponent, flags);
7843 } catch (PackageManager.NameNotFoundException e) {
7844 // ignore
7845 }
7846 } else {
7847 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007848 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007849 if (info != null) {
7850 ai = info.activityInfo;
7851 }
7852 }
7853
7854 return ai;
7855 }
7856
7857 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007858 * Special function for use by the system to resolve service
7859 * intents to system apps. Throws an exception if there are
7860 * multiple potential matches to the Intent. Returns null if
7861 * there are no matches.
7862 * @hide
7863 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007864 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
7865 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07007866 if (mComponent != null) {
7867 return mComponent;
7868 }
7869
7870 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7871 if (results == null) {
7872 return null;
7873 }
7874 ComponentName comp = null;
7875 for (int i=0; i<results.size(); i++) {
7876 ResolveInfo ri = results.get(i);
7877 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7878 continue;
7879 }
7880 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7881 ri.serviceInfo.name);
7882 if (comp != null) {
7883 throw new IllegalStateException("Multiple system services handle " + this
7884 + ": " + comp + ", " + foundComp);
7885 }
7886 comp = foundComp;
7887 }
7888 return comp;
7889 }
7890
7891 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007892 * Set the general action to be performed.
7893 *
7894 * @param action An action name, such as ACTION_VIEW. Application-specific
7895 * actions should be prefixed with the vendor's package name.
7896 *
7897 * @return Returns the same Intent object, for chaining multiple calls
7898 * into a single statement.
7899 *
7900 * @see #getAction
7901 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007902 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007903 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007904 return this;
7905 }
7906
7907 /**
7908 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007909 * clears any type that was previously set by {@link #setType} or
7910 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007911 *
Nick Pellyccae4122012-01-09 14:12:58 -08007912 * <p><em>Note: scheme matching in the Android framework is
7913 * case-sensitive, unlike the formal RFC. As a result,
7914 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007915 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007916 * {@link #setDataAndNormalize}
7917 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007918 *
Nick Pellyccae4122012-01-09 14:12:58 -08007919 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007920 *
7921 * @return Returns the same Intent object, for chaining multiple calls
7922 * into a single statement.
7923 *
7924 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007925 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007926 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007927 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007928 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007929 mData = data;
7930 mType = null;
7931 return this;
7932 }
7933
7934 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007935 * Normalize and set the data this intent is operating on.
7936 *
7937 * <p>This method automatically clears any type that was
7938 * previously set (for example, by {@link #setType}).
7939 *
7940 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007941 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007942 * so really this is just a convenience method for
7943 * <pre>
7944 * setData(data.normalize())
7945 * </pre>
7946 *
7947 * @param data The Uri of the data this intent is now targeting.
7948 *
7949 * @return Returns the same Intent object, for chaining multiple calls
7950 * into a single statement.
7951 *
7952 * @see #getData
7953 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007954 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007955 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007956 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007957 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007958 }
7959
7960 /**
7961 * Set an explicit MIME data type.
7962 *
7963 * <p>This is used to create intents that only specify a type and not data,
7964 * for example to indicate the type of data to return.
7965 *
7966 * <p>This method automatically clears any data that was
7967 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007968 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007969 * <p><em>Note: MIME type matching in the Android framework is
7970 * case-sensitive, unlike formal RFC MIME types. As a result,
7971 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007972 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7973 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007974 *
7975 * @param type The MIME type of the data being handled by this intent.
7976 *
7977 * @return Returns the same Intent object, for chaining multiple calls
7978 * into a single statement.
7979 *
7980 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007981 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007982 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007983 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007984 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007985 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007986 mData = null;
7987 mType = type;
7988 return this;
7989 }
7990
7991 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007992 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007993 *
Nick Pellyccae4122012-01-09 14:12:58 -08007994 * <p>This is used to create intents that only specify a type and not data,
7995 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007996 *
Nick Pellyccae4122012-01-09 14:12:58 -08007997 * <p>This method automatically clears any data that was
7998 * previously set (for example by {@link #setData}).
7999 *
8000 * <p>The MIME type is normalized using
8001 * {@link #normalizeMimeType} before it is set,
8002 * so really this is just a convenience method for
8003 * <pre>
8004 * setType(Intent.normalizeMimeType(type))
8005 * </pre>
8006 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008007 * @param type The MIME type of the data being handled by this intent.
8008 *
8009 * @return Returns the same Intent object, for chaining multiple calls
8010 * into a single statement.
8011 *
Nick Pellyccae4122012-01-09 14:12:58 -08008012 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008013 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08008014 * @see #normalizeMimeType
8015 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008016 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08008017 return setType(normalizeMimeType(type));
8018 }
8019
8020 /**
8021 * (Usually optional) Set the data for the intent along with an explicit
8022 * MIME data type. This method should very rarely be used -- it allows you
8023 * to override the MIME type that would ordinarily be inferred from the
8024 * data with your own type given here.
8025 *
8026 * <p><em>Note: MIME type and Uri scheme matching in the
8027 * Android framework is case-sensitive, unlike the formal RFC definitions.
8028 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008029 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08008030 * {@link #setDataAndTypeAndNormalize}
8031 * to ensure that they are converted to lower case.</em>
8032 *
8033 * @param data The Uri of the data this intent is now targeting.
8034 * @param type The MIME type of the data being handled by this intent.
8035 *
8036 * @return Returns the same Intent object, for chaining multiple calls
8037 * into a single statement.
8038 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008039 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08008040 * @see #setData
8041 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008042 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008043 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008044 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008045 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008046 mData = data;
8047 mType = type;
8048 return this;
8049 }
8050
8051 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008052 * (Usually optional) Normalize and set both the data Uri and an explicit
8053 * MIME data type. This method should very rarely be used -- it allows you
8054 * to override the MIME type that would ordinarily be inferred from the
8055 * data with your own type given here.
8056 *
8057 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008058 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08008059 * before they are set, so really this is just a convenience method for
8060 * <pre>
8061 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
8062 * </pre>
8063 *
8064 * @param data The Uri of the data this intent is now targeting.
8065 * @param type The MIME type of the data being handled by this intent.
8066 *
8067 * @return Returns the same Intent object, for chaining multiple calls
8068 * into a single statement.
8069 *
8070 * @see #setType
8071 * @see #setData
8072 * @see #setDataAndType
8073 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008074 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008075 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008076 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008077 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08008078 }
8079
8080 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008081 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008082 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008083 * activities that provide <em>all</em> of the requested categories will be
8084 * used.
8085 *
8086 * @param category The desired category. This can be either one of the
8087 * predefined Intent categories, or a custom category in your own
8088 * namespace.
8089 *
8090 * @return Returns the same Intent object, for chaining multiple calls
8091 * into a single statement.
8092 *
8093 * @see #hasCategory
8094 * @see #removeCategory
8095 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008096 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008097 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008098 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008099 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08008100 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008101 return this;
8102 }
8103
8104 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008105 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008106 *
8107 * @param category The category to remove.
8108 *
8109 * @see #addCategory
8110 */
8111 public void removeCategory(String category) {
8112 if (mCategories != null) {
8113 mCategories.remove(category);
8114 if (mCategories.size() == 0) {
8115 mCategories = null;
8116 }
8117 }
8118 }
8119
8120 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008121 * Set a selector for this Intent. This is a modification to the kinds of
8122 * things the Intent will match. If the selector is set, it will be used
8123 * when trying to find entities that can handle the Intent, instead of the
8124 * main contents of the Intent. This allows you build an Intent containing
8125 * a generic protocol while targeting it more specifically.
8126 *
8127 * <p>An example of where this may be used is with things like
8128 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
8129 * Intent that will launch the Browser application. However, the correct
8130 * main entry point of an application is actually {@link #ACTION_MAIN}
8131 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
8132 * used to specify the actual Activity to launch. If you launch the browser
8133 * with something different, undesired behavior may happen if the user has
8134 * previously or later launches it the normal way, since they do not match.
8135 * Instead, you can build an Intent with the MAIN action (but no ComponentName
8136 * yet specified) and set a selector with {@link #ACTION_MAIN} and
8137 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
8138 *
8139 * <p>Setting a selector does not impact the behavior of
8140 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
8141 * desired behavior of a selector -- it does not impact the base meaning
8142 * of the Intent, just what kinds of things will be matched against it
8143 * when determining who can handle it.</p>
8144 *
8145 * <p>You can not use both a selector and {@link #setPackage(String)} on
8146 * the same base Intent.</p>
8147 *
8148 * @param selector The desired selector Intent; set to null to not use
8149 * a special selector.
8150 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008151 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008152 if (selector == this) {
8153 throw new IllegalArgumentException(
8154 "Intent being set as a selector of itself");
8155 }
8156 if (selector != null && mPackage != null) {
8157 throw new IllegalArgumentException(
8158 "Can't set selector when package name is already set");
8159 }
8160 mSelector = selector;
8161 }
8162
8163 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008164 * Set a {@link ClipData} associated with this Intent. This replaces any
8165 * previously set ClipData.
8166 *
8167 * <p>The ClipData in an intent is not used for Intent matching or other
8168 * such operations. Semantically it is like extras, used to transmit
8169 * additional data with the Intent. The main feature of using this over
8170 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
8171 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
8172 * items included in the clip data. This is useful, in particular, if
8173 * you want to transmit an Intent containing multiple <code>content:</code>
8174 * URIs for which the recipient may not have global permission to access the
8175 * content provider.
8176 *
8177 * <p>If the ClipData contains items that are themselves Intents, any
8178 * grant flags in those Intents will be ignored. Only the top-level flags
8179 * of the main Intent are respected, and will be applied to all Uri or
8180 * Intent items in the clip (or sub-items of the clip).
8181 *
8182 * <p>The MIME type, label, and icon in the ClipData object are not
8183 * directly used by Intent. Applications should generally rely on the
8184 * MIME type of the Intent itself, not what it may find in the ClipData.
8185 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05008186 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008187 *
8188 * @param clip The new clip to set. May be null to clear the current clip.
8189 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008190 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008191 mClipData = clip;
8192 }
8193
8194 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008195 * This is NOT a secure mechanism to identify the user who sent the intent.
8196 * When the intent is sent to a different user, it is used to fix uris by adding the userId
8197 * who sent the intent.
8198 * @hide
8199 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01008200 public void prepareToLeaveUser(int userId) {
8201 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
8202 // We want mContentUserHint to refer to the original user, so don't do anything.
8203 if (mContentUserHint == UserHandle.USER_CURRENT) {
8204 mContentUserHint = userId;
8205 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008206 }
8207
8208 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008209 * Add extended data to the intent. The name must include a package
8210 * prefix, for example the app com.android.contacts would use names
8211 * like "com.android.contacts.ShowAll".
8212 *
8213 * @param name The name of the extra data, with package prefix.
8214 * @param value The boolean data value.
8215 *
8216 * @return Returns the same Intent object, for chaining multiple calls
8217 * into a single statement.
8218 *
8219 * @see #putExtras
8220 * @see #removeExtra
8221 * @see #getBooleanExtra(String, boolean)
8222 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008223 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008224 if (mExtras == null) {
8225 mExtras = new Bundle();
8226 }
8227 mExtras.putBoolean(name, value);
8228 return this;
8229 }
8230
8231 /**
8232 * Add extended data to the intent. The name must include a package
8233 * prefix, for example the app com.android.contacts would use names
8234 * like "com.android.contacts.ShowAll".
8235 *
8236 * @param name The name of the extra data, with package prefix.
8237 * @param value The byte data value.
8238 *
8239 * @return Returns the same Intent object, for chaining multiple calls
8240 * into a single statement.
8241 *
8242 * @see #putExtras
8243 * @see #removeExtra
8244 * @see #getByteExtra(String, byte)
8245 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008246 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008247 if (mExtras == null) {
8248 mExtras = new Bundle();
8249 }
8250 mExtras.putByte(name, value);
8251 return this;
8252 }
8253
8254 /**
8255 * Add extended data to the intent. The name must include a package
8256 * prefix, for example the app com.android.contacts would use names
8257 * like "com.android.contacts.ShowAll".
8258 *
8259 * @param name The name of the extra data, with package prefix.
8260 * @param value The char data value.
8261 *
8262 * @return Returns the same Intent object, for chaining multiple calls
8263 * into a single statement.
8264 *
8265 * @see #putExtras
8266 * @see #removeExtra
8267 * @see #getCharExtra(String, char)
8268 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008269 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008270 if (mExtras == null) {
8271 mExtras = new Bundle();
8272 }
8273 mExtras.putChar(name, value);
8274 return this;
8275 }
8276
8277 /**
8278 * Add extended data to the intent. The name must include a package
8279 * prefix, for example the app com.android.contacts would use names
8280 * like "com.android.contacts.ShowAll".
8281 *
8282 * @param name The name of the extra data, with package prefix.
8283 * @param value The short data value.
8284 *
8285 * @return Returns the same Intent object, for chaining multiple calls
8286 * into a single statement.
8287 *
8288 * @see #putExtras
8289 * @see #removeExtra
8290 * @see #getShortExtra(String, short)
8291 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008292 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008293 if (mExtras == null) {
8294 mExtras = new Bundle();
8295 }
8296 mExtras.putShort(name, value);
8297 return this;
8298 }
8299
8300 /**
8301 * Add extended data to the intent. The name must include a package
8302 * prefix, for example the app com.android.contacts would use names
8303 * like "com.android.contacts.ShowAll".
8304 *
8305 * @param name The name of the extra data, with package prefix.
8306 * @param value The integer data value.
8307 *
8308 * @return Returns the same Intent object, for chaining multiple calls
8309 * into a single statement.
8310 *
8311 * @see #putExtras
8312 * @see #removeExtra
8313 * @see #getIntExtra(String, int)
8314 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008315 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008316 if (mExtras == null) {
8317 mExtras = new Bundle();
8318 }
8319 mExtras.putInt(name, value);
8320 return this;
8321 }
8322
8323 /**
8324 * Add extended data to the intent. The name must include a package
8325 * prefix, for example the app com.android.contacts would use names
8326 * like "com.android.contacts.ShowAll".
8327 *
8328 * @param name The name of the extra data, with package prefix.
8329 * @param value The long data value.
8330 *
8331 * @return Returns the same Intent object, for chaining multiple calls
8332 * into a single statement.
8333 *
8334 * @see #putExtras
8335 * @see #removeExtra
8336 * @see #getLongExtra(String, long)
8337 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008338 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008339 if (mExtras == null) {
8340 mExtras = new Bundle();
8341 }
8342 mExtras.putLong(name, value);
8343 return this;
8344 }
8345
8346 /**
8347 * Add extended data to the intent. The name must include a package
8348 * prefix, for example the app com.android.contacts would use names
8349 * like "com.android.contacts.ShowAll".
8350 *
8351 * @param name The name of the extra data, with package prefix.
8352 * @param value The float data value.
8353 *
8354 * @return Returns the same Intent object, for chaining multiple calls
8355 * into a single statement.
8356 *
8357 * @see #putExtras
8358 * @see #removeExtra
8359 * @see #getFloatExtra(String, float)
8360 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008361 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008362 if (mExtras == null) {
8363 mExtras = new Bundle();
8364 }
8365 mExtras.putFloat(name, value);
8366 return this;
8367 }
8368
8369 /**
8370 * Add extended data to the intent. The name must include a package
8371 * prefix, for example the app com.android.contacts would use names
8372 * like "com.android.contacts.ShowAll".
8373 *
8374 * @param name The name of the extra data, with package prefix.
8375 * @param value The double data value.
8376 *
8377 * @return Returns the same Intent object, for chaining multiple calls
8378 * into a single statement.
8379 *
8380 * @see #putExtras
8381 * @see #removeExtra
8382 * @see #getDoubleExtra(String, double)
8383 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008384 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008385 if (mExtras == null) {
8386 mExtras = new Bundle();
8387 }
8388 mExtras.putDouble(name, value);
8389 return this;
8390 }
8391
8392 /**
8393 * Add extended data to the intent. The name must include a package
8394 * prefix, for example the app com.android.contacts would use names
8395 * like "com.android.contacts.ShowAll".
8396 *
8397 * @param name The name of the extra data, with package prefix.
8398 * @param value The String data value.
8399 *
8400 * @return Returns the same Intent object, for chaining multiple calls
8401 * into a single statement.
8402 *
8403 * @see #putExtras
8404 * @see #removeExtra
8405 * @see #getStringExtra(String)
8406 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008407 public @NonNull Intent putExtra(String name, String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008408 if (mExtras == null) {
8409 mExtras = new Bundle();
8410 }
8411 mExtras.putString(name, value);
8412 return this;
8413 }
8414
8415 /**
8416 * Add extended data to the intent. The name must include a package
8417 * prefix, for example the app com.android.contacts would use names
8418 * like "com.android.contacts.ShowAll".
8419 *
8420 * @param name The name of the extra data, with package prefix.
8421 * @param value The CharSequence data value.
8422 *
8423 * @return Returns the same Intent object, for chaining multiple calls
8424 * into a single statement.
8425 *
8426 * @see #putExtras
8427 * @see #removeExtra
8428 * @see #getCharSequenceExtra(String)
8429 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008430 public @NonNull Intent putExtra(String name, CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008431 if (mExtras == null) {
8432 mExtras = new Bundle();
8433 }
8434 mExtras.putCharSequence(name, value);
8435 return this;
8436 }
8437
8438 /**
8439 * Add extended data to the intent. The name must include a package
8440 * prefix, for example the app com.android.contacts would use names
8441 * like "com.android.contacts.ShowAll".
8442 *
8443 * @param name The name of the extra data, with package prefix.
8444 * @param value The Parcelable data value.
8445 *
8446 * @return Returns the same Intent object, for chaining multiple calls
8447 * into a single statement.
8448 *
8449 * @see #putExtras
8450 * @see #removeExtra
8451 * @see #getParcelableExtra(String)
8452 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008453 public @NonNull Intent putExtra(String name, Parcelable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008454 if (mExtras == null) {
8455 mExtras = new Bundle();
8456 }
8457 mExtras.putParcelable(name, value);
8458 return this;
8459 }
8460
8461 /**
8462 * Add extended data to the intent. The name must include a package
8463 * prefix, for example the app com.android.contacts would use names
8464 * like "com.android.contacts.ShowAll".
8465 *
8466 * @param name The name of the extra data, with package prefix.
8467 * @param value The Parcelable[] data value.
8468 *
8469 * @return Returns the same Intent object, for chaining multiple calls
8470 * into a single statement.
8471 *
8472 * @see #putExtras
8473 * @see #removeExtra
8474 * @see #getParcelableArrayExtra(String)
8475 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008476 public @NonNull Intent putExtra(String name, Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008477 if (mExtras == null) {
8478 mExtras = new Bundle();
8479 }
8480 mExtras.putParcelableArray(name, value);
8481 return this;
8482 }
8483
8484 /**
8485 * Add extended data to the intent. The name must include a package
8486 * prefix, for example the app com.android.contacts would use names
8487 * like "com.android.contacts.ShowAll".
8488 *
8489 * @param name The name of the extra data, with package prefix.
8490 * @param value The ArrayList<Parcelable> data value.
8491 *
8492 * @return Returns the same Intent object, for chaining multiple calls
8493 * into a single statement.
8494 *
8495 * @see #putExtras
8496 * @see #removeExtra
8497 * @see #getParcelableArrayListExtra(String)
8498 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008499 public @NonNull Intent putParcelableArrayListExtra(String name,
8500 ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008501 if (mExtras == null) {
8502 mExtras = new Bundle();
8503 }
8504 mExtras.putParcelableArrayList(name, value);
8505 return this;
8506 }
8507
8508 /**
8509 * Add extended data to the intent. The name must include a package
8510 * prefix, for example the app com.android.contacts would use names
8511 * like "com.android.contacts.ShowAll".
8512 *
8513 * @param name The name of the extra data, with package prefix.
8514 * @param value The ArrayList<Integer> data value.
8515 *
8516 * @return Returns the same Intent object, for chaining multiple calls
8517 * into a single statement.
8518 *
8519 * @see #putExtras
8520 * @see #removeExtra
8521 * @see #getIntegerArrayListExtra(String)
8522 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008523 public @NonNull Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008524 if (mExtras == null) {
8525 mExtras = new Bundle();
8526 }
8527 mExtras.putIntegerArrayList(name, value);
8528 return this;
8529 }
8530
8531 /**
8532 * Add extended data to the intent. The name must include a package
8533 * prefix, for example the app com.android.contacts would use names
8534 * like "com.android.contacts.ShowAll".
8535 *
8536 * @param name The name of the extra data, with package prefix.
8537 * @param value The ArrayList<String> data value.
8538 *
8539 * @return Returns the same Intent object, for chaining multiple calls
8540 * into a single statement.
8541 *
8542 * @see #putExtras
8543 * @see #removeExtra
8544 * @see #getStringArrayListExtra(String)
8545 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008546 public @NonNull Intent putStringArrayListExtra(String name, ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008547 if (mExtras == null) {
8548 mExtras = new Bundle();
8549 }
8550 mExtras.putStringArrayList(name, value);
8551 return this;
8552 }
8553
8554 /**
8555 * Add extended data to the intent. The name must include a package
8556 * prefix, for example the app com.android.contacts would use names
8557 * like "com.android.contacts.ShowAll".
8558 *
8559 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008560 * @param value The ArrayList<CharSequence> data value.
8561 *
8562 * @return Returns the same Intent object, for chaining multiple calls
8563 * into a single statement.
8564 *
8565 * @see #putExtras
8566 * @see #removeExtra
8567 * @see #getCharSequenceArrayListExtra(String)
8568 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008569 public @NonNull Intent putCharSequenceArrayListExtra(String name,
8570 ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008571 if (mExtras == null) {
8572 mExtras = new Bundle();
8573 }
8574 mExtras.putCharSequenceArrayList(name, value);
8575 return this;
8576 }
8577
8578 /**
8579 * Add extended data to the intent. The name must include a package
8580 * prefix, for example the app com.android.contacts would use names
8581 * like "com.android.contacts.ShowAll".
8582 *
8583 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008584 * @param value The Serializable data value.
8585 *
8586 * @return Returns the same Intent object, for chaining multiple calls
8587 * into a single statement.
8588 *
8589 * @see #putExtras
8590 * @see #removeExtra
8591 * @see #getSerializableExtra(String)
8592 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008593 public @NonNull Intent putExtra(String name, Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008594 if (mExtras == null) {
8595 mExtras = new Bundle();
8596 }
8597 mExtras.putSerializable(name, value);
8598 return this;
8599 }
8600
8601 /**
8602 * Add extended data to the intent. The name must include a package
8603 * prefix, for example the app com.android.contacts would use names
8604 * like "com.android.contacts.ShowAll".
8605 *
8606 * @param name The name of the extra data, with package prefix.
8607 * @param value The boolean array data value.
8608 *
8609 * @return Returns the same Intent object, for chaining multiple calls
8610 * into a single statement.
8611 *
8612 * @see #putExtras
8613 * @see #removeExtra
8614 * @see #getBooleanArrayExtra(String)
8615 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008616 public @NonNull Intent putExtra(String name, boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008617 if (mExtras == null) {
8618 mExtras = new Bundle();
8619 }
8620 mExtras.putBooleanArray(name, value);
8621 return this;
8622 }
8623
8624 /**
8625 * Add extended data to the intent. The name must include a package
8626 * prefix, for example the app com.android.contacts would use names
8627 * like "com.android.contacts.ShowAll".
8628 *
8629 * @param name The name of the extra data, with package prefix.
8630 * @param value The byte array data value.
8631 *
8632 * @return Returns the same Intent object, for chaining multiple calls
8633 * into a single statement.
8634 *
8635 * @see #putExtras
8636 * @see #removeExtra
8637 * @see #getByteArrayExtra(String)
8638 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008639 public @NonNull Intent putExtra(String name, byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008640 if (mExtras == null) {
8641 mExtras = new Bundle();
8642 }
8643 mExtras.putByteArray(name, value);
8644 return this;
8645 }
8646
8647 /**
8648 * Add extended data to the intent. The name must include a package
8649 * prefix, for example the app com.android.contacts would use names
8650 * like "com.android.contacts.ShowAll".
8651 *
8652 * @param name The name of the extra data, with package prefix.
8653 * @param value The short array data value.
8654 *
8655 * @return Returns the same Intent object, for chaining multiple calls
8656 * into a single statement.
8657 *
8658 * @see #putExtras
8659 * @see #removeExtra
8660 * @see #getShortArrayExtra(String)
8661 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008662 public @NonNull Intent putExtra(String name, short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008663 if (mExtras == null) {
8664 mExtras = new Bundle();
8665 }
8666 mExtras.putShortArray(name, value);
8667 return this;
8668 }
8669
8670 /**
8671 * Add extended data to the intent. The name must include a package
8672 * prefix, for example the app com.android.contacts would use names
8673 * like "com.android.contacts.ShowAll".
8674 *
8675 * @param name The name of the extra data, with package prefix.
8676 * @param value The char array data value.
8677 *
8678 * @return Returns the same Intent object, for chaining multiple calls
8679 * into a single statement.
8680 *
8681 * @see #putExtras
8682 * @see #removeExtra
8683 * @see #getCharArrayExtra(String)
8684 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008685 public @NonNull Intent putExtra(String name, char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008686 if (mExtras == null) {
8687 mExtras = new Bundle();
8688 }
8689 mExtras.putCharArray(name, value);
8690 return this;
8691 }
8692
8693 /**
8694 * Add extended data to the intent. The name must include a package
8695 * prefix, for example the app com.android.contacts would use names
8696 * like "com.android.contacts.ShowAll".
8697 *
8698 * @param name The name of the extra data, with package prefix.
8699 * @param value The int array data value.
8700 *
8701 * @return Returns the same Intent object, for chaining multiple calls
8702 * into a single statement.
8703 *
8704 * @see #putExtras
8705 * @see #removeExtra
8706 * @see #getIntArrayExtra(String)
8707 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008708 public @NonNull Intent putExtra(String name, int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008709 if (mExtras == null) {
8710 mExtras = new Bundle();
8711 }
8712 mExtras.putIntArray(name, value);
8713 return this;
8714 }
8715
8716 /**
8717 * Add extended data to the intent. The name must include a package
8718 * prefix, for example the app com.android.contacts would use names
8719 * like "com.android.contacts.ShowAll".
8720 *
8721 * @param name The name of the extra data, with package prefix.
8722 * @param value The byte array data value.
8723 *
8724 * @return Returns the same Intent object, for chaining multiple calls
8725 * into a single statement.
8726 *
8727 * @see #putExtras
8728 * @see #removeExtra
8729 * @see #getLongArrayExtra(String)
8730 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008731 public @NonNull Intent putExtra(String name, long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008732 if (mExtras == null) {
8733 mExtras = new Bundle();
8734 }
8735 mExtras.putLongArray(name, value);
8736 return this;
8737 }
8738
8739 /**
8740 * Add extended data to the intent. The name must include a package
8741 * prefix, for example the app com.android.contacts would use names
8742 * like "com.android.contacts.ShowAll".
8743 *
8744 * @param name The name of the extra data, with package prefix.
8745 * @param value The float array data value.
8746 *
8747 * @return Returns the same Intent object, for chaining multiple calls
8748 * into a single statement.
8749 *
8750 * @see #putExtras
8751 * @see #removeExtra
8752 * @see #getFloatArrayExtra(String)
8753 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008754 public @NonNull Intent putExtra(String name, float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008755 if (mExtras == null) {
8756 mExtras = new Bundle();
8757 }
8758 mExtras.putFloatArray(name, value);
8759 return this;
8760 }
8761
8762 /**
8763 * Add extended data to the intent. The name must include a package
8764 * prefix, for example the app com.android.contacts would use names
8765 * like "com.android.contacts.ShowAll".
8766 *
8767 * @param name The name of the extra data, with package prefix.
8768 * @param value The double array data value.
8769 *
8770 * @return Returns the same Intent object, for chaining multiple calls
8771 * into a single statement.
8772 *
8773 * @see #putExtras
8774 * @see #removeExtra
8775 * @see #getDoubleArrayExtra(String)
8776 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008777 public @NonNull Intent putExtra(String name, double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008778 if (mExtras == null) {
8779 mExtras = new Bundle();
8780 }
8781 mExtras.putDoubleArray(name, value);
8782 return this;
8783 }
8784
8785 /**
8786 * Add extended data to the intent. The name must include a package
8787 * prefix, for example the app com.android.contacts would use names
8788 * like "com.android.contacts.ShowAll".
8789 *
8790 * @param name The name of the extra data, with package prefix.
8791 * @param value The String array data value.
8792 *
8793 * @return Returns the same Intent object, for chaining multiple calls
8794 * into a single statement.
8795 *
8796 * @see #putExtras
8797 * @see #removeExtra
8798 * @see #getStringArrayExtra(String)
8799 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008800 public @NonNull Intent putExtra(String name, String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008801 if (mExtras == null) {
8802 mExtras = new Bundle();
8803 }
8804 mExtras.putStringArray(name, value);
8805 return this;
8806 }
8807
8808 /**
8809 * Add extended data to the intent. The name must include a package
8810 * prefix, for example the app com.android.contacts would use names
8811 * like "com.android.contacts.ShowAll".
8812 *
8813 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008814 * @param value The CharSequence array data value.
8815 *
8816 * @return Returns the same Intent object, for chaining multiple calls
8817 * into a single statement.
8818 *
8819 * @see #putExtras
8820 * @see #removeExtra
8821 * @see #getCharSequenceArrayExtra(String)
8822 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008823 public @NonNull Intent putExtra(String name, CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008824 if (mExtras == null) {
8825 mExtras = new Bundle();
8826 }
8827 mExtras.putCharSequenceArray(name, value);
8828 return this;
8829 }
8830
8831 /**
8832 * Add extended data to the intent. The name must include a package
8833 * prefix, for example the app com.android.contacts would use names
8834 * like "com.android.contacts.ShowAll".
8835 *
8836 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008837 * @param value The Bundle data value.
8838 *
8839 * @return Returns the same Intent object, for chaining multiple calls
8840 * into a single statement.
8841 *
8842 * @see #putExtras
8843 * @see #removeExtra
8844 * @see #getBundleExtra(String)
8845 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008846 public @NonNull Intent putExtra(String name, Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008847 if (mExtras == null) {
8848 mExtras = new Bundle();
8849 }
8850 mExtras.putBundle(name, value);
8851 return this;
8852 }
8853
8854 /**
8855 * Add extended data to the intent. The name must include a package
8856 * prefix, for example the app com.android.contacts would use names
8857 * like "com.android.contacts.ShowAll".
8858 *
8859 * @param name The name of the extra data, with package prefix.
8860 * @param value The IBinder data value.
8861 *
8862 * @return Returns the same Intent object, for chaining multiple calls
8863 * into a single statement.
8864 *
8865 * @see #putExtras
8866 * @see #removeExtra
8867 * @see #getIBinderExtra(String)
8868 *
8869 * @deprecated
8870 * @hide
8871 */
8872 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008873 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008874 if (mExtras == null) {
8875 mExtras = new Bundle();
8876 }
8877 mExtras.putIBinder(name, value);
8878 return this;
8879 }
8880
8881 /**
8882 * Copy all extras in 'src' in to this intent.
8883 *
8884 * @param src Contains the extras to copy.
8885 *
8886 * @see #putExtra
8887 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008888 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008889 if (src.mExtras != null) {
8890 if (mExtras == null) {
8891 mExtras = new Bundle(src.mExtras);
8892 } else {
8893 mExtras.putAll(src.mExtras);
8894 }
8895 }
8896 return this;
8897 }
8898
8899 /**
8900 * Add a set of extended data to the intent. The keys must include a package
8901 * prefix, for example the app com.android.contacts would use names
8902 * like "com.android.contacts.ShowAll".
8903 *
8904 * @param extras The Bundle of extras to add to this intent.
8905 *
8906 * @see #putExtra
8907 * @see #removeExtra
8908 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008909 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008910 if (mExtras == null) {
8911 mExtras = new Bundle();
8912 }
8913 mExtras.putAll(extras);
8914 return this;
8915 }
8916
8917 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008918 * Completely replace the extras in the Intent with the extras in the
8919 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008920 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008921 * @param src The exact extras contained in this Intent are copied
8922 * into the target intent, replacing any that were previously there.
8923 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008924 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008925 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8926 return this;
8927 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008928
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008929 /**
8930 * Completely replace the extras in the Intent with the given Bundle of
8931 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008932 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008933 * @param extras The new set of extras in the Intent, or null to erase
8934 * all extras.
8935 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008936 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008937 mExtras = extras != null ? new Bundle(extras) : null;
8938 return this;
8939 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008940
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008941 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008942 * Remove extended data from the intent.
8943 *
8944 * @see #putExtra
8945 */
8946 public void removeExtra(String name) {
8947 if (mExtras != null) {
8948 mExtras.remove(name);
8949 if (mExtras.size() == 0) {
8950 mExtras = null;
8951 }
8952 }
8953 }
8954
8955 /**
8956 * Set special flags controlling how this intent is handled. Most values
8957 * here depend on the type of component being executed by the Intent,
8958 * specifically the FLAG_ACTIVITY_* flags are all for use with
8959 * {@link Context#startActivity Context.startActivity()} and the
8960 * FLAG_RECEIVER_* flags are all for use with
8961 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8962 *
Scott Main7aee61f2011-02-08 11:25:01 -08008963 * <p>See the
8964 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8965 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008966 * the behavior of your application.
8967 *
8968 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008969 * @return Returns the same Intent object, for chaining multiple calls
8970 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008971 * @see #getFlags
8972 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008973 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008974 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008975 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008976 mFlags = flags;
8977 return this;
8978 }
8979
8980 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008981 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008982 *
8983 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008984 * @return Returns the same Intent object, for chaining multiple calls into
8985 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008986 * @see #setFlags
8987 * @see #getFlags
8988 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008989 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008990 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008991 mFlags |= flags;
8992 return this;
8993 }
8994
8995 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008996 * Remove these flags from the intent.
8997 *
8998 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008999 * @see #setFlags
9000 * @see #getFlags
9001 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009002 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009003 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009004 mFlags &= ~flags;
9005 }
9006
9007 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009008 * (Usually optional) Set an explicit application package name that limits
9009 * the components this Intent will resolve to. If left to the default
9010 * value of null, all components in all applications will considered.
9011 * If non-null, the Intent can only match the components in the given
9012 * application package.
9013 *
9014 * @param packageName The name of the application package to handle the
9015 * intent, or null to allow any application package.
9016 *
9017 * @return Returns the same Intent object, for chaining multiple calls
9018 * into a single statement.
9019 *
9020 * @see #getPackage
9021 * @see #resolveActivity
9022 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009023 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009024 if (packageName != null && mSelector != null) {
9025 throw new IllegalArgumentException(
9026 "Can't set package name when selector is already set");
9027 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009028 mPackage = packageName;
9029 return this;
9030 }
9031
9032 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009033 * (Usually optional) Explicitly set the component to handle the intent.
9034 * If left with the default value of null, the system will determine the
9035 * appropriate class to use based on the other fields (action, data,
9036 * type, categories) in the Intent. If this class is defined, the
9037 * specified class will always be used regardless of the other fields. You
9038 * should only set this value when you know you absolutely want a specific
9039 * class to be used; otherwise it is better to let the system find the
9040 * appropriate class so that you will respect the installed applications
9041 * and user preferences.
9042 *
9043 * @param component The name of the application component to handle the
9044 * intent, or null to let the system find one for you.
9045 *
9046 * @return Returns the same Intent object, for chaining multiple calls
9047 * into a single statement.
9048 *
9049 * @see #setClass
9050 * @see #setClassName(Context, String)
9051 * @see #setClassName(String, String)
9052 * @see #getComponent
9053 * @see #resolveActivity
9054 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009055 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009056 mComponent = component;
9057 return this;
9058 }
9059
9060 /**
9061 * Convenience for calling {@link #setComponent} with an
9062 * explicit class name.
9063 *
9064 * @param packageContext A Context of the application package implementing
9065 * this class.
9066 * @param className The name of a class inside of the application package
9067 * that will be used as the component for this Intent.
9068 *
9069 * @return Returns the same Intent object, for chaining multiple calls
9070 * into a single statement.
9071 *
9072 * @see #setComponent
9073 * @see #setClass
9074 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009075 public @NonNull Intent setClassName(@NonNull Context packageContext,
9076 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009077 mComponent = new ComponentName(packageContext, className);
9078 return this;
9079 }
9080
9081 /**
9082 * Convenience for calling {@link #setComponent} with an
9083 * explicit application package name and class name.
9084 *
9085 * @param packageName The name of the package implementing the desired
9086 * component.
9087 * @param className The name of a class inside of the application package
9088 * that will be used as the component for this Intent.
9089 *
9090 * @return Returns the same Intent object, for chaining multiple calls
9091 * into a single statement.
9092 *
9093 * @see #setComponent
9094 * @see #setClass
9095 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009096 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009097 mComponent = new ComponentName(packageName, className);
9098 return this;
9099 }
9100
9101 /**
9102 * Convenience for calling {@link #setComponent(ComponentName)} with the
9103 * name returned by a {@link Class} object.
9104 *
9105 * @param packageContext A Context of the application package implementing
9106 * this class.
9107 * @param cls The class name to set, equivalent to
9108 * <code>setClassName(context, cls.getName())</code>.
9109 *
9110 * @return Returns the same Intent object, for chaining multiple calls
9111 * into a single statement.
9112 *
9113 * @see #setComponent
9114 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009115 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009116 mComponent = new ComponentName(packageContext, cls);
9117 return this;
9118 }
9119
9120 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009121 * Set the bounds of the sender of this intent, in screen coordinates. This can be
9122 * used as a hint to the receiver for animations and the like. Null means that there
9123 * is no source bounds.
9124 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009125 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009126 if (r != null) {
9127 mSourceBounds = new Rect(r);
9128 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07009129 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009130 }
9131 }
9132
Tor Norbyed9273d62013-05-30 15:59:53 -07009133 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07009134 @IntDef(flag = true, prefix = { "FILL_IN_" }, value = {
9135 FILL_IN_ACTION,
9136 FILL_IN_DATA,
9137 FILL_IN_CATEGORIES,
9138 FILL_IN_COMPONENT,
9139 FILL_IN_PACKAGE,
9140 FILL_IN_SOURCE_BOUNDS,
9141 FILL_IN_SELECTOR,
9142 FILL_IN_CLIP_DATA
9143 })
Tor Norbyed9273d62013-05-30 15:59:53 -07009144 @Retention(RetentionPolicy.SOURCE)
9145 public @interface FillInFlags {}
9146
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009147 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009148 * Use with {@link #fillIn} to allow the current action value to be
9149 * overwritten, even if it is already set.
9150 */
9151 public static final int FILL_IN_ACTION = 1<<0;
9152
9153 /**
9154 * Use with {@link #fillIn} to allow the current data or type value
9155 * overwritten, even if it is already set.
9156 */
9157 public static final int FILL_IN_DATA = 1<<1;
9158
9159 /**
9160 * Use with {@link #fillIn} to allow the current categories to be
9161 * overwritten, even if they are already set.
9162 */
9163 public static final int FILL_IN_CATEGORIES = 1<<2;
9164
9165 /**
9166 * Use with {@link #fillIn} to allow the current component value to be
9167 * overwritten, even if it is already set.
9168 */
9169 public static final int FILL_IN_COMPONENT = 1<<3;
9170
9171 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009172 * Use with {@link #fillIn} to allow the current package value to be
9173 * overwritten, even if it is already set.
9174 */
9175 public static final int FILL_IN_PACKAGE = 1<<4;
9176
9177 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009178 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009179 * overwritten, even if it is already set.
9180 */
9181 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
9182
9183 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009184 * Use with {@link #fillIn} to allow the current selector to be
9185 * overwritten, even if it is already set.
9186 */
9187 public static final int FILL_IN_SELECTOR = 1<<6;
9188
9189 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009190 * Use with {@link #fillIn} to allow the current ClipData to be
9191 * overwritten, even if it is already set.
9192 */
9193 public static final int FILL_IN_CLIP_DATA = 1<<7;
9194
9195 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009196 * Copy the contents of <var>other</var> in to this object, but only
9197 * where fields are not defined by this object. For purposes of a field
9198 * being defined, the following pieces of data in the Intent are
9199 * considered to be separate fields:
9200 *
9201 * <ul>
9202 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08009203 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009204 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
9205 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009206 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009207 * <li> component, as set by {@link #setComponent(ComponentName)} or
9208 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009209 * <li> source bounds, as set by {@link #setSourceBounds}.
9210 * <li> selector, as set by {@link #setSelector(Intent)}.
9211 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009212 * <li> each top-level name in the associated extras.
9213 * </ul>
9214 *
9215 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009216 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009217 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
9218 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
9219 * the restriction where the corresponding field will not be replaced if
9220 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009221 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009222 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
9223 * is explicitly specified. The selector will only be copied if
9224 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07009225 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009226 * <p>For example, consider Intent A with {data="foo", categories="bar"}
9227 * and Intent B with {action="gotit", data-type="some/thing",
9228 * categories="one","two"}.
9229 *
9230 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
9231 * containing: {action="gotit", data-type="some/thing",
9232 * categories="bar"}.
9233 *
9234 * @param other Another Intent whose values are to be used to fill in
9235 * the current one.
9236 * @param flags Options to control which fields can be filled in.
9237 *
9238 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009239 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07009240 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08009241 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07009242 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009243 */
Tor Norbyed9273d62013-05-30 15:59:53 -07009244 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009245 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009246 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009247 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009248 if (other.mAction != null
9249 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009250 mAction = other.mAction;
9251 changes |= FILL_IN_ACTION;
9252 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009253 if ((other.mData != null || other.mType != null)
9254 && ((mData == null && mType == null)
9255 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009256 mData = other.mData;
9257 mType = other.mType;
9258 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009259 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009260 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009261 if (other.mCategories != null
9262 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009263 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009264 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009265 }
9266 changes |= FILL_IN_CATEGORIES;
9267 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009268 if (other.mPackage != null
9269 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009270 // Only do this if mSelector is not set.
9271 if (mSelector == null) {
9272 mPackage = other.mPackage;
9273 changes |= FILL_IN_PACKAGE;
9274 }
9275 }
9276 // Selector is special: it can only be set if explicitly allowed,
9277 // for the same reason as the component name.
9278 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
9279 if (mPackage == null) {
9280 mSelector = new Intent(other.mSelector);
9281 mPackage = null;
9282 changes |= FILL_IN_SELECTOR;
9283 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009284 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009285 if (other.mClipData != null
9286 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
9287 mClipData = other.mClipData;
9288 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009289 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009290 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009291 // Component is special: it can -only- be set if explicitly allowed,
9292 // since otherwise the sender could force the intent somewhere the
9293 // originator didn't intend.
9294 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009295 mComponent = other.mComponent;
9296 changes |= FILL_IN_COMPONENT;
9297 }
9298 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009299 if (other.mSourceBounds != null
9300 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
9301 mSourceBounds = new Rect(other.mSourceBounds);
9302 changes |= FILL_IN_SOURCE_BOUNDS;
9303 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009304 if (mExtras == null) {
9305 if (other.mExtras != null) {
9306 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009307 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009308 }
9309 } else if (other.mExtras != null) {
9310 try {
9311 Bundle newb = new Bundle(other.mExtras);
9312 newb.putAll(mExtras);
9313 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009314 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009315 } catch (RuntimeException e) {
9316 // Modifying the extras can cause us to unparcel the contents
9317 // of the bundle, and if we do this in the system process that
9318 // may fail. We really should handle this (i.e., the Bundle
9319 // impl shouldn't be on top of a plain map), but for now just
9320 // ignore it and keep the original contents. :(
9321 Log.w("Intent", "Failure filling in extras", e);
9322 }
9323 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009324 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9325 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9326 mContentUserHint = other.mContentUserHint;
9327 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009328 return changes;
9329 }
9330
9331 /**
9332 * Wrapper class holding an Intent and implementing comparisons on it for
9333 * the purpose of filtering. The class implements its
9334 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9335 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9336 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9337 * on the wrapped Intent.
9338 */
9339 public static final class FilterComparison {
9340 private final Intent mIntent;
9341 private final int mHashCode;
9342
9343 public FilterComparison(Intent intent) {
9344 mIntent = intent;
9345 mHashCode = intent.filterHashCode();
9346 }
9347
9348 /**
9349 * Return the Intent that this FilterComparison represents.
9350 * @return Returns the Intent held by the FilterComparison. Do
9351 * not modify!
9352 */
9353 public Intent getIntent() {
9354 return mIntent;
9355 }
9356
9357 @Override
9358 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009359 if (obj instanceof FilterComparison) {
9360 Intent other = ((FilterComparison)obj).mIntent;
9361 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009362 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009363 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009364 }
9365
9366 @Override
9367 public int hashCode() {
9368 return mHashCode;
9369 }
9370 }
9371
9372 /**
9373 * Determine if two intents are the same for the purposes of intent
9374 * resolution (filtering). That is, if their action, data, type,
9375 * class, and categories are the same. This does <em>not</em> compare
9376 * any extra data included in the intents.
9377 *
9378 * @param other The other Intent to compare against.
9379 *
9380 * @return Returns true if action, data, type, class, and categories
9381 * are the same.
9382 */
9383 public boolean filterEquals(Intent other) {
9384 if (other == null) {
9385 return false;
9386 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009387 if (!Objects.equals(this.mAction, other.mAction)) return false;
9388 if (!Objects.equals(this.mData, other.mData)) return false;
9389 if (!Objects.equals(this.mType, other.mType)) return false;
9390 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9391 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9392 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009393
9394 return true;
9395 }
9396
9397 /**
9398 * Generate hash code that matches semantics of filterEquals().
9399 *
9400 * @return Returns the hash value of the action, data, type, class, and
9401 * categories.
9402 *
9403 * @see #filterEquals
9404 */
9405 public int filterHashCode() {
9406 int code = 0;
9407 if (mAction != null) {
9408 code += mAction.hashCode();
9409 }
9410 if (mData != null) {
9411 code += mData.hashCode();
9412 }
9413 if (mType != null) {
9414 code += mType.hashCode();
9415 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009416 if (mPackage != null) {
9417 code += mPackage.hashCode();
9418 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009419 if (mComponent != null) {
9420 code += mComponent.hashCode();
9421 }
9422 if (mCategories != null) {
9423 code += mCategories.hashCode();
9424 }
9425 return code;
9426 }
9427
9428 @Override
9429 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009430 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009431
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009432 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009433 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009434 b.append(" }");
9435
9436 return b.toString();
9437 }
9438
9439 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009440 public String toInsecureString() {
9441 StringBuilder b = new StringBuilder(128);
9442
9443 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009444 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009445 b.append(" }");
9446
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009447 return b.toString();
9448 }
Romain Guy4969af72009-06-17 10:53:19 -07009449
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009450 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009451 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009452 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009453
9454 b.append("Intent { ");
9455 toShortString(b, false, true, true, true);
9456 b.append(" }");
9457
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009458 return b.toString();
9459 }
9460
9461 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009462 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9463 StringBuilder b = new StringBuilder(128);
9464 toShortString(b, secure, comp, extras, clip);
9465 return b.toString();
9466 }
9467
9468 /** @hide */
9469 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9470 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009471 boolean first = true;
9472 if (mAction != null) {
9473 b.append("act=").append(mAction);
9474 first = false;
9475 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009476 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009477 if (!first) {
9478 b.append(' ');
9479 }
9480 first = false;
9481 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009482 for (int i=0; i<mCategories.size(); i++) {
9483 if (i > 0) b.append(',');
9484 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009485 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009486 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009487 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009488 if (mData != null) {
9489 if (!first) {
9490 b.append(' ');
9491 }
9492 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009493 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009494 if (secure) {
9495 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009496 } else {
9497 b.append(mData);
9498 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009499 }
9500 if (mType != null) {
9501 if (!first) {
9502 b.append(' ');
9503 }
9504 first = false;
9505 b.append("typ=").append(mType);
9506 }
9507 if (mFlags != 0) {
9508 if (!first) {
9509 b.append(' ');
9510 }
9511 first = false;
9512 b.append("flg=0x").append(Integer.toHexString(mFlags));
9513 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009514 if (mPackage != null) {
9515 if (!first) {
9516 b.append(' ');
9517 }
9518 first = false;
9519 b.append("pkg=").append(mPackage);
9520 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009521 if (comp && mComponent != null) {
9522 if (!first) {
9523 b.append(' ');
9524 }
9525 first = false;
9526 b.append("cmp=").append(mComponent.flattenToShortString());
9527 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009528 if (mSourceBounds != null) {
9529 if (!first) {
9530 b.append(' ');
9531 }
9532 first = false;
9533 b.append("bnds=").append(mSourceBounds.toShortString());
9534 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009535 if (mClipData != null) {
9536 if (!first) {
9537 b.append(' ');
9538 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009539 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009540 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009541 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009542 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009543 if (mClipData.getDescription() != null) {
9544 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9545 } else {
9546 first = true;
9547 }
9548 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009549 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009550 first = false;
9551 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009552 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009553 if (extras && mExtras != null) {
9554 if (!first) {
9555 b.append(' ');
9556 }
9557 first = false;
9558 b.append("(has extras)");
9559 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009560 if (mContentUserHint != UserHandle.USER_CURRENT) {
9561 if (!first) {
9562 b.append(' ');
9563 }
9564 first = false;
9565 b.append("u=").append(mContentUserHint);
9566 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009567 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009568 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009569 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009570 b.append("}");
9571 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009572 }
9573
Yi Jin129fc6c2017-09-28 15:48:38 -07009574 /** @hide */
Kweku Adams85f2fbc2017-12-18 12:04:12 -08009575 public void writeToProto(ProtoOutputStream proto, long fieldId) {
9576 // Same input parameters that toString() gives to toShortString().
9577 writeToProto(proto, fieldId, true, true, true, false);
9578 }
9579
9580 /** @hide */
Yi Jin129fc6c2017-09-28 15:48:38 -07009581 public void writeToProto(ProtoOutputStream proto, long fieldId, boolean secure, boolean comp,
9582 boolean extras, boolean clip) {
9583 long token = proto.start(fieldId);
9584 if (mAction != null) {
9585 proto.write(IntentProto.ACTION, mAction);
9586 }
9587 if (mCategories != null) {
9588 for (String category : mCategories) {
9589 proto.write(IntentProto.CATEGORIES, category);
9590 }
9591 }
9592 if (mData != null) {
9593 proto.write(IntentProto.DATA, secure ? mData.toSafeString() : mData.toString());
9594 }
9595 if (mType != null) {
9596 proto.write(IntentProto.TYPE, mType);
9597 }
9598 if (mFlags != 0) {
9599 proto.write(IntentProto.FLAG, "0x" + Integer.toHexString(mFlags));
9600 }
9601 if (mPackage != null) {
9602 proto.write(IntentProto.PACKAGE, mPackage);
9603 }
9604 if (comp && mComponent != null) {
Yi Jin676d1ac2018-01-25 15:40:28 -08009605 mComponent.writeToProto(proto, IntentProto.COMPONENT);
Yi Jin129fc6c2017-09-28 15:48:38 -07009606 }
9607 if (mSourceBounds != null) {
9608 proto.write(IntentProto.SOURCE_BOUNDS, mSourceBounds.toShortString());
9609 }
9610 if (mClipData != null) {
9611 StringBuilder b = new StringBuilder();
9612 if (clip) {
9613 mClipData.toShortString(b);
9614 } else {
9615 mClipData.toShortStringShortItems(b, false);
9616 }
9617 proto.write(IntentProto.CLIP_DATA, b.toString());
9618 }
9619 if (extras && mExtras != null) {
9620 proto.write(IntentProto.EXTRAS, mExtras.toShortString());
9621 }
9622 if (mContentUserHint != 0) {
9623 proto.write(IntentProto.CONTENT_USER_HINT, mContentUserHint);
9624 }
9625 if (mSelector != null) {
9626 proto.write(IntentProto.SELECTOR, mSelector.toShortString(secure, comp, extras, clip));
9627 }
9628 proto.end(token);
9629 }
9630
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009631 /**
9632 * Call {@link #toUri} with 0 flags.
9633 * @deprecated Use {@link #toUri} instead.
9634 */
9635 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009636 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009637 return toUri(0);
9638 }
9639
9640 /**
9641 * Convert this Intent into a String holding a URI representation of it.
9642 * The returned URI string has been properly URI encoded, so it can be
9643 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9644 * Intent's data as the base URI, with an additional fragment describing
9645 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009646 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009647 * <p>You can convert the returned string back to an Intent with
9648 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009649 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009650 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009651 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009652 * @return Returns a URI encoding URI string describing the entire contents
9653 * of the Intent.
9654 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009655 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009656 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009657 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9658 if (mPackage == null) {
9659 throw new IllegalArgumentException(
9660 "Intent must include an explicit package name to build an android-app: "
9661 + this);
9662 }
9663 uri.append("android-app://");
9664 uri.append(mPackage);
9665 String scheme = null;
9666 if (mData != null) {
9667 scheme = mData.getScheme();
9668 if (scheme != null) {
9669 uri.append('/');
9670 uri.append(scheme);
9671 String authority = mData.getEncodedAuthority();
9672 if (authority != null) {
9673 uri.append('/');
9674 uri.append(authority);
9675 String path = mData.getEncodedPath();
9676 if (path != null) {
9677 uri.append(path);
9678 }
9679 String queryParams = mData.getEncodedQuery();
9680 if (queryParams != null) {
9681 uri.append('?');
9682 uri.append(queryParams);
9683 }
9684 String fragment = mData.getEncodedFragment();
9685 if (fragment != null) {
9686 uri.append('#');
9687 uri.append(fragment);
9688 }
9689 }
9690 }
9691 }
9692 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9693 mPackage, flags);
9694 return uri.toString();
9695 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009696 String scheme = null;
9697 if (mData != null) {
9698 String data = mData.toString();
9699 if ((flags&URI_INTENT_SCHEME) != 0) {
9700 final int N = data.length();
9701 for (int i=0; i<N; i++) {
9702 char c = data.charAt(i);
9703 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
Christopher Schuster42c3a6e2017-07-21 14:53:52 -07009704 || (c >= '0' && c <= '9') || c == '.' || c == '-' || c == '+') {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009705 continue;
9706 }
9707 if (c == ':' && i > 0) {
9708 // Valid scheme.
9709 scheme = data.substring(0, i);
9710 uri.append("intent:");
9711 data = data.substring(i+1);
9712 break;
9713 }
Tom Taylord4a47292009-12-21 13:59:18 -08009714
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009715 // No scheme.
9716 break;
9717 }
9718 }
9719 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009720
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009721 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9722 uri.append("intent:");
9723 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009724
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009725 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009726
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009727 return uri.toString();
9728 }
9729
9730 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9731 String defPackage, int flags) {
9732 StringBuilder frag = new StringBuilder(128);
9733
9734 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009735 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009736 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009737 // Note that for now we are not going to try to handle the
9738 // data part; not clear how to represent this as a URI, and
9739 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009740 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9741 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009742 }
9743
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009744 if (frag.length() > 0) {
9745 uri.append("#Intent;");
9746 uri.append(frag);
9747 uri.append("end");
9748 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009749 }
9750
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009751 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9752 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009753 if (scheme != null) {
9754 uri.append("scheme=").append(scheme).append(';');
9755 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009756 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009757 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009758 }
9759 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009760 for (int i=0; i<mCategories.size(); i++) {
9761 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009762 }
9763 }
9764 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009765 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009766 }
9767 if (mFlags != 0) {
9768 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9769 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009770 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009771 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9772 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009773 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009774 uri.append("component=").append(Uri.encode(
9775 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009776 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009777 if (mSourceBounds != null) {
9778 uri.append("sourceBounds=")
9779 .append(Uri.encode(mSourceBounds.flattenToString()))
9780 .append(';');
9781 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009782 if (mExtras != null) {
9783 for (String key : mExtras.keySet()) {
9784 final Object value = mExtras.get(key);
9785 char entryType =
9786 value instanceof String ? 'S' :
9787 value instanceof Boolean ? 'B' :
9788 value instanceof Byte ? 'b' :
9789 value instanceof Character ? 'c' :
9790 value instanceof Double ? 'd' :
9791 value instanceof Float ? 'f' :
9792 value instanceof Integer ? 'i' :
9793 value instanceof Long ? 'l' :
9794 value instanceof Short ? 's' :
9795 '\0';
9796
9797 if (entryType != '\0') {
9798 uri.append(entryType);
9799 uri.append('.');
9800 uri.append(Uri.encode(key));
9801 uri.append('=');
9802 uri.append(Uri.encode(value.toString()));
9803 uri.append(';');
9804 }
9805 }
9806 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009807 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009808
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009809 public int describeContents() {
9810 return (mExtras != null) ? mExtras.describeContents() : 0;
9811 }
9812
9813 public void writeToParcel(Parcel out, int flags) {
9814 out.writeString(mAction);
9815 Uri.writeToParcel(out, mData);
9816 out.writeString(mType);
9817 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009818 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009819 ComponentName.writeToParcel(mComponent, out);
9820
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009821 if (mSourceBounds != null) {
9822 out.writeInt(1);
9823 mSourceBounds.writeToParcel(out, flags);
9824 } else {
9825 out.writeInt(0);
9826 }
9827
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009828 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009829 final int N = mCategories.size();
9830 out.writeInt(N);
9831 for (int i=0; i<N; i++) {
9832 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009833 }
9834 } else {
9835 out.writeInt(0);
9836 }
9837
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009838 if (mSelector != null) {
9839 out.writeInt(1);
9840 mSelector.writeToParcel(out, flags);
9841 } else {
9842 out.writeInt(0);
9843 }
9844
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009845 if (mClipData != null) {
9846 out.writeInt(1);
9847 mClipData.writeToParcel(out, flags);
9848 } else {
9849 out.writeInt(0);
9850 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009851 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009852 out.writeBundle(mExtras);
9853 }
9854
9855 public static final Parcelable.Creator<Intent> CREATOR
9856 = new Parcelable.Creator<Intent>() {
9857 public Intent createFromParcel(Parcel in) {
9858 return new Intent(in);
9859 }
9860 public Intent[] newArray(int size) {
9861 return new Intent[size];
9862 }
9863 };
9864
Dianne Hackborneb034652009-09-07 00:49:58 -07009865 /** @hide */
9866 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009867 readFromParcel(in);
9868 }
9869
9870 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009871 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009872 mData = Uri.CREATOR.createFromParcel(in);
9873 mType = in.readString();
9874 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009875 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009876 mComponent = ComponentName.readFromParcel(in);
9877
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009878 if (in.readInt() != 0) {
9879 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9880 }
9881
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009882 int N = in.readInt();
9883 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009884 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009885 int i;
9886 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009887 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009888 }
9889 } else {
9890 mCategories = null;
9891 }
9892
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009893 if (in.readInt() != 0) {
9894 mSelector = new Intent(in);
9895 }
9896
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009897 if (in.readInt() != 0) {
9898 mClipData = new ClipData(in);
9899 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009900 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009901 mExtras = in.readBundle();
9902 }
9903
9904 /**
9905 * Parses the "intent" element (and its children) from XML and instantiates
9906 * an Intent object. The given XML parser should be located at the tag
9907 * where parsing should start (often named "intent"), from which the
9908 * basic action, data, type, and package and class name will be
9909 * retrieved. The function will then parse in to any child elements,
9910 * looking for <category android:name="xxx"> tags to add categories and
9911 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9912 * to the intent.
9913 *
9914 * @param resources The Resources to use when inflating resources.
9915 * @param parser The XML parser pointing at an "intent" tag.
9916 * @param attrs The AttributeSet interface for retrieving extended
9917 * attribute data at the current <var>parser</var> location.
9918 * @return An Intent object matching the XML data.
9919 * @throws XmlPullParserException If there was an XML parsing error.
9920 * @throws IOException If there was an I/O error.
9921 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009922 public static @NonNull Intent parseIntent(@NonNull Resources resources,
9923 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009924 throws XmlPullParserException, IOException {
9925 Intent intent = new Intent();
9926
9927 TypedArray sa = resources.obtainAttributes(attrs,
9928 com.android.internal.R.styleable.Intent);
9929
9930 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9931
9932 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9933 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9934 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9935
9936 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9937 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9938 if (packageName != null && className != null) {
9939 intent.setComponent(new ComponentName(packageName, className));
9940 }
9941
9942 sa.recycle();
9943
9944 int outerDepth = parser.getDepth();
9945 int type;
9946 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9947 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9948 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9949 continue;
9950 }
9951
9952 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009953 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009954 sa = resources.obtainAttributes(attrs,
9955 com.android.internal.R.styleable.IntentCategory);
9956 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9957 sa.recycle();
9958
9959 if (cat != null) {
9960 intent.addCategory(cat);
9961 }
9962 XmlUtils.skipCurrentTag(parser);
9963
Craig Mautner21d24a22014-04-23 11:45:37 -07009964 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009965 if (intent.mExtras == null) {
9966 intent.mExtras = new Bundle();
9967 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009968 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009969 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009970
9971 } else {
9972 XmlUtils.skipCurrentTag(parser);
9973 }
9974 }
9975
9976 return intent;
9977 }
Nick Pellyccae4122012-01-09 14:12:58 -08009978
Craig Mautner21d24a22014-04-23 11:45:37 -07009979 /** @hide */
9980 public void saveToXml(XmlSerializer out) throws IOException {
9981 if (mAction != null) {
9982 out.attribute(null, ATTR_ACTION, mAction);
9983 }
9984 if (mData != null) {
9985 out.attribute(null, ATTR_DATA, mData.toString());
9986 }
9987 if (mType != null) {
9988 out.attribute(null, ATTR_TYPE, mType);
9989 }
9990 if (mComponent != null) {
9991 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9992 }
9993 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9994
9995 if (mCategories != null) {
9996 out.startTag(null, TAG_CATEGORIES);
9997 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9998 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9999 }
Craig Mautner43e52ed2014-06-16 17:18:52 -070010000 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -070010001 }
10002 }
10003
10004 /** @hide */
10005 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
10006 XmlPullParserException {
10007 Intent intent = new Intent();
10008 final int outerDepth = in.getDepth();
10009
10010 int attrCount = in.getAttributeCount();
10011 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
10012 final String attrName = in.getAttributeName(attrNdx);
10013 final String attrValue = in.getAttributeValue(attrNdx);
10014 if (ATTR_ACTION.equals(attrName)) {
10015 intent.setAction(attrValue);
10016 } else if (ATTR_DATA.equals(attrName)) {
10017 intent.setData(Uri.parse(attrValue));
10018 } else if (ATTR_TYPE.equals(attrName)) {
10019 intent.setType(attrValue);
10020 } else if (ATTR_COMPONENT.equals(attrName)) {
10021 intent.setComponent(ComponentName.unflattenFromString(attrValue));
10022 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +010010023 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -070010024 } else {
10025 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
10026 }
10027 }
10028
10029 int event;
10030 String name;
10031 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
10032 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
10033 if (event == XmlPullParser.START_TAG) {
10034 name = in.getName();
10035 if (TAG_CATEGORIES.equals(name)) {
10036 attrCount = in.getAttributeCount();
10037 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
10038 intent.addCategory(in.getAttributeValue(attrNdx));
10039 }
10040 } else {
10041 Log.w("Intent", "restoreFromXml: unknown name=" + name);
10042 XmlUtils.skipCurrentTag(in);
10043 }
10044 }
10045 }
10046
10047 return intent;
10048 }
10049
Nick Pellyccae4122012-01-09 14:12:58 -080010050 /**
10051 * Normalize a MIME data type.
10052 *
10053 * <p>A normalized MIME type has white-space trimmed,
10054 * content-type parameters removed, and is lower-case.
10055 * This aligns the type with Android best practices for
10056 * intent filtering.
10057 *
10058 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
10059 * "text/x-vCard" becomes "text/x-vcard".
10060 *
10061 * <p>All MIME types received from outside Android (such as user input,
10062 * or external sources like Bluetooth, NFC, or the Internet) should
10063 * be normalized before they are used to create an Intent.
10064 *
10065 * @param type MIME data type to normalize
10066 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -050010067 * @see #setType
10068 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -080010069 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060010070 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -080010071 if (type == null) {
10072 return null;
10073 }
10074
Elliott Hughescb64d432013-08-02 10:00:44 -070010075 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -080010076
10077 final int semicolonIndex = type.indexOf(';');
10078 if (semicolonIndex != -1) {
10079 type = type.substring(0, semicolonIndex);
10080 }
10081 return type;
10082 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010083
10084 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010085 * Prepare this {@link Intent} to leave an app process.
10086 *
10087 * @hide
10088 */
Jeff Sharkey344744b2016-01-28 19:03:30 -070010089 public void prepareToLeaveProcess(Context context) {
10090 final boolean leavingPackage = (mComponent == null)
10091 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
10092 prepareToLeaveProcess(leavingPackage);
10093 }
10094
10095 /**
10096 * Prepare this {@link Intent} to leave an app process.
10097 *
10098 * @hide
10099 */
10100 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010101 setAllowFds(false);
10102
10103 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010104 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010105 }
10106 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010107 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010108 }
10109
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -070010110 if (mExtras != null && !mExtras.isParcelled()) {
10111 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
10112 if (intent instanceof Intent) {
10113 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
10114 }
10115 }
10116
Jeff Sharkeya8b42782016-01-30 17:58:09 -070010117 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
10118 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010119 switch (mAction) {
10120 case ACTION_MEDIA_REMOVED:
10121 case ACTION_MEDIA_UNMOUNTED:
10122 case ACTION_MEDIA_CHECKING:
10123 case ACTION_MEDIA_NOFS:
10124 case ACTION_MEDIA_MOUNTED:
10125 case ACTION_MEDIA_SHARED:
10126 case ACTION_MEDIA_UNSHARED:
10127 case ACTION_MEDIA_BAD_REMOVAL:
10128 case ACTION_MEDIA_UNMOUNTABLE:
10129 case ACTION_MEDIA_EJECT:
10130 case ACTION_MEDIA_SCANNER_STARTED:
10131 case ACTION_MEDIA_SCANNER_FINISHED:
10132 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -070010133 case ACTION_PACKAGE_NEEDS_VERIFICATION:
10134 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -070010135 // Ignore legacy actions
10136 break;
10137 default:
10138 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010139 }
10140 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010141
10142 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
10143 && leavingPackage) {
10144 switch (mAction) {
10145 case ACTION_PROVIDER_CHANGED:
Makoto Onuki7d1911f2017-06-09 12:30:09 -070010146 case QuickContact.ACTION_QUICK_CONTACT:
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010147 // Ignore actions that don't need to grant
10148 break;
10149 default:
10150 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
10151 }
10152 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010153 }
10154
10155 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010156 * @hide
10157 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010158 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -070010159 // We just entered destination process, so we should be able to read all
10160 // parcelables inside.
10161 setDefusable(true);
10162
10163 if (mSelector != null) {
10164 mSelector.prepareToEnterProcess();
10165 }
10166 if (mClipData != null) {
10167 mClipData.prepareToEnterProcess();
10168 }
10169
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010170 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000010171 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
10172 fixUris(mContentUserHint);
10173 mContentUserHint = UserHandle.USER_CURRENT;
10174 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010175 }
10176 }
10177
Patrick Baumann577d4022018-01-31 16:55:10 +000010178 /** @hide */
10179 public boolean hasWebURI() {
10180 if (getData() == null) {
10181 return false;
10182 }
10183 final String scheme = getScheme();
10184 if (TextUtils.isEmpty(scheme)) {
10185 return false;
10186 }
10187 return scheme.equals(IntentFilter.SCHEME_HTTP) || scheme.equals(IntentFilter.SCHEME_HTTPS);
10188 }
10189
10190 /** @hide */
Patrick Baumann0da85372018-02-02 16:07:35 -080010191 public boolean isWebIntent() {
Patrick Baumann577d4022018-01-31 16:55:10 +000010192 return ACTION_VIEW.equals(mAction)
Patrick Baumann577d4022018-01-31 16:55:10 +000010193 && hasWebURI();
10194 }
10195
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010196 /**
10197 * @hide
10198 */
10199 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010200 Uri data = getData();
10201 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010202 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010203 }
10204 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010205 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010206 }
10207 String action = getAction();
10208 if (ACTION_SEND.equals(action)) {
10209 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10210 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010211 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010212 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010213 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010214 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10215 if (streams != null) {
10216 ArrayList<Uri> newStreams = new ArrayList<Uri>();
10217 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010218 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010219 }
10220 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
10221 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010222 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10223 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10224 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10225 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10226 if (output != null) {
10227 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
10228 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010229 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010230 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010231
10232 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010233 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010234 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
10235 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010236 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010237 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010238 * @hide
10239 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010240 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010241 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010242 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010243
10244 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010245 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010246
10247 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010248 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010249 // Inspect contained intents to see if we need to migrate extras. We
10250 // don't promote ClipData to the parent, since ChooserActivity will
10251 // already start the picked item as the caller, and we can't combine
10252 // the flags in a safe way.
10253
10254 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -070010255 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010256 final Intent intent = getParcelableExtra(EXTRA_INTENT);
10257 if (intent != null) {
10258 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -070010259 }
10260 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010261 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010262 try {
10263 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
10264 if (intents != null) {
10265 for (int i = 0; i < intents.length; i++) {
10266 final Intent intent = (Intent) intents[i];
10267 if (intent != null) {
10268 migrated |= intent.migrateExtraStreamToClipData();
10269 }
10270 }
10271 }
10272 } catch (ClassCastException e) {
10273 }
10274 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010275
10276 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010277 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010278 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10279 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
10280 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
10281 if (stream != null || text != null || htmlText != null) {
10282 final ClipData clipData = new ClipData(
10283 null, new String[] { getType() },
10284 new ClipData.Item(text, htmlText, null, stream));
10285 setClipData(clipData);
10286 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010287 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010288 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010289 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010290 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010291
10292 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010293 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010294 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10295 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
10296 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
10297 int num = -1;
10298 if (streams != null) {
10299 num = streams.size();
10300 }
10301 if (texts != null) {
10302 if (num >= 0 && num != texts.size()) {
10303 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010304 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010305 }
10306 num = texts.size();
10307 }
10308 if (htmlTexts != null) {
10309 if (num >= 0 && num != htmlTexts.size()) {
10310 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010311 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010312 }
10313 num = htmlTexts.size();
10314 }
10315 if (num > 0) {
10316 final ClipData clipData = new ClipData(
10317 null, new String[] { getType() },
10318 makeClipItem(streams, texts, htmlTexts, 0));
10319
10320 for (int i = 1; i < num; i++) {
10321 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
10322 }
10323
10324 setClipData(clipData);
10325 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010326 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010327 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010328 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010329 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010330 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10331 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10332 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10333 final Uri output;
10334 try {
10335 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10336 } catch (ClassCastException e) {
10337 return false;
10338 }
10339 if (output != null) {
10340 setClipData(ClipData.newRawUri("", output));
10341 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
10342 return true;
10343 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010344 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010345
10346 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010347 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010348
Michael Wright19859762017-09-18 20:57:58 +010010349 /**
10350 * Convert the dock state to a human readable format.
10351 * @hide
10352 */
10353 public static String dockStateToString(int dock) {
10354 switch (dock) {
10355 case EXTRA_DOCK_STATE_HE_DESK:
10356 return "EXTRA_DOCK_STATE_HE_DESK";
10357 case EXTRA_DOCK_STATE_LE_DESK:
10358 return "EXTRA_DOCK_STATE_LE_DESK";
10359 case EXTRA_DOCK_STATE_CAR:
10360 return "EXTRA_DOCK_STATE_CAR";
10361 case EXTRA_DOCK_STATE_DESK:
10362 return "EXTRA_DOCK_STATE_DESK";
10363 case EXTRA_DOCK_STATE_UNDOCKED:
10364 return "EXTRA_DOCK_STATE_UNDOCKED";
10365 default:
10366 return Integer.toString(dock);
10367 }
10368 }
10369
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010370 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
10371 ArrayList<String> htmlTexts, int which) {
10372 Uri uri = streams != null ? streams.get(which) : null;
10373 CharSequence text = texts != null ? texts.get(which) : null;
10374 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
10375 return new ClipData.Item(text, htmlText, null, uri);
10376 }
Craig Mautnerd00f4742014-03-12 14:17:26 -070010377
10378 /** @hide */
10379 public boolean isDocument() {
10380 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
10381 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010382}