blob: 90f44425dd97786e32e2d6c5e5a0461e745e1e5a [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Makoto Onuki7d1911f2017-06-09 12:30:09 -070019import static android.content.ContentProvider.maybeAddUserId;
20
Tor Norbye7b9c9122013-05-30 16:48:33 -070021import android.annotation.AnyRes;
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -070022import android.annotation.BroadcastBehavior;
Tor Norbyed9273d62013-05-30 15:59:53 -070023import android.annotation.IntDef;
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060024import android.annotation.NonNull;
25import android.annotation.Nullable;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070026import android.annotation.SdkConstant;
27import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050028import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070029import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050030import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060031import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.content.pm.PackageManager;
33import android.content.pm.ResolveInfo;
34import android.content.res.Resources;
35import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080036import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070037import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060038import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039import android.os.Bundle;
40import android.os.IBinder;
41import android.os.Parcel;
42import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000043import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050044import android.os.ResultReceiver;
45import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070046import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010047import android.os.UserHandle;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070048import android.provider.ContactsContract.QuickContact;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070049import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070050import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050051import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070052import android.provider.OpenableColumns;
Jason Monk2f68e8a2016-02-23 17:57:28 -050053import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054import android.util.AttributeSet;
55import android.util.Log;
Yi Jin129fc6c2017-09-28 15:48:38 -070056import android.util.proto.ProtoOutputStream;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070057
Dianne Hackborn2269d1572010-02-24 19:54:22 -080058import com.android.internal.util.XmlUtils;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070059
Jason Monk2f68e8a2016-02-23 17:57:28 -050060import org.xmlpull.v1.XmlPullParser;
61import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070062import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070063
64import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080065import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070067import java.lang.annotation.Retention;
68import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070069import java.net.URISyntaxException;
70import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080071import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070072import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080073import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070074import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070075import java.util.Set;
76
77/**
78 * An intent is an abstract description of an operation to be performed. It
79 * can be used with {@link Context#startActivity(Intent) startActivity} to
80 * launch an {@link android.app.Activity},
81 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
82 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
83 * and {@link android.content.Context#startService} or
84 * {@link android.content.Context#bindService} to communicate with a
85 * background {@link android.app.Service}.
86 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070087 * <p>An Intent provides a facility for performing late runtime binding between the code in
88 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070089 * can be thought of as the glue between activities. It is basically a passive data structure
90 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070091 *
92 * <div class="special reference">
93 * <h3>Developer Guides</h3>
94 * <p>For information about how to create and resolve intents, read the
95 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
96 * developer guide.</p>
97 * </div>
98 *
99 * <a name="IntentStructure"></a>
100 * <h3>Intent Structure</h3>
101 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700102 *
103 * <ul>
104 * <li> <p><b>action</b> -- The general action to be performed, such as
105 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
106 * etc.</p>
107 * </li>
108 * <li> <p><b>data</b> -- The data to operate on, such as a person record
109 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
110 * </li>
111 * </ul>
112 *
113 *
114 * <p>Some examples of action/data pairs are:</p>
115 *
116 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700117 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700118 * information about the person whose identifier is "1".</p>
119 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700120 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700121 * the phone dialer with the person filled in.</p>
122 * </li>
123 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
124 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700125 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700126 * a particular URI.</p>
127 * </li>
128 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
129 * the phone dialer with the given number filled in.</p>
130 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700131 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700132 * information about the person whose identifier is "1".</p>
133 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700134 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700135 * a list of people, which the user can browse through. This example is a
136 * typical top-level entry into the Contacts application, showing you the
137 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700138 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700139 * being used to start an activity to display that person.</p>
140 * </li>
141 * </ul>
142 *
143 * <p>In addition to these primary attributes, there are a number of secondary
144 * attributes that you can also include with an intent:</p>
145 *
146 * <ul>
147 * <li> <p><b>category</b> -- Gives additional information about the action
148 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
149 * appear in the Launcher as a top-level application, while
150 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
151 * of alternative actions the user can perform on a piece of data.</p>
152 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
153 * intent data. Normally the type is inferred from the data itself.
154 * By setting this attribute, you disable that evaluation and force
155 * an explicit type.</p>
156 * <li> <p><b>component</b> -- Specifies an explicit name of a component
157 * class to use for the intent. Normally this is determined by looking
158 * at the other information in the intent (the action, data/type, and
159 * categories) and matching that with a component that can handle it.
160 * If this attribute is set then none of the evaluation is performed,
161 * and this component is used exactly as is. By specifying this attribute,
162 * all of the other Intent attributes become optional.</p>
163 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
164 * This can be used to provide extended information to the component.
165 * For example, if we have a action to send an e-mail message, we could
166 * also include extra pieces of data here to supply a subject, body,
167 * etc.</p>
168 * </ul>
169 *
170 * <p>Here are some examples of other operations you can specify as intents
171 * using these additional parameters:</p>
172 *
173 * <ul>
174 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
175 * Launch the home screen.</p>
176 * </li>
177 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
178 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
179 * vnd.android.cursor.item/phone}</i></b>
180 * -- Display the list of people's phone numbers, allowing the user to
181 * browse through them and pick one and return it to the parent activity.</p>
182 * </li>
183 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
184 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
185 * -- Display all pickers for data that can be opened with
186 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
187 * allowing the user to pick one of them and then some data inside of it
188 * and returning the resulting URI to the caller. This can be used,
189 * for example, in an e-mail application to allow the user to pick some
190 * data to include as an attachment.</p>
191 * </li>
192 * </ul>
193 *
194 * <p>There are a variety of standard Intent action and category constants
195 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700196 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700197 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700198 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700199 *
200 * <p>Put together, the set of actions, data types, categories, and extra data
201 * defines a language for the system allowing for the expression of phrases
202 * such as "call john smith's cell". As applications are added to the system,
203 * they can extend this language by adding new actions, types, and categories, or
204 * they can modify the behavior of existing phrases by supplying their own
205 * activities that handle them.</p>
206 *
207 * <a name="IntentResolution"></a>
208 * <h3>Intent Resolution</h3>
209 *
210 * <p>There are two primary forms of intents you will use.
211 *
212 * <ul>
213 * <li> <p><b>Explicit Intents</b> have specified a component (via
214 * {@link #setComponent} or {@link #setClass}), which provides the exact
215 * class to be run. Often these will not include any other information,
216 * simply being a way for an application to launch various internal
217 * activities it has as the user interacts with the application.
218 *
219 * <li> <p><b>Implicit Intents</b> have not specified a component;
220 * instead, they must include enough information for the system to
221 * determine which of the available components is best to run for that
222 * intent.
223 * </ul>
224 *
225 * <p>When using implicit intents, given such an arbitrary intent we need to
226 * know what to do with it. This is handled by the process of <em>Intent
227 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
228 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
229 * more activities/receivers) that can handle it.</p>
230 *
231 * <p>The intent resolution mechanism basically revolves around matching an
232 * Intent against all of the &lt;intent-filter&gt; descriptions in the
233 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
234 * objects explicitly registered with {@link Context#registerReceiver}.) More
235 * details on this can be found in the documentation on the {@link
236 * IntentFilter} class.</p>
237 *
238 * <p>There are three pieces of information in the Intent that are used for
239 * resolution: the action, type, and category. Using this information, a query
240 * is done on the {@link PackageManager} for a component that can handle the
241 * intent. The appropriate component is determined based on the intent
242 * information supplied in the <code>AndroidManifest.xml</code> file as
243 * follows:</p>
244 *
245 * <ul>
246 * <li> <p>The <b>action</b>, if given, must be listed by the component as
247 * one it handles.</p>
248 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
249 * already supplied in the Intent. Like the action, if a type is
250 * included in the intent (either explicitly or implicitly in its
251 * data), then this must be listed by the component as one it handles.</p>
252 * <li> For data that is not a <code>content:</code> URI and where no explicit
253 * type is included in the Intent, instead the <b>scheme</b> of the
254 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
255 * considered. Again like the action, if we are matching a scheme it
256 * must be listed by the component as one it can handle.
257 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
258 * by the activity as categories it handles. That is, if you include
259 * the categories {@link #CATEGORY_LAUNCHER} and
260 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
261 * with an intent that lists <em>both</em> of those categories.
262 * Activities will very often need to support the
263 * {@link #CATEGORY_DEFAULT} so that they can be found by
264 * {@link Context#startActivity Context.startActivity()}.</p>
265 * </ul>
266 *
267 * <p>For example, consider the Note Pad sample application that
268 * allows user to browse through a list of notes data and view details about
269 * individual items. Text in italics indicate places were you would replace a
270 * name with one specific to your own package.</p>
271 *
272 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
273 * package="<i>com.android.notepad</i>"&gt;
274 * &lt;application android:icon="@drawable/app_notes"
275 * android:label="@string/app_name"&gt;
276 *
277 * &lt;provider class=".NotePadProvider"
278 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
279 *
280 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
281 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700282 * &lt;action android:name="android.intent.action.MAIN" /&gt;
283 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700286 * &lt;action android:name="android.intent.action.VIEW" /&gt;
287 * &lt;action android:name="android.intent.action.EDIT" /&gt;
288 * &lt;action android:name="android.intent.action.PICK" /&gt;
289 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
290 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700291 * &lt;/intent-filter&gt;
292 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700293 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
294 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
295 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700296 * &lt;/intent-filter&gt;
297 * &lt;/activity&gt;
298 *
299 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
300 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700301 * &lt;action android:name="android.intent.action.VIEW" /&gt;
302 * &lt;action android:name="android.intent.action.EDIT" /&gt;
303 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
304 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700305 * &lt;/intent-filter&gt;
306 *
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="android.intent.action.INSERT" /&gt;
309 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
310 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700311 * &lt;/intent-filter&gt;
312 *
313 * &lt;/activity&gt;
314 *
315 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
316 * android:theme="@android:style/Theme.Dialog"&gt;
317 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700318 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
319 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
320 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
321 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
322 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700323 * &lt;/intent-filter&gt;
324 * &lt;/activity&gt;
325 *
326 * &lt;/application&gt;
327 * &lt;/manifest&gt;</pre>
328 *
329 * <p>The first activity,
330 * <code>com.android.notepad.NotesList</code>, serves as our main
331 * entry into the app. It can do three things as described by its three intent
332 * templates:
333 * <ol>
334 * <li><pre>
335 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700336 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
337 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700338 * &lt;/intent-filter&gt;</pre>
339 * <p>This provides a top-level entry into the NotePad application: the standard
340 * MAIN action is a main entry point (not requiring any other information in
341 * the Intent), and the LAUNCHER category says that this entry point should be
342 * listed in the application launcher.</p>
343 * <li><pre>
344 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700345 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
346 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
347 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
348 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700349 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700350 * &lt;/intent-filter&gt;</pre>
351 * <p>This declares the things that the activity can do on a directory of
352 * notes. The type being supported is given with the &lt;type&gt; tag, where
353 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
354 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
355 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
356 * The activity allows the user to view or edit the directory of data (via
357 * the VIEW and EDIT actions), or to pick a particular note and return it
358 * to the caller (via the PICK action). Note also the DEFAULT category
359 * supplied here: this is <em>required</em> for the
360 * {@link Context#startActivity Context.startActivity} method to resolve your
361 * activity when its component name is not explicitly specified.</p>
362 * <li><pre>
363 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700364 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
365 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
366 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700367 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700368 * <p>This filter describes the ability to return to the caller a note selected by
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700369 * the user without needing to know where it came from. The data type
370 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
371 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
372 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
373 * The GET_CONTENT action is similar to the PICK action, where the activity
374 * will return to its caller a piece of data selected by the user. Here,
375 * however, the caller specifies the type of data they desire instead of
376 * the type of data the user will be picking from.</p>
377 * </ol>
378 *
379 * <p>Given these capabilities, the following intents will resolve to the
380 * NotesList activity:</p>
381 *
382 * <ul>
383 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
384 * activities that can be used as top-level entry points into an
385 * application.</p>
386 * <li> <p><b>{ action=android.app.action.MAIN,
387 * category=android.app.category.LAUNCHER }</b> is the actual intent
388 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700389 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700390 * data=content://com.google.provider.NotePad/notes }</b>
391 * displays a list of all the notes under
392 * "content://com.google.provider.NotePad/notes", which
393 * the user can browse through and see the details on.</p>
394 * <li> <p><b>{ action=android.app.action.PICK
395 * data=content://com.google.provider.NotePad/notes }</b>
396 * provides a list of the notes under
397 * "content://com.google.provider.NotePad/notes", from which
398 * the user can pick a note whose data URL is returned back to the caller.</p>
399 * <li> <p><b>{ action=android.app.action.GET_CONTENT
400 * type=vnd.android.cursor.item/vnd.google.note }</b>
401 * is similar to the pick action, but allows the caller to specify the
402 * kind of data they want back so that the system can find the appropriate
403 * activity to pick something of that data type.</p>
404 * </ul>
405 *
406 * <p>The second activity,
407 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
408 * note entry and allows them to edit it. It can do two things as described
409 * by its two intent templates:
410 * <ol>
411 * <li><pre>
412 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700413 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
414 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
415 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
416 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700417 * &lt;/intent-filter&gt;</pre>
418 * <p>The first, primary, purpose of this activity is to let the user interact
419 * with a single note, as decribed by the MIME type
420 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
421 * either VIEW a note or allow the user to EDIT it. Again we support the
422 * DEFAULT category to allow the activity to be launched without explicitly
423 * specifying its component.</p>
424 * <li><pre>
425 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700426 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
427 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
428 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700429 * &lt;/intent-filter&gt;</pre>
430 * <p>The secondary use of this activity is to insert a new note entry into
431 * an existing directory of notes. This is used when the user creates a new
432 * note: the INSERT action is executed on the directory of notes, causing
433 * this activity to run and have the user create the new note data which
434 * it then adds to the content provider.</p>
435 * </ol>
436 *
437 * <p>Given these capabilities, the following intents will resolve to the
438 * NoteEditor activity:</p>
439 *
440 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700441 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700442 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
443 * shows the user the content of note <var>{ID}</var>.</p>
444 * <li> <p><b>{ action=android.app.action.EDIT
445 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
446 * allows the user to edit the content of note <var>{ID}</var>.</p>
447 * <li> <p><b>{ action=android.app.action.INSERT
448 * data=content://com.google.provider.NotePad/notes }</b>
449 * creates a new, empty note in the notes list at
450 * "content://com.google.provider.NotePad/notes"
451 * and allows the user to edit it. If they keep their changes, the URI
452 * of the newly created note is returned to the caller.</p>
453 * </ul>
454 *
455 * <p>The last activity,
456 * <code>com.android.notepad.TitleEditor</code>, allows the user to
457 * edit the title of a note. This could be implemented as a class that the
458 * application directly invokes (by explicitly setting its component in
459 * the Intent), but here we show a way you can publish alternative
460 * operations on existing data:</p>
461 *
462 * <pre>
463 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700464 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
465 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
466 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
467 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
468 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700469 * &lt;/intent-filter&gt;</pre>
470 *
471 * <p>In the single intent template here, we
472 * have created our own private action called
473 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
474 * edit the title of a note. It must be invoked on a specific note
475 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
476 * view and edit actions, but here displays and edits the title contained
477 * in the note data.
478 *
479 * <p>In addition to supporting the default category as usual, our title editor
480 * also supports two other standard categories: ALTERNATIVE and
481 * SELECTED_ALTERNATIVE. Implementing
482 * these categories allows others to find the special action it provides
483 * without directly knowing about it, through the
484 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
485 * more often to build dynamic menu items with
486 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
487 * template here was also supply an explicit name for the template
488 * (via <code>android:label="@string/resolve_title"</code>) to better control
489 * what the user sees when presented with this activity as an alternative
490 * action to the data they are viewing.
491 *
492 * <p>Given these capabilities, the following intent will resolve to the
493 * TitleEditor activity:</p>
494 *
495 * <ul>
496 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
497 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
498 * displays and allows the user to edit the title associated
499 * with note <var>{ID}</var>.</p>
500 * </ul>
501 *
502 * <h3>Standard Activity Actions</h3>
503 *
504 * <p>These are the current standard actions that Intent defines for launching
505 * activities (usually through {@link Context#startActivity}. The most
506 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
507 * {@link #ACTION_EDIT}.
508 *
509 * <ul>
510 * <li> {@link #ACTION_MAIN}
511 * <li> {@link #ACTION_VIEW}
512 * <li> {@link #ACTION_ATTACH_DATA}
513 * <li> {@link #ACTION_EDIT}
514 * <li> {@link #ACTION_PICK}
515 * <li> {@link #ACTION_CHOOSER}
516 * <li> {@link #ACTION_GET_CONTENT}
517 * <li> {@link #ACTION_DIAL}
518 * <li> {@link #ACTION_CALL}
519 * <li> {@link #ACTION_SEND}
520 * <li> {@link #ACTION_SENDTO}
521 * <li> {@link #ACTION_ANSWER}
522 * <li> {@link #ACTION_INSERT}
523 * <li> {@link #ACTION_DELETE}
524 * <li> {@link #ACTION_RUN}
525 * <li> {@link #ACTION_SYNC}
526 * <li> {@link #ACTION_PICK_ACTIVITY}
527 * <li> {@link #ACTION_SEARCH}
528 * <li> {@link #ACTION_WEB_SEARCH}
529 * <li> {@link #ACTION_FACTORY_TEST}
530 * </ul>
531 *
532 * <h3>Standard Broadcast Actions</h3>
533 *
534 * <p>These are the current standard actions that Intent defines for receiving
535 * broadcasts (usually through {@link Context#registerReceiver} or a
536 * &lt;receiver&gt; tag in a manifest).
537 *
538 * <ul>
539 * <li> {@link #ACTION_TIME_TICK}
540 * <li> {@link #ACTION_TIME_CHANGED}
541 * <li> {@link #ACTION_TIMEZONE_CHANGED}
542 * <li> {@link #ACTION_BOOT_COMPLETED}
543 * <li> {@link #ACTION_PACKAGE_ADDED}
544 * <li> {@link #ACTION_PACKAGE_CHANGED}
545 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800546 * <li> {@link #ACTION_PACKAGE_RESTARTED}
547 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000548 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
549 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700550 * <li> {@link #ACTION_UID_REMOVED}
551 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700552 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700553 * <li> {@link #ACTION_POWER_DISCONNECTED}
554 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700555 * </ul>
556 *
557 * <h3>Standard Categories</h3>
558 *
559 * <p>These are the current standard categories that can be used to further
560 * clarify an Intent via {@link #addCategory}.
561 *
562 * <ul>
563 * <li> {@link #CATEGORY_DEFAULT}
564 * <li> {@link #CATEGORY_BROWSABLE}
565 * <li> {@link #CATEGORY_TAB}
566 * <li> {@link #CATEGORY_ALTERNATIVE}
567 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
568 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800569 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700570 * <li> {@link #CATEGORY_HOME}
571 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700572 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400573 * <li> {@link #CATEGORY_CAR_DOCK}
574 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500575 * <li> {@link #CATEGORY_LE_DESK_DOCK}
576 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200577 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700578 * <li> {@link #CATEGORY_APP_MARKET}
Zak Cohendb6ca492017-01-26 14:09:00 -0800579 * <li> {@link #CATEGORY_VR_HOME}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700580 * </ul>
581 *
582 * <h3>Standard Extra Data</h3>
583 *
584 * <p>These are the current standard fields that can be used as extra data via
585 * {@link #putExtra}.
586 *
587 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800588 * <li> {@link #EXTRA_ALARM_COUNT}
589 * <li> {@link #EXTRA_BCC}
590 * <li> {@link #EXTRA_CC}
591 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
592 * <li> {@link #EXTRA_DATA_REMOVED}
593 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500594 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
595 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800596 * <li> {@link #EXTRA_DOCK_STATE_CAR}
597 * <li> {@link #EXTRA_DOCK_STATE_DESK}
598 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
599 * <li> {@link #EXTRA_DONT_KILL_APP}
600 * <li> {@link #EXTRA_EMAIL}
601 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700602 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800603 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700604 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800605 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700606 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800607 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
608 * <li> {@link #EXTRA_REPLACING}
609 * <li> {@link #EXTRA_SHORTCUT_ICON}
610 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
611 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700612 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800613 * <li> {@link #EXTRA_SHORTCUT_NAME}
614 * <li> {@link #EXTRA_SUBJECT}
615 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700616 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800617 * <li> {@link #EXTRA_TITLE}
618 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700619 * </ul>
620 *
621 * <h3>Flags</h3>
622 *
623 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800624 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
625 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700626 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800627public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700628 private static final String ATTR_ACTION = "action";
629 private static final String TAG_CATEGORIES = "categories";
630 private static final String ATTR_CATEGORY = "category";
631 private static final String TAG_EXTRA = "extra";
632 private static final String ATTR_TYPE = "type";
633 private static final String ATTR_COMPONENT = "component";
634 private static final String ATTR_DATA = "data";
635 private static final String ATTR_FLAGS = "flags";
636
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700637 // ---------------------------------------------------------------------
638 // ---------------------------------------------------------------------
639 // Standard intent activity actions (see action variable).
640
641 /**
642 * Activity Action: Start as a main entry point, does not expect to
643 * receive data.
644 * <p>Input: nothing
645 * <p>Output: nothing
646 */
647 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
648 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700650 /**
651 * Activity Action: Display the data to the user. This is the most common
652 * action performed on data -- it is the generic action you can use on
653 * a piece of data to get the most reasonable thing to occur. For example,
654 * when used on a contacts entry it will view the entry; when used on a
655 * mailto: URI it will bring up a compose window filled with the information
656 * supplied by the URI; when used with a tel: URI it will invoke the
657 * dialer.
658 * <p>Input: {@link #getData} is URI from which to retrieve data.
659 * <p>Output: nothing.
660 */
661 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
662 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800663
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700664 /**
Dianne Hackborna320f012017-04-07 13:57:48 -0700665 * Extra that can be included on activity intents coming from the storage UI
666 * when it launches sub-activities to manage various types of storage. For example,
667 * it may use {@link #ACTION_VIEW} with a "image/*" MIME type to have an app show
668 * the images on the device, and in that case also include this extra to tell the
669 * app it is coming from the storage UI so should help the user manage storage of
670 * this type.
671 */
672 public static final String EXTRA_FROM_STORAGE = "android.intent.extra.FROM_STORAGE";
673
674 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700675 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
676 * performed on a piece of data.
677 */
678 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800679
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700680 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900681 * Activity Action: Quick view the data. Launches a quick viewer for
682 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900683 * <p>Activities handling this intent action should handle the vast majority of
684 * MIME types rather than only specific ones.
Garfield Tance1d0e92017-03-23 10:52:48 -0700685 * <p>Quick viewers must render the quick view image locally, and must not send
686 * file content outside current device.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900687 * <p>Input: {@link #getData} is a mandatory content URI of the item to
688 * preview. {@link #getClipData} contains an optional list of content URIs
689 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
690 * optional index of the URI in the clip data to show first.
Garfield Tance1d0e92017-03-23 10:52:48 -0700691 * {@link #EXTRA_QUICK_VIEW_FEATURES} is an optional extra indicating the features
692 * that can be shown in the quick view UI.
Steve McKayc78bcb82015-07-31 14:35:22 -0700693 * <p>Output: nothing.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900694 * @see #EXTRA_INDEX
Garfield Tance1d0e92017-03-23 10:52:48 -0700695 * @see #EXTRA_QUICK_VIEW_FEATURES
Steve McKayc78bcb82015-07-31 14:35:22 -0700696 */
697 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
698 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
699
700 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700701 * Used to indicate that some piece of data should be attached to some other
702 * place. For example, image data could be attached to a contact. It is up
703 * to the recipient to decide where the data should be attached; the intent
704 * does not specify the ultimate destination.
705 * <p>Input: {@link #getData} is URI of data to be attached.
706 * <p>Output: nothing.
707 */
708 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
709 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800710
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700711 /**
712 * Activity Action: Provide explicit editable access to the given data.
713 * <p>Input: {@link #getData} is URI of data to be edited.
714 * <p>Output: nothing.
715 */
716 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
717 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800718
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700719 /**
720 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
721 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
722 * The extras can contain type specific data to pass through to the editing/creating
723 * activity.
724 * <p>Output: The URI of the item that was picked. This must be a content:
725 * URI so that any receiver can access it.
726 */
727 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
728 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800729
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700730 /**
731 * Activity Action: Pick an item from the data, returning what was selected.
732 * <p>Input: {@link #getData} is URI containing a directory of data
733 * (vnd.android.cursor.dir/*) from which to pick an item.
734 * <p>Output: The URI of the item that was picked.
735 */
736 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
737 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800738
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700739 /**
740 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800741 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800742 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
743 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700744 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
745 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800746 * (value: ShortcutIconResource).</p>
747 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800748 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700749 * @see #EXTRA_SHORTCUT_INTENT
750 * @see #EXTRA_SHORTCUT_NAME
751 * @see #EXTRA_SHORTCUT_ICON
752 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
753 * @see android.content.Intent.ShortcutIconResource
754 */
755 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
756 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
757
758 /**
759 * The name of the extra used to define the Intent of a shortcut.
760 *
761 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800762 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700763 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800764 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700765 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
766 /**
767 * The name of the extra used to define the name of a shortcut.
768 *
769 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800770 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700771 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800772 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700773 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
774 /**
775 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
776 *
777 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800778 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700779 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800780 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700781 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
782 /**
783 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
784 *
785 * @see #ACTION_CREATE_SHORTCUT
786 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800787 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700788 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800789 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700790 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
791 "android.intent.extra.shortcut.ICON_RESOURCE";
792
793 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500794 * An activity that provides a user interface for adjusting application preferences.
795 * Optional but recommended settings for all applications which have settings.
796 */
797 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
798 public static final String ACTION_APPLICATION_PREFERENCES
799 = "android.intent.action.APPLICATION_PREFERENCES";
800
801 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700802 * Activity Action: Launch an activity showing the app information.
803 * For applications which install other applications (such as app stores), it is recommended
804 * to handle this action for providing the app information to the user.
805 *
806 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
807 * to be displayed.
808 * <p>Output: Nothing.
809 */
810 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
811 public static final String ACTION_SHOW_APP_INFO
812 = "android.intent.action.SHOW_APP_INFO";
813
814 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800815 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700816 *
817 * @see Intent#ACTION_CREATE_SHORTCUT
818 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800819 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
820 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700821 */
822 public static class ShortcutIconResource implements Parcelable {
823 /**
824 * The package name of the application containing the icon.
825 */
826 public String packageName;
827
828 /**
829 * The resource name of the icon, including package, name and type.
830 */
831 public String resourceName;
832
833 /**
834 * Creates a new ShortcutIconResource for the specified context and resource
835 * identifier.
836 *
837 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700838 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700839 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700840 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700841 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700842 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700843 ShortcutIconResource icon = new ShortcutIconResource();
844 icon.packageName = context.getPackageName();
845 icon.resourceName = context.getResources().getResourceName(resourceId);
846 return icon;
847 }
848
849 /**
850 * Used to read a ShortcutIconResource from a Parcel.
851 */
852 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
853 new Parcelable.Creator<ShortcutIconResource>() {
854
855 public ShortcutIconResource createFromParcel(Parcel source) {
856 ShortcutIconResource icon = new ShortcutIconResource();
857 icon.packageName = source.readString();
858 icon.resourceName = source.readString();
859 return icon;
860 }
861
862 public ShortcutIconResource[] newArray(int size) {
863 return new ShortcutIconResource[size];
864 }
865 };
866
867 /**
868 * No special parcel contents.
869 */
870 public int describeContents() {
871 return 0;
872 }
873
874 public void writeToParcel(Parcel dest, int flags) {
875 dest.writeString(packageName);
876 dest.writeString(resourceName);
877 }
878
879 @Override
880 public String toString() {
881 return resourceName;
882 }
883 }
884
885 /**
886 * Activity Action: Display an activity chooser, allowing the user to pick
887 * what they want to before proceeding. This can be used as an alternative
888 * to the standard activity picker that is displayed by the system when
889 * you try to start an activity with multiple possible matches, with these
890 * differences in behavior:
891 * <ul>
892 * <li>You can specify the title that will appear in the activity chooser.
893 * <li>The user does not have the option to make one of the matching
894 * activities a preferred activity, and all possible activities will
895 * always be shown even if one of them is currently marked as the
896 * preferred activity.
897 * </ul>
898 * <p>
899 * This action should be used when the user will naturally expect to
900 * select an activity in order to proceed. An example if when not to use
901 * it is when the user clicks on a "mailto:" link. They would naturally
902 * expect to go directly to their mail app, so startActivity() should be
903 * called directly: it will
904 * either launch the current preferred app, or put up a dialog allowing the
905 * user to pick an app to use and optionally marking that as preferred.
906 * <p>
907 * In contrast, if the user is selecting a menu item to send a picture
908 * they are viewing to someone else, there are many different things they
909 * may want to do at this point: send it through e-mail, upload it to a
910 * web service, etc. In this case the CHOOSER action should be used, to
911 * always present to the user a list of the things they can do, with a
912 * nice title given by the caller such as "Send this photo with:".
913 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700914 * If you need to grant URI permissions through a chooser, you must specify
915 * the permissions to be granted on the ACTION_CHOOSER Intent
916 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
917 * {@link #setClipData} to specify the URIs to be granted as well as
918 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
919 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
920 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700921 * As a convenience, an Intent of this form can be created with the
922 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700923 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700924 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700925 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
926 * and can optionally have a {@link #EXTRA_TITLE} field containing the
927 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700928 * <p>
929 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700930 */
931 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
932 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
933
934 /**
935 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
936 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700937 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
938 * target intent, also optionally supplying a title. If the target
939 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
940 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
941 * set in the returned chooser intent, with its ClipData set appropriately:
942 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500943 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700944 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700945 * @param target The Intent that the user will be selecting an activity
946 * to perform.
947 * @param title Optional title that will be displayed in the chooser.
948 * @return Return a new Intent object that you can hand to
949 * {@link Context#startActivity(Intent) Context.startActivity()} and
950 * related methods.
951 */
952 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700953 return createChooser(target, title, null);
954 }
955
956 /**
957 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
958 *
959 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
960 * target intent, also optionally supplying a title. If the target
961 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
962 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
963 * set in the returned chooser intent, with its ClipData set appropriately:
964 * either a direct reflection of {@link #getClipData()} if that is non-null,
965 * or a new ClipData built from {@link #getData()}.</p>
966 *
967 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
968 * when the user makes a choice. This can be useful if the calling application wants
969 * to remember the last chosen target and surface it as a more prominent or one-touch
970 * affordance elsewhere in the UI for next time.</p>
971 *
972 * @param target The Intent that the user will be selecting an activity
973 * to perform.
974 * @param title Optional title that will be displayed in the chooser.
975 * @param sender Optional IntentSender to be called when a choice is made.
976 * @return Return a new Intent object that you can hand to
977 * {@link Context#startActivity(Intent) Context.startActivity()} and
978 * related methods.
979 */
980 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700981 Intent intent = new Intent(ACTION_CHOOSER);
982 intent.putExtra(EXTRA_INTENT, target);
983 if (title != null) {
984 intent.putExtra(EXTRA_TITLE, title);
985 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700986
Adam Powell0b3c1122014-10-09 12:50:14 -0700987 if (sender != null) {
988 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
989 }
990
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700991 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700992 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
993 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
994 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700995 if (permFlags != 0) {
996 ClipData targetClipData = target.getClipData();
997 if (targetClipData == null && target.getData() != null) {
998 ClipData.Item item = new ClipData.Item(target.getData());
999 String[] mimeTypes;
1000 if (target.getType() != null) {
1001 mimeTypes = new String[] { target.getType() };
1002 } else {
1003 mimeTypes = new String[] { };
1004 }
1005 targetClipData = new ClipData(null, mimeTypes, item);
1006 }
1007 if (targetClipData != null) {
1008 intent.setClipData(targetClipData);
1009 intent.addFlags(permFlags);
1010 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001011 }
Dianne Hackborne302a162012-05-15 14:58:32 -07001012
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001013 return intent;
1014 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001015
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001016 /**
1017 * Activity Action: Allow the user to select a particular kind of data and
1018 * return it. This is different than {@link #ACTION_PICK} in that here we
1019 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001020 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001021 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001022 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001023 * etc.
1024 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001025 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001026 * of data, such as a person contact, you set the MIME type to the kind of
1027 * data you want and launch it with {@link Context#startActivity(Intent)}.
1028 * The system will then launch the best application to select that kind
1029 * of data for you.
1030 * <p>
1031 * You may also be interested in any of a set of types of content the user
1032 * can pick. For example, an e-mail application that wants to allow the
1033 * user to add an attachment to an e-mail message can use this action to
1034 * bring up a list of all of the types of content the user can attach.
1035 * <p>
1036 * In this case, you should wrap the GET_CONTENT intent with a chooser
1037 * (through {@link #createChooser}), which will give the proper interface
1038 * for the user to pick how to send your data and allow you to specify
1039 * a prompt indicating what they are doing. You will usually specify a
1040 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1041 * broad range of content types the user can select from.
1042 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001043 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001044 * only pick from data that can be represented as a stream. This is
1045 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1046 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001047 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001048 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001049 * is locally available on the device. For example, if this extra is set
1050 * to true then an image picker should not show any pictures that are available
1051 * from a remote server but not already on the local device (thus requiring
1052 * they be downloaded when opened).
1053 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001054 * If the caller can handle multiple returned items (the user performing
1055 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1056 * to indicate this.
1057 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001058 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1059 * that no URI is supplied in the intent, as there are no constraints on
1060 * where the returned data originally comes from. You may also include the
1061 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001062 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001063 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1064 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001065 * <p>
1066 * Output: The URI of the item that was picked. This must be a content:
1067 * URI so that any receiver can access it.
1068 */
1069 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1070 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1071 /**
1072 * Activity Action: Dial a number as specified by the data. This shows a
1073 * UI with the number being dialed, allowing the user to explicitly
1074 * initiate the call.
1075 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1076 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1077 * number.
1078 * <p>Output: nothing.
1079 */
1080 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1081 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1082 /**
1083 * Activity Action: Perform a call to someone specified by the data.
1084 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1085 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1086 * number.
1087 * <p>Output: nothing.
1088 *
1089 * <p>Note: there will be restrictions on which applications can initiate a
1090 * call; most applications should use the {@link #ACTION_DIAL}.
1091 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1092 * numbers. Applications can <strong>dial</strong> emergency numbers using
1093 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001094 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001095 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001096 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001097 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001098 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001099 */
1100 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1101 public static final String ACTION_CALL = "android.intent.action.CALL";
1102 /**
1103 * Activity Action: Perform a call to an emergency number specified by the
1104 * data.
1105 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1106 * tel: URI of an explicit phone number.
1107 * <p>Output: nothing.
1108 * @hide
1109 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001110 @SystemApi
1111 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001112 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1113 /**
1114 * Activity action: Perform a call to any number (emergency or not)
1115 * specified by the data.
1116 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1117 * tel: URI of an explicit phone number.
1118 * <p>Output: nothing.
1119 * @hide
1120 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001121 @SystemApi
1122 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001123 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
fionaxu77a744c2017-03-17 14:35:39 -07001124
Santos Cordon15a13782015-03-31 18:32:31 -07001125 /**
fionaxuadfe7002017-02-17 17:20:46 -08001126 * Activity Action: Main entry point for carrier setup apps.
1127 * <p>Carrier apps that provide an implementation for this action may be invoked to configure
1128 * carrier service and typically require
1129 * {@link android.telephony.TelephonyManager#hasCarrierPrivileges() carrier privileges} to
1130 * fulfill their duties.
1131 */
1132 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1133 public static final String ACTION_CARRIER_SETUP = "android.intent.action.CARRIER_SETUP";
1134 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001135 * Activity Action: Send a message to someone specified by the data.
1136 * <p>Input: {@link #getData} is URI describing the target.
1137 * <p>Output: nothing.
1138 */
1139 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1140 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1141 /**
1142 * Activity Action: Deliver some data to someone else. Who the data is
1143 * being delivered to is not specified; it is up to the receiver of this
1144 * action to ask the user where the data should be sent.
1145 * <p>
1146 * When launching a SEND intent, you should usually wrap it in a chooser
1147 * (through {@link #createChooser}), which will give the proper interface
1148 * for the user to pick how to send your data and allow you to specify
1149 * a prompt indicating what they are doing.
1150 * <p>
1151 * Input: {@link #getType} is the MIME type of the data being sent.
1152 * get*Extra can have either a {@link #EXTRA_TEXT}
1153 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1154 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1155 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1156 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001157 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1158 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1159 * your text with HTML formatting.
1160 * <p>
1161 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1162 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1163 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1164 * content: URIs and other advanced features of {@link ClipData}. If
1165 * using this approach, you still must supply the same data through the
1166 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1167 * for compatibility with old applications. If you don't set a ClipData,
1168 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001169 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001170 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1171 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1172 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1173 * be openable only as asset typed files using
1174 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1175 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001176 * Optional standard extras, which may be interpreted by some recipients as
1177 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1178 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1179 * <p>
1180 * Output: nothing.
1181 */
1182 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1183 public static final String ACTION_SEND = "android.intent.action.SEND";
1184 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001185 * Activity Action: Deliver multiple data to someone else.
1186 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001187 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001188 * <p>
1189 * Input: {@link #getType} is the MIME type of the data being sent.
1190 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001191 * #EXTRA_STREAM} field, containing the data to be sent. If using
1192 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1193 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001194 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001195 * Multiple types are supported, and receivers should handle mixed types
1196 * whenever possible. The right way for the receiver to check them is to
1197 * use the content resolver on each URI. The intent sender should try to
1198 * put the most concrete mime type in the intent type, but it can fall
1199 * back to {@literal <type>/*} or {@literal *}/* as needed.
1200 * <p>
1201 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1202 * be image/jpg, but if you are sending image/jpg and image/png, then the
1203 * intent's type should be image/*.
1204 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001205 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1206 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1207 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1208 * content: URIs and other advanced features of {@link ClipData}. If
1209 * using this approach, you still must supply the same data through the
1210 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1211 * for compatibility with old applications. If you don't set a ClipData,
1212 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1213 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001214 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1215 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1216 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1217 * be openable only as asset typed files using
1218 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1219 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001220 * Optional standard extras, which may be interpreted by some recipients as
1221 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1222 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1223 * <p>
1224 * Output: nothing.
1225 */
1226 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1227 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1228 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001229 * Activity Action: Handle an incoming phone call.
1230 * <p>Input: nothing.
1231 * <p>Output: nothing.
1232 */
1233 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1234 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1235 /**
1236 * Activity Action: Insert an empty item into the given container.
1237 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1238 * in which to place the data.
1239 * <p>Output: URI of the new data that was created.
1240 */
1241 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1242 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1243 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001244 * Activity Action: Create a new item in the given container, initializing it
1245 * from the current contents of the clipboard.
1246 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1247 * in which to place the data.
1248 * <p>Output: URI of the new data that was created.
1249 */
1250 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1251 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1252 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001253 * Activity Action: Delete the given data from its container.
1254 * <p>Input: {@link #getData} is URI of data to be deleted.
1255 * <p>Output: nothing.
1256 */
1257 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1258 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1259 /**
1260 * Activity Action: Run the data, whatever that means.
1261 * <p>Input: ? (Note: this is currently specific to the test harness.)
1262 * <p>Output: nothing.
1263 */
1264 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1265 public static final String ACTION_RUN = "android.intent.action.RUN";
1266 /**
1267 * Activity Action: Perform a data synchronization.
1268 * <p>Input: ?
1269 * <p>Output: ?
1270 */
1271 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1272 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1273 /**
1274 * Activity Action: Pick an activity given an intent, returning the class
1275 * selected.
1276 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1277 * used with {@link PackageManager#queryIntentActivities} to determine the
1278 * set of activities from which to pick.
1279 * <p>Output: Class name of the activity that was selected.
1280 */
1281 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1282 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1283 /**
1284 * Activity Action: Perform a search.
1285 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1286 * is the text to search for. If empty, simply
1287 * enter your search results Activity with the search UI activated.
1288 * <p>Output: nothing.
1289 */
1290 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1291 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1292 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001293 * Activity Action: Start the platform-defined tutorial
1294 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1295 * is the text to search for. If empty, simply
1296 * enter your search results Activity with the search UI activated.
1297 * <p>Output: nothing.
1298 */
1299 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1300 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1301 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001302 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001303 * <p>
1304 * Input: {@link android.app.SearchManager#QUERY
1305 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1306 * a url starts with http or https, the site will be opened. If it is plain
1307 * text, Google search will be applied.
1308 * <p>
1309 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001310 */
1311 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1312 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001313
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001314 /**
Jim Miller07994402012-05-02 14:22:27 -07001315 * Activity Action: Perform assist action.
1316 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001317 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1318 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001319 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1320 * information.
Jim Miller07994402012-05-02 14:22:27 -07001321 * Output: nothing.
1322 */
1323 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1324 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001325
1326 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001327 * Activity Action: Perform voice assist action.
1328 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001329 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1330 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001331 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001332 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001333 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001334 */
Amith Yamasani16452032017-03-03 10:15:57 -08001335 @SystemApi
Bjorn Bringertbc086862013-03-01 12:59:24 +00001336 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1337 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1338
1339 /**
Adam Skory7140a252013-09-11 12:04:58 +01001340 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1341 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001342 */
1343 public static final String EXTRA_ASSIST_PACKAGE
1344 = "android.intent.extra.ASSIST_PACKAGE";
1345
1346 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001347 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1348 * application package at the time the assist was invoked.
1349 */
1350 public static final String EXTRA_ASSIST_UID
1351 = "android.intent.extra.ASSIST_UID";
1352
1353 /**
Adam Skory7140a252013-09-11 12:04:58 +01001354 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1355 * information supplied by the current foreground app at the time of the assist request.
1356 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001357 */
1358 public static final String EXTRA_ASSIST_CONTEXT
1359 = "android.intent.extra.ASSIST_CONTEXT";
1360
Jim Miller07994402012-05-02 14:22:27 -07001361 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001362 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1363 * keyboard as the primary input device for assistance.
1364 */
1365 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1366 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1367
1368 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001369 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1370 * that was used to invoke the assist.
1371 */
1372 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1373 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1374
1375 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001376 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001377 * <p>Input: Nothing.
1378 * <p>Output: nothing.
1379 */
1380 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1381 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1382 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001383 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001384 * <p>Input: Nothing.
1385 * <p>Output: Nothing.
1386 */
1387 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1388 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1389
1390 /**
1391 * Activity Action: Show activity for reporting a bug.
1392 * <p>Input: Nothing.
1393 * <p>Output: Nothing.
1394 */
1395 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1396 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1397
1398 /**
1399 * Activity Action: Main entry point for factory tests. Only used when
1400 * the device is booting in factory test node. The implementing package
1401 * must be installed in the system image.
1402 * <p>Input: nothing
1403 * <p>Output: nothing
1404 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06001405 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001406 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1407
1408 /**
1409 * Activity Action: The user pressed the "call" button to go to the dialer
1410 * or other appropriate UI for placing a call.
1411 * <p>Input: Nothing.
1412 * <p>Output: Nothing.
1413 */
1414 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1415 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1416
1417 /**
1418 * Activity Action: Start Voice Command.
1419 * <p>Input: Nothing.
1420 * <p>Output: Nothing.
1421 */
1422 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1423 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001424
1425 /**
1426 * Activity Action: Start action associated with long pressing on the
1427 * search key.
1428 * <p>Input: Nothing.
1429 * <p>Output: Nothing.
1430 */
1431 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1432 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001433
Jacek Surazski86b6c532009-05-13 14:38:28 +02001434 /**
1435 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1436 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001437 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001438 * <p>Input: No data is specified. The bug report is passed in using
1439 * an {@link #EXTRA_BUG_REPORT} field.
1440 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001441 *
1442 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001443 */
1444 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1445 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001446
1447 /**
1448 * Activity Action: Show power usage information to the user.
1449 * <p>Input: Nothing.
1450 * <p>Output: Nothing.
1451 */
1452 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1453 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001454
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001455 /**
Russell Brenner4cd32e52017-02-24 11:11:47 -08001456 * Activity Action: Setup wizard action provided for OTA provisioning to determine if it needs
1457 * to run.
1458 * <p>Input: Nothing.
1459 * <p>Output: Nothing.
1460 * @deprecated As of {@link android.os.Build.VERSION_CODES#M}, setup wizard can be identified
1461 * using {@link #ACTION_MAIN} and {@link #CATEGORY_SETUP_WIZARD}
1462 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001463 * @removed
Russell Brenner4cd32e52017-02-24 11:11:47 -08001464 */
1465 @Deprecated
1466 @SystemApi
1467 public static final String ACTION_DEVICE_INITIALIZATION_WIZARD =
1468 "android.intent.action.DEVICE_INITIALIZATION_WIZARD";
1469
1470 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001471 * Activity Action: Setup wizard to launch after a platform update. This
1472 * activity should have a string meta-data field associated with it,
1473 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1474 * the platform for setup. The activity will be launched only if
1475 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1476 * same value.
1477 * <p>Input: Nothing.
1478 * <p>Output: Nothing.
1479 * @hide
1480 */
Russell Brenner4cd32e52017-02-24 11:11:47 -08001481 @SystemApi
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001482 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1483 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001484
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001485 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001486 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1487 * <p>Input: Nothing.
1488 * <p>Output: Nothing.
1489 * @hide
1490 */
1491 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1492 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001493 "com.android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001494
1495 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001496 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1497 * <p>Input: Nothing.
1498 * <p>Output: Nothing.
1499 * @hide
1500 */
1501 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1502 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001503 "com.android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001504
1505 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001506 * Activity Action: Show settings for managing network data usage of a
1507 * specific application. Applications should define an activity that offers
1508 * options to control data usage.
1509 */
1510 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1511 public static final String ACTION_MANAGE_NETWORK_USAGE =
1512 "android.intent.action.MANAGE_NETWORK_USAGE";
1513
1514 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001515 * Activity Action: Launch application installer.
1516 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001517 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001518 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1519 * you can also use "package:<package-name>" to install an application for the
1520 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001521 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1522 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1523 * <p>
1524 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1525 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001526 * <p>
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001527 * <strong>Note:</strong>If your app is targeting API level higher than 25 you
Svet Ganov86877e42015-05-28 08:19:48 -07001528 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1529 * in order to launch the application installer.
1530 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001531 *
1532 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1533 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1534 * @see #EXTRA_RETURN_RESULT
1535 */
1536 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1537 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1538
1539 /**
Todd Kennedyd0084f72017-07-28 13:56:14 -07001540 * Activity Action: Activity to handle split installation failures.
1541 * <p>Splits may be installed dynamically. This happens when an Activity is launched,
1542 * but the split that contains the application isn't installed. When a split is
1543 * installed in this manner, the containing package usually doesn't know this is
1544 * happening. However, if an error occurs during installation, the containing
1545 * package can define a single activity handling this action to deal with such
1546 * failures.
1547 * <p>The activity handling this action must be in the base package.
1548 * <p>
1549 * Input: {@link #EXTRA_INTENT} the original intent that started split installation.
1550 * {@link #EXTRA_SPLIT_NAME} the name of the split that failed to be installed.
1551 */
1552 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1553 public static final String ACTION_INSTALL_FAILURE = "android.intent.action.INSTALL_FAILURE";
1554
1555 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001556 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001557 * @removed
Todd Kennedyd46a1602017-04-03 15:22:38 -07001558 * @deprecated Do not use. This will go away.
1559 * Replace with {@link #ACTION_INSTALL_INSTANT_APP_PACKAGE}.
1560 */
1561 @SystemApi
1562 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1563 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1564 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1565 /**
1566 * Activity Action: Launch instant application installer.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001567 * <p class="note">
1568 * This is a protected intent that can only be sent by the system.
1569 * </p>
1570 *
1571 * @hide
1572 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001573 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001574 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001575 public static final String ACTION_INSTALL_INSTANT_APP_PACKAGE
1576 = "android.intent.action.INSTALL_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001577
1578 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001579 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001580 * @removed
Todd Kennedyd46a1602017-04-03 15:22:38 -07001581 * @deprecated Do not use. This will go away.
1582 * Replace with {@link #ACTION_RESOLVE_INSTANT_APP_PACKAGE}.
1583 */
1584 @SystemApi
1585 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1586 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1587 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1588 /**
1589 * Service Action: Resolve instant application.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001590 * <p>
1591 * The system will have a persistent connection to this service.
1592 * This is a protected intent that can only be sent by the system.
1593 * </p>
1594 *
1595 * @hide
1596 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001597 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001598 @SdkConstant(SdkConstantType.SERVICE_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001599 public static final String ACTION_RESOLVE_INSTANT_APP_PACKAGE
1600 = "android.intent.action.RESOLVE_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001601
1602 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001603 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001604 * @removed
Todd Kennedyd46a1602017-04-03 15:22:38 -07001605 * @deprecated Do not use. This will go away.
1606 * Replace with {@link #ACTION_INSTANT_APP_RESOLVER_SETTINGS}.
1607 */
1608 @SystemApi
1609 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1610 public static final String ACTION_EPHEMERAL_RESOLVER_SETTINGS
1611 = "android.intent.action.EPHEMERAL_RESOLVER_SETTINGS";
1612 /**
1613 * Activity Action: Launch instant app settings.
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001614 *
1615 * <p class="note">
1616 * This is a protected intent that can only be sent by the system.
1617 * </p>
1618 *
1619 * @hide
1620 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001621 @SystemApi
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001622 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001623 public static final String ACTION_INSTANT_APP_RESOLVER_SETTINGS
1624 = "android.intent.action.INSTANT_APP_RESOLVER_SETTINGS";
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001625
1626 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001627 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1628 * package. Specifies the installer package name; this package will receive the
1629 * {@link #ACTION_APP_ERROR} intent.
1630 */
1631 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1632 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1633
1634 /**
1635 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1636 * package. Specifies that the application being installed should not be
1637 * treated as coming from an unknown source, but as coming from the app
1638 * invoking the Intent. For this to work you must start the installer with
1639 * startActivityForResult().
1640 */
1641 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1642 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1643
1644 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001645 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1646 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001647 * data field originated from.
1648 */
rich cannings706e8ba2012-08-20 13:20:14 -07001649 public static final String EXTRA_ORIGINATING_URI
1650 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001651
1652 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001653 * This extra can be used with any Intent used to launch an activity, supplying information
1654 * about who is launching that activity. This field contains a {@link android.net.Uri}
1655 * object, typically an http: or https: URI of the web site that the referral came from;
1656 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1657 * a native application that it came from.
1658 *
1659 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1660 * instead of directly retrieving the extra. It is also valid for applications to
1661 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1662 * a string, not a Uri; the field here, if supplied, will always take precedence,
1663 * however.</p>
1664 *
1665 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001666 */
1667 public static final String EXTRA_REFERRER
1668 = "android.intent.extra.REFERRER";
1669
1670 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001671 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1672 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1673 * not be created, in particular when Intent extras are supplied through the
1674 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1675 * schemes.
1676 *
1677 * @see #EXTRA_REFERRER
1678 */
1679 public static final String EXTRA_REFERRER_NAME
1680 = "android.intent.extra.REFERRER_NAME";
1681
1682 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001683 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001684 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001685 * Currently only a system app that hosts the provider authority "downloads" or holds the
1686 * permission {@link android.Manifest.permission.MANAGE_DOCUMENTS} can use this.
Ben Gruver37d83a32012-09-27 13:02:06 -07001687 * @hide
1688 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001689 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001690 public static final String EXTRA_ORIGINATING_UID
1691 = "android.intent.extra.ORIGINATING_UID";
1692
1693 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001694 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1695 * package. Tells the installer UI to skip the confirmation with the user
1696 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001697 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1698 * will no longer show an interstitial message about updating existing
1699 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001700 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001701 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001702 public static final String EXTRA_ALLOW_REPLACE
1703 = "android.intent.extra.ALLOW_REPLACE";
1704
1705 /**
1706 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1707 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1708 * return to the application the result code of the install/uninstall. The returned result
1709 * code will be {@link android.app.Activity#RESULT_OK} on success or
1710 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1711 */
1712 public static final String EXTRA_RETURN_RESULT
1713 = "android.intent.extra.RETURN_RESULT";
1714
1715 /**
1716 * Package manager install result code. @hide because result codes are not
1717 * yet ready to be exposed.
1718 */
1719 public static final String EXTRA_INSTALL_RESULT
1720 = "android.intent.extra.INSTALL_RESULT";
1721
1722 /**
1723 * Activity Action: Launch application uninstaller.
1724 * <p>
1725 * Input: The data must be a package: URI whose scheme specific part is
1726 * the package name of the current installed package to be uninstalled.
1727 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1728 * <p>
1729 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1730 * succeeded.
Philip P. Moltmannd9bb39a2017-09-05 12:41:15 -07001731 * <p>
1732 * Requires {@link android.Manifest.permission#REQUEST_DELETE_PACKAGES}
1733 * since {@link Build.VERSION_CODES#P}.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001734 */
1735 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1736 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1737
1738 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001739 * Specify whether the package should be uninstalled for all users.
1740 * @hide because these should not be part of normal application flow.
1741 */
1742 public static final String EXTRA_UNINSTALL_ALL_USERS
1743 = "android.intent.extra.UNINSTALL_ALL_USERS";
1744
1745 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001746 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1747 * describing the last run version of the platform that was setup.
1748 * @hide
1749 */
1750 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1751
Svet Ganov3695b8a2015-03-24 16:30:25 -07001752 /**
1753 * Activity action: Launch UI to manage the permissions of an app.
1754 * <p>
1755 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1756 * will be managed by the launched UI.
1757 * </p>
1758 * <p>
1759 * Output: Nothing.
1760 * </p>
1761 *
1762 * @see #EXTRA_PACKAGE_NAME
1763 *
1764 * @hide
1765 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001766 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001767 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1768 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1769 "android.intent.action.MANAGE_APP_PERMISSIONS";
1770
1771 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001772 * Activity action: Launch UI to manage permissions.
1773 * <p>
1774 * Input: Nothing.
1775 * </p>
1776 * <p>
1777 * Output: Nothing.
1778 * </p>
1779 *
1780 * @hide
1781 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001782 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001783 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1784 public static final String ACTION_MANAGE_PERMISSIONS =
1785 "android.intent.action.MANAGE_PERMISSIONS";
1786
1787 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001788 * Activity action: Launch UI to review permissions for an app.
1789 * The system uses this intent if permission review for apps not
1790 * supporting the new runtime permissions model is enabled. In
1791 * this mode a permission review is required before any of the
1792 * app components can run.
1793 * <p>
1794 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1795 * permissions will be reviewed (mandatory).
1796 * </p>
1797 * <p>
1798 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1799 * be fired after the permission review (optional).
1800 * </p>
1801 * <p>
1802 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1803 * be invoked after the permission review (optional).
1804 * </p>
1805 * <p>
1806 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1807 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1808 * </p>
1809 * <p>
1810 * Output: Nothing.
1811 * </p>
1812 *
1813 * @see #EXTRA_PACKAGE_NAME
1814 * @see #EXTRA_INTENT
1815 * @see #EXTRA_REMOTE_CALLBACK
1816 * @see #EXTRA_RESULT_NEEDED
1817 *
1818 * @hide
1819 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001820 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001821 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1822 public static final String ACTION_REVIEW_PERMISSIONS =
1823 "android.intent.action.REVIEW_PERMISSIONS";
1824
1825 /**
1826 * Intent extra: A callback for reporting remote result as a bundle.
1827 * <p>
1828 * Type: IRemoteCallback
1829 * </p>
1830 *
1831 * @hide
1832 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001833 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001834 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1835
1836 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001837 * Intent extra: An app package name.
1838 * <p>
1839 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001840 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001841 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001842 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001843 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1844
1845 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001846 * Intent extra: An app split name.
1847 * <p>
1848 * Type: String
1849 * </p>
Todd Kennedye5195dd2016-10-19 15:29:19 -07001850 */
Todd Kennedye5195dd2016-10-19 15:29:19 -07001851 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1852
1853 /**
Jeff Sharkey1a749422017-04-28 14:19:50 -06001854 * Intent extra: A {@link ComponentName} value.
1855 * <p>
1856 * Type: String
1857 * </p>
1858 */
1859 public static final String EXTRA_COMPONENT_NAME = "android.intent.extra.COMPONENT_NAME";
1860
1861 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001862 * Intent extra: An extra for specifying whether a result is needed.
1863 * <p>
1864 * Type: boolean
1865 * </p>
1866 *
1867 * @hide
1868 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001869 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001870 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1871
1872 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001873 * Activity action: Launch UI to manage which apps have a given permission.
1874 * <p>
1875 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1876 * to which will be managed by the launched UI.
1877 * </p>
1878 * <p>
1879 * Output: Nothing.
1880 * </p>
1881 *
1882 * @see #EXTRA_PERMISSION_NAME
1883 *
1884 * @hide
1885 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001886 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001887 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1888 public static final String ACTION_MANAGE_PERMISSION_APPS =
1889 "android.intent.action.MANAGE_PERMISSION_APPS";
1890
1891 /**
1892 * Intent extra: The name of a permission.
1893 * <p>
1894 * Type: String
1895 * </p>
1896 *
1897 * @hide
1898 */
1899 @SystemApi
1900 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1901
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001902 // ---------------------------------------------------------------------
1903 // ---------------------------------------------------------------------
1904 // Standard intent broadcast actions (see action variable).
1905
1906 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001907 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1908 * <p>
1909 * For historical reasons, the name of this broadcast action refers to the power
1910 * state of the screen but it is actually sent in response to changes in the
1911 * overall interactive state of the device.
1912 * </p><p>
1913 * This broadcast is sent when the device becomes non-interactive which may have
1914 * nothing to do with the screen turning off. To determine the
1915 * actual state of the screen, use {@link android.view.Display#getState}.
1916 * </p><p>
1917 * See {@link android.os.PowerManager#isInteractive} for details.
1918 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001919 * You <em>cannot</em> receive this through components declared in
1920 * manifests, only by explicitly registering for it with
1921 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1922 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001923 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001924 * <p class="note">This is a protected intent that can only be sent
1925 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001929
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001930 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001931 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1932 * <p>
1933 * For historical reasons, the name of this broadcast action refers to the power
1934 * state of the screen but it is actually sent in response to changes in the
1935 * overall interactive state of the device.
1936 * </p><p>
1937 * This broadcast is sent when the device becomes interactive which may have
1938 * nothing to do with the screen turning on. To determine the
1939 * actual state of the screen, use {@link android.view.Display#getState}.
1940 * </p><p>
1941 * See {@link android.os.PowerManager#isInteractive} for details.
1942 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001943 * You <em>cannot</em> receive this through components declared in
1944 * manifests, only by explicitly registering for it with
1945 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1946 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001947 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001948 * <p class="note">This is a protected intent that can only be sent
1949 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001950 */
1951 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1952 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001953
1954 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001955 * Broadcast Action: Sent after the system stops dreaming.
1956 *
1957 * <p class="note">This is a protected intent that can only be sent by the system.
1958 * It is only sent to registered receivers.</p>
1959 */
1960 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1961 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1962
1963 /**
1964 * Broadcast Action: Sent after the system starts dreaming.
1965 *
1966 * <p class="note">This is a protected intent that can only be sent by the system.
1967 * It is only sent to registered receivers.</p>
1968 */
1969 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1970 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1971
1972 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001973 * 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 -07001974 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001975 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001976 * <p class="note">This is a protected intent that can only be sent
1977 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001978 */
1979 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001980 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001981
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001982 /**
1983 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001984 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001985 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001986 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1987 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001988 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001989 * <p class="note">This is a protected intent that can only be sent
1990 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001991 */
1992 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1993 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1994 /**
1995 * Broadcast Action: The time was set.
1996 */
1997 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1998 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1999 /**
2000 * Broadcast Action: The date has changed.
2001 */
2002 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2003 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
2004 /**
2005 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
2006 * <ul>
2007 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
2008 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002009 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002010 * <p class="note">This is a protected intent that can only be sent
2011 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002012 */
2013 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2014 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
2015 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07002016 * Clear DNS Cache Action: This is broadcast when networks have changed and old
2017 * DNS entries should be tossed.
2018 * @hide
2019 */
2020 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2021 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
2022 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002023 * Alarm Changed Action: This is broadcast when the AlarmClock
2024 * application's alarm is set or unset. It is used by the
2025 * AlarmClock application and the StatusBar service.
2026 * @hide
2027 */
2028 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2029 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002030
2031 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002032 * Broadcast Action: This is broadcast once, after the user has finished
2033 * booting, but while still in the "locked" state. It can be used to perform
2034 * application-specific initialization, such as installing alarms. You must
2035 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
2036 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002037 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002038 * This broadcast is sent immediately at boot by all devices (regardless of
2039 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
2040 * higher. Upon receipt of this broadcast, the user is still locked and only
2041 * device-protected storage can be accessed safely. If you want to access
2042 * credential-protected storage, you need to wait for the user to be
2043 * unlocked (typically by entering their lock pattern or PIN for the first
2044 * time), after which the {@link #ACTION_USER_UNLOCKED} and
2045 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
2046 * <p>
2047 * To receive this broadcast, your receiver component must be marked as
2048 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002049 * <p class="note">
2050 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002051 *
2052 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002053 */
2054 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2055 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2056
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002057 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002058 * Broadcast Action: This is broadcast once, after the user has finished
2059 * booting. It can be used to perform application-specific initialization,
2060 * such as installing alarms. You must hold the
2061 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2062 * order to receive this broadcast.
2063 * <p>
2064 * This broadcast is sent at boot by all devices (both with and without
2065 * direct boot support). Upon receipt of this broadcast, the user is
2066 * unlocked and both device-protected and credential-protected storage can
2067 * accessed safely.
2068 * <p>
2069 * If you need to run while the user is still locked (before they've entered
2070 * their lock pattern or PIN for the first time), you can listen for the
2071 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2072 * <p class="note">
2073 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002074 */
2075 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002076 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002077 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002078
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002079 /**
2080 * Broadcast Action: This is broadcast when a user action should request a
2081 * temporary system dialog to dismiss. Some examples of temporary system
2082 * dialogs are the notification window-shade and the recent tasks dialog.
2083 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002084 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002085 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2086 /**
2087 * Broadcast Action: Trigger the download and eventual installation
2088 * of a package.
2089 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002090 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002091 * <p class="note">This is a protected intent that can only be sent
2092 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002093 *
2094 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002095 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002096 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002097 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2098 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2099 /**
Christopher Tate94b91db2017-04-19 15:49:17 -07002100 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002101 * device. The data contains the name of the package. Note that the
2102 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002103 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002104 * <ul>
Christopher Tate94b91db2017-04-19 15:49:17 -07002105 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2106 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002107 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2108 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002109 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002110 * <p class="note">This is a protected intent that can only be sent
2111 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002112 */
2113 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2114 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2115 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002116 * Broadcast Action: A new version of an application package has been
2117 * installed, replacing an existing version that was previously installed.
2118 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002119 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002120 * <ul>
2121 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2122 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002123 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002124 * <p class="note">This is a protected intent that can only be sent
2125 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002126 */
2127 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2128 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2129 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002130 * Broadcast Action: A new version of your application has been installed
2131 * over an existing one. This is only sent to the application that was
2132 * replaced. It does not contain any additional data; to receive it, just
2133 * use an intent filter for this action.
2134 *
2135 * <p class="note">This is a protected intent that can only be sent
2136 * by the system.
2137 */
2138 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2139 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2140 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002141 * Broadcast Action: An existing application package has been removed from
2142 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002143 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002144 * <ul>
2145 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2146 * to the package.
2147 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2148 * application -- data and code -- is being removed.
2149 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2150 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2151 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002152 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002153 * <p class="note">This is a protected intent that can only be sent
2154 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002155 */
2156 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2157 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2158 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002159 * Broadcast Action: An existing application package has been completely
2160 * removed from the device. The data contains the name of the package.
2161 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2162 * {@link #EXTRA_DATA_REMOVED} is true and
2163 * {@link #EXTRA_REPLACING} is false of that broadcast.
2164 *
2165 * <ul>
2166 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2167 * to the package.
2168 * </ul>
2169 *
2170 * <p class="note">This is a protected intent that can only be sent
2171 * by the system.
2172 */
2173 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2174 public static final String ACTION_PACKAGE_FULLY_REMOVED
2175 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2176 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002177 * Broadcast Action: An existing application package has been changed (for
2178 * example, a component has been enabled or disabled). The data contains
2179 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002180 * <ul>
2181 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002182 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002183 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002184 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2185 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002186 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002187 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002188 * <p class="note">This is a protected intent that can only be sent
2189 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002190 */
2191 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2192 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2193 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002194 * @hide
2195 * Broadcast Action: Ask system services if there is any reason to
2196 * restart the given package. The data contains the name of the
2197 * package.
2198 * <ul>
2199 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2200 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2201 * </ul>
2202 *
2203 * <p class="note">This is a protected intent that can only be sent
2204 * by the system.
2205 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002206 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002207 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2208 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2209 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002210 * Broadcast Action: The user has restarted a package, and all of its
2211 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002212 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002213 * be removed. Note that the restarted package does <em>not</em>
2214 * receive this broadcast.
2215 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002216 * <ul>
2217 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2218 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002219 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002220 * <p class="note">This is a protected intent that can only be sent
2221 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002222 */
2223 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2224 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2225 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002226 * Broadcast Action: The user has cleared the data of a package. This should
2227 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002228 * its persistent data is erased and this broadcast sent.
2229 * Note that the cleared package does <em>not</em>
2230 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002231 * <ul>
Svet Ganovf935a702017-08-22 12:15:58 -07002232 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package. If the
2233 * package whose data was cleared is an uninstalled instant app, then the UID
2234 * will be -1. The platform keeps some meta-data associated with instant apps
2235 * after they are uninstalled.
2236 * <li> {@link #EXTRA_PACKAGE_NAME} containing the package name only if the cleared
2237 * data was for an instant app.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002238 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002239 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002240 * <p class="note">This is a protected intent that can only be sent
2241 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002242 */
2243 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2244 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2245 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002246 * Broadcast Action: Packages have been suspended.
2247 * <p>Includes the following extras:
2248 * <ul>
2249 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2250 * </ul>
2251 *
2252 * <p class="note">This is a protected intent that can only be sent
2253 * by the system. It is only sent to registered receivers.
2254 */
2255 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2256 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2257 /**
2258 * Broadcast Action: Packages have been unsuspended.
2259 * <p>Includes the following extras:
2260 * <ul>
2261 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2262 * </ul>
2263 *
2264 * <p class="note">This is a protected intent that can only be sent
2265 * by the system. It is only sent to registered receivers.
2266 */
2267 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2268 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2269 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002270 * Broadcast Action: A user ID has been removed from the system. The user
2271 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002272 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002273 * <p class="note">This is a protected intent that can only be sent
2274 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002275 */
2276 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2277 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002278
2279 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002280 * Broadcast Action: Sent to the installer package of an application when
2281 * that application is first launched (that is the first time it is moved
2282 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002283 *
2284 * <p class="note">This is a protected intent that can only be sent
2285 * by the system.
2286 */
2287 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2288 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2289
2290 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002291 * Broadcast Action: Sent to the system package verifier when a package
2292 * needs to be verified. The data contains the package URI.
2293 * <p class="note">
2294 * This is a protected intent that can only be sent by the system.
2295 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002296 */
2297 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2298 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2299
2300 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002301 * Broadcast Action: Sent to the system package verifier when a package is
2302 * verified. The data contains the package URI.
2303 * <p class="note">
2304 * This is a protected intent that can only be sent by the system.
2305 */
2306 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2307 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2308
2309 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002310 * Broadcast Action: Sent to the system intent filter verifier when an
2311 * intent filter needs to be verified. The data contains the filter data
2312 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002313 * <p class="note">
2314 * This is a protected intent that can only be sent by the system.
2315 * </p>
2316 *
2317 * @hide
2318 */
2319 @SystemApi
2320 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2321 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2322
2323 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002324 * Broadcast Action: Resources for a set of packages (which were
2325 * previously unavailable) are currently
2326 * available since the media on which they exist is available.
2327 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2328 * list of packages whose availability changed.
2329 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2330 * list of uids of packages whose availability changed.
2331 * Note that the
2332 * packages in this list do <em>not</em> receive this broadcast.
2333 * The specified set of packages are now available on the system.
2334 * <p>Includes the following extras:
2335 * <ul>
2336 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2337 * whose resources(were previously unavailable) are currently available.
2338 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2339 * packages whose resources(were previously unavailable)
2340 * are currently available.
2341 * </ul>
2342 *
2343 * <p class="note">This is a protected intent that can only be sent
2344 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002345 */
2346 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002347 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2348 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002349
2350 /**
2351 * Broadcast Action: Resources for a set of packages are currently
2352 * unavailable since the media on which they exist is unavailable.
2353 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2354 * list of packages whose availability changed.
2355 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2356 * list of uids of packages whose availability changed.
2357 * The specified set of packages can no longer be
2358 * launched and are practically unavailable on the system.
2359 * <p>Inclues the following extras:
2360 * <ul>
2361 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2362 * whose resources are no longer available.
2363 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2364 * whose resources are no longer available.
2365 * </ul>
2366 *
2367 * <p class="note">This is a protected intent that can only be sent
2368 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002369 */
2370 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002371 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002372 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002373
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002374 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002375 * Broadcast Action: preferred activities have changed *explicitly*.
2376 *
2377 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2378 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2379 * be sent.
2380 *
2381 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2382 *
2383 * @hide
2384 */
2385 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2386 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2387 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2388
2389
2390 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002391 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002392 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002393 * This should <em>only</em> be used to determine when the wallpaper
2394 * has changed to show the new wallpaper to the user. You should certainly
2395 * never, in response to this, change the wallpaper or other attributes of
2396 * it such as the suggested size. That would be crazy, right? You'd cause
2397 * all kinds of loops, especially if other apps are doing similar things,
2398 * right? Of course. So please don't do this.
2399 *
2400 * @deprecated Modern applications should use
2401 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2402 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2403 * shown behind their UI, rather than watching for this broadcast and
2404 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002405 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002406 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002407 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2408 /**
2409 * Broadcast Action: The current device {@link android.content.res.Configuration}
2410 * (orientation, locale, etc) has changed. When such a change happens, the
2411 * UIs (view hierarchy) will need to be rebuilt based on this new
2412 * information; for the most part, applications don't need to worry about
2413 * this, because the system will take care of stopping and restarting the
2414 * application to make sure it sees the new changes. Some system code that
2415 * can not be restarted will need to watch for this action and handle it
2416 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002417 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002418 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002419 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002420 * in manifests, only by explicitly registering for it with
2421 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2422 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002423 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002424 * <p class="note">This is a protected intent that can only be sent
2425 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002426 *
2427 * @see android.content.res.Configuration
2428 */
2429 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2430 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2431 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002432 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002433 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002434 * <p class="note">This is a protected intent that can only be sent
2435 * by the system.
2436 */
2437 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2438 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2439 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002440 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2441 * charging state, level, and other information about the battery.
2442 * See {@link android.os.BatteryManager} for documentation on the
2443 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002444 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002445 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002446 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002447 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002448 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002449 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2450 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2451 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2452 * broadcasts that are sent and can be received through manifest
2453 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002454 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002455 * <p class="note">This is a protected intent that can only be sent
2456 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002457 */
2458 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2459 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2460 /**
2461 * Broadcast Action: Indicates low battery condition on the device.
2462 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002463 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002464 * <p class="note">This is a protected intent that can only be sent
2465 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002466 */
2467 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2468 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2469 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002470 * Broadcast Action: Indicates the battery is now okay after being low.
2471 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2472 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002473 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002474 * <p class="note">This is a protected intent that can only be sent
2475 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002476 */
2477 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2478 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2479 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002480 * Broadcast Action: External power has been connected to the device.
2481 * This is intended for applications that wish to register specifically to this notification.
2482 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2483 * stay active to receive this notification. This action can be used to implement actions
2484 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002485 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002486 * <p class="note">This is a protected intent that can only be sent
2487 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002488 */
2489 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002490 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002491 /**
2492 * Broadcast Action: External power has been removed from the device.
2493 * This is intended for applications that wish to register specifically to this notification.
2494 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2495 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002496 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002497 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002498 * <p class="note">This is a protected intent that can only be sent
2499 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002500 */
2501 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002502 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002503 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002504 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002505 * Broadcast Action: Device is shutting down.
2506 * This is broadcast when the device is being shut down (completely turned
2507 * off, not sleeping). Once the broadcast is complete, the final shutdown
2508 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002509 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002510 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002511 * <p class="note">This is a protected intent that can only be sent
2512 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002513 * <p>May include the following extras:
2514 * <ul>
2515 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2516 * shutdown is only for userspace processes. If not set, assumed to be false.
2517 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002518 */
2519 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002520 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002521 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002522 * Activity Action: Start this activity to request system shutdown.
2523 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002524 * to request confirmation from the user before shutting down. The optional boolean
2525 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2526 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002527 *
2528 * <p class="note">This is a protected intent that can only be sent
2529 * by the system.
2530 *
2531 * {@hide}
2532 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002533 public static final String ACTION_REQUEST_SHUTDOWN
2534 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002535 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002536 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002537 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002538 * <p class="note">
2539 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002540 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002541 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2542 * or above, this broadcast will no longer be delivered to any
2543 * {@link BroadcastReceiver} defined in your manifest. Instead,
2544 * apps are strongly encouraged to use the improved
2545 * {@link Context#getCacheDir()} behavior so the system can
2546 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002547 */
2548 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002549 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002550 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2551 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002552 * Broadcast Action: Indicates low storage space condition on the device no
2553 * longer exists
2554 * <p class="note">
2555 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002556 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002557 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2558 * or above, this broadcast will no longer be delivered to any
2559 * {@link BroadcastReceiver} defined in your manifest. Instead,
2560 * apps are strongly encouraged to use the improved
2561 * {@link Context#getCacheDir()} behavior so the system can
2562 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002563 */
2564 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002565 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002566 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2567 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002568 * Broadcast Action: A sticky broadcast that indicates a storage space full
2569 * condition on the device. This is intended for activities that want to be
2570 * able to fill the data partition completely, leaving only enough free
2571 * space to prevent system-wide SQLite failures.
2572 * <p class="note">
2573 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002574 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002575 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2576 * or above, this broadcast will no longer be delivered to any
2577 * {@link BroadcastReceiver} defined in your manifest. Instead,
2578 * apps are strongly encouraged to use the improved
2579 * {@link Context#getCacheDir()} behavior so the system can
2580 * automatically free up storage when needed.
2581 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002582 */
2583 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002584 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002585 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2586 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002587 * Broadcast Action: Indicates storage space full condition on the device no
2588 * longer exists.
2589 * <p class="note">
2590 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002591 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002592 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2593 * or above, this broadcast will no longer be delivered to any
2594 * {@link BroadcastReceiver} defined in your manifest. Instead,
2595 * apps are strongly encouraged to use the improved
2596 * {@link Context#getCacheDir()} behavior so the system can
2597 * automatically free up storage when needed.
2598 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002599 */
2600 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002601 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002602 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2603 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002604 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2605 * and package management should be started.
2606 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2607 * notification.
2608 */
2609 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2610 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2611 /**
2612 * Broadcast Action: The device has entered USB Mass Storage mode.
2613 * This is used mainly for the USB Settings panel.
2614 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2615 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002616 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002617 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002618 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002619 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002620 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2621
2622 /**
2623 * Broadcast Action: The device has exited USB Mass Storage mode.
2624 * This is used mainly for the USB Settings panel.
2625 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2626 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002627 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002628 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002629 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002630 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002631 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2632
2633 /**
2634 * Broadcast Action: External media has been removed.
2635 * The path to the mount point for the removed media is contained in the Intent.mData field.
2636 */
2637 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2638 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2639
2640 /**
2641 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002642 * 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 -07002643 */
2644 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2645 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2646
2647 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002648 * Broadcast Action: External media is present, and being disk-checked
2649 * 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 -08002650 */
2651 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2652 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2653
2654 /**
2655 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2656 * 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 -08002657 */
2658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2659 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2660
2661 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002662 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002663 * 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 -07002664 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2665 * media was mounted read only.
2666 */
2667 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2668 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2669
2670 /**
2671 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002672 * 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 -07002673 */
2674 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2675 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2676
2677 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002678 * Broadcast Action: External media is no longer being shared via USB mass storage.
2679 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2680 *
2681 * @hide
2682 */
2683 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2684
2685 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002686 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2687 * The path to the mount point for the removed media is contained in the Intent.mData field.
2688 */
2689 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2690 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2691
2692 /**
2693 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002694 * 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 -07002695 */
2696 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2697 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2698
2699 /**
2700 * Broadcast Action: User has expressed the desire to remove the external storage media.
2701 * Applications should close all files they have open within the mount point when they receive this intent.
2702 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2703 */
2704 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2705 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2706
2707 /**
2708 * Broadcast Action: The media scanner has started scanning a directory.
2709 * The path to the directory being scanned is contained in the Intent.mData field.
2710 */
2711 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2712 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2713
2714 /**
2715 * Broadcast Action: The media scanner has finished scanning a directory.
2716 * The path to the scanned directory is contained in the Intent.mData field.
2717 */
2718 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2719 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2720
2721 /**
2722 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2723 * The path to the file is contained in the Intent.mData field.
2724 */
2725 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2726 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2727
2728 /**
2729 * Broadcast Action: The "Media Button" was pressed. Includes a single
2730 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2731 * caused the broadcast.
2732 */
2733 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2734 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2735
2736 /**
2737 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2738 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2739 * caused the broadcast.
2740 */
2741 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2742 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2743
2744 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2745 // location; they are not general-purpose actions.
2746
2747 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002748 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002749 */
2750 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2751 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2752 "android.intent.action.GTALK_CONNECTED";
2753
2754 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002755 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002756 */
2757 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2758 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2759 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002760
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002761 /**
2762 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002763 */
2764 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2765 public static final String ACTION_INPUT_METHOD_CHANGED =
2766 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002767
2768 /**
2769 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2770 * more radios have been turned off or on. The intent will have the following extra value:</p>
2771 * <ul>
2772 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2773 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2774 * turned off</li>
2775 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002776 *
Peng Xua35b5532016-01-20 00:05:45 -08002777 * <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 -07002778 */
2779 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2780 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2781
2782 /**
2783 * Broadcast Action: Some content providers have parts of their namespace
2784 * where they publish new events or items that the user may be especially
2785 * interested in. For these things, they may broadcast this action when the
2786 * set of interesting items change.
2787 *
2788 * For example, GmailProvider sends this notification when the set of unread
2789 * mail in the inbox changes.
2790 *
2791 * <p>The data of the intent identifies which part of which provider
2792 * changed. When queried through the content resolver, the data URI will
2793 * return the data set in question.
2794 *
2795 * <p>The intent will have the following extra values:
2796 * <ul>
2797 * <li><em>count</em> - The number of items in the data set. This is the
2798 * same as the number of items in the cursor returned by querying the
2799 * data URI. </li>
2800 * </ul>
2801 *
2802 * This intent will be sent at boot (if the count is non-zero) and when the
2803 * data set changes. It is possible for the data set to change without the
2804 * count changing (for example, if a new unread message arrives in the same
2805 * sync operation in which a message is archived). The phone should still
2806 * ring/vibrate/etc as normal in this case.
2807 */
2808 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2809 public static final String ACTION_PROVIDER_CHANGED =
2810 "android.intent.action.PROVIDER_CHANGED";
2811
2812 /**
2813 * Broadcast Action: Wired Headset plugged in or unplugged.
2814 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002815 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2816 * and documentation.
2817 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002818 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002819 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002820 */
2821 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002822 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002823
2824 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002825 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2826 * <ul>
2827 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2828 * </ul>
2829 *
2830 * <p class="note">This is a protected intent that can only be sent
2831 * by the system.
2832 *
2833 * @hide
2834 */
2835 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2836 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2837 = "android.intent.action.ADVANCED_SETTINGS";
2838
2839 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002840 * Broadcast Action: Sent after application restrictions are changed.
2841 *
2842 * <p class="note">This is a protected intent that can only be sent
2843 * by the system.</p>
2844 */
2845 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2846 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2847 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2848
2849 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002850 * Broadcast Action: An outgoing call is about to be placed.
2851 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002852 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002853 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002854 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002855 * the phone number originally intended to be dialed.</li>
2856 * </ul>
2857 * <p>Once the broadcast is finished, the resultData is used as the actual
2858 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002859 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002860 * outgoing call in turn: for example, a parental control application
2861 * might verify that the user is authorized to place the call at that
2862 * time, then a number-rewriting application might add an area code if
2863 * one was not specified.</p>
2864 * <p>For consistency, any receiver whose purpose is to prohibit phone
2865 * calls should have a priority of 0, to ensure it will see the final
2866 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002867 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002868 * should have a positive priority.
2869 * Negative priorities are reserved for the system for this broadcast;
2870 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002871 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2872 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002873 * <p>Emergency calls cannot be intercepted using this mechanism, and
2874 * other calls cannot be modified to call emergency numbers using this
2875 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002876 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2877 * call to use their own service instead. Those apps should first prevent
2878 * the call from being placed by setting resultData to <code>null</code>
2879 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002880 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002881 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2882 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002883 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002884 * <p class="note">This is a protected intent that can only be sent
2885 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002886 */
2887 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2888 public static final String ACTION_NEW_OUTGOING_CALL =
2889 "android.intent.action.NEW_OUTGOING_CALL";
2890
2891 /**
2892 * Broadcast Action: Have the device reboot. This is only for use by
2893 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002894 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002895 * <p class="note">This is a protected intent that can only be sent
2896 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002897 */
2898 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2899 public static final String ACTION_REBOOT =
2900 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002901
Wei Huang97ecc9c2009-05-11 17:44:20 -07002902 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002903 * Broadcast Action: A sticky broadcast for changes in the physical
2904 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002905 *
2906 * <p>The intent will have the following extra values:
2907 * <ul>
2908 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002909 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002910 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002911 * <p>This is intended for monitoring the current physical dock state.
2912 * See {@link android.app.UiModeManager} for the normal API dealing with
2913 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002914 */
2915 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2916 public static final String ACTION_DOCK_EVENT =
2917 "android.intent.action.DOCK_EVENT";
2918
2919 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002920 * Broadcast Action: A broadcast when idle maintenance can be started.
2921 * This means that the user is not interacting with the device and is
2922 * not expected to do so soon. Typical use of the idle maintenance is
2923 * to perform somehow expensive tasks that can be postponed at a moment
2924 * when they will not degrade user experience.
2925 * <p>
2926 * <p class="note">In order to keep the device responsive in case of an
2927 * unexpected user interaction, implementations of a maintenance task
2928 * should be interruptible. In such a scenario a broadcast with action
2929 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2930 * should not do the maintenance work in
2931 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2932 * maintenance service by {@link Context#startService(Intent)}. Also
2933 * you should hold a wake lock while your maintenance service is running
2934 * to prevent the device going to sleep.
2935 * </p>
2936 * <p>
2937 * <p class="note">This is a protected intent that can only be sent by
2938 * the system.
2939 * </p>
2940 *
2941 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002942 *
2943 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002944 */
2945 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2946 public static final String ACTION_IDLE_MAINTENANCE_START =
2947 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2948
2949 /**
2950 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2951 * This means that the user was not interacting with the device as a result
2952 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2953 * was sent and now the user started interacting with the device. Typical
2954 * use of the idle maintenance is to perform somehow expensive tasks that
2955 * can be postponed at a moment when they will not degrade user experience.
2956 * <p>
2957 * <p class="note">In order to keep the device responsive in case of an
2958 * unexpected user interaction, implementations of a maintenance task
2959 * should be interruptible. Hence, on receiving a broadcast with this
2960 * action, the maintenance task should be interrupted as soon as possible.
2961 * In other words, you should not do the maintenance work in
2962 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2963 * maintenance service that was started on receiving of
2964 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2965 * lock you acquired when your maintenance service started.
2966 * </p>
2967 * <p class="note">This is a protected intent that can only be sent
2968 * by the system.
2969 *
2970 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002971 *
2972 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002973 */
2974 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2975 public static final String ACTION_IDLE_MAINTENANCE_END =
2976 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2977
2978 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002979 * Broadcast Action: a remote intent is to be broadcasted.
2980 *
2981 * A remote intent is used for remote RPC between devices. The remote intent
2982 * is serialized and sent from one device to another device. The receiving
2983 * device parses the remote intent and broadcasts it. Note that anyone can
2984 * broadcast a remote intent. However, if the intent receiver of the remote intent
2985 * does not trust intent broadcasts from arbitrary intent senders, it should require
2986 * the sender to hold certain permissions so only trusted sender's broadcast will be
2987 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002988 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002989 */
2990 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002991 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002992
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002993 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002994 * Broadcast Action: This is broadcast once when the user is booting after a
2995 * system update. It can be used to perform cleanup or upgrades after a
2996 * system update.
2997 * <p>
2998 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2999 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
3000 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
3001 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003002 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003003 * @hide
3004 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003005 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003006 public static final String ACTION_PRE_BOOT_COMPLETED =
3007 "android.intent.action.PRE_BOOT_COMPLETED";
3008
Amith Yamasani13593602012-03-22 16:16:17 -07003009 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003010 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003011 * on restricted users. The broadcast intent contains an extra
3012 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
3013 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
3014 * String[] depending on the restriction type.<p/>
3015 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07003016 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
3017 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
3018 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003019 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
3020 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003021 * @see RestrictionEntry
3022 */
3023 public static final String ACTION_GET_RESTRICTION_ENTRIES =
3024 "android.intent.action.GET_RESTRICTION_ENTRIES";
3025
3026 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003027 * Sent the first time a user is starting, to allow system apps to
3028 * perform one time initialization. (This will not be seen by third
3029 * party applications because a newly initialized user does not have any
3030 * third party applications installed for it.) This is sent early in
3031 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003032 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3033 * broadcast, since it is part of a visible user interaction; be as quick
3034 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003035 */
3036 public static final String ACTION_USER_INITIALIZE =
3037 "android.intent.action.USER_INITIALIZE";
3038
3039 /**
3040 * Sent when a user switch is happening, causing the process's user to be
3041 * brought to the foreground. This is only sent to receivers registered
3042 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3043 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003044 * foreground. This is sent as a foreground
3045 * broadcast, since it is part of a visible user interaction; be as quick
3046 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003047 */
3048 public static final String ACTION_USER_FOREGROUND =
3049 "android.intent.action.USER_FOREGROUND";
3050
3051 /**
3052 * Sent when a user switch is happening, causing the process's user to be
3053 * sent to the background. This is only sent to receivers registered
3054 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3055 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003056 * background. This is sent as a foreground
3057 * broadcast, since it is part of a visible user interaction; be as quick
3058 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003059 */
3060 public static final String ACTION_USER_BACKGROUND =
3061 "android.intent.action.USER_BACKGROUND";
3062
3063 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003064 * Broadcast sent to the system when a user is added. Carries an extra
3065 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3066 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003067 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003068 * @hide
3069 */
3070 public static final String ACTION_USER_ADDED =
3071 "android.intent.action.USER_ADDED";
3072
3073 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003074 * Broadcast sent by the system when a user is started. Carries an extra
3075 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003076 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003077 * that has been started. This is sent as a foreground
3078 * broadcast, since it is part of a visible user interaction; be as quick
3079 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003080 * @hide
3081 */
3082 public static final String ACTION_USER_STARTED =
3083 "android.intent.action.USER_STARTED";
3084
3085 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003086 * Broadcast sent when a user is in the process of starting. Carries an extra
3087 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3088 * sent to registered receivers, not manifest receivers. It is sent to all
3089 * users (including the one that is being started). You must hold
3090 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3091 * this broadcast. This is sent as a background broadcast, since
3092 * its result is not part of the primary UX flow; to safely keep track of
3093 * started/stopped state of a user you can use this in conjunction with
3094 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3095 * other user state broadcasts since those are foreground broadcasts so can
3096 * execute in a different order.
3097 * @hide
3098 */
3099 public static final String ACTION_USER_STARTING =
3100 "android.intent.action.USER_STARTING";
3101
3102 /**
3103 * Broadcast sent when a user is going to be stopped. Carries an extra
3104 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3105 * sent to registered receivers, not manifest receivers. It is sent to all
3106 * users (including the one that is being stopped). You must hold
3107 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3108 * this broadcast. The user will not stop until all receivers have
3109 * handled the broadcast. This is sent as a background broadcast, since
3110 * its result is not part of the primary UX flow; to safely keep track of
3111 * started/stopped state of a user you can use this in conjunction with
3112 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3113 * other user state broadcasts since those are foreground broadcasts so can
3114 * execute in a different order.
3115 * @hide
3116 */
3117 public static final String ACTION_USER_STOPPING =
3118 "android.intent.action.USER_STOPPING";
3119
3120 /**
3121 * Broadcast sent to the system when a user is stopped. Carries an extra
3122 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3123 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3124 * specific package. This is only sent to registered receivers, not manifest
3125 * receivers. It is sent to all running users <em>except</em> the one that
3126 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003127 * @hide
3128 */
3129 public static final String ACTION_USER_STOPPED =
3130 "android.intent.action.USER_STOPPED";
3131
3132 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003133 * 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 -07003134 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003135 * one that has been removed. The user will not be completely removed until all receivers have
3136 * handled the broadcast. 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 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003140 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003141 public static final String ACTION_USER_REMOVED =
3142 "android.intent.action.USER_REMOVED";
3143
3144 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003145 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003146 * the userHandle of the user to become the current one. This is only sent to
3147 * registered receivers, not manifest receivers. It is sent to all running users.
3148 * You must hold
3149 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003150 * @hide
3151 */
3152 public static final String ACTION_USER_SWITCHED =
3153 "android.intent.action.USER_SWITCHED";
3154
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003155 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003156 * Broadcast Action: Sent when the credential-encrypted private storage has
3157 * become unlocked for the target user. This is only sent to registered
3158 * receivers, not manifest receivers.
3159 */
3160 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3161 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3162
3163 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003164 * Broadcast sent to the system when a user's information changes. Carries an extra
3165 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003166 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003167 * @hide
3168 */
3169 public static final String ACTION_USER_INFO_CHANGED =
3170 "android.intent.action.USER_INFO_CHANGED";
3171
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003172 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003173 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3174 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003175 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3176 * that need to display merged content across both primary and managed profiles need to
3177 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003178 * not manifest receivers.
3179 */
3180 public static final String ACTION_MANAGED_PROFILE_ADDED =
3181 "android.intent.action.MANAGED_PROFILE_ADDED";
3182
3183 /**
3184 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003185 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3186 * Only applications (for example Launchers) that need to display merged content across both
3187 * primary and managed profiles need to worry about this broadcast. This is only sent to
3188 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003189 */
3190 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3191 "android.intent.action.MANAGED_PROFILE_REMOVED";
3192
3193 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003194 * Broadcast sent to the primary user when the credential-encrypted private storage for
3195 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3196 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3197 * Launchers) that need to display merged content across both primary and managed profiles
3198 * need to worry about this broadcast. This is only sent to registered receivers,
3199 * not manifest receivers.
3200 */
3201 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3202 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3203
3204 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003205 * Broadcast sent to the primary user when an associated managed profile has become available.
3206 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003207 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3208 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3209 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003210 */
Rubin Xue95057a2016-04-01 16:49:25 +01003211 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3212 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3213
3214 /**
3215 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3216 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3217 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3218 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3219 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3220 */
3221 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3222 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003223
3224 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003225 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3226 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3227 * the device was locked or unlocked.
3228 *
3229 * This is only sent to registered receivers.
3230 *
3231 * @hide
3232 */
3233 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3234 "android.intent.action.DEVICE_LOCKED_CHANGED";
3235
3236 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003237 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3238 */
3239 public static final String ACTION_QUICK_CLOCK =
3240 "android.intent.action.QUICK_CLOCK";
3241
Michael Wright0087a142013-02-05 16:29:39 -08003242 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003243 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003244 * @hide
3245 */
3246 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003247 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003248
Justin Kohd378ad72013-04-01 12:18:26 -07003249 /**
3250 * Broadcast Action: A global button was pressed. Includes a single
3251 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3252 * caused the broadcast.
3253 * @hide
3254 */
Sujith Ramakrishnan48e19c82017-04-24 15:57:58 -07003255 @SystemApi
Justin Kohd378ad72013-04-01 12:18:26 -07003256 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3257
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003258 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003259 * Broadcast Action: Sent when media resource is granted.
3260 * <p>
3261 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3262 * granted.
3263 * </p>
3264 * <p class="note">
3265 * This is a protected intent that can only be sent by the system.
3266 * </p>
3267 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003268 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003269 * </p>
3270 *
3271 * @hide
3272 */
3273 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3274 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3275
3276 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003277 * Broadcast Action: An overlay package has changed. The data contains the
3278 * name of the overlay package which has changed. This is broadcast on all
3279 * changes to the OverlayInfo returned by {@link
3280 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3281 * most common change is a state change that will change whether the
3282 * overlay is enabled or not.
3283 * @hide
3284 */
3285 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3286
3287 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003288 * Activity Action: Allow the user to select and return one or more existing
3289 * documents. When invoked, the system will display the various
3290 * {@link DocumentsProvider} instances installed on the device, letting the
3291 * user interactively navigate through them. These documents include local
3292 * media, such as photos and video, and documents provided by installed
3293 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003294 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003295 * Each document is represented as a {@code content://} URI backed by a
3296 * {@link DocumentsProvider}, which can be opened as a stream with
3297 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3298 * {@link android.provider.DocumentsContract.Document} metadata.
3299 * <p>
3300 * All selected documents are returned to the calling application with
3301 * persistable read and write permission grants. If you want to maintain
3302 * access to the documents across device reboots, you need to explicitly
3303 * take the persistable permissions using
3304 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3305 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003306 * Callers must indicate the acceptable document MIME types through
3307 * {@link #setType(String)}. For example, to select photos, use
3308 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3309 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3310 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003311 * <p>
3312 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003313 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3314 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003315 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003316 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3317 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003318 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003319 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003320 * Callers can set a document URI through
3321 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3322 * location of documents navigator. System will do its best to launch the
3323 * navigator in the specified document if it's a folder, or the folder that
3324 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003325 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003326 * Output: The URI of the item that was picked, returned in
3327 * {@link #getData()}. This must be a {@code content://} URI so that any
3328 * receiver can access it. If multiple documents were selected, they are
3329 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003330 *
3331 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003332 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003333 * @see #ACTION_CREATE_DOCUMENT
3334 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003335 */
3336 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3337 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3338
3339 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003340 * Activity Action: Allow the user to create a new document. When invoked,
3341 * the system will display the various {@link DocumentsProvider} instances
3342 * installed on the device, letting the user navigate through them. The
3343 * returned document may be a newly created document with no content, or it
3344 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003345 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003346 * Each document is represented as a {@code content://} URI backed by a
3347 * {@link DocumentsProvider}, which can be opened as a stream with
3348 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3349 * {@link android.provider.DocumentsContract.Document} metadata.
3350 * <p>
3351 * Callers must indicate the concrete MIME type of the document being
3352 * created by setting {@link #setType(String)}. This MIME type cannot be
3353 * changed after the document is created.
3354 * <p>
3355 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3356 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003357 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003358 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3359 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003360 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003361 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003362 * Callers can set a document URI through
3363 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3364 * location of documents navigator. System will do its best to launch the
3365 * navigator in the specified document if it's a folder, or the folder that
3366 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003367 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003368 * Output: The URI of the item that was created. This must be a
3369 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003370 *
3371 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003372 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003373 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003374 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003375 */
3376 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3377 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3378
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003379 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003380 * Activity Action: Allow the user to pick a directory subtree. When
3381 * invoked, the system will display the various {@link DocumentsProvider}
3382 * instances installed on the device, letting the user navigate through
3383 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003384 * <p>
3385 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003386 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3387 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3388 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -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 Sharkeyb9fbb722014-06-04 16:42:47 -07003396 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003397 *
3398 * @see DocumentsContract
3399 */
3400 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003401 public static final String
3402 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003403
Felipe Lemec7b1f892016-01-15 15:02:31 -08003404 /**
Peng Xua35b5532016-01-20 00:05:45 -08003405 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3406 * exisiting sensor being disconnected.
3407 *
3408 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3409 *
3410 * {@hide}
3411 */
3412 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3413 public static final String
3414 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3415
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003416 /**
Sam Line707f832017-04-13 17:00:55 -07003417 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003418 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003419 * @removed
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003420 */
3421 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003422 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003423 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3424
Christopher Tate6597e342015-02-17 12:15:25 -08003425 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003426 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3427 * is about to be performed.
3428 * @hide
3429 */
3430 @SystemApi
3431 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3432 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3433 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3434
3435 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003436 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3437 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3438 *
3439 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3440 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003441 * @hide
3442 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003443 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003444 public static final String EXTRA_FORCE_MASTER_CLEAR =
3445 "android.intent.extra.FORCE_MASTER_CLEAR";
3446
3447 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003448 * A broadcast action to trigger a factory reset.
3449 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003450 * <p>The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission. The
3451 * reason for the factory reset should be specified as {@link #EXTRA_REASON}.
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003452 *
3453 * <p>Not for use by third-party applications.
3454 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003455 * @see #EXTRA_FORCE_FACTORY_RESET
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003456 *
3457 * {@hide}
3458 */
3459 @SystemApi
3460 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3461 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3462
3463 /**
3464 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3465 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3466 *
3467 * <p>Not for use by third-party applications.
3468 *
3469 * @hide
3470 */
3471 @SystemApi
3472 public static final String EXTRA_FORCE_FACTORY_RESET =
3473 "android.intent.extra.FORCE_FACTORY_RESET";
3474
3475 /**
Michal Karpinski6135a262017-08-11 10:45:58 +01003476 * Broadcast action: report that a settings element is being restored from backup. The intent
3477 * contains four extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3478 * EXTRA_SETTING_NEW_VALUE is the value being restored, EXTRA_SETTING_PREVIOUS_VALUE
3479 * is the value of that settings entry prior to the restore operation, and
3480 * EXTRA_SETTING_RESTORED_FROM_SDK_INT is the version of the SDK that the setting has been
3481 * restored from (corresponds to {@link android.os.Build.VERSION#SDK_INT}). The first three
3482 * values are represented as strings, the fourth one as int.
Christopher Tate6597e342015-02-17 12:15:25 -08003483 *
3484 * <p>This broadcast is sent only for settings provider entries known to require special handling
3485 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3486 * the provider's backup agent implementation.
3487 *
3488 * @see #EXTRA_SETTING_NAME
3489 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3490 * @see #EXTRA_SETTING_NEW_VALUE
Michal Karpinski6135a262017-08-11 10:45:58 +01003491 * @see #EXTRA_SETTING_RESTORED_FROM_SDK_INT
Christopher Tate6597e342015-02-17 12:15:25 -08003492 * {@hide}
3493 */
3494 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3495
3496 /** {@hide} */
3497 public static final String EXTRA_SETTING_NAME = "setting_name";
3498 /** {@hide} */
3499 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3500 /** {@hide} */
3501 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
Michal Karpinski6135a262017-08-11 10:45:58 +01003502 /** {@hide} */
3503 public static final String EXTRA_SETTING_RESTORED_FROM_SDK_INT = "restored_from_sdk_int";
Christopher Tate6597e342015-02-17 12:15:25 -08003504
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003505 /**
3506 * Activity Action: Process a piece of text.
3507 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3508 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3509 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3510 */
3511 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3512 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003513
3514 /**
3515 * Broadcast Action: The sim card state has changed.
3516 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3517 * because TelephonyIntents is an internal class.
3518 * @hide
3519 */
3520 @SystemApi
3521 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3522 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3523
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003524 /**
fionaxu90fee272017-03-31 12:45:12 -07003525 * Broadcast Action: indicate that the phone service state has changed.
3526 * The intent will have the following extra values:</p>
3527 * <p>
3528 * @see #EXTRA_VOICE_REG_STATE
3529 * @see #EXTRA_DATA_REG_STATE
3530 * @see #EXTRA_VOICE_ROAMING_TYPE
3531 * @see #EXTRA_DATA_ROAMING_TYPE
3532 * @see #EXTRA_OPERATOR_ALPHA_LONG
3533 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3534 * @see #EXTRA_OPERATOR_NUMERIC
3535 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3536 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3537 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3538 * @see #EXTRA_MANUAL
3539 * @see #EXTRA_VOICE_RADIO_TECH
3540 * @see #EXTRA_DATA_RADIO_TECH
3541 * @see #EXTRA_CSS_INDICATOR
3542 * @see #EXTRA_NETWORK_ID
3543 * @see #EXTRA_SYSTEM_ID
3544 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3545 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3546 * @see #EXTRA_EMERGENCY_ONLY
3547 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3548 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3549 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3550 *
3551 * <p class="note">
3552 * Requires the READ_PHONE_STATE permission.
3553 *
3554 * <p class="note">This is a protected intent that can only be sent by the system.
3555 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003556 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003557 */
3558 @Deprecated
3559 @SystemApi
3560 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3561 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3562
3563 /**
3564 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3565 * state.
3566 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3567 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3568 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3569 * @see android.telephony.ServiceState#STATE_POWER_OFF
3570 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003571 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003572 */
3573 @Deprecated
3574 @SystemApi
3575 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3576
3577 /**
3578 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3579 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3580 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3581 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3582 * @see android.telephony.ServiceState#STATE_POWER_OFF
3583 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003584 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003585 */
3586 @Deprecated
3587 @SystemApi
3588 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3589
3590 /**
3591 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3592 * type.
3593 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003594 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003595 */
3596 @Deprecated
3597 @SystemApi
3598 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3599
3600 /**
3601 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3602 * type.
3603 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003604 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003605 */
3606 @Deprecated
3607 @SystemApi
3608 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3609
3610 /**
3611 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3612 * registered voice operator name in long alphanumeric format.
3613 * {@code null} if the operator name is not known or unregistered.
3614 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003615 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003616 */
3617 @Deprecated
3618 @SystemApi
3619 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3620
3621 /**
3622 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3623 * registered voice operator name in short alphanumeric format.
3624 * {@code null} if the operator name is not known or unregistered.
3625 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003626 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003627 */
3628 @Deprecated
3629 @SystemApi
3630 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3631
3632 /**
3633 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3634 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3635 * network.
3636 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003637 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003638 */
3639 @Deprecated
3640 @SystemApi
3641 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3642
3643 /**
3644 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3645 * registered data operator name in long alphanumeric format.
3646 * {@code null} if the operator name is not known or unregistered.
3647 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003648 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003649 */
3650 @Deprecated
3651 @SystemApi
3652 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3653
3654 /**
3655 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3656 * registered data operator name in short alphanumeric format.
3657 * {@code null} if the operator name is not known or unregistered.
3658 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003659 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003660 */
3661 @Deprecated
3662 @SystemApi
3663 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3664
3665 /**
3666 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3667 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3668 * data operator.
3669 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003670 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003671 */
3672 @Deprecated
3673 @SystemApi
3674 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3675
3676 /**
3677 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3678 * network selection mode is manual.
3679 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3680 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003681 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003682 */
3683 @Deprecated
3684 @SystemApi
3685 public static final String EXTRA_MANUAL = "manual";
3686
3687 /**
3688 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3689 * radio technology.
3690 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003691 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003692 */
3693 @Deprecated
3694 @SystemApi
3695 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3696
3697 /**
3698 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3699 * radio technology.
3700 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003701 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003702 */
3703 @Deprecated
3704 @SystemApi
3705 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3706
3707 /**
3708 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3709 * support on CDMA network.
3710 * Will be {@code true} if support, {@code false} otherwise.
3711 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003712 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003713 */
3714 @Deprecated
3715 @SystemApi
3716 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3717
3718 /**
3719 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3720 * id. {@code Integer.MAX_VALUE} if unknown.
3721 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003722 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003723 */
3724 @Deprecated
3725 @SystemApi
3726 public static final String EXTRA_NETWORK_ID = "networkId";
3727
3728 /**
3729 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3730 * {@code Integer.MAX_VALUE} if unknown.
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_SYSTEM_ID = "systemId";
3737
3738 /**
3739 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3740 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3741 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003742 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003743 */
3744 @Deprecated
3745 @SystemApi
3746 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3747
3748 /**
3749 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3750 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3751 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003752 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003753 */
3754 @Deprecated
3755 @SystemApi
3756 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3757
3758 /**
3759 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3760 * only mode.
3761 * {@code true} if in emergency only mode, {@code false} otherwise.
3762 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003763 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003764 */
3765 @Deprecated
3766 @SystemApi
3767 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3768
3769 /**
3770 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3771 * registration state is roaming.
3772 * {@code true} if registration indicates roaming, {@code false} otherwise
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_IS_DATA_ROAMING_FROM_REGISTRATION =
3779 "isDataRoamingFromRegistration";
3780
3781 /**
3782 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
3783 * aggregation is in use.
3784 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
3785 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003786 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003787 */
3788 @Deprecated
3789 @SystemApi
3790 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
3791
3792 /**
3793 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
3794 * is reduced from the rsrp threshold while calculating signal strength level.
3795 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003796 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003797 */
3798 @Deprecated
3799 @SystemApi
3800 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
3801
3802 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003803 * The name of the extra used to define the text to be processed, as a
3804 * CharSequence. Note that this may be a styled CharSequence, so you must use
3805 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003806 */
3807 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3808 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003809 * 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 +00003810 */
3811 public static final String EXTRA_PROCESS_TEXT_READONLY =
3812 "android.intent.extra.PROCESS_TEXT_READONLY";
3813
Bryce Leebc58f592015-09-25 16:43:01 -07003814 /**
3815 * Broadcast action: reports when a new thermal event has been reached. When the device
3816 * is reaching its maximum temperatue, the thermal level reported
3817 * {@hide}
3818 */
3819 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3820 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3821
3822 /** {@hide} */
3823 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3824
3825 /**
3826 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003827 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003828 * {@hide}
3829 */
3830 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3831
3832 /**
3833 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003834 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003835 * {@hide}
3836 */
3837 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3838
3839 /**
3840 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003841 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003842 * {@hide}
3843 */
3844 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3845
3846
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003847 // ---------------------------------------------------------------------
3848 // ---------------------------------------------------------------------
3849 // Standard intent categories (see addCategory()).
3850
3851 /**
3852 * Set if the activity should be an option for the default action
3853 * (center press) to perform on a piece of data. Setting this will
3854 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003855 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003856 * Intent when initiating an action -- it is for use in intent filters
3857 * specified in packages.
3858 */
3859 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3860 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3861 /**
3862 * Activities that can be safely invoked from a browser must support this
3863 * category. For example, if the user is viewing a web page or an e-mail
3864 * and clicks on a link in the text, the Intent generated execute that
3865 * link will require the BROWSABLE category, so that only activities
3866 * supporting this category will be considered as possible actions. By
3867 * supporting this category, you are promising that there is nothing
3868 * damaging (without user intervention) that can happen by invoking any
3869 * matching Intent.
3870 */
3871 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3872 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3873 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003874 * Categories for activities that can participate in voice interaction.
3875 * An activity that supports this category must be prepared to run with
3876 * no UI shown at all (though in some case it may have a UI shown), and
3877 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3878 */
3879 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3880 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3881 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003882 * Set if the activity should be considered as an alternative action to
3883 * the data the user is currently viewing. See also
3884 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3885 * applies to the selection in a list of items.
3886 *
3887 * <p>Supporting this category means that you would like your activity to be
3888 * displayed in the set of alternative things the user can do, usually as
3889 * part of the current activity's options menu. You will usually want to
3890 * include a specific label in the &lt;intent-filter&gt; of this action
3891 * describing to the user what it does.
3892 *
3893 * <p>The action of IntentFilter with this category is important in that it
3894 * describes the specific action the target will perform. This generally
3895 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3896 * a specific name such as "com.android.camera.action.CROP. Only one
3897 * alternative of any particular action will be shown to the user, so using
3898 * a specific action like this makes sure that your alternative will be
3899 * displayed while also allowing other applications to provide their own
3900 * overrides of that particular action.
3901 */
3902 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3903 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3904 /**
3905 * Set if the activity should be considered as an alternative selection
3906 * action to the data the user has currently selected. This is like
3907 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3908 * of items from which the user can select, giving them alternatives to the
3909 * default action that will be performed on it.
3910 */
3911 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3912 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3913 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003914 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003915 */
3916 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3917 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3918 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003919 * Should be displayed in the top-level launcher.
3920 */
3921 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3922 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3923 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003924 * Indicates an activity optimized for Leanback mode, and that should
3925 * be displayed in the Leanback launcher.
3926 */
3927 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3928 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3929 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003930 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3931 * @hide
3932 */
3933 @SystemApi
3934 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3935 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003936 * Provides information about the package it is in; typically used if
3937 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3938 * a front-door to the user without having to be shown in the all apps list.
3939 */
3940 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3941 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3942 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003943 * This is the home activity, that is the first activity that is displayed
3944 * when the device boots.
3945 */
3946 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3947 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3948 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003949 * This is the home activity that is displayed when the device is finished setting up and ready
3950 * for use.
3951 * @hide
3952 */
3953 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3954 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3955 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003956 * This is the setup wizard activity, that is the first activity that is displayed
3957 * when the user sets up the device for the first time.
3958 * @hide
3959 */
3960 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3961 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3962 /**
Svet Ganov5bb6bc62017-08-28 12:39:35 -07003963 * This is the home activity, that is the activity that serves as the launcher app
3964 * from there the user can start other apps. Often components with lower/higher
3965 * priority intent filters handle the home intent, for example SetupWizard, to
3966 * setup the device and we need to be able to distinguish the home app from these
3967 * setup helpers.
3968 * @hide
3969 */
3970 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3971 public static final String CATEGORY_LAUNCHER_APP = "android.intent.category.LAUNCHER_APP";
3972 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003973 * This activity is a preference panel.
3974 */
3975 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3976 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3977 /**
3978 * This activity is a development preference panel.
3979 */
3980 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3981 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3982 /**
3983 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003984 */
3985 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3986 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3987 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003988 * This activity allows the user to browse and download new applications.
3989 */
3990 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3991 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3992 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003993 * This activity may be exercised by the monkey or other automated test tools.
3994 */
3995 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3996 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3997 /**
3998 * To be used as a test (not part of the normal user experience).
3999 */
4000 public static final String CATEGORY_TEST = "android.intent.category.TEST";
4001 /**
4002 * To be used as a unit test (run through the Test Harness).
4003 */
4004 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
4005 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004006 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004007 * experience).
4008 */
4009 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004010
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004011 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004012 * Used to indicate that an intent only wants URIs that can be opened with
4013 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
4014 * must support at least the columns defined in {@link OpenableColumns} when
4015 * queried.
4016 *
4017 * @see #ACTION_GET_CONTENT
4018 * @see #ACTION_OPEN_DOCUMENT
4019 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004020 */
4021 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4022 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
4023
4024 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09004025 * Used to indicate that an intent filter can accept files which are not necessarily
4026 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
4027 * at least streamable via
4028 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
4029 * using one of the stream types exposed via
4030 * {@link ContentResolver#getStreamTypes(Uri, String)}.
4031 *
4032 * @see #ACTION_SEND
4033 * @see #ACTION_SEND_MULTIPLE
4034 */
4035 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4036 public static final String CATEGORY_TYPED_OPENABLE =
4037 "android.intent.category.TYPED_OPENABLE";
4038
4039 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004040 * To be used as code under test for framework instrumentation tests.
4041 */
4042 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
4043 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04004044 /**
4045 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004046 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4047 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004048 */
4049 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4050 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
4051 /**
4052 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004053 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4054 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004055 */
4056 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4057 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004058 /**
4059 * An activity to run when device is inserted into a analog (low end) dock.
4060 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4061 * information, see {@link android.app.UiModeManager}.
4062 */
4063 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4064 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
4065
4066 /**
4067 * An activity to run when device is inserted into a digital (high end) dock.
4068 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4069 * information, see {@link android.app.UiModeManager}.
4070 */
4071 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4072 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004073
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004074 /**
4075 * Used to indicate that the activity can be used in a car environment.
4076 */
4077 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4078 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4079
Zak Cohendb6ca492017-01-26 14:09:00 -08004080 /**
4081 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4082 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4083 * information, see {@link android.app.UiModeManager}.
4084 */
4085 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4086 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004087 // ---------------------------------------------------------------------
4088 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004089 // Application launch intent categories (see addCategory()).
4090
4091 /**
4092 * Used with {@link #ACTION_MAIN} to launch the browser application.
4093 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004094 * <p>NOTE: This should not be used as the primary key of an Intent,
4095 * since it will not result in the app launching with the correct
4096 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004097 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004098 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004099 */
4100 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4101 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4102
4103 /**
4104 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4105 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004106 * <p>NOTE: This should not be used as the primary key of an Intent,
4107 * since it will not result in the app launching with the correct
4108 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004109 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004110 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004111 */
4112 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4113 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4114
4115 /**
4116 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4117 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004118 * <p>NOTE: This should not be used as the primary key of an Intent,
4119 * since it will not result in the app launching with the correct
4120 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004121 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004122 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004123 */
4124 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4125 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4126
4127 /**
4128 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4129 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004130 * <p>NOTE: This should not be used as the primary key of an Intent,
4131 * since it will not result in the app launching with the correct
4132 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004133 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004134 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004135 */
4136 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4137 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4138
4139 /**
4140 * Used with {@link #ACTION_MAIN} to launch the email application.
4141 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004142 * <p>NOTE: This should not be used as the primary key of an Intent,
4143 * since it will not result in the app launching with the correct
4144 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004145 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004146 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004147 */
4148 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4149 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4150
4151 /**
4152 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4153 * The activity should be able to view and manipulate image and video files
4154 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004155 * <p>NOTE: This should not be used as the primary key of an Intent,
4156 * since it will not result in the app launching with the correct
4157 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004158 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004159 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004160 */
4161 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4162 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4163
4164 /**
4165 * Used with {@link #ACTION_MAIN} to launch the maps application.
4166 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004167 * <p>NOTE: This should not be used as the primary key of an Intent,
4168 * since it will not result in the app launching with the correct
4169 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004170 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004171 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004172 */
4173 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4174 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4175
4176 /**
4177 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4178 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004179 * <p>NOTE: This should not be used as the primary key of an Intent,
4180 * since it will not result in the app launching with the correct
4181 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004182 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004183 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004184 */
4185 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4186 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4187
4188 /**
4189 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004190 * The activity should be able to play, browse, or manipulate music files
4191 * stored on the device.
4192 * <p>NOTE: This should not be used as the primary key of an Intent,
4193 * since it will not result in the app launching with the correct
4194 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004195 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004196 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004197 */
4198 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4199 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4200
4201 // ---------------------------------------------------------------------
4202 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004203 // Standard extra data keys.
4204
4205 /**
4206 * The initial data to place in a newly created record. Use with
4207 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4208 * fields as would be given to the underlying ContentProvider.insert()
4209 * call.
4210 */
4211 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4212
4213 /**
4214 * A constant CharSequence that is associated with the Intent, used with
4215 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4216 * this may be a styled CharSequence, so you must use
4217 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4218 * retrieve it.
4219 */
4220 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4221
4222 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004223 * A constant String that is associated with the Intent, used with
4224 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4225 * as HTML formatted text. Note that you <em>must</em> also supply
4226 * {@link #EXTRA_TEXT}.
4227 */
4228 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4229
4230 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004231 * A content: URI holding a stream of data associated with the Intent,
4232 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004233 */
4234 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4235
4236 /**
4237 * A String[] holding e-mail addresses that should be delivered to.
4238 */
4239 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4240
4241 /**
4242 * A String[] holding e-mail addresses that should be carbon copied.
4243 */
4244 public static final String EXTRA_CC = "android.intent.extra.CC";
4245
4246 /**
4247 * A String[] holding e-mail addresses that should be blind carbon copied.
4248 */
4249 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4250
4251 /**
4252 * A constant string holding the desired subject line of a message.
4253 */
4254 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4255
4256 /**
4257 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004258 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004259 */
4260 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4261
4262 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004263 * An int representing the user id to be used.
4264 *
4265 * @hide
4266 */
4267 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4268
4269 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004270 * An int representing the task id to be retrieved. This is used when a launch from recents is
4271 * intercepted by another action such as credentials confirmation to remember which task should
4272 * be resumed when complete.
4273 *
4274 * @hide
4275 */
4276 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4277
4278 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004279 * An Intent[] describing additional, alternate choices you would like shown with
4280 * {@link #ACTION_CHOOSER}.
4281 *
4282 * <p>An app may be capable of providing several different payload types to complete a
4283 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4284 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4285 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4286 * photo data or a hosted link where the photos can be viewed.</p>
4287 *
4288 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4289 * first/primary/preferred intent in the set. Additional intents specified in
4290 * this extra are ordered; by default intents that appear earlier in the array will be
4291 * preferred over intents that appear later in the array as matches for the same
4292 * target component. To alter this preference, a calling app may also supply
4293 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4294 */
4295 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4296
4297 /**
Adam Powell52c39212016-04-07 15:14:18 -07004298 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4299 * and omitted from a list of components presented to the user.
4300 *
4301 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4302 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4303 * from your own package or other apps from your organization if the idea of sending to those
4304 * targets would be redundant with other app functionality. Filtered components will not
4305 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4306 */
4307 public static final String EXTRA_EXCLUDE_COMPONENTS
4308 = "android.intent.extra.EXCLUDE_COMPONENTS";
4309
4310 /**
4311 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4312 * describing additional high-priority deep-link targets for the chooser to present to the user.
4313 *
4314 * <p>Targets provided in this way will be presented inline with all other targets provided
4315 * by services from other apps. They will be prioritized before other service targets, but
4316 * after those targets provided by sources that the user has manually pinned to the front.</p>
4317 *
4318 * @see #ACTION_CHOOSER
4319 */
4320 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4321
4322 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004323 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4324 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4325 *
4326 * <p>An app preparing an action for another app to complete may wish to allow the user to
4327 * disambiguate between several options for completing the action based on the chosen target
4328 * or otherwise refine the action before it is invoked.
4329 * </p>
4330 *
4331 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4332 * <ul>
4333 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4334 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4335 * chosen target beyond the first</li>
4336 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4337 * should fill in and send once the disambiguation is complete</li>
4338 * </ul>
4339 */
4340 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4341 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4342
4343 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004344 * An {@code ArrayList} of {@code String} annotations describing content for
4345 * {@link #ACTION_CHOOSER}.
4346 *
4347 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4348 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4349 *
4350 * <p>Annotations should describe the major components or topics of the content. It is up to
4351 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4352 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004353 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4354 * character. Performance on customized annotations can suffer, if they are rarely used for
4355 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4356 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004357 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004358 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004359 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004360 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004361 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004362 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004363 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004364 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004365 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004366 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4367 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4368 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4369 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4370 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004371 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004372 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4373 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004374 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004375 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004376 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004377 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004378 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004379 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004380 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004381 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004382 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004383 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004384 * Christmas and Thanksgiving.</li>
4385 * </ul>
4386 */
4387 public static final String EXTRA_CONTENT_ANNOTATIONS
4388 = "android.intent.extra.CONTENT_ANNOTATIONS";
4389
4390 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004391 * A {@link ResultReceiver} used to return data back to the sender.
4392 *
4393 * <p>Used to complete an app-specific
4394 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4395 *
4396 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4397 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4398 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4399 * when the user selects a target component from the chooser. It is up to the recipient
4400 * to send a result to this ResultReceiver to signal that disambiguation is complete
4401 * and that the chooser should invoke the user's choice.</p>
4402 *
4403 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4404 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4405 * to match and fill in the final Intent or ChooserTarget before starting it.
4406 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4407 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4408 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4409 *
4410 * <p>The result code passed to the ResultReceiver should be
4411 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4412 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4413 * the chooser should finish without starting a target.</p>
4414 */
4415 public static final String EXTRA_RESULT_RECEIVER
4416 = "android.intent.extra.RESULT_RECEIVER";
4417
4418 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004419 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004420 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004421 */
4422 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4423
4424 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004425 * A Parcelable[] of {@link Intent} or
4426 * {@link android.content.pm.LabeledIntent} objects as set with
4427 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4428 * a the front of the list of choices, when shown to the user with a
4429 * {@link #ACTION_CHOOSER}.
4430 */
4431 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4432
4433 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004434 * A {@link IntentSender} to start after ephemeral installation success.
4435 * @hide
4436 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004437 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4438
4439 /**
4440 * A {@link IntentSender} to start after ephemeral installation failure.
4441 * @hide
4442 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004443 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4444
4445 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004446 * The host name that triggered an ephemeral resolution.
4447 * @hide
4448 */
4449 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4450
4451 /**
4452 * An opaque token to track ephemeral resolution.
4453 * @hide
4454 */
4455 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4456
4457 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004458 * The version code of the app to install components from.
Dianne Hackborn3accca02013-09-20 09:32:11 -07004459 * @deprecated Use {@link #EXTRA_LONG_VERSION_CODE).
Todd Kennedy316c2f22017-01-23 15:40:07 -08004460 * @hide
4461 */
Dianne Hackborn3accca02013-09-20 09:32:11 -07004462 @Deprecated
Todd Kennedy316c2f22017-01-23 15:40:07 -08004463 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4464
4465 /**
Dianne Hackborn3accca02013-09-20 09:32:11 -07004466 * The version code of the app to install components from.
4467 * @hide
4468 */
4469 public static final String EXTRA_LONG_VERSION_CODE = "android.intent.extra.LONG_VERSION_CODE";
4470
4471 /**
Chad Brubaker06068612017-04-06 09:43:47 -07004472 * The app that triggered the ephemeral installation.
4473 * @hide
4474 */
4475 public static final String EXTRA_CALLING_PACKAGE
4476 = "android.intent.extra.CALLING_PACKAGE";
4477
4478 /**
4479 * Optional calling app provided bundle containing additional launch information the
4480 * installer may use.
4481 * @hide
4482 */
4483 public static final String EXTRA_VERIFICATION_BUNDLE
4484 = "android.intent.extra.VERIFICATION_BUNDLE";
4485
4486 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004487 * A Bundle forming a mapping of potential target package names to different extras Bundles
4488 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4489 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4490 * be currently installed on the device.
4491 *
4492 * <p>An application may choose to provide alternate extras for the case where a user
4493 * selects an activity from a predetermined set of target packages. If the activity
4494 * the user selects from the chooser belongs to a package with its package name as
4495 * a key in this bundle, the corresponding extras for that package will be merged with
4496 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4497 * extra has the same key as an extra already present in the intent it will overwrite
4498 * the extra from the intent.</p>
4499 *
4500 * <p><em>Examples:</em>
4501 * <ul>
4502 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4503 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4504 * parameters for that target.</li>
4505 * <li>An application may offer additional metadata for known targets of a given intent
4506 * to pass along information only relevant to that target such as account or content
4507 * identifiers already known to that application.</li>
4508 * </ul></p>
4509 */
4510 public static final String EXTRA_REPLACEMENT_EXTRAS =
4511 "android.intent.extra.REPLACEMENT_EXTRAS";
4512
4513 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004514 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4515 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4516 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4517 * {@link ComponentName} of the chosen component.
4518 *
4519 * <p>In some situations this callback may never come, for example if the user abandons
4520 * the chooser, switches to another task or any number of other reasons. Apps should not
4521 * be written assuming that this callback will always occur.</p>
4522 */
4523 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4524 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4525
4526 /**
4527 * The {@link ComponentName} chosen by the user to complete an action.
4528 *
4529 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4530 */
4531 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4532
4533 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004534 * A {@link android.view.KeyEvent} object containing the event that
4535 * triggered the creation of the Intent it is in.
4536 */
4537 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4538
4539 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004540 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4541 * before shutting down.
4542 *
4543 * {@hide}
4544 */
4545 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4546
4547 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004548 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4549 * requested by the user.
4550 *
4551 * {@hide}
4552 */
4553 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4554 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4555
4556 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004557 * 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 -07004558 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4559 * of restarting the application.
4560 */
4561 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4562
4563 /**
4564 * A String holding the phone number originally entered in
4565 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4566 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4567 */
4568 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004569
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004570 /**
4571 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4572 * intents to supply the uid the package had been assigned. Also an optional
4573 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4574 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4575 * purpose.
4576 */
4577 public static final String EXTRA_UID = "android.intent.extra.UID";
4578
4579 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004580 * @hide String array of package names.
4581 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004582 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004583 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4584
4585 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004586 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4587 * intents to indicate whether this represents a full uninstall (removing
4588 * both the code and its data) or a partial uninstall (leaving its data,
4589 * implying that this is an update).
4590 */
4591 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004592
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004593 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004594 * @hide
4595 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4596 * intents to indicate that at this point the package has been removed for
4597 * all users on the device.
4598 */
4599 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4600 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4601
4602 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004603 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4604 * intents to indicate that this is a replacement of the package, so this
4605 * broadcast will immediately be followed by an add broadcast for a
4606 * different version of the same package.
4607 */
4608 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004609
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004610 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004611 * Used as an int extra field in {@link android.app.AlarmManager} intents
4612 * to tell the application being invoked how many pending alarms are being
4613 * delievered with the intent. For one-shot alarms this will always be 1.
4614 * For recurring alarms, this might be greater than 1 if the device was
4615 * asleep or powered off at the time an earlier alarm would have been
4616 * delivered.
4617 */
4618 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004619
Jacek Surazski86b6c532009-05-13 14:38:28 +02004620 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004621 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4622 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004623 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4624 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004625 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4626 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4627 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004628 */
4629 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4630
4631 /**
4632 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4633 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004634 */
4635 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4636
4637 /**
4638 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4639 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004640 */
4641 public static final int EXTRA_DOCK_STATE_DESK = 1;
4642
4643 /**
4644 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4645 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004646 */
4647 public static final int EXTRA_DOCK_STATE_CAR = 2;
4648
4649 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004650 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4651 * to represent that the phone is in a analog (low end) dock.
4652 */
4653 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4654
4655 /**
4656 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4657 * to represent that the phone is in a digital (high end) dock.
4658 */
4659 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4660
4661 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004662 * Boolean that can be supplied as meta-data with a dock activity, to
4663 * indicate that the dock should take over the home key when it is active.
4664 */
4665 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004666
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004667 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004668 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4669 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004670 */
4671 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4672
4673 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004674 * Used in the extra field in the remote intent. It's astring token passed with the
4675 * remote intent.
4676 */
4677 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4678 "android.intent.extra.remote_intent_token";
4679
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004680 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004681 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004682 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004683 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004684 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004685 "android.intent.extra.changed_component_name";
4686
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004687 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004688 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004689 * and contains a string array of all of the components that have changed. If
4690 * the state of the overall package has changed, then it will contain an entry
4691 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004692 */
4693 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4694 "android.intent.extra.changed_component_name_list";
4695
4696 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004697 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004698 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004699 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4700 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4701 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004702 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004703 */
4704 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4705 "android.intent.extra.changed_package_list";
4706
4707 /**
4708 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004709 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4710 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004711 * and contains an integer array of uids of all of the components
4712 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004713 */
4714 public static final String EXTRA_CHANGED_UID_LIST =
4715 "android.intent.extra.changed_uid_list";
4716
4717 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004718 * @hide
4719 * Magic extra system code can use when binding, to give a label for
4720 * who it is that has bound to a service. This is an integer giving
4721 * a framework string resource that can be displayed to the user.
4722 */
4723 public static final String EXTRA_CLIENT_LABEL =
4724 "android.intent.extra.client_label";
4725
4726 /**
4727 * @hide
4728 * Magic extra system code can use when binding, to give a PendingIntent object
4729 * that can be launched for the user to disable the system's use of this
4730 * service.
4731 */
4732 public static final String EXTRA_CLIENT_INTENT =
4733 "android.intent.extra.client_intent";
4734
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004735 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004736 * Extra used to indicate that an intent should only return data that is on
4737 * the local device. This is a boolean extra; the default is false. If true,
4738 * an implementation should only allow the user to select data that is
4739 * already on the device, not requiring it be downloaded from a remote
4740 * service when opened.
4741 *
4742 * @see #ACTION_GET_CONTENT
4743 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004744 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004745 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004746 */
4747 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004748 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004749
Amith Yamasani13593602012-03-22 16:16:17 -07004750 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004751 * Extra used to indicate that an intent can allow the user to select and
4752 * return multiple items. This is a boolean extra; the default is false. If
4753 * true, an implementation is allowed to present the user with a UI where
4754 * they can pick multiple items that are all returned to the caller. When
4755 * this happens, they should be returned as the {@link #getClipData()} part
4756 * of the result Intent.
4757 *
4758 * @see #ACTION_GET_CONTENT
4759 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004760 */
4761 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004762 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004763
4764 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004765 * The integer userHandle carried with broadcast intents related to addition, removal and
4766 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4767 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4768 *
Amith Yamasani13593602012-03-22 16:16:17 -07004769 * @hide
4770 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004771 public static final String EXTRA_USER_HANDLE =
4772 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004773
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004774 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004775 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4776 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4777 */
4778 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004779 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004780
4781 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004782 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004783 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4784 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004785 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004786 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4787
4788 /**
4789 * Extra sent in the intent to the BroadcastReceiver that handles
4790 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4791 * the restrictions as key/value pairs.
4792 */
4793 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4794 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004795
Amith Yamasani86118ba2013-03-28 14:33:16 -07004796 /**
4797 * Extra used in the response from a BroadcastReceiver that handles
4798 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4799 */
4800 public static final String EXTRA_RESTRICTIONS_INTENT =
4801 "android.intent.extra.restrictions_intent";
4802
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004803 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004804 * Extra used to communicate a set of acceptable MIME types. The type of the
4805 * extra is {@code String[]}. Values may be a combination of concrete MIME
4806 * types (such as "image/png") and/or partial MIME types (such as
4807 * "audio/*").
4808 *
4809 * @see #ACTION_GET_CONTENT
4810 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004811 */
4812 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4813
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004814 /**
4815 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4816 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004817 * When this is true, hardware devices can use this information to determine that
4818 * they shouldn't do a complete shutdown of their device since this is not a
4819 * complete shutdown down to the kernel, but only user space restarting.
4820 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004821 */
4822 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4823 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4824
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004825 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004826 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4827 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4828 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4829 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004830 *
4831 * @hide for internal use only.
4832 */
4833 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4834 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004835 /** @hide */
4836 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4837 /** @hide */
4838 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4839 /** @hide */
4840 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004841
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07004842 /**
4843 * Intent extra: the reason that the operation associated with this intent is being performed.
4844 *
4845 * <p>Type: String
4846 * @hide
4847 */
4848 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004849 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4850
qingxi240c2bb2017-04-12 17:31:18 -07004851 /**
4852 * {@hide}
4853 * This extra will be send together with {@link #ACTION_FACTORY_RESET}
4854 */
Rubin Xue8490f12015-06-25 12:17:48 +01004855 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4856
Santos Cordon15a13782015-03-31 18:32:31 -07004857 /**
qingxi240c2bb2017-04-12 17:31:18 -07004858 * {@hide}
4859 * This extra will be set to true when the user choose to wipe the data on eSIM during factory
4860 * reset for the device with eSIM. This extra will be sent together with
4861 * {@link #ACTION_FACTORY_RESET}
4862 */
4863 public static final String EXTRA_WIPE_ESIMS = "com.android.internal.intent.extra.WIPE_ESIMS";
4864
4865 /**
Santos Cordon15a13782015-03-31 18:32:31 -07004866 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4867 * activation request.
4868 * TODO: Add information about the structure and response data used with the pending intent.
4869 * @hide
4870 */
4871 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4872 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4873
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004874 /**
4875 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004876 *
4877 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07004878 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004879 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004880 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4881
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004882 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004883 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
4884 * such as opening in other apps, sharing, opening, editing, printing, deleting,
4885 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004886 *
4887 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07004888 * @see #ACTION_QUICK_VIEW
4889 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004890 */
Garfield Tance1d0e92017-03-23 10:52:48 -07004891 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004892 public static final String EXTRA_QUICK_VIEW_ADVANCED =
4893 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004894
4895 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07004896 * An optional extra of {@code String[]} indicating which quick view features should be made
4897 * available to the user in the quick view UI while handing a
4898 * {@link Intent#ACTION_QUICK_VIEW} intent.
4899 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
4900 * Quick viewer can implement features not listed below.
4901 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
4902 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DOWNLOAD},
4903 * {@link QuickViewConstants#FEATURE_SEND}, {@link QuickViewConstants#FEATURE_PRINT}.
4904 * <p>
4905 * Requirements:
4906 * <li>Quick viewer shouldn't show a feature if the feature is absent in
4907 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
4908 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
4909 * internal policies.
4910 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
4911 * requirement that the feature be shown. Quick viewer may, according to its own policies,
4912 * disable or hide features.
4913 *
4914 * @see #ACTION_QUICK_VIEW
4915 */
4916 public static final String EXTRA_QUICK_VIEW_FEATURES =
4917 "android.intent.extra.QUICK_VIEW_FEATURES";
4918
4919 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004920 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004921 * When a profile goes into quiet mode, all apps in the profile are killed and the
4922 * profile user is stopped. Widgets originating from the profile are masked, and app
4923 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004924 */
4925 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004926
4927 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004928 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004929 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004930 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4931 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004932 *
4933 * @hide
4934 */
4935 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4936 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4937
4938 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004939 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4940 * whether to show the chooser or not when there is only one application available
4941 * to choose from.
4942 *
4943 * @hide
4944 */
4945 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4946 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4947
4948 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004949 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004950 * to represent that a video codec is allowed to use.
4951 *
4952 * @hide
4953 */
4954 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4955
4956 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004957 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004958 * to represent that a audio codec is allowed to use.
4959 *
4960 * @hide
4961 */
4962 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4963
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004964 // ---------------------------------------------------------------------
4965 // ---------------------------------------------------------------------
4966 // Intent flags (see mFlags variable).
4967
Tor Norbyed9273d62013-05-30 15:59:53 -07004968 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06004969 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07004970 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4971 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004972 @Retention(RetentionPolicy.SOURCE)
4973 public @interface GrantUriMode {}
4974
Jeff Sharkey846318a2014-04-04 12:12:41 -07004975 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06004976 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07004977 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4978 @Retention(RetentionPolicy.SOURCE)
4979 public @interface AccessUriMode {}
4980
4981 /**
4982 * Test if given mode flags specify an access mode, which must be at least
4983 * read and/or write.
4984 *
4985 * @hide
4986 */
4987 public static boolean isAccessUriMode(int modeFlags) {
4988 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4989 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4990 }
4991
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06004992 /** @hide */
4993 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
4994 FLAG_GRANT_READ_URI_PERMISSION,
4995 FLAG_GRANT_WRITE_URI_PERMISSION,
4996 FLAG_FROM_BACKGROUND,
4997 FLAG_DEBUG_LOG_RESOLUTION,
4998 FLAG_EXCLUDE_STOPPED_PACKAGES,
4999 FLAG_INCLUDE_STOPPED_PACKAGES,
5000 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
5001 FLAG_GRANT_PREFIX_URI_PERMISSION,
5002 FLAG_DEBUG_TRIAGED_MISSING,
5003 FLAG_IGNORE_EPHEMERAL,
5004 FLAG_ACTIVITY_NO_HISTORY,
5005 FLAG_ACTIVITY_SINGLE_TOP,
5006 FLAG_ACTIVITY_NEW_TASK,
5007 FLAG_ACTIVITY_MULTIPLE_TASK,
5008 FLAG_ACTIVITY_CLEAR_TOP,
5009 FLAG_ACTIVITY_FORWARD_RESULT,
5010 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5011 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5012 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5013 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5014 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5015 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5016 FLAG_ACTIVITY_NEW_DOCUMENT,
5017 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5018 FLAG_ACTIVITY_NO_USER_ACTION,
5019 FLAG_ACTIVITY_REORDER_TO_FRONT,
5020 FLAG_ACTIVITY_NO_ANIMATION,
5021 FLAG_ACTIVITY_CLEAR_TASK,
5022 FLAG_ACTIVITY_TASK_ON_HOME,
5023 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5024 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5025 FLAG_RECEIVER_REGISTERED_ONLY,
5026 FLAG_RECEIVER_REPLACE_PENDING,
5027 FLAG_RECEIVER_FOREGROUND,
5028 FLAG_RECEIVER_NO_ABORT,
5029 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5030 FLAG_RECEIVER_BOOT_UPGRADE,
5031 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5032 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5033 FLAG_RECEIVER_FROM_SHELL,
5034 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5035 })
5036 @Retention(RetentionPolicy.SOURCE)
5037 public @interface Flags {}
5038
5039 /** @hide */
5040 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5041 FLAG_FROM_BACKGROUND,
5042 FLAG_DEBUG_LOG_RESOLUTION,
5043 FLAG_EXCLUDE_STOPPED_PACKAGES,
5044 FLAG_INCLUDE_STOPPED_PACKAGES,
5045 FLAG_DEBUG_TRIAGED_MISSING,
5046 FLAG_IGNORE_EPHEMERAL,
5047 FLAG_ACTIVITY_NO_HISTORY,
5048 FLAG_ACTIVITY_SINGLE_TOP,
5049 FLAG_ACTIVITY_NEW_TASK,
5050 FLAG_ACTIVITY_MULTIPLE_TASK,
5051 FLAG_ACTIVITY_CLEAR_TOP,
5052 FLAG_ACTIVITY_FORWARD_RESULT,
5053 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5054 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5055 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5056 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5057 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5058 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5059 FLAG_ACTIVITY_NEW_DOCUMENT,
5060 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5061 FLAG_ACTIVITY_NO_USER_ACTION,
5062 FLAG_ACTIVITY_REORDER_TO_FRONT,
5063 FLAG_ACTIVITY_NO_ANIMATION,
5064 FLAG_ACTIVITY_CLEAR_TASK,
5065 FLAG_ACTIVITY_TASK_ON_HOME,
5066 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5067 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5068 FLAG_RECEIVER_REGISTERED_ONLY,
5069 FLAG_RECEIVER_REPLACE_PENDING,
5070 FLAG_RECEIVER_FOREGROUND,
5071 FLAG_RECEIVER_NO_ABORT,
5072 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5073 FLAG_RECEIVER_BOOT_UPGRADE,
5074 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5075 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5076 FLAG_RECEIVER_FROM_SHELL,
5077 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5078 })
5079 @Retention(RetentionPolicy.SOURCE)
5080 public @interface MutableFlags {}
5081
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005082 /**
5083 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005084 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005085 * specified in its ClipData. When applying to an Intent's ClipData,
5086 * all URIs as well as recursive traversals through data or other ClipData
5087 * in Intent items will be granted; only the grant flags of the top-level
5088 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005089 */
5090 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5091 /**
5092 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005093 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005094 * specified in its ClipData. When applying to an Intent's ClipData,
5095 * all URIs as well as recursive traversals through data or other ClipData
5096 * in Intent items will be granted; only the grant flags of the top-level
5097 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005098 */
5099 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5100 /**
5101 * Can be set by the caller to indicate that this Intent is coming from
5102 * a background operation, not from direct user interaction.
5103 */
5104 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5105 /**
5106 * A flag you can enable for debugging: when set, log messages will be
5107 * printed during the resolution of this intent to show you what has
5108 * been found to create the final resolved list.
5109 */
5110 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005111 /**
5112 * If set, this intent will not match any components in packages that
5113 * are currently stopped. If this is not set, then the default behavior
5114 * is to include such applications in the result.
5115 */
5116 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5117 /**
5118 * If set, this intent will always match any components in packages that
5119 * are currently stopped. This is the default behavior when
5120 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5121 * flags are set, this one wins (it allows overriding of exclude for
5122 * places where the framework may automatically set the exclude flag).
5123 */
5124 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005125
5126 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005127 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005128 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005129 * persisted across device reboots until explicitly revoked with
5130 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5131 * grant for possible persisting; the receiving application must call
5132 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5133 * actually persist.
5134 *
5135 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5136 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5137 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005138 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005139 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005140 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005141
5142 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005143 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5144 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5145 * applies to any URI that is a prefix match against the original granted
5146 * URI. (Without this flag, the URI must match exactly for access to be
5147 * granted.) Another URI is considered a prefix match only when scheme,
5148 * authority, and all path segments defined by the prefix are an exact
5149 * match.
5150 */
5151 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5152
5153 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005154 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005155 * homework and verified that they correctly handle packages and components
5156 * that come and go over time. In particular:
5157 * <ul>
5158 * <li>Apps installed on external storage, which will appear to be
5159 * uninstalled while the the device is ejected.
5160 * <li>Apps with encryption unaware components, which will appear to not
5161 * exist while the device is locked.
5162 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005163 *
5164 * @hide
5165 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005166 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005167
5168 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005169 * Internal flag used to indicate ephemeral applications should not be
5170 * considered when resolving the intent.
5171 *
5172 * @hide
5173 */
5174 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5175
5176 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005177 * If set, the new activity is not kept in the history stack. As soon as
5178 * the user navigates away from it, the activity is finished. This may also
5179 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5180 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005181 *
5182 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5183 * is never invoked when the current activity starts a new activity which
5184 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005185 */
5186 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5187 /**
5188 * If set, the activity will not be launched if it is already running
5189 * at the top of the history stack.
5190 */
5191 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5192 /**
5193 * If set, this activity will become the start of a new task on this
5194 * history stack. A task (from the activity that started it to the
5195 * next task activity) defines an atomic group of activities that the
5196 * user can move to. Tasks can be moved to the foreground and background;
5197 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005198 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005199 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5200 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005201 *
5202 * <p>This flag is generally used by activities that want
5203 * to present a "launcher" style behavior: they give the user a list of
5204 * separate things that can be done, which otherwise run completely
5205 * independently of the activity launching them.
5206 *
5207 * <p>When using this flag, if a task is already running for the activity
5208 * you are now starting, then a new activity will not be started; instead,
5209 * the current task will simply be brought to the front of the screen with
5210 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5211 * to disable this behavior.
5212 *
5213 * <p>This flag can not be used when the caller is requesting a result from
5214 * the activity being launched.
5215 */
5216 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5217 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005218 * This flag is used to create a new task and launch an activity into it.
5219 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5220 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5221 * search through existing tasks for ones matching this Intent. Only if no such
5222 * task is found would a new task be created. When paired with
5223 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5224 * the search for a matching task and unconditionally start a new task.
5225 *
5226 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5227 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005228 * top-level application launcher.</strong> Used in conjunction with
5229 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5230 * behavior of bringing an existing task to the foreground. When set,
5231 * a new task is <em>always</em> started to host the Activity for the
5232 * Intent, regardless of whether there is already an existing task running
5233 * the same thing.
5234 *
5235 * <p><strong>Because the default system does not include graphical task management,
5236 * you should not use this flag unless you provide some way for a user to
5237 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005238 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005239 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5240 * creating new document tasks.
5241 *
5242 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005243 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005244 *
Scott Main7aee61f2011-02-08 11:25:01 -08005245 * <p>See
5246 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5247 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005248 *
5249 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5250 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005251 */
5252 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5253 /**
5254 * If set, and the activity being launched is already running in the
5255 * current task, then instead of launching a new instance of that activity,
5256 * all of the other activities on top of it will be closed and this Intent
5257 * will be delivered to the (now on top) old activity as a new Intent.
5258 *
5259 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5260 * If D calls startActivity() with an Intent that resolves to the component
5261 * of activity B, then C and D will be finished and B receive the given
5262 * Intent, resulting in the stack now being: A, B.
5263 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005264 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005265 * either receive the new intent you are starting here in its
5266 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005267 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005268 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5269 * the same intent, then it will be finished and re-created; for all other
5270 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5271 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005272 *
5273 * <p>This launch mode can also be used to good effect in conjunction with
5274 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5275 * of a task, it will bring any currently running instance of that task
5276 * to the foreground, and then clear it to its root state. This is
5277 * especially useful, for example, when launching an activity from the
5278 * notification manager.
5279 *
Scott Main7aee61f2011-02-08 11:25:01 -08005280 * <p>See
5281 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5282 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005283 */
5284 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5285 /**
5286 * If set and this intent is being used to launch a new activity from an
5287 * existing one, then the reply target of the existing activity will be
5288 * transfered to the new activity. This way the new activity can call
5289 * {@link android.app.Activity#setResult} and have that result sent back to
5290 * the reply target of the original activity.
5291 */
5292 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5293 /**
5294 * If set and this intent is being used to launch a new activity from an
5295 * existing one, the current activity will not be counted as the top
5296 * activity for deciding whether the new intent should be delivered to
5297 * the top instead of starting a new one. The previous activity will
5298 * be used as the top, with the assumption being that the current activity
5299 * will finish itself immediately.
5300 */
5301 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5302 /**
5303 * If set, the new activity is not kept in the list of recently launched
5304 * activities.
5305 */
5306 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5307 /**
5308 * This flag is not normally set by application code, but set for you by
5309 * the system as described in the
5310 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5311 * launchMode} documentation for the singleTask mode.
5312 */
5313 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5314 /**
5315 * If set, and this activity is either being started in a new task or
5316 * bringing to the top an existing task, then it will be launched as
5317 * the front door of the task. This will result in the application of
5318 * any affinities needed to have that task in the proper state (either
5319 * moving activities to or from it), or simply resetting that task to
5320 * its initial state if needed.
5321 */
5322 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5323 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005324 * This flag is not normally set by application code, but set for you by
5325 * the system if this activity is being launched from history
5326 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005327 */
5328 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005329 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005330 * @deprecated As of API 21 this performs identically to
5331 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005332 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005333 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005334 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005335 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005336 * This flag is used to open a document into a new task rooted at the activity launched
5337 * by this Intent. Through the use of this flag, or its equivalent attribute,
5338 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005339 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005340 *
Craig Mautner026596b2014-05-21 15:35:44 -07005341 * <p>The use of the activity attribute form of this,
5342 * {@link android.R.attr#documentLaunchMode}, is
5343 * preferred over the Intent flag described here. The attribute form allows the
5344 * Activity to specify multiple document behavior for all launchers of the Activity
5345 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005346 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005347 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5348 * it is kept after the activity is finished is different than the use of
5349 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5350 * this flag is being used to create a new recents entry, then by default that entry
5351 * will be removed once the activity is finished. You can modify this behavior with
5352 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5353 *
Craig Mautner026596b2014-05-21 15:35:44 -07005354 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5355 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5356 * equivalent of the Activity manifest specifying {@link
5357 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5358 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5359 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005360 *
Craig Mautner026596b2014-05-21 15:35:44 -07005361 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005362 *
Craig Mautner026596b2014-05-21 15:35:44 -07005363 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005364 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5365 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005366 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005367 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005368 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005369 * callback from occurring on the current frontmost activity before it is
5370 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005371 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005372 * <p>Typically, an activity can rely on that callback to indicate that an
5373 * explicit user action has caused their activity to be moved out of the
5374 * foreground. The callback marks an appropriate point in the activity's
5375 * lifecycle for it to dismiss any notifications that it intends to display
5376 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005377 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005378 * <p>If an activity is ever started via any non-user-driven events such as
5379 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5380 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005381 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005382 */
5383 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005384 /**
5385 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5386 * this flag will cause the launched activity to be brought to the front of its
5387 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005388 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005389 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5390 * If D calls startActivity() with an Intent that resolves to the component
5391 * of activity B, then B will be brought to the front of the history stack,
5392 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005393 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005394 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005395 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005396 */
5397 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005398 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005399 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5400 * this flag will prevent the system from applying an activity transition
5401 * animation to go to the next activity state. This doesn't mean an
5402 * animation will never run -- if another activity change happens that doesn't
5403 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005404 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005405 * when you are going to do a series of activity operations but the
5406 * animation seen by the user shouldn't be driven by the first activity
5407 * change but rather a later one.
5408 */
5409 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5410 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005411 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5412 * this flag will cause any existing task that would be associated with the
5413 * activity to be cleared before the activity is started. That is, the activity
5414 * becomes the new root of an otherwise empty task, and any old activities
5415 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5416 */
5417 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5418 /**
5419 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5420 * this flag will cause a newly launching task to be placed on top of the current
5421 * home activity task (if there is one). That is, pressing back from the task
5422 * will always return the user to home even if that was not the last activity they
5423 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5424 */
5425 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5426 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005427 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5428 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005429 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005430 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005431 * this flag. When set and the task's activity is finished, the recents
5432 * entry will remain in the interface for the user to re-launch it, like a
5433 * recents entry for a top-level application.
5434 * <p>
5435 * The receiving activity can override this request with
5436 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5437 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005438 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005439 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005440 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005441
5442 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005443 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5444 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005445 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5446 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005447 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005448 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005449
5450 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005451 * If set, when sending a broadcast only registered receivers will be
5452 * called -- no BroadcastReceiver components will be launched.
5453 */
5454 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005455 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005456 * If set, when sending a broadcast the new broadcast will replace
5457 * any existing pending broadcast that matches it. Matching is defined
5458 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5459 * true for the intents of the two broadcasts. When a match is found,
5460 * the new broadcast (and receivers associated with it) will replace the
5461 * existing one in the pending broadcast list, remaining at the same
5462 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005463 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005464 * <p>This flag is most typically used with sticky broadcasts, which
5465 * only care about delivering the most recent values of the broadcast
5466 * to their receivers.
5467 */
5468 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5469 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005470 * If set, when sending a broadcast the recipient is allowed to run at
5471 * foreground priority, with a shorter timeout interval. During normal
5472 * broadcasts the receivers are not automatically hoisted out of the
5473 * background priority class.
5474 */
5475 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5476 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005477 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5478 * They can still propagate results through to later receivers, but they can not prevent
5479 * later receivers from seeing the broadcast.
5480 */
5481 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5482 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005483 * If set, when sending a broadcast <i>before boot has completed</i> only
5484 * registered receivers will be called -- no BroadcastReceiver components
5485 * will be launched. Sticky intent state will be recorded properly even
5486 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5487 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005488 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005489 * <p>This flag is only for use by system sevices as a convenience to
5490 * avoid having to implement a more complex mechanism around detection
5491 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005492 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005493 * @hide
5494 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005495 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005496 /**
5497 * Set when this broadcast is for a boot upgrade, a special mode that
5498 * allows the broadcast to be sent before the system is ready and launches
5499 * the app process with no providers running in it.
5500 * @hide
5501 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005502 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005503 /**
5504 * If set, the broadcast will always go to manifest receivers in background (cached
5505 * or not running) apps, regardless of whether that would be done by default. By
5506 * default they will only receive broadcasts if the broadcast has specified an
5507 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005508 *
5509 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5510 * the broadcast code there must also be changed to match.
5511 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005512 * @hide
5513 */
5514 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5515 /**
5516 * If set, the broadcast will never go to manifest receivers in background (cached
5517 * or not running) apps, regardless of whether that would be done by default. By
5518 * default they will receive broadcasts if the broadcast has specified an
5519 * explicit component or package name.
5520 * @hide
5521 */
5522 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005523 /**
5524 * If set, this broadcast is being sent from the shell.
5525 * @hide
5526 */
5527 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005528
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005529 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005530 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5531 * will not receive broadcasts.
5532 *
5533 * <em>This flag has no effect when used by an Instant App.</em>
5534 */
5535 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5536
5537 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005538 * @hide Flags that can't be changed with PendingIntent.
5539 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005540 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5541 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5542 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005543
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005544 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005545 // ---------------------------------------------------------------------
5546 // toUri() and parseUri() options.
5547
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005548 /** @hide */
5549 @IntDef(flag = true, prefix = { "URI_" }, value = {
5550 URI_ALLOW_UNSAFE,
5551 URI_ANDROID_APP_SCHEME,
5552 URI_INTENT_SCHEME,
5553 })
5554 @Retention(RetentionPolicy.SOURCE)
5555 public @interface UriFlags {}
5556
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005557 /**
5558 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5559 * always has the "intent:" scheme. This syntax can be used when you want
5560 * to later disambiguate between URIs that are intended to describe an
5561 * Intent vs. all others that should be treated as raw URIs. When used
5562 * with {@link #parseUri}, any other scheme will result in a generic
5563 * VIEW action for that raw URI.
5564 */
5565 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005566
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005567 /**
5568 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5569 * always has the "android-app:" scheme. This is a variation of
5570 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5571 * http/https URI being delivered to a specific package name. The format
5572 * is:
5573 *
5574 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005575 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005576 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005577 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5578 * you must also include a scheme; including a path also requires both a host and a scheme.
5579 * The final #Intent; fragment can be used without a scheme, host, or path.
5580 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005581 * used with intents that have a {@link #setSelector}, since the base intent
5582 * will always have an explicit package name.</p>
5583 *
5584 * <p>Some examples of how this scheme maps to Intent objects:</p>
5585 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5586 * <colgroup align="left" />
5587 * <colgroup align="left" />
5588 * <thead>
5589 * <tr><th>URI</th> <th>Intent</th></tr>
5590 * </thead>
5591 *
5592 * <tbody>
5593 * <tr><td><code>android-app://com.example.app</code></td>
5594 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5595 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5596 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5597 * </table></td>
5598 * </tr>
5599 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5600 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5601 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5602 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5603 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5604 * </table></td>
5605 * </tr>
5606 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5607 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5608 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5609 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5610 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5611 * </table></td>
5612 * </tr>
5613 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5614 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5615 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5616 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5617 * </table></td>
5618 * </tr>
5619 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5620 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5621 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5622 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5623 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5624 * </table></td>
5625 * </tr>
5626 * <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>
5627 * <td><table border="" style="margin:0" >
5628 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5629 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5630 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5631 * </table></td>
5632 * </tr>
5633 * </tbody>
5634 * </table>
5635 */
5636 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5637
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005638 /**
5639 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5640 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5641 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5642 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5643 * generated Intent can not cause unexpected data access to happen.
5644 *
5645 * <p>If you do not trust the source of the URI being parsed, you should still do further
5646 * processing to protect yourself from it. In particular, when using it to start an
5647 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5648 * that can handle it.</p>
5649 */
5650 public static final int URI_ALLOW_UNSAFE = 1<<2;
5651
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005652 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005653
5654 private String mAction;
5655 private Uri mData;
5656 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005657 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005658 private ComponentName mComponent;
5659 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005660 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005661 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005662 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005663 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005664 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005665 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005666 /** Token to track instant app launches. Local only; do not copy cross-process. */
5667 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005668
5669 // ---------------------------------------------------------------------
5670
Makoto Onuki97f82f22017-05-31 16:20:21 -07005671 private static final int COPY_MODE_ALL = 0;
5672 private static final int COPY_MODE_FILTER = 1;
5673 private static final int COPY_MODE_HISTORY = 2;
5674
5675 /** @hide */
5676 @IntDef(value = {COPY_MODE_ALL, COPY_MODE_FILTER, COPY_MODE_HISTORY})
5677 @Retention(RetentionPolicy.SOURCE)
5678 public @interface CopyMode {}
5679
5680
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005681 /**
5682 * Create an empty intent.
5683 */
5684 public Intent() {
5685 }
5686
5687 /**
5688 * Copy constructor.
5689 */
5690 public Intent(Intent o) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005691 this(o, COPY_MODE_ALL);
5692 }
5693
5694 private Intent(Intent o, @CopyMode int copyMode) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005695 this.mAction = o.mAction;
5696 this.mData = o.mData;
5697 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005698 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005699 this.mComponent = o.mComponent;
Makoto Onuki97f82f22017-05-31 16:20:21 -07005700
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005701 if (o.mCategories != null) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005702 this.mCategories = new ArraySet<>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005703 }
Makoto Onuki97f82f22017-05-31 16:20:21 -07005704
5705 if (copyMode != COPY_MODE_FILTER) {
5706 this.mFlags = o.mFlags;
5707 this.mContentUserHint = o.mContentUserHint;
5708 this.mLaunchToken = o.mLaunchToken;
5709 if (o.mSourceBounds != null) {
5710 this.mSourceBounds = new Rect(o.mSourceBounds);
5711 }
5712 if (o.mSelector != null) {
5713 this.mSelector = new Intent(o.mSelector);
5714 }
5715
5716 if (copyMode != COPY_MODE_HISTORY) {
5717 if (o.mExtras != null) {
5718 this.mExtras = new Bundle(o.mExtras);
5719 }
5720 if (o.mClipData != null) {
5721 this.mClipData = new ClipData(o.mClipData);
5722 }
5723 } else {
5724 if (o.mExtras != null && !o.mExtras.maybeIsEmpty()) {
5725 this.mExtras = Bundle.STRIPPED;
5726 }
5727
5728 // Also set "stripped" clip data when we ever log mClipData in the (broadcast)
5729 // history.
5730 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005731 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005732 }
5733
5734 @Override
5735 public Object clone() {
5736 return new Intent(this);
5737 }
5738
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005739 /**
5740 * Make a clone of only the parts of the Intent that are relevant for
5741 * filter matching: the action, data, type, component, and categories.
5742 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005743 public @NonNull Intent cloneFilter() {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005744 return new Intent(this, COPY_MODE_FILTER);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005745 }
5746
5747 /**
5748 * Create an intent with a given action. All other fields (data, type,
5749 * class) are null. Note that the action <em>must</em> be in a
5750 * namespace because Intents are used globally in the system -- for
5751 * example the system VIEW action is android.intent.action.VIEW; an
5752 * application's custom action would be something like
5753 * com.google.app.myapp.CUSTOM_ACTION.
5754 *
5755 * @param action The Intent action, such as ACTION_VIEW.
5756 */
5757 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005758 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005759 }
5760
5761 /**
5762 * Create an intent with a given action and for a given data url. Note
5763 * that the action <em>must</em> be in a namespace because Intents are
5764 * used globally in the system -- for example the system VIEW action is
5765 * android.intent.action.VIEW; an application's custom action would be
5766 * something like com.google.app.myapp.CUSTOM_ACTION.
5767 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005768 * <p><em>Note: scheme and host name matching in the Android framework is
5769 * case-sensitive, unlike the formal RFC. As a result,
5770 * you should always ensure that you write your Uri with these elements
5771 * using lower case letters, and normalize any Uris you receive from
5772 * outside of Android to ensure the scheme and host is lower case.</em></p>
5773 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005774 * @param action The Intent action, such as ACTION_VIEW.
5775 * @param uri The Intent data URI.
5776 */
5777 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005778 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005779 mData = uri;
5780 }
5781
5782 /**
5783 * Create an intent for a specific component. All other fields (action, data,
5784 * type, class) are null, though they can be modified later with explicit
5785 * calls. This provides a convenient way to create an intent that is
5786 * intended to execute a hard-coded class name, rather than relying on the
5787 * system to find an appropriate class for you; see {@link #setComponent}
5788 * for more information on the repercussions of this.
5789 *
5790 * @param packageContext A Context of the application package implementing
5791 * this class.
5792 * @param cls The component class that is to be used for the intent.
5793 *
5794 * @see #setClass
5795 * @see #setComponent
5796 * @see #Intent(String, android.net.Uri , Context, Class)
5797 */
5798 public Intent(Context packageContext, Class<?> cls) {
5799 mComponent = new ComponentName(packageContext, cls);
5800 }
5801
5802 /**
5803 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005804 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005805 * construct the Intent and then calling {@link #setClass} to set its
5806 * class.
5807 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005808 * <p><em>Note: scheme and host name matching in the Android framework is
5809 * case-sensitive, unlike the formal RFC. As a result,
5810 * you should always ensure that you write your Uri with these elements
5811 * using lower case letters, and normalize any Uris you receive from
5812 * outside of Android to ensure the scheme and host is lower case.</em></p>
5813 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005814 * @param action The Intent action, such as ACTION_VIEW.
5815 * @param uri The Intent data URI.
5816 * @param packageContext A Context of the application package implementing
5817 * this class.
5818 * @param cls The component class that is to be used for the intent.
5819 *
5820 * @see #Intent(String, android.net.Uri)
5821 * @see #Intent(Context, Class)
5822 * @see #setClass
5823 * @see #setComponent
5824 */
5825 public Intent(String action, Uri uri,
5826 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005827 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005828 mData = uri;
5829 mComponent = new ComponentName(packageContext, cls);
5830 }
5831
5832 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005833 * Create an intent to launch the main (root) activity of a task. This
5834 * is the Intent that is started when the application's is launched from
5835 * Home. For anything else that wants to launch an application in the
5836 * same way, it is important that they use an Intent structured the same
5837 * way, and can use this function to ensure this is the case.
5838 *
5839 * <p>The returned Intent has the given Activity component as its explicit
5840 * component, {@link #ACTION_MAIN} as its action, and includes the
5841 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5842 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5843 * to do that through {@link #addFlags(int)} on the returned Intent.
5844 *
5845 * @param mainActivity The main activity component that this Intent will
5846 * launch.
5847 * @return Returns a newly created Intent that can be used to launch the
5848 * activity as a main application entry.
5849 *
5850 * @see #setClass
5851 * @see #setComponent
5852 */
5853 public static Intent makeMainActivity(ComponentName mainActivity) {
5854 Intent intent = new Intent(ACTION_MAIN);
5855 intent.setComponent(mainActivity);
5856 intent.addCategory(CATEGORY_LAUNCHER);
5857 return intent;
5858 }
5859
5860 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005861 * Make an Intent for the main activity of an application, without
5862 * specifying a specific activity to run but giving a selector to find
5863 * the activity. This results in a final Intent that is structured
5864 * the same as when the application is launched from
5865 * Home. For anything else that wants to launch an application in the
5866 * same way, it is important that they use an Intent structured the same
5867 * way, and can use this function to ensure this is the case.
5868 *
5869 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5870 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5871 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5872 * to do that through {@link #addFlags(int)} on the returned Intent.
5873 *
5874 * @param selectorAction The action name of the Intent's selector.
5875 * @param selectorCategory The name of a category to add to the Intent's
5876 * selector.
5877 * @return Returns a newly created Intent that can be used to launch the
5878 * activity as a main application entry.
5879 *
5880 * @see #setSelector(Intent)
5881 */
5882 public static Intent makeMainSelectorActivity(String selectorAction,
5883 String selectorCategory) {
5884 Intent intent = new Intent(ACTION_MAIN);
5885 intent.addCategory(CATEGORY_LAUNCHER);
5886 Intent selector = new Intent();
5887 selector.setAction(selectorAction);
5888 selector.addCategory(selectorCategory);
5889 intent.setSelector(selector);
5890 return intent;
5891 }
5892
5893 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005894 * Make an Intent that can be used to re-launch an application's task
5895 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5896 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5897 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5898 *
5899 * @param mainActivity The activity component that is the root of the
5900 * task; this is the activity that has been published in the application's
5901 * manifest as the main launcher icon.
5902 *
5903 * @return Returns a newly created Intent that can be used to relaunch the
5904 * activity's task in its root state.
5905 */
5906 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5907 Intent intent = makeMainActivity(mainActivity);
5908 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5909 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5910 return intent;
5911 }
5912
5913 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005914 * Call {@link #parseUri} with 0 flags.
5915 * @deprecated Use {@link #parseUri} instead.
5916 */
5917 @Deprecated
5918 public static Intent getIntent(String uri) throws URISyntaxException {
5919 return parseUri(uri, 0);
5920 }
Tom Taylord4a47292009-12-21 13:59:18 -08005921
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005922 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005923 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005924 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005925 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005926 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005927 *
5928 * <p>The URI given here must not be relative -- that is, it must include
5929 * the scheme and full path.
5930 *
5931 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005932 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005933 *
5934 * @return Intent The newly created Intent object.
5935 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005936 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5937 * it bad (as parsed by the Uri class) or the Intent data within the
5938 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005939 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005940 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005941 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005942 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005943 int i = 0;
5944 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005945 final boolean androidApp = uri.startsWith("android-app:");
5946
5947 // Validate intent scheme if requested.
5948 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5949 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005950 Intent intent = new Intent(ACTION_VIEW);
5951 try {
5952 intent.setData(Uri.parse(uri));
5953 } catch (IllegalArgumentException e) {
5954 throw new URISyntaxException(uri, e.getMessage());
5955 }
5956 return intent;
5957 }
5958 }
Tom Taylord4a47292009-12-21 13:59:18 -08005959
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005960 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005961 // simple case
5962 if (i == -1) {
5963 if (!androidApp) {
5964 return new Intent(ACTION_VIEW, Uri.parse(uri));
5965 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005966
5967 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005968 } else if (!uri.startsWith("#Intent;", i)) {
5969 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005970 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005971 } else {
5972 i = -1;
5973 }
5974 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005975
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005976 // new format
5977 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005978 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005979 boolean explicitAction = false;
5980 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005981
5982 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005983 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005984 String data;
5985 if (i >= 0) {
5986 data = uri.substring(0, i);
5987 i += 8; // length of "#Intent;"
5988 } else {
5989 data = uri;
5990 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005991
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005992 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005993 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005994 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005995 if (eq < 0) eq = i-1;
5996 int semi = uri.indexOf(';', i);
5997 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005998
5999 // action
6000 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006001 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006002 if (!inSelector) {
6003 explicitAction = true;
6004 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006005 }
6006
6007 // categories
6008 else if (uri.startsWith("category=", i)) {
6009 intent.addCategory(value);
6010 }
6011
6012 // type
6013 else if (uri.startsWith("type=", i)) {
6014 intent.mType = value;
6015 }
6016
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006017 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006018 else if (uri.startsWith("launchFlags=", i)) {
6019 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006020 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6021 intent.mFlags &= ~IMMUTABLE_FLAGS;
6022 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006023 }
6024
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006025 // package
6026 else if (uri.startsWith("package=", i)) {
6027 intent.mPackage = value;
6028 }
6029
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006030 // component
6031 else if (uri.startsWith("component=", i)) {
6032 intent.mComponent = ComponentName.unflattenFromString(value);
6033 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006034
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006035 // scheme
6036 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006037 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006038 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006039 } else {
6040 scheme = value;
6041 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006042 }
6043
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006044 // source bounds
6045 else if (uri.startsWith("sourceBounds=", i)) {
6046 intent.mSourceBounds = Rect.unflattenFromString(value);
6047 }
6048
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006049 // selector
6050 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
6051 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006052 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006053 }
6054
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006055 // extra
6056 else {
6057 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006058 // create Bundle if it doesn't already exist
6059 if (intent.mExtras == null) intent.mExtras = new Bundle();
6060 Bundle b = intent.mExtras;
6061 // add EXTRA
6062 if (uri.startsWith("S.", i)) b.putString(key, value);
6063 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
6064 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
6065 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
6066 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
6067 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
6068 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
6069 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
6070 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
6071 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
6072 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006073
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006074 // move to the next item
6075 i = semi + 1;
6076 }
6077
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006078 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006079 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006080 if (baseIntent.mPackage == null) {
6081 baseIntent.setSelector(intent);
6082 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006083 intent = baseIntent;
6084 }
6085
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006086 if (data != null) {
6087 if (data.startsWith("intent:")) {
6088 data = data.substring(7);
6089 if (scheme != null) {
6090 data = scheme + ':' + data;
6091 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006092 } else if (data.startsWith("android-app:")) {
6093 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
6094 // Correctly formed android-app, first part is package name.
6095 int end = data.indexOf('/', 14);
6096 if (end < 0) {
6097 // All we have is a package name.
6098 intent.mPackage = data.substring(14);
6099 if (!explicitAction) {
6100 intent.setAction(ACTION_MAIN);
6101 }
6102 data = "";
6103 } else {
6104 // Target the Intent at the given package name always.
6105 String authority = null;
6106 intent.mPackage = data.substring(14, end);
6107 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006108 if ((end+1) < data.length()) {
6109 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6110 // Found a scheme, remember it.
6111 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006112 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006113 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6114 // Found a authority, remember it.
6115 authority = data.substring(end+1, newEnd);
6116 end = newEnd;
6117 }
6118 } else {
6119 // All we have is a scheme.
6120 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006121 }
6122 }
6123 if (scheme == null) {
6124 // If there was no scheme, then this just targets the package.
6125 if (!explicitAction) {
6126 intent.setAction(ACTION_MAIN);
6127 }
6128 data = "";
6129 } else if (authority == null) {
6130 data = scheme + ":";
6131 } else {
6132 data = scheme + "://" + authority + data.substring(end);
6133 }
6134 }
6135 } else {
6136 data = "";
6137 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006138 }
Tom Taylord4a47292009-12-21 13:59:18 -08006139
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006140 if (data.length() > 0) {
6141 try {
6142 intent.mData = Uri.parse(data);
6143 } catch (IllegalArgumentException e) {
6144 throw new URISyntaxException(uri, e.getMessage());
6145 }
6146 }
6147 }
Tom Taylord4a47292009-12-21 13:59:18 -08006148
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006149 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006150
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006151 } catch (IndexOutOfBoundsException e) {
6152 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6153 }
6154 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006155
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006156 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006157 return getIntentOld(uri, 0);
6158 }
6159
6160 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006161 Intent intent;
6162
6163 int i = uri.lastIndexOf('#');
6164 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006165 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006166 final int intentFragmentStart = i;
6167 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006168
6169 i++;
6170
6171 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006172 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006173 i += 7;
6174 int j = uri.indexOf(')', i);
6175 action = uri.substring(i, j);
6176 i = j + 1;
6177 }
6178
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006179 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006180
6181 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006182 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006183 i += 11;
6184 int j = uri.indexOf(')', i);
6185 while (i < j) {
6186 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006187 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006188 if (i < sep) {
6189 intent.addCategory(uri.substring(i, sep));
6190 }
6191 i = sep + 1;
6192 }
6193 i = j + 1;
6194 }
6195
6196 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006197 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006198 i += 5;
6199 int j = uri.indexOf(')', i);
6200 intent.mType = uri.substring(i, j);
6201 i = j + 1;
6202 }
6203
6204 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006205 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006206 i += 12;
6207 int j = uri.indexOf(')', i);
6208 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006209 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6210 intent.mFlags &= ~IMMUTABLE_FLAGS;
6211 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006212 i = j + 1;
6213 }
6214
6215 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006216 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006217 i += 10;
6218 int j = uri.indexOf(')', i);
6219 int sep = uri.indexOf('!', i);
6220 if (sep >= 0 && sep < j) {
6221 String pkg = uri.substring(i, sep);
6222 String cls = uri.substring(sep + 1, j);
6223 intent.mComponent = new ComponentName(pkg, cls);
6224 }
6225 i = j + 1;
6226 }
6227
6228 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006229 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006230 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006231
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006232 final int closeParen = uri.indexOf(')', i);
6233 if (closeParen == -1) throw new URISyntaxException(uri,
6234 "EXTRA missing trailing ')'", i);
6235
6236 while (i < closeParen) {
6237 // fetch the key value
6238 int j = uri.indexOf('=', i);
6239 if (j <= i + 1 || i >= closeParen) {
6240 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6241 }
6242 char type = uri.charAt(i);
6243 i++;
6244 String key = uri.substring(i, j);
6245 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006246
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006247 // get type-value
6248 j = uri.indexOf('!', i);
6249 if (j == -1 || j >= closeParen) j = closeParen;
6250 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6251 String value = uri.substring(i, j);
6252 i = j;
6253
6254 // create Bundle if it doesn't already exist
6255 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006256
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006257 // add item to bundle
6258 try {
6259 switch (type) {
6260 case 'S':
6261 intent.mExtras.putString(key, Uri.decode(value));
6262 break;
6263 case 'B':
6264 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6265 break;
6266 case 'b':
6267 intent.mExtras.putByte(key, Byte.parseByte(value));
6268 break;
6269 case 'c':
6270 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6271 break;
6272 case 'd':
6273 intent.mExtras.putDouble(key, Double.parseDouble(value));
6274 break;
6275 case 'f':
6276 intent.mExtras.putFloat(key, Float.parseFloat(value));
6277 break;
6278 case 'i':
6279 intent.mExtras.putInt(key, Integer.parseInt(value));
6280 break;
6281 case 'l':
6282 intent.mExtras.putLong(key, Long.parseLong(value));
6283 break;
6284 case 's':
6285 intent.mExtras.putShort(key, Short.parseShort(value));
6286 break;
6287 default:
6288 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6289 }
6290 } catch (NumberFormatException e) {
6291 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6292 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006293
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006294 char ch = uri.charAt(i);
6295 if (ch == ')') break;
6296 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6297 i++;
6298 }
6299 }
6300
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006301 if (isIntentFragment) {
6302 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6303 } else {
6304 intent.mData = Uri.parse(uri);
6305 }
Tom Taylord4a47292009-12-21 13:59:18 -08006306
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006307 if (intent.mAction == null) {
6308 // By default, if no action is specified, then use VIEW.
6309 intent.mAction = ACTION_VIEW;
6310 }
6311
6312 } else {
6313 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6314 }
6315
6316 return intent;
6317 }
6318
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006319 /** @hide */
6320 public interface CommandOptionHandler {
6321 boolean handleOption(String opt, ShellCommand cmd);
6322 }
6323
6324 /** @hide */
6325 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6326 throws URISyntaxException {
6327 Intent intent = new Intent();
6328 Intent baseIntent = intent;
6329 boolean hasIntentInfo = false;
6330
6331 Uri data = null;
6332 String type = null;
6333
6334 String opt;
6335 while ((opt=cmd.getNextOption()) != null) {
6336 switch (opt) {
6337 case "-a":
6338 intent.setAction(cmd.getNextArgRequired());
6339 if (intent == baseIntent) {
6340 hasIntentInfo = true;
6341 }
6342 break;
6343 case "-d":
6344 data = Uri.parse(cmd.getNextArgRequired());
6345 if (intent == baseIntent) {
6346 hasIntentInfo = true;
6347 }
6348 break;
6349 case "-t":
6350 type = cmd.getNextArgRequired();
6351 if (intent == baseIntent) {
6352 hasIntentInfo = true;
6353 }
6354 break;
6355 case "-c":
6356 intent.addCategory(cmd.getNextArgRequired());
6357 if (intent == baseIntent) {
6358 hasIntentInfo = true;
6359 }
6360 break;
6361 case "-e":
6362 case "--es": {
6363 String key = cmd.getNextArgRequired();
6364 String value = cmd.getNextArgRequired();
6365 intent.putExtra(key, value);
6366 }
6367 break;
6368 case "--esn": {
6369 String key = cmd.getNextArgRequired();
6370 intent.putExtra(key, (String) null);
6371 }
6372 break;
6373 case "--ei": {
6374 String key = cmd.getNextArgRequired();
6375 String value = cmd.getNextArgRequired();
6376 intent.putExtra(key, Integer.decode(value));
6377 }
6378 break;
6379 case "--eu": {
6380 String key = cmd.getNextArgRequired();
6381 String value = cmd.getNextArgRequired();
6382 intent.putExtra(key, Uri.parse(value));
6383 }
6384 break;
6385 case "--ecn": {
6386 String key = cmd.getNextArgRequired();
6387 String value = cmd.getNextArgRequired();
6388 ComponentName cn = ComponentName.unflattenFromString(value);
6389 if (cn == null)
6390 throw new IllegalArgumentException("Bad component name: " + value);
6391 intent.putExtra(key, cn);
6392 }
6393 break;
6394 case "--eia": {
6395 String key = cmd.getNextArgRequired();
6396 String value = cmd.getNextArgRequired();
6397 String[] strings = value.split(",");
6398 int[] list = new int[strings.length];
6399 for (int i = 0; i < strings.length; i++) {
6400 list[i] = Integer.decode(strings[i]);
6401 }
6402 intent.putExtra(key, list);
6403 }
6404 break;
6405 case "--eial": {
6406 String key = cmd.getNextArgRequired();
6407 String value = cmd.getNextArgRequired();
6408 String[] strings = value.split(",");
6409 ArrayList<Integer> list = new ArrayList<>(strings.length);
6410 for (int i = 0; i < strings.length; i++) {
6411 list.add(Integer.decode(strings[i]));
6412 }
6413 intent.putExtra(key, list);
6414 }
6415 break;
6416 case "--el": {
6417 String key = cmd.getNextArgRequired();
6418 String value = cmd.getNextArgRequired();
6419 intent.putExtra(key, Long.valueOf(value));
6420 }
6421 break;
6422 case "--ela": {
6423 String key = cmd.getNextArgRequired();
6424 String value = cmd.getNextArgRequired();
6425 String[] strings = value.split(",");
6426 long[] list = new long[strings.length];
6427 for (int i = 0; i < strings.length; i++) {
6428 list[i] = Long.valueOf(strings[i]);
6429 }
6430 intent.putExtra(key, list);
6431 hasIntentInfo = true;
6432 }
6433 break;
6434 case "--elal": {
6435 String key = cmd.getNextArgRequired();
6436 String value = cmd.getNextArgRequired();
6437 String[] strings = value.split(",");
6438 ArrayList<Long> list = new ArrayList<>(strings.length);
6439 for (int i = 0; i < strings.length; i++) {
6440 list.add(Long.valueOf(strings[i]));
6441 }
6442 intent.putExtra(key, list);
6443 hasIntentInfo = true;
6444 }
6445 break;
6446 case "--ef": {
6447 String key = cmd.getNextArgRequired();
6448 String value = cmd.getNextArgRequired();
6449 intent.putExtra(key, Float.valueOf(value));
6450 hasIntentInfo = true;
6451 }
6452 break;
6453 case "--efa": {
6454 String key = cmd.getNextArgRequired();
6455 String value = cmd.getNextArgRequired();
6456 String[] strings = value.split(",");
6457 float[] list = new float[strings.length];
6458 for (int i = 0; i < strings.length; i++) {
6459 list[i] = Float.valueOf(strings[i]);
6460 }
6461 intent.putExtra(key, list);
6462 hasIntentInfo = true;
6463 }
6464 break;
6465 case "--efal": {
6466 String key = cmd.getNextArgRequired();
6467 String value = cmd.getNextArgRequired();
6468 String[] strings = value.split(",");
6469 ArrayList<Float> list = new ArrayList<>(strings.length);
6470 for (int i = 0; i < strings.length; i++) {
6471 list.add(Float.valueOf(strings[i]));
6472 }
6473 intent.putExtra(key, list);
6474 hasIntentInfo = true;
6475 }
6476 break;
6477 case "--esa": {
6478 String key = cmd.getNextArgRequired();
6479 String value = cmd.getNextArgRequired();
6480 // Split on commas unless they are preceeded by an escape.
6481 // The escape character must be escaped for the string and
6482 // again for the regex, thus four escape characters become one.
6483 String[] strings = value.split("(?<!\\\\),");
6484 intent.putExtra(key, strings);
6485 hasIntentInfo = true;
6486 }
6487 break;
6488 case "--esal": {
6489 String key = cmd.getNextArgRequired();
6490 String value = cmd.getNextArgRequired();
6491 // Split on commas unless they are preceeded by an escape.
6492 // The escape character must be escaped for the string and
6493 // again for the regex, thus four escape characters become one.
6494 String[] strings = value.split("(?<!\\\\),");
6495 ArrayList<String> list = new ArrayList<>(strings.length);
6496 for (int i = 0; i < strings.length; i++) {
6497 list.add(strings[i]);
6498 }
6499 intent.putExtra(key, list);
6500 hasIntentInfo = true;
6501 }
6502 break;
6503 case "--ez": {
6504 String key = cmd.getNextArgRequired();
6505 String value = cmd.getNextArgRequired().toLowerCase();
6506 // Boolean.valueOf() results in false for anything that is not "true", which is
6507 // error-prone in shell commands
6508 boolean arg;
6509 if ("true".equals(value) || "t".equals(value)) {
6510 arg = true;
6511 } else if ("false".equals(value) || "f".equals(value)) {
6512 arg = false;
6513 } else {
6514 try {
6515 arg = Integer.decode(value) != 0;
6516 } catch (NumberFormatException ex) {
6517 throw new IllegalArgumentException("Invalid boolean value: " + value);
6518 }
6519 }
6520
6521 intent.putExtra(key, arg);
6522 }
6523 break;
6524 case "-n": {
6525 String str = cmd.getNextArgRequired();
6526 ComponentName cn = ComponentName.unflattenFromString(str);
6527 if (cn == null)
6528 throw new IllegalArgumentException("Bad component name: " + str);
6529 intent.setComponent(cn);
6530 if (intent == baseIntent) {
6531 hasIntentInfo = true;
6532 }
6533 }
6534 break;
6535 case "-p": {
6536 String str = cmd.getNextArgRequired();
6537 intent.setPackage(str);
6538 if (intent == baseIntent) {
6539 hasIntentInfo = true;
6540 }
6541 }
6542 break;
6543 case "-f":
6544 String str = cmd.getNextArgRequired();
6545 intent.setFlags(Integer.decode(str).intValue());
6546 break;
6547 case "--grant-read-uri-permission":
6548 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6549 break;
6550 case "--grant-write-uri-permission":
6551 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6552 break;
6553 case "--grant-persistable-uri-permission":
6554 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6555 break;
6556 case "--grant-prefix-uri-permission":
6557 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6558 break;
6559 case "--exclude-stopped-packages":
6560 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6561 break;
6562 case "--include-stopped-packages":
6563 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6564 break;
6565 case "--debug-log-resolution":
6566 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6567 break;
6568 case "--activity-brought-to-front":
6569 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6570 break;
6571 case "--activity-clear-top":
6572 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6573 break;
6574 case "--activity-clear-when-task-reset":
6575 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6576 break;
6577 case "--activity-exclude-from-recents":
6578 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6579 break;
6580 case "--activity-launched-from-history":
6581 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6582 break;
6583 case "--activity-multiple-task":
6584 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6585 break;
6586 case "--activity-no-animation":
6587 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6588 break;
6589 case "--activity-no-history":
6590 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6591 break;
6592 case "--activity-no-user-action":
6593 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6594 break;
6595 case "--activity-previous-is-top":
6596 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6597 break;
6598 case "--activity-reorder-to-front":
6599 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6600 break;
6601 case "--activity-reset-task-if-needed":
6602 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6603 break;
6604 case "--activity-single-top":
6605 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6606 break;
6607 case "--activity-clear-task":
6608 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6609 break;
6610 case "--activity-task-on-home":
6611 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6612 break;
6613 case "--receiver-registered-only":
6614 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6615 break;
6616 case "--receiver-replace-pending":
6617 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6618 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006619 case "--receiver-foreground":
6620 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6621 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006622 case "--receiver-no-abort":
6623 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6624 break;
6625 case "--receiver-include-background":
6626 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6627 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006628 case "--selector":
6629 intent.setDataAndType(data, type);
6630 intent = new Intent();
6631 break;
6632 default:
6633 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6634 // Okay, caller handled this option.
6635 } else {
6636 throw new IllegalArgumentException("Unknown option: " + opt);
6637 }
6638 break;
6639 }
6640 }
6641 intent.setDataAndType(data, type);
6642
6643 final boolean hasSelector = intent != baseIntent;
6644 if (hasSelector) {
6645 // A selector was specified; fix up.
6646 baseIntent.setSelector(intent);
6647 intent = baseIntent;
6648 }
6649
6650 String arg = cmd.getNextArg();
6651 baseIntent = null;
6652 if (arg == null) {
6653 if (hasSelector) {
6654 // If a selector has been specified, and no arguments
6655 // have been supplied for the main Intent, then we can
6656 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6657 // need to have a component name specified yet, the
6658 // selector will take care of that.
6659 baseIntent = new Intent(Intent.ACTION_MAIN);
6660 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6661 }
6662 } else if (arg.indexOf(':') >= 0) {
6663 // The argument is a URI. Fully parse it, and use that result
6664 // to fill in any data not specified so far.
6665 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6666 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6667 } else if (arg.indexOf('/') >= 0) {
6668 // The argument is a component name. Build an Intent to launch
6669 // it.
6670 baseIntent = new Intent(Intent.ACTION_MAIN);
6671 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6672 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6673 } else {
6674 // Assume the argument is a package name.
6675 baseIntent = new Intent(Intent.ACTION_MAIN);
6676 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6677 baseIntent.setPackage(arg);
6678 }
6679 if (baseIntent != null) {
6680 Bundle extras = intent.getExtras();
6681 intent.replaceExtras((Bundle)null);
6682 Bundle uriExtras = baseIntent.getExtras();
6683 baseIntent.replaceExtras((Bundle)null);
6684 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6685 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6686 for (String c : cats) {
6687 baseIntent.removeCategory(c);
6688 }
6689 }
6690 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6691 if (extras == null) {
6692 extras = uriExtras;
6693 } else if (uriExtras != null) {
6694 uriExtras.putAll(extras);
6695 extras = uriExtras;
6696 }
6697 intent.replaceExtras(extras);
6698 hasIntentInfo = true;
6699 }
6700
6701 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6702 return intent;
6703 }
6704
6705 /** @hide */
6706 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6707 final String[] lines = new String[] {
6708 "<INTENT> specifications include these flags and arguments:",
6709 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6710 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6711 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6712 " [--esn <EXTRA_KEY> ...]",
6713 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6714 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6715 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6716 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6717 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6718 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6719 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6720 " (mutiple extras passed as Integer[])",
6721 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6722 " (mutiple extras passed as List<Integer>)",
6723 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6724 " (mutiple extras passed as Long[])",
6725 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6726 " (mutiple extras passed as List<Long>)",
6727 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6728 " (mutiple extras passed as Float[])",
6729 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6730 " (mutiple extras passed as List<Float>)",
6731 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6732 " (mutiple extras passed as String[]; to embed a comma into a string,",
6733 " escape it using \"\\,\")",
6734 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6735 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6736 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006737 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006738 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6739 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6740 " [--debug-log-resolution] [--exclude-stopped-packages]",
6741 " [--include-stopped-packages]",
6742 " [--activity-brought-to-front] [--activity-clear-top]",
6743 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6744 " [--activity-launched-from-history] [--activity-multiple-task]",
6745 " [--activity-no-animation] [--activity-no-history]",
6746 " [--activity-no-user-action] [--activity-previous-is-top]",
6747 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6748 " [--activity-single-top] [--activity-clear-task]",
6749 " [--activity-task-on-home]",
6750 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08006751 " [--receiver-foreground] [--receiver-no-abort]",
6752 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006753 " [--selector]",
6754 " [<URI> | <PACKAGE> | <COMPONENT>]"
6755 };
6756 for (String line : lines) {
6757 pw.print(prefix);
6758 pw.println(line);
6759 }
6760 }
6761
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006762 /**
6763 * Retrieve the general action to be performed, such as
6764 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6765 * the information in the intent should be interpreted -- most importantly,
6766 * what to do with the data returned by {@link #getData}.
6767 *
6768 * @return The action of this intent or null if none is specified.
6769 *
6770 * @see #setAction
6771 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006772 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006773 return mAction;
6774 }
6775
6776 /**
6777 * Retrieve data this intent is operating on. This URI specifies the name
6778 * of the data; often it uses the content: scheme, specifying data in a
6779 * content provider. Other schemes may be handled by specific activities,
6780 * such as http: by the web browser.
6781 *
6782 * @return The URI of the data this intent is targeting or null.
6783 *
6784 * @see #getScheme
6785 * @see #setData
6786 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006787 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006788 return mData;
6789 }
6790
6791 /**
6792 * The same as {@link #getData()}, but returns the URI as an encoded
6793 * String.
6794 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006795 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006796 return mData != null ? mData.toString() : null;
6797 }
6798
6799 /**
6800 * Return the scheme portion of the intent's data. If the data is null or
6801 * does not include a scheme, null is returned. Otherwise, the scheme
6802 * prefix without the final ':' is returned, i.e. "http".
6803 *
6804 * <p>This is the same as calling getData().getScheme() (and checking for
6805 * null data).
6806 *
6807 * @return The scheme of this intent.
6808 *
6809 * @see #getData
6810 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006811 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006812 return mData != null ? mData.getScheme() : null;
6813 }
6814
6815 /**
6816 * Retrieve any explicit MIME type included in the intent. This is usually
6817 * null, as the type is determined by the intent data.
6818 *
6819 * @return If a type was manually set, it is returned; else null is
6820 * returned.
6821 *
6822 * @see #resolveType(ContentResolver)
6823 * @see #setType
6824 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006825 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006826 return mType;
6827 }
6828
6829 /**
6830 * Return the MIME data type of this intent. If the type field is
6831 * explicitly set, that is simply returned. Otherwise, if the data is set,
6832 * the type of that data is returned. If neither fields are set, a null is
6833 * returned.
6834 *
6835 * @return The MIME type of this intent.
6836 *
6837 * @see #getType
6838 * @see #resolveType(ContentResolver)
6839 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006840 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006841 return resolveType(context.getContentResolver());
6842 }
6843
6844 /**
6845 * Return the MIME data type of this intent. If the type field is
6846 * explicitly set, that is simply returned. Otherwise, if the data is set,
6847 * the type of that data is returned. If neither fields are set, a null is
6848 * returned.
6849 *
6850 * @param resolver A ContentResolver that can be used to determine the MIME
6851 * type of the intent's data.
6852 *
6853 * @return The MIME type of this intent.
6854 *
6855 * @see #getType
6856 * @see #resolveType(Context)
6857 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006858 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006859 if (mType != null) {
6860 return mType;
6861 }
6862 if (mData != null) {
6863 if ("content".equals(mData.getScheme())) {
6864 return resolver.getType(mData);
6865 }
6866 }
6867 return null;
6868 }
6869
6870 /**
6871 * Return the MIME data type of this intent, only if it will be needed for
6872 * intent resolution. This is not generally useful for application code;
6873 * it is used by the frameworks for communicating with back-end system
6874 * services.
6875 *
6876 * @param resolver A ContentResolver that can be used to determine the MIME
6877 * type of the intent's data.
6878 *
6879 * @return The MIME type of this intent, or null if it is unknown or not
6880 * needed.
6881 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006882 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006883 if (mComponent != null) {
6884 return mType;
6885 }
6886 return resolveType(resolver);
6887 }
6888
6889 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006890 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006891 *
6892 * @param category The category to check.
6893 *
6894 * @return boolean True if the intent contains the category, else false.
6895 *
6896 * @see #getCategories
6897 * @see #addCategory
6898 */
6899 public boolean hasCategory(String category) {
6900 return mCategories != null && mCategories.contains(category);
6901 }
6902
6903 /**
6904 * Return the set of all categories in the intent. If there are no categories,
6905 * returns NULL.
6906 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006907 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006908 *
6909 * @see #hasCategory
6910 * @see #addCategory
6911 */
6912 public Set<String> getCategories() {
6913 return mCategories;
6914 }
6915
6916 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006917 * Return the specific selector associated with this Intent. If there is
6918 * none, returns null. See {@link #setSelector} for more information.
6919 *
6920 * @see #setSelector
6921 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006922 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006923 return mSelector;
6924 }
6925
6926 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006927 * Return the {@link ClipData} associated with this Intent. If there is
6928 * none, returns null. See {@link #setClipData} for more information.
6929 *
John Spurlock125d1332013-11-25 11:58:37 -05006930 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006931 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006932 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006933 return mClipData;
6934 }
6935
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006936 /** @hide */
6937 public int getContentUserHint() {
6938 return mContentUserHint;
6939 }
6940
Todd Kennedyb3b431302017-03-20 16:05:48 -07006941 /** @hide */
6942 public String getLaunchToken() {
6943 return mLaunchToken;
6944 }
6945
6946 /** @hide */
6947 public void setLaunchToken(String launchToken) {
6948 mLaunchToken = launchToken;
6949 }
6950
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006951 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006952 * Sets the ClassLoader that will be used when unmarshalling
6953 * any Parcelable values from the extras of this Intent.
6954 *
6955 * @param loader a ClassLoader, or null to use the default loader
6956 * at the time of unmarshalling.
6957 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006958 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006959 if (mExtras != null) {
6960 mExtras.setClassLoader(loader);
6961 }
6962 }
6963
6964 /**
6965 * Returns true if an extra value is associated with the given name.
6966 * @param name the extra's name
6967 * @return true if the given extra is present.
6968 */
6969 public boolean hasExtra(String name) {
6970 return mExtras != null && mExtras.containsKey(name);
6971 }
6972
6973 /**
6974 * Returns true if the Intent's extras contain a parcelled file descriptor.
6975 * @return true if the Intent contains a parcelled file descriptor.
6976 */
6977 public boolean hasFileDescriptors() {
6978 return mExtras != null && mExtras.hasFileDescriptors();
6979 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006980
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006981 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006982 public void setAllowFds(boolean allowFds) {
6983 if (mExtras != null) {
6984 mExtras.setAllowFds(allowFds);
6985 }
6986 }
6987
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006988 /** {@hide} */
6989 public void setDefusable(boolean defusable) {
6990 if (mExtras != null) {
6991 mExtras.setDefusable(defusable);
6992 }
6993 }
6994
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006995 /**
6996 * Retrieve extended data from the intent.
6997 *
6998 * @param name The name of the desired item.
6999 *
7000 * @return the value of an item that previously added with putExtra()
7001 * or null if none was found.
7002 *
7003 * @deprecated
7004 * @hide
7005 */
7006 @Deprecated
7007 public Object getExtra(String name) {
7008 return getExtra(name, null);
7009 }
7010
7011 /**
7012 * Retrieve extended data from the intent.
7013 *
7014 * @param name The name of the desired item.
7015 * @param defaultValue the value to be returned if no value of the desired
7016 * type is stored with the given name.
7017 *
7018 * @return the value of an item that previously added with putExtra()
7019 * or the default value if none was found.
7020 *
7021 * @see #putExtra(String, boolean)
7022 */
7023 public boolean getBooleanExtra(String name, boolean defaultValue) {
7024 return mExtras == null ? defaultValue :
7025 mExtras.getBoolean(name, defaultValue);
7026 }
7027
7028 /**
7029 * Retrieve extended data from the intent.
7030 *
7031 * @param name The name of the desired item.
7032 * @param defaultValue the value to be returned if no value of the desired
7033 * type is stored with the given name.
7034 *
7035 * @return the value of an item that previously added with putExtra()
7036 * or the default value if none was found.
7037 *
7038 * @see #putExtra(String, byte)
7039 */
7040 public byte getByteExtra(String name, byte defaultValue) {
7041 return mExtras == null ? defaultValue :
7042 mExtras.getByte(name, defaultValue);
7043 }
7044
7045 /**
7046 * Retrieve extended data from the intent.
7047 *
7048 * @param name The name of the desired item.
7049 * @param defaultValue the value to be returned if no value of the desired
7050 * type is stored with the given name.
7051 *
7052 * @return the value of an item that previously added with putExtra()
7053 * or the default value if none was found.
7054 *
7055 * @see #putExtra(String, short)
7056 */
7057 public short getShortExtra(String name, short defaultValue) {
7058 return mExtras == null ? defaultValue :
7059 mExtras.getShort(name, defaultValue);
7060 }
7061
7062 /**
7063 * Retrieve extended data from the intent.
7064 *
7065 * @param name The name of the desired item.
7066 * @param defaultValue the value to be returned if no value of the desired
7067 * type is stored with the given name.
7068 *
7069 * @return the value of an item that previously added with putExtra()
7070 * or the default value if none was found.
7071 *
7072 * @see #putExtra(String, char)
7073 */
7074 public char getCharExtra(String name, char defaultValue) {
7075 return mExtras == null ? defaultValue :
7076 mExtras.getChar(name, defaultValue);
7077 }
7078
7079 /**
7080 * Retrieve extended data from the intent.
7081 *
7082 * @param name The name of the desired item.
7083 * @param defaultValue the value to be returned if no value of the desired
7084 * type is stored with the given name.
7085 *
7086 * @return the value of an item that previously added with putExtra()
7087 * or the default value if none was found.
7088 *
7089 * @see #putExtra(String, int)
7090 */
7091 public int getIntExtra(String name, int defaultValue) {
7092 return mExtras == null ? defaultValue :
7093 mExtras.getInt(name, defaultValue);
7094 }
7095
7096 /**
7097 * Retrieve extended data from the intent.
7098 *
7099 * @param name The name of the desired item.
7100 * @param defaultValue the value to be returned if no value of the desired
7101 * type is stored with the given name.
7102 *
7103 * @return the value of an item that previously added with putExtra()
7104 * or the default value if none was found.
7105 *
7106 * @see #putExtra(String, long)
7107 */
7108 public long getLongExtra(String name, long defaultValue) {
7109 return mExtras == null ? defaultValue :
7110 mExtras.getLong(name, defaultValue);
7111 }
7112
7113 /**
7114 * Retrieve extended data from the intent.
7115 *
7116 * @param name The name of the desired item.
7117 * @param defaultValue the value to be returned if no value of the desired
7118 * type is stored with the given name.
7119 *
7120 * @return the value of an item that previously added with putExtra(),
7121 * or the default value if no such item is present
7122 *
7123 * @see #putExtra(String, float)
7124 */
7125 public float getFloatExtra(String name, float defaultValue) {
7126 return mExtras == null ? defaultValue :
7127 mExtras.getFloat(name, defaultValue);
7128 }
7129
7130 /**
7131 * Retrieve extended data from the intent.
7132 *
7133 * @param name The name of the desired item.
7134 * @param defaultValue the value to be returned if no value of the desired
7135 * type is stored with the given name.
7136 *
7137 * @return the value of an item that previously added with putExtra()
7138 * or the default value if none was found.
7139 *
7140 * @see #putExtra(String, double)
7141 */
7142 public double getDoubleExtra(String name, double defaultValue) {
7143 return mExtras == null ? defaultValue :
7144 mExtras.getDouble(name, defaultValue);
7145 }
7146
7147 /**
7148 * Retrieve extended data from the intent.
7149 *
7150 * @param name The name of the desired item.
7151 *
7152 * @return the value of an item that previously added with putExtra()
7153 * or null if no String value was found.
7154 *
7155 * @see #putExtra(String, String)
7156 */
7157 public String getStringExtra(String name) {
7158 return mExtras == null ? null : mExtras.getString(name);
7159 }
7160
7161 /**
7162 * Retrieve extended data from the intent.
7163 *
7164 * @param name The name of the desired item.
7165 *
7166 * @return the value of an item that previously added with putExtra()
7167 * or null if no CharSequence value was found.
7168 *
7169 * @see #putExtra(String, CharSequence)
7170 */
7171 public CharSequence getCharSequenceExtra(String name) {
7172 return mExtras == null ? null : mExtras.getCharSequence(name);
7173 }
7174
7175 /**
7176 * Retrieve extended data from the intent.
7177 *
7178 * @param name The name of the desired item.
7179 *
7180 * @return the value of an item that previously added with putExtra()
7181 * or null if no Parcelable value was found.
7182 *
7183 * @see #putExtra(String, Parcelable)
7184 */
7185 public <T extends Parcelable> T getParcelableExtra(String name) {
7186 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7187 }
7188
7189 /**
7190 * Retrieve extended data from the intent.
7191 *
7192 * @param name The name of the desired item.
7193 *
7194 * @return the value of an item that previously added with putExtra()
7195 * or null if no Parcelable[] value was found.
7196 *
7197 * @see #putExtra(String, Parcelable[])
7198 */
7199 public Parcelable[] getParcelableArrayExtra(String name) {
7200 return mExtras == null ? null : mExtras.getParcelableArray(name);
7201 }
7202
7203 /**
7204 * Retrieve extended data from the intent.
7205 *
7206 * @param name The name of the desired item.
7207 *
7208 * @return the value of an item that previously added with putExtra()
7209 * or null if no ArrayList<Parcelable> value was found.
7210 *
7211 * @see #putParcelableArrayListExtra(String, ArrayList)
7212 */
7213 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
7214 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7215 }
7216
7217 /**
7218 * Retrieve extended data from the intent.
7219 *
7220 * @param name The name of the desired item.
7221 *
7222 * @return the value of an item that previously added with putExtra()
7223 * or null if no Serializable value was found.
7224 *
7225 * @see #putExtra(String, Serializable)
7226 */
7227 public Serializable getSerializableExtra(String name) {
7228 return mExtras == null ? null : mExtras.getSerializable(name);
7229 }
7230
7231 /**
7232 * Retrieve extended data from the intent.
7233 *
7234 * @param name The name of the desired item.
7235 *
7236 * @return the value of an item that previously added with putExtra()
7237 * or null if no ArrayList<Integer> value was found.
7238 *
7239 * @see #putIntegerArrayListExtra(String, ArrayList)
7240 */
7241 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
7242 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7243 }
7244
7245 /**
7246 * Retrieve extended data from the intent.
7247 *
7248 * @param name The name of the desired item.
7249 *
7250 * @return the value of an item that previously added with putExtra()
7251 * or null if no ArrayList<String> value was found.
7252 *
7253 * @see #putStringArrayListExtra(String, ArrayList)
7254 */
7255 public ArrayList<String> getStringArrayListExtra(String name) {
7256 return mExtras == null ? null : mExtras.getStringArrayList(name);
7257 }
7258
7259 /**
7260 * Retrieve extended data from the intent.
7261 *
7262 * @param name The name of the desired item.
7263 *
7264 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007265 * or null if no ArrayList<CharSequence> value was found.
7266 *
7267 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7268 */
7269 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
7270 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7271 }
7272
7273 /**
7274 * Retrieve extended data from the intent.
7275 *
7276 * @param name The name of the desired item.
7277 *
7278 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007279 * or null if no boolean array value was found.
7280 *
7281 * @see #putExtra(String, boolean[])
7282 */
7283 public boolean[] getBooleanArrayExtra(String name) {
7284 return mExtras == null ? null : mExtras.getBooleanArray(name);
7285 }
7286
7287 /**
7288 * Retrieve extended data from the intent.
7289 *
7290 * @param name The name of the desired item.
7291 *
7292 * @return the value of an item that previously added with putExtra()
7293 * or null if no byte array value was found.
7294 *
7295 * @see #putExtra(String, byte[])
7296 */
7297 public byte[] getByteArrayExtra(String name) {
7298 return mExtras == null ? null : mExtras.getByteArray(name);
7299 }
7300
7301 /**
7302 * Retrieve extended data from the intent.
7303 *
7304 * @param name The name of the desired item.
7305 *
7306 * @return the value of an item that previously added with putExtra()
7307 * or null if no short array value was found.
7308 *
7309 * @see #putExtra(String, short[])
7310 */
7311 public short[] getShortArrayExtra(String name) {
7312 return mExtras == null ? null : mExtras.getShortArray(name);
7313 }
7314
7315 /**
7316 * Retrieve extended data from the intent.
7317 *
7318 * @param name The name of the desired item.
7319 *
7320 * @return the value of an item that previously added with putExtra()
7321 * or null if no char array value was found.
7322 *
7323 * @see #putExtra(String, char[])
7324 */
7325 public char[] getCharArrayExtra(String name) {
7326 return mExtras == null ? null : mExtras.getCharArray(name);
7327 }
7328
7329 /**
7330 * Retrieve extended data from the intent.
7331 *
7332 * @param name The name of the desired item.
7333 *
7334 * @return the value of an item that previously added with putExtra()
7335 * or null if no int array value was found.
7336 *
7337 * @see #putExtra(String, int[])
7338 */
7339 public int[] getIntArrayExtra(String name) {
7340 return mExtras == null ? null : mExtras.getIntArray(name);
7341 }
7342
7343 /**
7344 * Retrieve extended data from the intent.
7345 *
7346 * @param name The name of the desired item.
7347 *
7348 * @return the value of an item that previously added with putExtra()
7349 * or null if no long array value was found.
7350 *
7351 * @see #putExtra(String, long[])
7352 */
7353 public long[] getLongArrayExtra(String name) {
7354 return mExtras == null ? null : mExtras.getLongArray(name);
7355 }
7356
7357 /**
7358 * Retrieve extended data from the intent.
7359 *
7360 * @param name The name of the desired item.
7361 *
7362 * @return the value of an item that previously added with putExtra()
7363 * or null if no float array value was found.
7364 *
7365 * @see #putExtra(String, float[])
7366 */
7367 public float[] getFloatArrayExtra(String name) {
7368 return mExtras == null ? null : mExtras.getFloatArray(name);
7369 }
7370
7371 /**
7372 * Retrieve extended data from the intent.
7373 *
7374 * @param name The name of the desired item.
7375 *
7376 * @return the value of an item that previously added with putExtra()
7377 * or null if no double array value was found.
7378 *
7379 * @see #putExtra(String, double[])
7380 */
7381 public double[] getDoubleArrayExtra(String name) {
7382 return mExtras == null ? null : mExtras.getDoubleArray(name);
7383 }
7384
7385 /**
7386 * Retrieve extended data from the intent.
7387 *
7388 * @param name The name of the desired item.
7389 *
7390 * @return the value of an item that previously added with putExtra()
7391 * or null if no String array value was found.
7392 *
7393 * @see #putExtra(String, String[])
7394 */
7395 public String[] getStringArrayExtra(String name) {
7396 return mExtras == null ? null : mExtras.getStringArray(name);
7397 }
7398
7399 /**
7400 * Retrieve extended data from the intent.
7401 *
7402 * @param name The name of the desired item.
7403 *
7404 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007405 * or null if no CharSequence array value was found.
7406 *
7407 * @see #putExtra(String, CharSequence[])
7408 */
7409 public CharSequence[] getCharSequenceArrayExtra(String name) {
7410 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7411 }
7412
7413 /**
7414 * Retrieve extended data from the intent.
7415 *
7416 * @param name The name of the desired item.
7417 *
7418 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007419 * or null if no Bundle value was found.
7420 *
7421 * @see #putExtra(String, Bundle)
7422 */
7423 public Bundle getBundleExtra(String name) {
7424 return mExtras == null ? null : mExtras.getBundle(name);
7425 }
7426
7427 /**
7428 * Retrieve extended data from the intent.
7429 *
7430 * @param name The name of the desired item.
7431 *
7432 * @return the value of an item that previously added with putExtra()
7433 * or null if no IBinder value was found.
7434 *
7435 * @see #putExtra(String, IBinder)
7436 *
7437 * @deprecated
7438 * @hide
7439 */
7440 @Deprecated
7441 public IBinder getIBinderExtra(String name) {
7442 return mExtras == null ? null : mExtras.getIBinder(name);
7443 }
7444
7445 /**
7446 * Retrieve extended data from the intent.
7447 *
7448 * @param name The name of the desired item.
7449 * @param defaultValue The default value to return in case no item is
7450 * associated with the key 'name'
7451 *
7452 * @return the value of an item that previously added with putExtra()
7453 * or defaultValue if none was found.
7454 *
7455 * @see #putExtra
7456 *
7457 * @deprecated
7458 * @hide
7459 */
7460 @Deprecated
7461 public Object getExtra(String name, Object defaultValue) {
7462 Object result = defaultValue;
7463 if (mExtras != null) {
7464 Object result2 = mExtras.get(name);
7465 if (result2 != null) {
7466 result = result2;
7467 }
7468 }
7469
7470 return result;
7471 }
7472
7473 /**
7474 * Retrieves a map of extended data from the intent.
7475 *
7476 * @return the map of all extras previously added with putExtra(),
7477 * or null if none have been added.
7478 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007479 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007480 return (mExtras != null)
7481 ? new Bundle(mExtras)
7482 : null;
7483 }
7484
7485 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007486 * Filter extras to only basic types.
7487 * @hide
7488 */
7489 public void removeUnsafeExtras() {
7490 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007491 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007492 }
7493 }
7494
7495 /**
Makoto Onuki97f82f22017-05-31 16:20:21 -07007496 * @return Whether {@link #maybeStripForHistory} will return an lightened intent or
7497 * return itself as-is.
7498 * @hide
7499 */
7500 public boolean canStripForHistory() {
7501 return ((mExtras != null) && mExtras.isParcelled()) || (mClipData != null);
7502 }
7503
7504 /**
7505 * Call it when the system needs to keep an intent for logging purposes to remove fields
7506 * that are not needed for logging.
7507 * @hide
7508 */
7509 public Intent maybeStripForHistory() {
7510 // TODO Scan and remove possibly heavy instances like Bitmaps from unparcelled extras?
7511
7512 if (!canStripForHistory()) {
7513 return this;
7514 }
7515 return new Intent(this, COPY_MODE_HISTORY);
7516 }
7517
7518 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007519 * Retrieve any special flags associated with this intent. You will
7520 * normally just set them with {@link #setFlags} and let the system
7521 * take the appropriate action with them.
7522 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007523 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007524 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007525 * @see #addFlags
7526 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007527 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007528 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007529 return mFlags;
7530 }
7531
Dianne Hackborne7f97212011-02-24 14:40:20 -08007532 /** @hide */
7533 public boolean isExcludingStopped() {
7534 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7535 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7536 }
7537
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007538 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007539 * Retrieve the application package name this Intent is limited to. When
7540 * resolving an Intent, if non-null this limits the resolution to only
7541 * components in the given application package.
7542 *
7543 * @return The name of the application package for the Intent.
7544 *
7545 * @see #resolveActivity
7546 * @see #setPackage
7547 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007548 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007549 return mPackage;
7550 }
7551
7552 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007553 * Retrieve the concrete component associated with the intent. When receiving
7554 * an intent, this is the component that was found to best handle it (that is,
7555 * yourself) and will always be non-null; in all other cases it will be
7556 * null unless explicitly set.
7557 *
7558 * @return The name of the application component to handle the intent.
7559 *
7560 * @see #resolveActivity
7561 * @see #setComponent
7562 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007563 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007564 return mComponent;
7565 }
7566
7567 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007568 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7569 * used as a hint to the receiver for animations and the like. Null means that there
7570 * is no source bounds.
7571 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007572 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007573 return mSourceBounds;
7574 }
7575
7576 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007577 * Return the Activity component that should be used to handle this intent.
7578 * The appropriate component is determined based on the information in the
7579 * intent, evaluated as follows:
7580 *
7581 * <p>If {@link #getComponent} returns an explicit class, that is returned
7582 * without any further consideration.
7583 *
7584 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7585 * category to be considered.
7586 *
7587 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7588 * action.
7589 *
7590 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7591 * this type.
7592 *
7593 * <p>If {@link #addCategory} has added any categories, the activity must
7594 * handle ALL of the categories specified.
7595 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007596 * <p>If {@link #getPackage} is non-NULL, only activity components in
7597 * that application package will be considered.
7598 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007599 * <p>If there are no activities that satisfy all of these conditions, a
7600 * null string is returned.
7601 *
7602 * <p>If multiple activities are found to satisfy the intent, the one with
7603 * the highest priority will be used. If there are multiple activities
7604 * with the same priority, the system will either pick the best activity
7605 * based on user preference, or resolve to a system class that will allow
7606 * the user to pick an activity and forward from there.
7607 *
7608 * <p>This method is implemented simply by calling
7609 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7610 * true.</p>
7611 * <p> This API is called for you as part of starting an activity from an
7612 * intent. You do not normally need to call it yourself.</p>
7613 *
7614 * @param pm The package manager with which to resolve the Intent.
7615 *
7616 * @return Name of the component implementing an activity that can
7617 * display the intent.
7618 *
7619 * @see #setComponent
7620 * @see #getComponent
7621 * @see #resolveActivityInfo
7622 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007623 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007624 if (mComponent != null) {
7625 return mComponent;
7626 }
7627
7628 ResolveInfo info = pm.resolveActivity(
7629 this, PackageManager.MATCH_DEFAULT_ONLY);
7630 if (info != null) {
7631 return new ComponentName(
7632 info.activityInfo.applicationInfo.packageName,
7633 info.activityInfo.name);
7634 }
7635
7636 return null;
7637 }
7638
7639 /**
7640 * Resolve the Intent into an {@link ActivityInfo}
7641 * describing the activity that should execute the intent. Resolution
7642 * follows the same rules as described for {@link #resolveActivity}, but
7643 * you get back the completely information about the resolved activity
7644 * instead of just its class name.
7645 *
7646 * @param pm The package manager with which to resolve the Intent.
7647 * @param flags Addition information to retrieve as per
7648 * {@link PackageManager#getActivityInfo(ComponentName, int)
7649 * PackageManager.getActivityInfo()}.
7650 *
7651 * @return PackageManager.ActivityInfo
7652 *
7653 * @see #resolveActivity
7654 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007655 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
7656 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007657 ActivityInfo ai = null;
7658 if (mComponent != null) {
7659 try {
7660 ai = pm.getActivityInfo(mComponent, flags);
7661 } catch (PackageManager.NameNotFoundException e) {
7662 // ignore
7663 }
7664 } else {
7665 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007666 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007667 if (info != null) {
7668 ai = info.activityInfo;
7669 }
7670 }
7671
7672 return ai;
7673 }
7674
7675 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007676 * Special function for use by the system to resolve service
7677 * intents to system apps. Throws an exception if there are
7678 * multiple potential matches to the Intent. Returns null if
7679 * there are no matches.
7680 * @hide
7681 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007682 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
7683 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07007684 if (mComponent != null) {
7685 return mComponent;
7686 }
7687
7688 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7689 if (results == null) {
7690 return null;
7691 }
7692 ComponentName comp = null;
7693 for (int i=0; i<results.size(); i++) {
7694 ResolveInfo ri = results.get(i);
7695 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7696 continue;
7697 }
7698 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7699 ri.serviceInfo.name);
7700 if (comp != null) {
7701 throw new IllegalStateException("Multiple system services handle " + this
7702 + ": " + comp + ", " + foundComp);
7703 }
7704 comp = foundComp;
7705 }
7706 return comp;
7707 }
7708
7709 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007710 * Set the general action to be performed.
7711 *
7712 * @param action An action name, such as ACTION_VIEW. Application-specific
7713 * actions should be prefixed with the vendor's package name.
7714 *
7715 * @return Returns the same Intent object, for chaining multiple calls
7716 * into a single statement.
7717 *
7718 * @see #getAction
7719 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007720 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007721 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007722 return this;
7723 }
7724
7725 /**
7726 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007727 * clears any type that was previously set by {@link #setType} or
7728 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007729 *
Nick Pellyccae4122012-01-09 14:12:58 -08007730 * <p><em>Note: scheme matching in the Android framework is
7731 * case-sensitive, unlike the formal RFC. As a result,
7732 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007733 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007734 * {@link #setDataAndNormalize}
7735 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007736 *
Nick Pellyccae4122012-01-09 14:12:58 -08007737 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007738 *
7739 * @return Returns the same Intent object, for chaining multiple calls
7740 * into a single statement.
7741 *
7742 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007743 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007744 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007745 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007746 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007747 mData = data;
7748 mType = null;
7749 return this;
7750 }
7751
7752 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007753 * Normalize and set the data this intent is operating on.
7754 *
7755 * <p>This method automatically clears any type that was
7756 * previously set (for example, by {@link #setType}).
7757 *
7758 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007759 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007760 * so really this is just a convenience method for
7761 * <pre>
7762 * setData(data.normalize())
7763 * </pre>
7764 *
7765 * @param data The Uri of the data this intent is now targeting.
7766 *
7767 * @return Returns the same Intent object, for chaining multiple calls
7768 * into a single statement.
7769 *
7770 * @see #getData
7771 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007772 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007773 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007774 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007775 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007776 }
7777
7778 /**
7779 * Set an explicit MIME data type.
7780 *
7781 * <p>This is used to create intents that only specify a type and not data,
7782 * for example to indicate the type of data to return.
7783 *
7784 * <p>This method automatically clears any data that was
7785 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007786 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007787 * <p><em>Note: MIME type matching in the Android framework is
7788 * case-sensitive, unlike formal RFC MIME types. As a result,
7789 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007790 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7791 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007792 *
7793 * @param type The MIME type of the data being handled by this intent.
7794 *
7795 * @return Returns the same Intent object, for chaining multiple calls
7796 * into a single statement.
7797 *
7798 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007799 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007800 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007801 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007802 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007803 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007804 mData = null;
7805 mType = type;
7806 return this;
7807 }
7808
7809 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007810 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007811 *
Nick Pellyccae4122012-01-09 14:12:58 -08007812 * <p>This is used to create intents that only specify a type and not data,
7813 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007814 *
Nick Pellyccae4122012-01-09 14:12:58 -08007815 * <p>This method automatically clears any data that was
7816 * previously set (for example by {@link #setData}).
7817 *
7818 * <p>The MIME type is normalized using
7819 * {@link #normalizeMimeType} before it is set,
7820 * so really this is just a convenience method for
7821 * <pre>
7822 * setType(Intent.normalizeMimeType(type))
7823 * </pre>
7824 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007825 * @param type The MIME type of the data being handled by this intent.
7826 *
7827 * @return Returns the same Intent object, for chaining multiple calls
7828 * into a single statement.
7829 *
Nick Pellyccae4122012-01-09 14:12:58 -08007830 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007831 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007832 * @see #normalizeMimeType
7833 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007834 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08007835 return setType(normalizeMimeType(type));
7836 }
7837
7838 /**
7839 * (Usually optional) Set the data for the intent along with an explicit
7840 * MIME data type. This method should very rarely be used -- it allows you
7841 * to override the MIME type that would ordinarily be inferred from the
7842 * data with your own type given here.
7843 *
7844 * <p><em>Note: MIME type and Uri scheme matching in the
7845 * Android framework is case-sensitive, unlike the formal RFC definitions.
7846 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007847 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007848 * {@link #setDataAndTypeAndNormalize}
7849 * to ensure that they are converted to lower case.</em>
7850 *
7851 * @param data The Uri of the data this intent is now targeting.
7852 * @param type The MIME type of the data being handled by this intent.
7853 *
7854 * @return Returns the same Intent object, for chaining multiple calls
7855 * into a single statement.
7856 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007857 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007858 * @see #setData
7859 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007860 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007861 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007862 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007863 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007864 mData = data;
7865 mType = type;
7866 return this;
7867 }
7868
7869 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007870 * (Usually optional) Normalize and set both the data Uri and an explicit
7871 * MIME data type. This method should very rarely be used -- it allows you
7872 * to override the MIME type that would ordinarily be inferred from the
7873 * data with your own type given here.
7874 *
7875 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007876 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007877 * before they are set, so really this is just a convenience method for
7878 * <pre>
7879 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7880 * </pre>
7881 *
7882 * @param data The Uri of the data this intent is now targeting.
7883 * @param type The MIME type of the data being handled by this intent.
7884 *
7885 * @return Returns the same Intent object, for chaining multiple calls
7886 * into a single statement.
7887 *
7888 * @see #setType
7889 * @see #setData
7890 * @see #setDataAndType
7891 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007892 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007893 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007894 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007895 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007896 }
7897
7898 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007899 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007900 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007901 * activities that provide <em>all</em> of the requested categories will be
7902 * used.
7903 *
7904 * @param category The desired category. This can be either one of the
7905 * predefined Intent categories, or a custom category in your own
7906 * namespace.
7907 *
7908 * @return Returns the same Intent object, for chaining multiple calls
7909 * into a single statement.
7910 *
7911 * @see #hasCategory
7912 * @see #removeCategory
7913 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007914 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007915 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007916 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007917 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007918 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007919 return this;
7920 }
7921
7922 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007923 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007924 *
7925 * @param category The category to remove.
7926 *
7927 * @see #addCategory
7928 */
7929 public void removeCategory(String category) {
7930 if (mCategories != null) {
7931 mCategories.remove(category);
7932 if (mCategories.size() == 0) {
7933 mCategories = null;
7934 }
7935 }
7936 }
7937
7938 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007939 * Set a selector for this Intent. This is a modification to the kinds of
7940 * things the Intent will match. If the selector is set, it will be used
7941 * when trying to find entities that can handle the Intent, instead of the
7942 * main contents of the Intent. This allows you build an Intent containing
7943 * a generic protocol while targeting it more specifically.
7944 *
7945 * <p>An example of where this may be used is with things like
7946 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7947 * Intent that will launch the Browser application. However, the correct
7948 * main entry point of an application is actually {@link #ACTION_MAIN}
7949 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7950 * used to specify the actual Activity to launch. If you launch the browser
7951 * with something different, undesired behavior may happen if the user has
7952 * previously or later launches it the normal way, since they do not match.
7953 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7954 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7955 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7956 *
7957 * <p>Setting a selector does not impact the behavior of
7958 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7959 * desired behavior of a selector -- it does not impact the base meaning
7960 * of the Intent, just what kinds of things will be matched against it
7961 * when determining who can handle it.</p>
7962 *
7963 * <p>You can not use both a selector and {@link #setPackage(String)} on
7964 * the same base Intent.</p>
7965 *
7966 * @param selector The desired selector Intent; set to null to not use
7967 * a special selector.
7968 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007969 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007970 if (selector == this) {
7971 throw new IllegalArgumentException(
7972 "Intent being set as a selector of itself");
7973 }
7974 if (selector != null && mPackage != null) {
7975 throw new IllegalArgumentException(
7976 "Can't set selector when package name is already set");
7977 }
7978 mSelector = selector;
7979 }
7980
7981 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007982 * Set a {@link ClipData} associated with this Intent. This replaces any
7983 * previously set ClipData.
7984 *
7985 * <p>The ClipData in an intent is not used for Intent matching or other
7986 * such operations. Semantically it is like extras, used to transmit
7987 * additional data with the Intent. The main feature of using this over
7988 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7989 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7990 * items included in the clip data. This is useful, in particular, if
7991 * you want to transmit an Intent containing multiple <code>content:</code>
7992 * URIs for which the recipient may not have global permission to access the
7993 * content provider.
7994 *
7995 * <p>If the ClipData contains items that are themselves Intents, any
7996 * grant flags in those Intents will be ignored. Only the top-level flags
7997 * of the main Intent are respected, and will be applied to all Uri or
7998 * Intent items in the clip (or sub-items of the clip).
7999 *
8000 * <p>The MIME type, label, and icon in the ClipData object are not
8001 * directly used by Intent. Applications should generally rely on the
8002 * MIME type of the Intent itself, not what it may find in the ClipData.
8003 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05008004 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008005 *
8006 * @param clip The new clip to set. May be null to clear the current clip.
8007 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008008 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008009 mClipData = clip;
8010 }
8011
8012 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008013 * This is NOT a secure mechanism to identify the user who sent the intent.
8014 * When the intent is sent to a different user, it is used to fix uris by adding the userId
8015 * who sent the intent.
8016 * @hide
8017 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01008018 public void prepareToLeaveUser(int userId) {
8019 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
8020 // We want mContentUserHint to refer to the original user, so don't do anything.
8021 if (mContentUserHint == UserHandle.USER_CURRENT) {
8022 mContentUserHint = userId;
8023 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008024 }
8025
8026 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008027 * Add extended data to the intent. The name must include a package
8028 * prefix, for example the app com.android.contacts would use names
8029 * like "com.android.contacts.ShowAll".
8030 *
8031 * @param name The name of the extra data, with package prefix.
8032 * @param value The boolean data value.
8033 *
8034 * @return Returns the same Intent object, for chaining multiple calls
8035 * into a single statement.
8036 *
8037 * @see #putExtras
8038 * @see #removeExtra
8039 * @see #getBooleanExtra(String, boolean)
8040 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008041 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008042 if (mExtras == null) {
8043 mExtras = new Bundle();
8044 }
8045 mExtras.putBoolean(name, value);
8046 return this;
8047 }
8048
8049 /**
8050 * Add extended data to the intent. The name must include a package
8051 * prefix, for example the app com.android.contacts would use names
8052 * like "com.android.contacts.ShowAll".
8053 *
8054 * @param name The name of the extra data, with package prefix.
8055 * @param value The byte data value.
8056 *
8057 * @return Returns the same Intent object, for chaining multiple calls
8058 * into a single statement.
8059 *
8060 * @see #putExtras
8061 * @see #removeExtra
8062 * @see #getByteExtra(String, byte)
8063 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008064 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008065 if (mExtras == null) {
8066 mExtras = new Bundle();
8067 }
8068 mExtras.putByte(name, value);
8069 return this;
8070 }
8071
8072 /**
8073 * Add extended data to the intent. The name must include a package
8074 * prefix, for example the app com.android.contacts would use names
8075 * like "com.android.contacts.ShowAll".
8076 *
8077 * @param name The name of the extra data, with package prefix.
8078 * @param value The char data value.
8079 *
8080 * @return Returns the same Intent object, for chaining multiple calls
8081 * into a single statement.
8082 *
8083 * @see #putExtras
8084 * @see #removeExtra
8085 * @see #getCharExtra(String, char)
8086 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008087 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008088 if (mExtras == null) {
8089 mExtras = new Bundle();
8090 }
8091 mExtras.putChar(name, value);
8092 return this;
8093 }
8094
8095 /**
8096 * Add extended data to the intent. The name must include a package
8097 * prefix, for example the app com.android.contacts would use names
8098 * like "com.android.contacts.ShowAll".
8099 *
8100 * @param name The name of the extra data, with package prefix.
8101 * @param value The short data value.
8102 *
8103 * @return Returns the same Intent object, for chaining multiple calls
8104 * into a single statement.
8105 *
8106 * @see #putExtras
8107 * @see #removeExtra
8108 * @see #getShortExtra(String, short)
8109 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008110 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008111 if (mExtras == null) {
8112 mExtras = new Bundle();
8113 }
8114 mExtras.putShort(name, value);
8115 return this;
8116 }
8117
8118 /**
8119 * Add extended data to the intent. The name must include a package
8120 * prefix, for example the app com.android.contacts would use names
8121 * like "com.android.contacts.ShowAll".
8122 *
8123 * @param name The name of the extra data, with package prefix.
8124 * @param value The integer data value.
8125 *
8126 * @return Returns the same Intent object, for chaining multiple calls
8127 * into a single statement.
8128 *
8129 * @see #putExtras
8130 * @see #removeExtra
8131 * @see #getIntExtra(String, int)
8132 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008133 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008134 if (mExtras == null) {
8135 mExtras = new Bundle();
8136 }
8137 mExtras.putInt(name, value);
8138 return this;
8139 }
8140
8141 /**
8142 * Add extended data to the intent. The name must include a package
8143 * prefix, for example the app com.android.contacts would use names
8144 * like "com.android.contacts.ShowAll".
8145 *
8146 * @param name The name of the extra data, with package prefix.
8147 * @param value The long data value.
8148 *
8149 * @return Returns the same Intent object, for chaining multiple calls
8150 * into a single statement.
8151 *
8152 * @see #putExtras
8153 * @see #removeExtra
8154 * @see #getLongExtra(String, long)
8155 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008156 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008157 if (mExtras == null) {
8158 mExtras = new Bundle();
8159 }
8160 mExtras.putLong(name, value);
8161 return this;
8162 }
8163
8164 /**
8165 * Add extended data to the intent. The name must include a package
8166 * prefix, for example the app com.android.contacts would use names
8167 * like "com.android.contacts.ShowAll".
8168 *
8169 * @param name The name of the extra data, with package prefix.
8170 * @param value The float data value.
8171 *
8172 * @return Returns the same Intent object, for chaining multiple calls
8173 * into a single statement.
8174 *
8175 * @see #putExtras
8176 * @see #removeExtra
8177 * @see #getFloatExtra(String, float)
8178 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008179 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008180 if (mExtras == null) {
8181 mExtras = new Bundle();
8182 }
8183 mExtras.putFloat(name, value);
8184 return this;
8185 }
8186
8187 /**
8188 * Add extended data to the intent. The name must include a package
8189 * prefix, for example the app com.android.contacts would use names
8190 * like "com.android.contacts.ShowAll".
8191 *
8192 * @param name The name of the extra data, with package prefix.
8193 * @param value The double data value.
8194 *
8195 * @return Returns the same Intent object, for chaining multiple calls
8196 * into a single statement.
8197 *
8198 * @see #putExtras
8199 * @see #removeExtra
8200 * @see #getDoubleExtra(String, double)
8201 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008202 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008203 if (mExtras == null) {
8204 mExtras = new Bundle();
8205 }
8206 mExtras.putDouble(name, value);
8207 return this;
8208 }
8209
8210 /**
8211 * Add extended data to the intent. The name must include a package
8212 * prefix, for example the app com.android.contacts would use names
8213 * like "com.android.contacts.ShowAll".
8214 *
8215 * @param name The name of the extra data, with package prefix.
8216 * @param value The String data value.
8217 *
8218 * @return Returns the same Intent object, for chaining multiple calls
8219 * into a single statement.
8220 *
8221 * @see #putExtras
8222 * @see #removeExtra
8223 * @see #getStringExtra(String)
8224 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008225 public @NonNull Intent putExtra(String name, String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008226 if (mExtras == null) {
8227 mExtras = new Bundle();
8228 }
8229 mExtras.putString(name, value);
8230 return this;
8231 }
8232
8233 /**
8234 * Add extended data to the intent. The name must include a package
8235 * prefix, for example the app com.android.contacts would use names
8236 * like "com.android.contacts.ShowAll".
8237 *
8238 * @param name The name of the extra data, with package prefix.
8239 * @param value The CharSequence data value.
8240 *
8241 * @return Returns the same Intent object, for chaining multiple calls
8242 * into a single statement.
8243 *
8244 * @see #putExtras
8245 * @see #removeExtra
8246 * @see #getCharSequenceExtra(String)
8247 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008248 public @NonNull Intent putExtra(String name, CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008249 if (mExtras == null) {
8250 mExtras = new Bundle();
8251 }
8252 mExtras.putCharSequence(name, value);
8253 return this;
8254 }
8255
8256 /**
8257 * Add extended data to the intent. The name must include a package
8258 * prefix, for example the app com.android.contacts would use names
8259 * like "com.android.contacts.ShowAll".
8260 *
8261 * @param name The name of the extra data, with package prefix.
8262 * @param value The Parcelable data value.
8263 *
8264 * @return Returns the same Intent object, for chaining multiple calls
8265 * into a single statement.
8266 *
8267 * @see #putExtras
8268 * @see #removeExtra
8269 * @see #getParcelableExtra(String)
8270 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008271 public @NonNull Intent putExtra(String name, Parcelable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008272 if (mExtras == null) {
8273 mExtras = new Bundle();
8274 }
8275 mExtras.putParcelable(name, value);
8276 return this;
8277 }
8278
8279 /**
8280 * Add extended data to the intent. The name must include a package
8281 * prefix, for example the app com.android.contacts would use names
8282 * like "com.android.contacts.ShowAll".
8283 *
8284 * @param name The name of the extra data, with package prefix.
8285 * @param value The Parcelable[] data value.
8286 *
8287 * @return Returns the same Intent object, for chaining multiple calls
8288 * into a single statement.
8289 *
8290 * @see #putExtras
8291 * @see #removeExtra
8292 * @see #getParcelableArrayExtra(String)
8293 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008294 public @NonNull Intent putExtra(String name, Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008295 if (mExtras == null) {
8296 mExtras = new Bundle();
8297 }
8298 mExtras.putParcelableArray(name, value);
8299 return this;
8300 }
8301
8302 /**
8303 * Add extended data to the intent. The name must include a package
8304 * prefix, for example the app com.android.contacts would use names
8305 * like "com.android.contacts.ShowAll".
8306 *
8307 * @param name The name of the extra data, with package prefix.
8308 * @param value The ArrayList<Parcelable> data value.
8309 *
8310 * @return Returns the same Intent object, for chaining multiple calls
8311 * into a single statement.
8312 *
8313 * @see #putExtras
8314 * @see #removeExtra
8315 * @see #getParcelableArrayListExtra(String)
8316 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008317 public @NonNull Intent putParcelableArrayListExtra(String name,
8318 ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008319 if (mExtras == null) {
8320 mExtras = new Bundle();
8321 }
8322 mExtras.putParcelableArrayList(name, value);
8323 return this;
8324 }
8325
8326 /**
8327 * Add extended data to the intent. The name must include a package
8328 * prefix, for example the app com.android.contacts would use names
8329 * like "com.android.contacts.ShowAll".
8330 *
8331 * @param name The name of the extra data, with package prefix.
8332 * @param value The ArrayList<Integer> data value.
8333 *
8334 * @return Returns the same Intent object, for chaining multiple calls
8335 * into a single statement.
8336 *
8337 * @see #putExtras
8338 * @see #removeExtra
8339 * @see #getIntegerArrayListExtra(String)
8340 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008341 public @NonNull Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008342 if (mExtras == null) {
8343 mExtras = new Bundle();
8344 }
8345 mExtras.putIntegerArrayList(name, value);
8346 return this;
8347 }
8348
8349 /**
8350 * Add extended data to the intent. The name must include a package
8351 * prefix, for example the app com.android.contacts would use names
8352 * like "com.android.contacts.ShowAll".
8353 *
8354 * @param name The name of the extra data, with package prefix.
8355 * @param value The ArrayList<String> data value.
8356 *
8357 * @return Returns the same Intent object, for chaining multiple calls
8358 * into a single statement.
8359 *
8360 * @see #putExtras
8361 * @see #removeExtra
8362 * @see #getStringArrayListExtra(String)
8363 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008364 public @NonNull Intent putStringArrayListExtra(String name, ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008365 if (mExtras == null) {
8366 mExtras = new Bundle();
8367 }
8368 mExtras.putStringArrayList(name, value);
8369 return this;
8370 }
8371
8372 /**
8373 * Add extended data to the intent. The name must include a package
8374 * prefix, for example the app com.android.contacts would use names
8375 * like "com.android.contacts.ShowAll".
8376 *
8377 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008378 * @param value The ArrayList<CharSequence> data value.
8379 *
8380 * @return Returns the same Intent object, for chaining multiple calls
8381 * into a single statement.
8382 *
8383 * @see #putExtras
8384 * @see #removeExtra
8385 * @see #getCharSequenceArrayListExtra(String)
8386 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008387 public @NonNull Intent putCharSequenceArrayListExtra(String name,
8388 ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008389 if (mExtras == null) {
8390 mExtras = new Bundle();
8391 }
8392 mExtras.putCharSequenceArrayList(name, value);
8393 return this;
8394 }
8395
8396 /**
8397 * Add extended data to the intent. The name must include a package
8398 * prefix, for example the app com.android.contacts would use names
8399 * like "com.android.contacts.ShowAll".
8400 *
8401 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008402 * @param value The Serializable data value.
8403 *
8404 * @return Returns the same Intent object, for chaining multiple calls
8405 * into a single statement.
8406 *
8407 * @see #putExtras
8408 * @see #removeExtra
8409 * @see #getSerializableExtra(String)
8410 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008411 public @NonNull Intent putExtra(String name, Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008412 if (mExtras == null) {
8413 mExtras = new Bundle();
8414 }
8415 mExtras.putSerializable(name, value);
8416 return this;
8417 }
8418
8419 /**
8420 * Add extended data to the intent. The name must include a package
8421 * prefix, for example the app com.android.contacts would use names
8422 * like "com.android.contacts.ShowAll".
8423 *
8424 * @param name The name of the extra data, with package prefix.
8425 * @param value The boolean array data value.
8426 *
8427 * @return Returns the same Intent object, for chaining multiple calls
8428 * into a single statement.
8429 *
8430 * @see #putExtras
8431 * @see #removeExtra
8432 * @see #getBooleanArrayExtra(String)
8433 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008434 public @NonNull Intent putExtra(String name, boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008435 if (mExtras == null) {
8436 mExtras = new Bundle();
8437 }
8438 mExtras.putBooleanArray(name, value);
8439 return this;
8440 }
8441
8442 /**
8443 * Add extended data to the intent. The name must include a package
8444 * prefix, for example the app com.android.contacts would use names
8445 * like "com.android.contacts.ShowAll".
8446 *
8447 * @param name The name of the extra data, with package prefix.
8448 * @param value The byte array data value.
8449 *
8450 * @return Returns the same Intent object, for chaining multiple calls
8451 * into a single statement.
8452 *
8453 * @see #putExtras
8454 * @see #removeExtra
8455 * @see #getByteArrayExtra(String)
8456 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008457 public @NonNull Intent putExtra(String name, byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008458 if (mExtras == null) {
8459 mExtras = new Bundle();
8460 }
8461 mExtras.putByteArray(name, value);
8462 return this;
8463 }
8464
8465 /**
8466 * Add extended data to the intent. The name must include a package
8467 * prefix, for example the app com.android.contacts would use names
8468 * like "com.android.contacts.ShowAll".
8469 *
8470 * @param name The name of the extra data, with package prefix.
8471 * @param value The short array data value.
8472 *
8473 * @return Returns the same Intent object, for chaining multiple calls
8474 * into a single statement.
8475 *
8476 * @see #putExtras
8477 * @see #removeExtra
8478 * @see #getShortArrayExtra(String)
8479 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008480 public @NonNull Intent putExtra(String name, short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008481 if (mExtras == null) {
8482 mExtras = new Bundle();
8483 }
8484 mExtras.putShortArray(name, value);
8485 return this;
8486 }
8487
8488 /**
8489 * Add extended data to the intent. The name must include a package
8490 * prefix, for example the app com.android.contacts would use names
8491 * like "com.android.contacts.ShowAll".
8492 *
8493 * @param name The name of the extra data, with package prefix.
8494 * @param value The char array data value.
8495 *
8496 * @return Returns the same Intent object, for chaining multiple calls
8497 * into a single statement.
8498 *
8499 * @see #putExtras
8500 * @see #removeExtra
8501 * @see #getCharArrayExtra(String)
8502 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008503 public @NonNull Intent putExtra(String name, char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008504 if (mExtras == null) {
8505 mExtras = new Bundle();
8506 }
8507 mExtras.putCharArray(name, value);
8508 return this;
8509 }
8510
8511 /**
8512 * Add extended data to the intent. The name must include a package
8513 * prefix, for example the app com.android.contacts would use names
8514 * like "com.android.contacts.ShowAll".
8515 *
8516 * @param name The name of the extra data, with package prefix.
8517 * @param value The int array data value.
8518 *
8519 * @return Returns the same Intent object, for chaining multiple calls
8520 * into a single statement.
8521 *
8522 * @see #putExtras
8523 * @see #removeExtra
8524 * @see #getIntArrayExtra(String)
8525 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008526 public @NonNull Intent putExtra(String name, int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008527 if (mExtras == null) {
8528 mExtras = new Bundle();
8529 }
8530 mExtras.putIntArray(name, value);
8531 return this;
8532 }
8533
8534 /**
8535 * Add extended data to the intent. The name must include a package
8536 * prefix, for example the app com.android.contacts would use names
8537 * like "com.android.contacts.ShowAll".
8538 *
8539 * @param name The name of the extra data, with package prefix.
8540 * @param value The byte array data value.
8541 *
8542 * @return Returns the same Intent object, for chaining multiple calls
8543 * into a single statement.
8544 *
8545 * @see #putExtras
8546 * @see #removeExtra
8547 * @see #getLongArrayExtra(String)
8548 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008549 public @NonNull Intent putExtra(String name, long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008550 if (mExtras == null) {
8551 mExtras = new Bundle();
8552 }
8553 mExtras.putLongArray(name, value);
8554 return this;
8555 }
8556
8557 /**
8558 * Add extended data to the intent. The name must include a package
8559 * prefix, for example the app com.android.contacts would use names
8560 * like "com.android.contacts.ShowAll".
8561 *
8562 * @param name The name of the extra data, with package prefix.
8563 * @param value The float array data value.
8564 *
8565 * @return Returns the same Intent object, for chaining multiple calls
8566 * into a single statement.
8567 *
8568 * @see #putExtras
8569 * @see #removeExtra
8570 * @see #getFloatArrayExtra(String)
8571 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008572 public @NonNull Intent putExtra(String name, float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008573 if (mExtras == null) {
8574 mExtras = new Bundle();
8575 }
8576 mExtras.putFloatArray(name, value);
8577 return this;
8578 }
8579
8580 /**
8581 * Add extended data to the intent. The name must include a package
8582 * prefix, for example the app com.android.contacts would use names
8583 * like "com.android.contacts.ShowAll".
8584 *
8585 * @param name The name of the extra data, with package prefix.
8586 * @param value The double array data value.
8587 *
8588 * @return Returns the same Intent object, for chaining multiple calls
8589 * into a single statement.
8590 *
8591 * @see #putExtras
8592 * @see #removeExtra
8593 * @see #getDoubleArrayExtra(String)
8594 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008595 public @NonNull Intent putExtra(String name, double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008596 if (mExtras == null) {
8597 mExtras = new Bundle();
8598 }
8599 mExtras.putDoubleArray(name, value);
8600 return this;
8601 }
8602
8603 /**
8604 * Add extended data to the intent. The name must include a package
8605 * prefix, for example the app com.android.contacts would use names
8606 * like "com.android.contacts.ShowAll".
8607 *
8608 * @param name The name of the extra data, with package prefix.
8609 * @param value The String array data value.
8610 *
8611 * @return Returns the same Intent object, for chaining multiple calls
8612 * into a single statement.
8613 *
8614 * @see #putExtras
8615 * @see #removeExtra
8616 * @see #getStringArrayExtra(String)
8617 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008618 public @NonNull Intent putExtra(String name, String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008619 if (mExtras == null) {
8620 mExtras = new Bundle();
8621 }
8622 mExtras.putStringArray(name, value);
8623 return this;
8624 }
8625
8626 /**
8627 * Add extended data to the intent. The name must include a package
8628 * prefix, for example the app com.android.contacts would use names
8629 * like "com.android.contacts.ShowAll".
8630 *
8631 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008632 * @param value The CharSequence array data value.
8633 *
8634 * @return Returns the same Intent object, for chaining multiple calls
8635 * into a single statement.
8636 *
8637 * @see #putExtras
8638 * @see #removeExtra
8639 * @see #getCharSequenceArrayExtra(String)
8640 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008641 public @NonNull Intent putExtra(String name, CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008642 if (mExtras == null) {
8643 mExtras = new Bundle();
8644 }
8645 mExtras.putCharSequenceArray(name, value);
8646 return this;
8647 }
8648
8649 /**
8650 * Add extended data to the intent. The name must include a package
8651 * prefix, for example the app com.android.contacts would use names
8652 * like "com.android.contacts.ShowAll".
8653 *
8654 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008655 * @param value The Bundle data value.
8656 *
8657 * @return Returns the same Intent object, for chaining multiple calls
8658 * into a single statement.
8659 *
8660 * @see #putExtras
8661 * @see #removeExtra
8662 * @see #getBundleExtra(String)
8663 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008664 public @NonNull Intent putExtra(String name, Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008665 if (mExtras == null) {
8666 mExtras = new Bundle();
8667 }
8668 mExtras.putBundle(name, value);
8669 return this;
8670 }
8671
8672 /**
8673 * Add extended data to the intent. The name must include a package
8674 * prefix, for example the app com.android.contacts would use names
8675 * like "com.android.contacts.ShowAll".
8676 *
8677 * @param name The name of the extra data, with package prefix.
8678 * @param value The IBinder data value.
8679 *
8680 * @return Returns the same Intent object, for chaining multiple calls
8681 * into a single statement.
8682 *
8683 * @see #putExtras
8684 * @see #removeExtra
8685 * @see #getIBinderExtra(String)
8686 *
8687 * @deprecated
8688 * @hide
8689 */
8690 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008691 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008692 if (mExtras == null) {
8693 mExtras = new Bundle();
8694 }
8695 mExtras.putIBinder(name, value);
8696 return this;
8697 }
8698
8699 /**
8700 * Copy all extras in 'src' in to this intent.
8701 *
8702 * @param src Contains the extras to copy.
8703 *
8704 * @see #putExtra
8705 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008706 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008707 if (src.mExtras != null) {
8708 if (mExtras == null) {
8709 mExtras = new Bundle(src.mExtras);
8710 } else {
8711 mExtras.putAll(src.mExtras);
8712 }
8713 }
8714 return this;
8715 }
8716
8717 /**
8718 * Add a set of extended data to the intent. The keys must include a package
8719 * prefix, for example the app com.android.contacts would use names
8720 * like "com.android.contacts.ShowAll".
8721 *
8722 * @param extras The Bundle of extras to add to this intent.
8723 *
8724 * @see #putExtra
8725 * @see #removeExtra
8726 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008727 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008728 if (mExtras == null) {
8729 mExtras = new Bundle();
8730 }
8731 mExtras.putAll(extras);
8732 return this;
8733 }
8734
8735 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008736 * Completely replace the extras in the Intent with the extras in the
8737 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008738 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008739 * @param src The exact extras contained in this Intent are copied
8740 * into the target intent, replacing any that were previously there.
8741 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008742 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008743 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8744 return this;
8745 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008746
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008747 /**
8748 * Completely replace the extras in the Intent with the given Bundle of
8749 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008750 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008751 * @param extras The new set of extras in the Intent, or null to erase
8752 * all extras.
8753 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008754 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008755 mExtras = extras != null ? new Bundle(extras) : null;
8756 return this;
8757 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008758
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008759 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008760 * Remove extended data from the intent.
8761 *
8762 * @see #putExtra
8763 */
8764 public void removeExtra(String name) {
8765 if (mExtras != null) {
8766 mExtras.remove(name);
8767 if (mExtras.size() == 0) {
8768 mExtras = null;
8769 }
8770 }
8771 }
8772
8773 /**
8774 * Set special flags controlling how this intent is handled. Most values
8775 * here depend on the type of component being executed by the Intent,
8776 * specifically the FLAG_ACTIVITY_* flags are all for use with
8777 * {@link Context#startActivity Context.startActivity()} and the
8778 * FLAG_RECEIVER_* flags are all for use with
8779 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8780 *
Scott Main7aee61f2011-02-08 11:25:01 -08008781 * <p>See the
8782 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8783 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008784 * the behavior of your application.
8785 *
8786 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008787 * @return Returns the same Intent object, for chaining multiple calls
8788 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008789 * @see #getFlags
8790 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008791 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008792 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008793 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008794 mFlags = flags;
8795 return this;
8796 }
8797
8798 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008799 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008800 *
8801 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008802 * @return Returns the same Intent object, for chaining multiple calls into
8803 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008804 * @see #setFlags
8805 * @see #getFlags
8806 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008807 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008808 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008809 mFlags |= flags;
8810 return this;
8811 }
8812
8813 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008814 * Remove these flags from the intent.
8815 *
8816 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008817 * @see #setFlags
8818 * @see #getFlags
8819 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008820 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008821 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008822 mFlags &= ~flags;
8823 }
8824
8825 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008826 * (Usually optional) Set an explicit application package name that limits
8827 * the components this Intent will resolve to. If left to the default
8828 * value of null, all components in all applications will considered.
8829 * If non-null, the Intent can only match the components in the given
8830 * application package.
8831 *
8832 * @param packageName The name of the application package to handle the
8833 * intent, or null to allow any application package.
8834 *
8835 * @return Returns the same Intent object, for chaining multiple calls
8836 * into a single statement.
8837 *
8838 * @see #getPackage
8839 * @see #resolveActivity
8840 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008841 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008842 if (packageName != null && mSelector != null) {
8843 throw new IllegalArgumentException(
8844 "Can't set package name when selector is already set");
8845 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008846 mPackage = packageName;
8847 return this;
8848 }
8849
8850 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008851 * (Usually optional) Explicitly set the component to handle the intent.
8852 * If left with the default value of null, the system will determine the
8853 * appropriate class to use based on the other fields (action, data,
8854 * type, categories) in the Intent. If this class is defined, the
8855 * specified class will always be used regardless of the other fields. You
8856 * should only set this value when you know you absolutely want a specific
8857 * class to be used; otherwise it is better to let the system find the
8858 * appropriate class so that you will respect the installed applications
8859 * and user preferences.
8860 *
8861 * @param component The name of the application component to handle the
8862 * intent, or null to let the system find one for you.
8863 *
8864 * @return Returns the same Intent object, for chaining multiple calls
8865 * into a single statement.
8866 *
8867 * @see #setClass
8868 * @see #setClassName(Context, String)
8869 * @see #setClassName(String, String)
8870 * @see #getComponent
8871 * @see #resolveActivity
8872 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008873 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008874 mComponent = component;
8875 return this;
8876 }
8877
8878 /**
8879 * Convenience for calling {@link #setComponent} with an
8880 * explicit class name.
8881 *
8882 * @param packageContext A Context of the application package implementing
8883 * this class.
8884 * @param className The name of a class inside of the application package
8885 * that will be used as the component for this Intent.
8886 *
8887 * @return Returns the same Intent object, for chaining multiple calls
8888 * into a single statement.
8889 *
8890 * @see #setComponent
8891 * @see #setClass
8892 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008893 public @NonNull Intent setClassName(@NonNull Context packageContext,
8894 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008895 mComponent = new ComponentName(packageContext, className);
8896 return this;
8897 }
8898
8899 /**
8900 * Convenience for calling {@link #setComponent} with an
8901 * explicit application package name and class name.
8902 *
8903 * @param packageName The name of the package implementing the desired
8904 * component.
8905 * @param className The name of a class inside of the application package
8906 * that will be used as the component for this Intent.
8907 *
8908 * @return Returns the same Intent object, for chaining multiple calls
8909 * into a single statement.
8910 *
8911 * @see #setComponent
8912 * @see #setClass
8913 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008914 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008915 mComponent = new ComponentName(packageName, className);
8916 return this;
8917 }
8918
8919 /**
8920 * Convenience for calling {@link #setComponent(ComponentName)} with the
8921 * name returned by a {@link Class} object.
8922 *
8923 * @param packageContext A Context of the application package implementing
8924 * this class.
8925 * @param cls The class name to set, equivalent to
8926 * <code>setClassName(context, cls.getName())</code>.
8927 *
8928 * @return Returns the same Intent object, for chaining multiple calls
8929 * into a single statement.
8930 *
8931 * @see #setComponent
8932 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008933 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008934 mComponent = new ComponentName(packageContext, cls);
8935 return this;
8936 }
8937
8938 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008939 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8940 * used as a hint to the receiver for animations and the like. Null means that there
8941 * is no source bounds.
8942 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008943 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008944 if (r != null) {
8945 mSourceBounds = new Rect(r);
8946 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008947 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008948 }
8949 }
8950
Tor Norbyed9273d62013-05-30 15:59:53 -07008951 /** @hide */
8952 @IntDef(flag = true,
8953 value = {
8954 FILL_IN_ACTION,
8955 FILL_IN_DATA,
8956 FILL_IN_CATEGORIES,
8957 FILL_IN_COMPONENT,
8958 FILL_IN_PACKAGE,
8959 FILL_IN_SOURCE_BOUNDS,
8960 FILL_IN_SELECTOR,
8961 FILL_IN_CLIP_DATA
8962 })
8963 @Retention(RetentionPolicy.SOURCE)
8964 public @interface FillInFlags {}
8965
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008966 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008967 * Use with {@link #fillIn} to allow the current action value to be
8968 * overwritten, even if it is already set.
8969 */
8970 public static final int FILL_IN_ACTION = 1<<0;
8971
8972 /**
8973 * Use with {@link #fillIn} to allow the current data or type value
8974 * overwritten, even if it is already set.
8975 */
8976 public static final int FILL_IN_DATA = 1<<1;
8977
8978 /**
8979 * Use with {@link #fillIn} to allow the current categories to be
8980 * overwritten, even if they are already set.
8981 */
8982 public static final int FILL_IN_CATEGORIES = 1<<2;
8983
8984 /**
8985 * Use with {@link #fillIn} to allow the current component value to be
8986 * overwritten, even if it is already set.
8987 */
8988 public static final int FILL_IN_COMPONENT = 1<<3;
8989
8990 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008991 * Use with {@link #fillIn} to allow the current package value to be
8992 * overwritten, even if it is already set.
8993 */
8994 public static final int FILL_IN_PACKAGE = 1<<4;
8995
8996 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008997 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008998 * overwritten, even if it is already set.
8999 */
9000 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
9001
9002 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009003 * Use with {@link #fillIn} to allow the current selector to be
9004 * overwritten, even if it is already set.
9005 */
9006 public static final int FILL_IN_SELECTOR = 1<<6;
9007
9008 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009009 * Use with {@link #fillIn} to allow the current ClipData to be
9010 * overwritten, even if it is already set.
9011 */
9012 public static final int FILL_IN_CLIP_DATA = 1<<7;
9013
9014 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009015 * Copy the contents of <var>other</var> in to this object, but only
9016 * where fields are not defined by this object. For purposes of a field
9017 * being defined, the following pieces of data in the Intent are
9018 * considered to be separate fields:
9019 *
9020 * <ul>
9021 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08009022 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009023 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
9024 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009025 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009026 * <li> component, as set by {@link #setComponent(ComponentName)} or
9027 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009028 * <li> source bounds, as set by {@link #setSourceBounds}.
9029 * <li> selector, as set by {@link #setSelector(Intent)}.
9030 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009031 * <li> each top-level name in the associated extras.
9032 * </ul>
9033 *
9034 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009035 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009036 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
9037 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
9038 * the restriction where the corresponding field will not be replaced if
9039 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009040 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009041 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
9042 * is explicitly specified. The selector will only be copied if
9043 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07009044 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009045 * <p>For example, consider Intent A with {data="foo", categories="bar"}
9046 * and Intent B with {action="gotit", data-type="some/thing",
9047 * categories="one","two"}.
9048 *
9049 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
9050 * containing: {action="gotit", data-type="some/thing",
9051 * categories="bar"}.
9052 *
9053 * @param other Another Intent whose values are to be used to fill in
9054 * the current one.
9055 * @param flags Options to control which fields can be filled in.
9056 *
9057 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009058 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07009059 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08009060 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07009061 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009062 */
Tor Norbyed9273d62013-05-30 15:59:53 -07009063 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009064 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009065 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009066 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009067 if (other.mAction != null
9068 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009069 mAction = other.mAction;
9070 changes |= FILL_IN_ACTION;
9071 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009072 if ((other.mData != null || other.mType != null)
9073 && ((mData == null && mType == null)
9074 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009075 mData = other.mData;
9076 mType = other.mType;
9077 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009078 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009079 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009080 if (other.mCategories != null
9081 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009082 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009083 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009084 }
9085 changes |= FILL_IN_CATEGORIES;
9086 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009087 if (other.mPackage != null
9088 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009089 // Only do this if mSelector is not set.
9090 if (mSelector == null) {
9091 mPackage = other.mPackage;
9092 changes |= FILL_IN_PACKAGE;
9093 }
9094 }
9095 // Selector is special: it can only be set if explicitly allowed,
9096 // for the same reason as the component name.
9097 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
9098 if (mPackage == null) {
9099 mSelector = new Intent(other.mSelector);
9100 mPackage = null;
9101 changes |= FILL_IN_SELECTOR;
9102 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009103 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009104 if (other.mClipData != null
9105 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
9106 mClipData = other.mClipData;
9107 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009108 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009109 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009110 // Component is special: it can -only- be set if explicitly allowed,
9111 // since otherwise the sender could force the intent somewhere the
9112 // originator didn't intend.
9113 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009114 mComponent = other.mComponent;
9115 changes |= FILL_IN_COMPONENT;
9116 }
9117 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009118 if (other.mSourceBounds != null
9119 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
9120 mSourceBounds = new Rect(other.mSourceBounds);
9121 changes |= FILL_IN_SOURCE_BOUNDS;
9122 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009123 if (mExtras == null) {
9124 if (other.mExtras != null) {
9125 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009126 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009127 }
9128 } else if (other.mExtras != null) {
9129 try {
9130 Bundle newb = new Bundle(other.mExtras);
9131 newb.putAll(mExtras);
9132 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009133 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009134 } catch (RuntimeException e) {
9135 // Modifying the extras can cause us to unparcel the contents
9136 // of the bundle, and if we do this in the system process that
9137 // may fail. We really should handle this (i.e., the Bundle
9138 // impl shouldn't be on top of a plain map), but for now just
9139 // ignore it and keep the original contents. :(
9140 Log.w("Intent", "Failure filling in extras", e);
9141 }
9142 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009143 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9144 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9145 mContentUserHint = other.mContentUserHint;
9146 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009147 return changes;
9148 }
9149
9150 /**
9151 * Wrapper class holding an Intent and implementing comparisons on it for
9152 * the purpose of filtering. The class implements its
9153 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9154 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9155 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9156 * on the wrapped Intent.
9157 */
9158 public static final class FilterComparison {
9159 private final Intent mIntent;
9160 private final int mHashCode;
9161
9162 public FilterComparison(Intent intent) {
9163 mIntent = intent;
9164 mHashCode = intent.filterHashCode();
9165 }
9166
9167 /**
9168 * Return the Intent that this FilterComparison represents.
9169 * @return Returns the Intent held by the FilterComparison. Do
9170 * not modify!
9171 */
9172 public Intent getIntent() {
9173 return mIntent;
9174 }
9175
9176 @Override
9177 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009178 if (obj instanceof FilterComparison) {
9179 Intent other = ((FilterComparison)obj).mIntent;
9180 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009181 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009182 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009183 }
9184
9185 @Override
9186 public int hashCode() {
9187 return mHashCode;
9188 }
9189 }
9190
9191 /**
9192 * Determine if two intents are the same for the purposes of intent
9193 * resolution (filtering). That is, if their action, data, type,
9194 * class, and categories are the same. This does <em>not</em> compare
9195 * any extra data included in the intents.
9196 *
9197 * @param other The other Intent to compare against.
9198 *
9199 * @return Returns true if action, data, type, class, and categories
9200 * are the same.
9201 */
9202 public boolean filterEquals(Intent other) {
9203 if (other == null) {
9204 return false;
9205 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009206 if (!Objects.equals(this.mAction, other.mAction)) return false;
9207 if (!Objects.equals(this.mData, other.mData)) return false;
9208 if (!Objects.equals(this.mType, other.mType)) return false;
9209 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9210 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9211 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009212
9213 return true;
9214 }
9215
9216 /**
9217 * Generate hash code that matches semantics of filterEquals().
9218 *
9219 * @return Returns the hash value of the action, data, type, class, and
9220 * categories.
9221 *
9222 * @see #filterEquals
9223 */
9224 public int filterHashCode() {
9225 int code = 0;
9226 if (mAction != null) {
9227 code += mAction.hashCode();
9228 }
9229 if (mData != null) {
9230 code += mData.hashCode();
9231 }
9232 if (mType != null) {
9233 code += mType.hashCode();
9234 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009235 if (mPackage != null) {
9236 code += mPackage.hashCode();
9237 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009238 if (mComponent != null) {
9239 code += mComponent.hashCode();
9240 }
9241 if (mCategories != null) {
9242 code += mCategories.hashCode();
9243 }
9244 return code;
9245 }
9246
9247 @Override
9248 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009249 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009250
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009251 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009252 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009253 b.append(" }");
9254
9255 return b.toString();
9256 }
9257
9258 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009259 public String toInsecureString() {
9260 StringBuilder b = new StringBuilder(128);
9261
9262 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009263 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009264 b.append(" }");
9265
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009266 return b.toString();
9267 }
Romain Guy4969af72009-06-17 10:53:19 -07009268
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009269 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009270 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009271 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009272
9273 b.append("Intent { ");
9274 toShortString(b, false, true, true, true);
9275 b.append(" }");
9276
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009277 return b.toString();
9278 }
9279
9280 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009281 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9282 StringBuilder b = new StringBuilder(128);
9283 toShortString(b, secure, comp, extras, clip);
9284 return b.toString();
9285 }
9286
9287 /** @hide */
9288 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9289 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009290 boolean first = true;
9291 if (mAction != null) {
9292 b.append("act=").append(mAction);
9293 first = false;
9294 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009295 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009296 if (!first) {
9297 b.append(' ');
9298 }
9299 first = false;
9300 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009301 for (int i=0; i<mCategories.size(); i++) {
9302 if (i > 0) b.append(',');
9303 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009304 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009305 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009306 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009307 if (mData != null) {
9308 if (!first) {
9309 b.append(' ');
9310 }
9311 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009312 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009313 if (secure) {
9314 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009315 } else {
9316 b.append(mData);
9317 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009318 }
9319 if (mType != null) {
9320 if (!first) {
9321 b.append(' ');
9322 }
9323 first = false;
9324 b.append("typ=").append(mType);
9325 }
9326 if (mFlags != 0) {
9327 if (!first) {
9328 b.append(' ');
9329 }
9330 first = false;
9331 b.append("flg=0x").append(Integer.toHexString(mFlags));
9332 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009333 if (mPackage != null) {
9334 if (!first) {
9335 b.append(' ');
9336 }
9337 first = false;
9338 b.append("pkg=").append(mPackage);
9339 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009340 if (comp && mComponent != null) {
9341 if (!first) {
9342 b.append(' ');
9343 }
9344 first = false;
9345 b.append("cmp=").append(mComponent.flattenToShortString());
9346 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009347 if (mSourceBounds != null) {
9348 if (!first) {
9349 b.append(' ');
9350 }
9351 first = false;
9352 b.append("bnds=").append(mSourceBounds.toShortString());
9353 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009354 if (mClipData != null) {
9355 if (!first) {
9356 b.append(' ');
9357 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009358 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009359 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009360 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009361 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009362 if (mClipData.getDescription() != null) {
9363 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9364 } else {
9365 first = true;
9366 }
9367 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009368 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009369 first = false;
9370 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009371 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009372 if (extras && mExtras != null) {
9373 if (!first) {
9374 b.append(' ');
9375 }
9376 first = false;
9377 b.append("(has extras)");
9378 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009379 if (mContentUserHint != UserHandle.USER_CURRENT) {
9380 if (!first) {
9381 b.append(' ');
9382 }
9383 first = false;
9384 b.append("u=").append(mContentUserHint);
9385 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009386 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009387 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009388 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009389 b.append("}");
9390 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009391 }
9392
Yi Jin129fc6c2017-09-28 15:48:38 -07009393 /** @hide */
9394 public void writeToProto(ProtoOutputStream proto, long fieldId, boolean secure, boolean comp,
9395 boolean extras, boolean clip) {
9396 long token = proto.start(fieldId);
9397 if (mAction != null) {
9398 proto.write(IntentProto.ACTION, mAction);
9399 }
9400 if (mCategories != null) {
9401 for (String category : mCategories) {
9402 proto.write(IntentProto.CATEGORIES, category);
9403 }
9404 }
9405 if (mData != null) {
9406 proto.write(IntentProto.DATA, secure ? mData.toSafeString() : mData.toString());
9407 }
9408 if (mType != null) {
9409 proto.write(IntentProto.TYPE, mType);
9410 }
9411 if (mFlags != 0) {
9412 proto.write(IntentProto.FLAG, "0x" + Integer.toHexString(mFlags));
9413 }
9414 if (mPackage != null) {
9415 proto.write(IntentProto.PACKAGE, mPackage);
9416 }
9417 if (comp && mComponent != null) {
9418 proto.write(IntentProto.COMPONENT, mComponent.flattenToShortString());
9419 }
9420 if (mSourceBounds != null) {
9421 proto.write(IntentProto.SOURCE_BOUNDS, mSourceBounds.toShortString());
9422 }
9423 if (mClipData != null) {
9424 StringBuilder b = new StringBuilder();
9425 if (clip) {
9426 mClipData.toShortString(b);
9427 } else {
9428 mClipData.toShortStringShortItems(b, false);
9429 }
9430 proto.write(IntentProto.CLIP_DATA, b.toString());
9431 }
9432 if (extras && mExtras != null) {
9433 proto.write(IntentProto.EXTRAS, mExtras.toShortString());
9434 }
9435 if (mContentUserHint != 0) {
9436 proto.write(IntentProto.CONTENT_USER_HINT, mContentUserHint);
9437 }
9438 if (mSelector != null) {
9439 proto.write(IntentProto.SELECTOR, mSelector.toShortString(secure, comp, extras, clip));
9440 }
9441 proto.end(token);
9442 }
9443
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009444 /**
9445 * Call {@link #toUri} with 0 flags.
9446 * @deprecated Use {@link #toUri} instead.
9447 */
9448 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009449 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009450 return toUri(0);
9451 }
9452
9453 /**
9454 * Convert this Intent into a String holding a URI representation of it.
9455 * The returned URI string has been properly URI encoded, so it can be
9456 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9457 * Intent's data as the base URI, with an additional fragment describing
9458 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009459 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009460 * <p>You can convert the returned string back to an Intent with
9461 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009462 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009463 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009464 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009465 * @return Returns a URI encoding URI string describing the entire contents
9466 * of the Intent.
9467 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009468 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009469 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009470 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9471 if (mPackage == null) {
9472 throw new IllegalArgumentException(
9473 "Intent must include an explicit package name to build an android-app: "
9474 + this);
9475 }
9476 uri.append("android-app://");
9477 uri.append(mPackage);
9478 String scheme = null;
9479 if (mData != null) {
9480 scheme = mData.getScheme();
9481 if (scheme != null) {
9482 uri.append('/');
9483 uri.append(scheme);
9484 String authority = mData.getEncodedAuthority();
9485 if (authority != null) {
9486 uri.append('/');
9487 uri.append(authority);
9488 String path = mData.getEncodedPath();
9489 if (path != null) {
9490 uri.append(path);
9491 }
9492 String queryParams = mData.getEncodedQuery();
9493 if (queryParams != null) {
9494 uri.append('?');
9495 uri.append(queryParams);
9496 }
9497 String fragment = mData.getEncodedFragment();
9498 if (fragment != null) {
9499 uri.append('#');
9500 uri.append(fragment);
9501 }
9502 }
9503 }
9504 }
9505 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9506 mPackage, flags);
9507 return uri.toString();
9508 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009509 String scheme = null;
9510 if (mData != null) {
9511 String data = mData.toString();
9512 if ((flags&URI_INTENT_SCHEME) != 0) {
9513 final int N = data.length();
9514 for (int i=0; i<N; i++) {
9515 char c = data.charAt(i);
9516 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
Christopher Schuster42c3a6e2017-07-21 14:53:52 -07009517 || (c >= '0' && c <= '9') || c == '.' || c == '-' || c == '+') {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009518 continue;
9519 }
9520 if (c == ':' && i > 0) {
9521 // Valid scheme.
9522 scheme = data.substring(0, i);
9523 uri.append("intent:");
9524 data = data.substring(i+1);
9525 break;
9526 }
Tom Taylord4a47292009-12-21 13:59:18 -08009527
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009528 // No scheme.
9529 break;
9530 }
9531 }
9532 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009533
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009534 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9535 uri.append("intent:");
9536 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009537
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009538 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009539
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009540 return uri.toString();
9541 }
9542
9543 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9544 String defPackage, int flags) {
9545 StringBuilder frag = new StringBuilder(128);
9546
9547 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009548 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009549 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009550 // Note that for now we are not going to try to handle the
9551 // data part; not clear how to represent this as a URI, and
9552 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009553 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9554 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009555 }
9556
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009557 if (frag.length() > 0) {
9558 uri.append("#Intent;");
9559 uri.append(frag);
9560 uri.append("end");
9561 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009562 }
9563
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009564 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9565 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009566 if (scheme != null) {
9567 uri.append("scheme=").append(scheme).append(';');
9568 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009569 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009570 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009571 }
9572 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009573 for (int i=0; i<mCategories.size(); i++) {
9574 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009575 }
9576 }
9577 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009578 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009579 }
9580 if (mFlags != 0) {
9581 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9582 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009583 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009584 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9585 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009586 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009587 uri.append("component=").append(Uri.encode(
9588 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009589 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009590 if (mSourceBounds != null) {
9591 uri.append("sourceBounds=")
9592 .append(Uri.encode(mSourceBounds.flattenToString()))
9593 .append(';');
9594 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009595 if (mExtras != null) {
9596 for (String key : mExtras.keySet()) {
9597 final Object value = mExtras.get(key);
9598 char entryType =
9599 value instanceof String ? 'S' :
9600 value instanceof Boolean ? 'B' :
9601 value instanceof Byte ? 'b' :
9602 value instanceof Character ? 'c' :
9603 value instanceof Double ? 'd' :
9604 value instanceof Float ? 'f' :
9605 value instanceof Integer ? 'i' :
9606 value instanceof Long ? 'l' :
9607 value instanceof Short ? 's' :
9608 '\0';
9609
9610 if (entryType != '\0') {
9611 uri.append(entryType);
9612 uri.append('.');
9613 uri.append(Uri.encode(key));
9614 uri.append('=');
9615 uri.append(Uri.encode(value.toString()));
9616 uri.append(';');
9617 }
9618 }
9619 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009620 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009621
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009622 public int describeContents() {
9623 return (mExtras != null) ? mExtras.describeContents() : 0;
9624 }
9625
9626 public void writeToParcel(Parcel out, int flags) {
9627 out.writeString(mAction);
9628 Uri.writeToParcel(out, mData);
9629 out.writeString(mType);
9630 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009631 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009632 ComponentName.writeToParcel(mComponent, out);
9633
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009634 if (mSourceBounds != null) {
9635 out.writeInt(1);
9636 mSourceBounds.writeToParcel(out, flags);
9637 } else {
9638 out.writeInt(0);
9639 }
9640
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009641 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009642 final int N = mCategories.size();
9643 out.writeInt(N);
9644 for (int i=0; i<N; i++) {
9645 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009646 }
9647 } else {
9648 out.writeInt(0);
9649 }
9650
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009651 if (mSelector != null) {
9652 out.writeInt(1);
9653 mSelector.writeToParcel(out, flags);
9654 } else {
9655 out.writeInt(0);
9656 }
9657
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009658 if (mClipData != null) {
9659 out.writeInt(1);
9660 mClipData.writeToParcel(out, flags);
9661 } else {
9662 out.writeInt(0);
9663 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009664 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009665 out.writeBundle(mExtras);
9666 }
9667
9668 public static final Parcelable.Creator<Intent> CREATOR
9669 = new Parcelable.Creator<Intent>() {
9670 public Intent createFromParcel(Parcel in) {
9671 return new Intent(in);
9672 }
9673 public Intent[] newArray(int size) {
9674 return new Intent[size];
9675 }
9676 };
9677
Dianne Hackborneb034652009-09-07 00:49:58 -07009678 /** @hide */
9679 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009680 readFromParcel(in);
9681 }
9682
9683 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009684 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009685 mData = Uri.CREATOR.createFromParcel(in);
9686 mType = in.readString();
9687 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009688 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009689 mComponent = ComponentName.readFromParcel(in);
9690
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009691 if (in.readInt() != 0) {
9692 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9693 }
9694
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009695 int N = in.readInt();
9696 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009697 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009698 int i;
9699 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009700 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009701 }
9702 } else {
9703 mCategories = null;
9704 }
9705
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009706 if (in.readInt() != 0) {
9707 mSelector = new Intent(in);
9708 }
9709
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009710 if (in.readInt() != 0) {
9711 mClipData = new ClipData(in);
9712 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009713 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009714 mExtras = in.readBundle();
9715 }
9716
9717 /**
9718 * Parses the "intent" element (and its children) from XML and instantiates
9719 * an Intent object. The given XML parser should be located at the tag
9720 * where parsing should start (often named "intent"), from which the
9721 * basic action, data, type, and package and class name will be
9722 * retrieved. The function will then parse in to any child elements,
9723 * looking for <category android:name="xxx"> tags to add categories and
9724 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9725 * to the intent.
9726 *
9727 * @param resources The Resources to use when inflating resources.
9728 * @param parser The XML parser pointing at an "intent" tag.
9729 * @param attrs The AttributeSet interface for retrieving extended
9730 * attribute data at the current <var>parser</var> location.
9731 * @return An Intent object matching the XML data.
9732 * @throws XmlPullParserException If there was an XML parsing error.
9733 * @throws IOException If there was an I/O error.
9734 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009735 public static @NonNull Intent parseIntent(@NonNull Resources resources,
9736 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009737 throws XmlPullParserException, IOException {
9738 Intent intent = new Intent();
9739
9740 TypedArray sa = resources.obtainAttributes(attrs,
9741 com.android.internal.R.styleable.Intent);
9742
9743 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9744
9745 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9746 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9747 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9748
9749 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9750 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9751 if (packageName != null && className != null) {
9752 intent.setComponent(new ComponentName(packageName, className));
9753 }
9754
9755 sa.recycle();
9756
9757 int outerDepth = parser.getDepth();
9758 int type;
9759 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9760 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9761 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9762 continue;
9763 }
9764
9765 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009766 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009767 sa = resources.obtainAttributes(attrs,
9768 com.android.internal.R.styleable.IntentCategory);
9769 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9770 sa.recycle();
9771
9772 if (cat != null) {
9773 intent.addCategory(cat);
9774 }
9775 XmlUtils.skipCurrentTag(parser);
9776
Craig Mautner21d24a22014-04-23 11:45:37 -07009777 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009778 if (intent.mExtras == null) {
9779 intent.mExtras = new Bundle();
9780 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009781 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009782 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009783
9784 } else {
9785 XmlUtils.skipCurrentTag(parser);
9786 }
9787 }
9788
9789 return intent;
9790 }
Nick Pellyccae4122012-01-09 14:12:58 -08009791
Craig Mautner21d24a22014-04-23 11:45:37 -07009792 /** @hide */
9793 public void saveToXml(XmlSerializer out) throws IOException {
9794 if (mAction != null) {
9795 out.attribute(null, ATTR_ACTION, mAction);
9796 }
9797 if (mData != null) {
9798 out.attribute(null, ATTR_DATA, mData.toString());
9799 }
9800 if (mType != null) {
9801 out.attribute(null, ATTR_TYPE, mType);
9802 }
9803 if (mComponent != null) {
9804 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9805 }
9806 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9807
9808 if (mCategories != null) {
9809 out.startTag(null, TAG_CATEGORIES);
9810 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9811 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9812 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009813 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009814 }
9815 }
9816
9817 /** @hide */
9818 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9819 XmlPullParserException {
9820 Intent intent = new Intent();
9821 final int outerDepth = in.getDepth();
9822
9823 int attrCount = in.getAttributeCount();
9824 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9825 final String attrName = in.getAttributeName(attrNdx);
9826 final String attrValue = in.getAttributeValue(attrNdx);
9827 if (ATTR_ACTION.equals(attrName)) {
9828 intent.setAction(attrValue);
9829 } else if (ATTR_DATA.equals(attrName)) {
9830 intent.setData(Uri.parse(attrValue));
9831 } else if (ATTR_TYPE.equals(attrName)) {
9832 intent.setType(attrValue);
9833 } else if (ATTR_COMPONENT.equals(attrName)) {
9834 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9835 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009836 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009837 } else {
9838 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9839 }
9840 }
9841
9842 int event;
9843 String name;
9844 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9845 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9846 if (event == XmlPullParser.START_TAG) {
9847 name = in.getName();
9848 if (TAG_CATEGORIES.equals(name)) {
9849 attrCount = in.getAttributeCount();
9850 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9851 intent.addCategory(in.getAttributeValue(attrNdx));
9852 }
9853 } else {
9854 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9855 XmlUtils.skipCurrentTag(in);
9856 }
9857 }
9858 }
9859
9860 return intent;
9861 }
9862
Nick Pellyccae4122012-01-09 14:12:58 -08009863 /**
9864 * Normalize a MIME data type.
9865 *
9866 * <p>A normalized MIME type has white-space trimmed,
9867 * content-type parameters removed, and is lower-case.
9868 * This aligns the type with Android best practices for
9869 * intent filtering.
9870 *
9871 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9872 * "text/x-vCard" becomes "text/x-vcard".
9873 *
9874 * <p>All MIME types received from outside Android (such as user input,
9875 * or external sources like Bluetooth, NFC, or the Internet) should
9876 * be normalized before they are used to create an Intent.
9877 *
9878 * @param type MIME data type to normalize
9879 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009880 * @see #setType
9881 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009882 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009883 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08009884 if (type == null) {
9885 return null;
9886 }
9887
Elliott Hughescb64d432013-08-02 10:00:44 -07009888 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009889
9890 final int semicolonIndex = type.indexOf(';');
9891 if (semicolonIndex != -1) {
9892 type = type.substring(0, semicolonIndex);
9893 }
9894 return type;
9895 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009896
9897 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009898 * Prepare this {@link Intent} to leave an app process.
9899 *
9900 * @hide
9901 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009902 public void prepareToLeaveProcess(Context context) {
9903 final boolean leavingPackage = (mComponent == null)
9904 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9905 prepareToLeaveProcess(leavingPackage);
9906 }
9907
9908 /**
9909 * Prepare this {@link Intent} to leave an app process.
9910 *
9911 * @hide
9912 */
9913 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009914 setAllowFds(false);
9915
9916 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009917 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009918 }
9919 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009920 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009921 }
9922
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -07009923 if (mExtras != null && !mExtras.isParcelled()) {
9924 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
9925 if (intent instanceof Intent) {
9926 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
9927 }
9928 }
9929
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009930 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9931 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009932 switch (mAction) {
9933 case ACTION_MEDIA_REMOVED:
9934 case ACTION_MEDIA_UNMOUNTED:
9935 case ACTION_MEDIA_CHECKING:
9936 case ACTION_MEDIA_NOFS:
9937 case ACTION_MEDIA_MOUNTED:
9938 case ACTION_MEDIA_SHARED:
9939 case ACTION_MEDIA_UNSHARED:
9940 case ACTION_MEDIA_BAD_REMOVAL:
9941 case ACTION_MEDIA_UNMOUNTABLE:
9942 case ACTION_MEDIA_EJECT:
9943 case ACTION_MEDIA_SCANNER_STARTED:
9944 case ACTION_MEDIA_SCANNER_FINISHED:
9945 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009946 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9947 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009948 // Ignore legacy actions
9949 break;
9950 default:
9951 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009952 }
9953 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009954
9955 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
9956 && leavingPackage) {
9957 switch (mAction) {
9958 case ACTION_PROVIDER_CHANGED:
Makoto Onuki7d1911f2017-06-09 12:30:09 -07009959 case QuickContact.ACTION_QUICK_CONTACT:
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009960 // Ignore actions that don't need to grant
9961 break;
9962 default:
9963 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
9964 }
9965 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009966 }
9967
9968 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009969 * @hide
9970 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009971 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009972 // We just entered destination process, so we should be able to read all
9973 // parcelables inside.
9974 setDefusable(true);
9975
9976 if (mSelector != null) {
9977 mSelector.prepareToEnterProcess();
9978 }
9979 if (mClipData != null) {
9980 mClipData.prepareToEnterProcess();
9981 }
9982
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009983 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009984 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9985 fixUris(mContentUserHint);
9986 mContentUserHint = UserHandle.USER_CURRENT;
9987 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009988 }
9989 }
9990
9991 /**
9992 * @hide
9993 */
9994 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009995 Uri data = getData();
9996 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009997 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009998 }
9999 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010000 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010001 }
10002 String action = getAction();
10003 if (ACTION_SEND.equals(action)) {
10004 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10005 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010006 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010007 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010008 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010009 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10010 if (streams != null) {
10011 ArrayList<Uri> newStreams = new ArrayList<Uri>();
10012 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010013 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010014 }
10015 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
10016 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010017 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10018 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10019 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10020 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10021 if (output != null) {
10022 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
10023 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010024 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010025 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010026
10027 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010028 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010029 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
10030 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010031 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010032 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010033 * @hide
10034 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010035 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010036 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010037 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010038
10039 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010040 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010041
10042 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010043 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010044 // Inspect contained intents to see if we need to migrate extras. We
10045 // don't promote ClipData to the parent, since ChooserActivity will
10046 // already start the picked item as the caller, and we can't combine
10047 // the flags in a safe way.
10048
10049 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -070010050 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010051 final Intent intent = getParcelableExtra(EXTRA_INTENT);
10052 if (intent != null) {
10053 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -070010054 }
10055 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010056 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010057 try {
10058 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
10059 if (intents != null) {
10060 for (int i = 0; i < intents.length; i++) {
10061 final Intent intent = (Intent) intents[i];
10062 if (intent != null) {
10063 migrated |= intent.migrateExtraStreamToClipData();
10064 }
10065 }
10066 }
10067 } catch (ClassCastException e) {
10068 }
10069 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010070
10071 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010072 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010073 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10074 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
10075 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
10076 if (stream != null || text != null || htmlText != null) {
10077 final ClipData clipData = new ClipData(
10078 null, new String[] { getType() },
10079 new ClipData.Item(text, htmlText, null, stream));
10080 setClipData(clipData);
10081 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010082 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010083 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010084 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010085 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010086
10087 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010088 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010089 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10090 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
10091 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
10092 int num = -1;
10093 if (streams != null) {
10094 num = streams.size();
10095 }
10096 if (texts != null) {
10097 if (num >= 0 && num != texts.size()) {
10098 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010099 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010100 }
10101 num = texts.size();
10102 }
10103 if (htmlTexts != null) {
10104 if (num >= 0 && num != htmlTexts.size()) {
10105 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010106 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010107 }
10108 num = htmlTexts.size();
10109 }
10110 if (num > 0) {
10111 final ClipData clipData = new ClipData(
10112 null, new String[] { getType() },
10113 makeClipItem(streams, texts, htmlTexts, 0));
10114
10115 for (int i = 1; i < num; i++) {
10116 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
10117 }
10118
10119 setClipData(clipData);
10120 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010121 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010122 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010123 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010124 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010125 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10126 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10127 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10128 final Uri output;
10129 try {
10130 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10131 } catch (ClassCastException e) {
10132 return false;
10133 }
10134 if (output != null) {
10135 setClipData(ClipData.newRawUri("", output));
10136 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
10137 return true;
10138 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010139 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010140
10141 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010142 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010143
Michael Wright19859762017-09-18 20:57:58 +010010144 /**
10145 * Convert the dock state to a human readable format.
10146 * @hide
10147 */
10148 public static String dockStateToString(int dock) {
10149 switch (dock) {
10150 case EXTRA_DOCK_STATE_HE_DESK:
10151 return "EXTRA_DOCK_STATE_HE_DESK";
10152 case EXTRA_DOCK_STATE_LE_DESK:
10153 return "EXTRA_DOCK_STATE_LE_DESK";
10154 case EXTRA_DOCK_STATE_CAR:
10155 return "EXTRA_DOCK_STATE_CAR";
10156 case EXTRA_DOCK_STATE_DESK:
10157 return "EXTRA_DOCK_STATE_DESK";
10158 case EXTRA_DOCK_STATE_UNDOCKED:
10159 return "EXTRA_DOCK_STATE_UNDOCKED";
10160 default:
10161 return Integer.toString(dock);
10162 }
10163 }
10164
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010165 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
10166 ArrayList<String> htmlTexts, int which) {
10167 Uri uri = streams != null ? streams.get(which) : null;
10168 CharSequence text = texts != null ? texts.get(which) : null;
10169 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
10170 return new ClipData.Item(text, htmlText, null, uri);
10171 }
Craig Mautnerd00f4742014-03-12 14:17:26 -070010172
10173 /** @hide */
10174 public boolean isDocument() {
10175 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
10176 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010177}