blob: aa34da8e01590fbca80c889e5dc88a5dcdbfe17d [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;
Joel Galenson78ec58d2018-10-24 10:06:25 -070026import android.annotation.RequiresPermission;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.annotation.SdkConstant;
28import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050029import android.annotation.SystemApi;
Mathew Inwood5c0d3542018-08-14 13:54:31 +010030import android.annotation.UnsupportedAppUsage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070031import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050032import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060033import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.content.pm.PackageManager;
35import android.content.pm.ResolveInfo;
36import android.content.res.Resources;
37import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080038import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060040import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070041import android.os.Bundle;
42import android.os.IBinder;
43import android.os.Parcel;
44import android.os.Parcelable;
Suprabh Shukla96212bc2018-04-10 15:04:51 -070045import android.os.PersistableBundle;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000046import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050047import android.os.ResultReceiver;
48import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070049import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010050import android.os.UserHandle;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070051import android.provider.ContactsContract.QuickContact;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070052import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070053import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050054import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070055import android.provider.OpenableColumns;
Patrick Baumann577d4022018-01-31 16:55:10 +000056import android.text.TextUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050057import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070058import android.util.AttributeSet;
59import android.util.Log;
Yi Jin129fc6c2017-09-28 15:48:38 -070060import android.util.proto.ProtoOutputStream;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070061
Dianne Hackborn2269d1572010-02-24 19:54:22 -080062import com.android.internal.util.XmlUtils;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070063
Jason Monk2f68e8a2016-02-23 17:57:28 -050064import org.xmlpull.v1.XmlPullParser;
65import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070066import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070067
68import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080069import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070070import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070071import java.lang.annotation.Retention;
72import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070073import java.net.URISyntaxException;
74import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080075import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070076import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080077import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070078import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070079import java.util.Set;
80
81/**
82 * An intent is an abstract description of an operation to be performed. It
83 * can be used with {@link Context#startActivity(Intent) startActivity} to
84 * launch an {@link android.app.Activity},
85 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
86 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
87 * and {@link android.content.Context#startService} or
88 * {@link android.content.Context#bindService} to communicate with a
89 * background {@link android.app.Service}.
90 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070091 * <p>An Intent provides a facility for performing late runtime binding between the code in
92 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070093 * can be thought of as the glue between activities. It is basically a passive data structure
94 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070095 *
96 * <div class="special reference">
97 * <h3>Developer Guides</h3>
98 * <p>For information about how to create and resolve intents, read the
99 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
100 * developer guide.</p>
101 * </div>
102 *
103 * <a name="IntentStructure"></a>
104 * <h3>Intent Structure</h3>
105 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700106 *
107 * <ul>
108 * <li> <p><b>action</b> -- The general action to be performed, such as
109 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
110 * etc.</p>
111 * </li>
112 * <li> <p><b>data</b> -- The data to operate on, such as a person record
113 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
114 * </li>
115 * </ul>
116 *
117 *
118 * <p>Some examples of action/data pairs are:</p>
119 *
120 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700121 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700122 * information about the person whose identifier is "1".</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * the phone dialer with the person filled in.</p>
126 * </li>
127 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
128 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700129 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700130 * a particular URI.</p>
131 * </li>
132 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
133 * the phone dialer with the given number filled in.</p>
134 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700135 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700136 * information about the person whose identifier is "1".</p>
137 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700138 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700139 * a list of people, which the user can browse through. This example is a
140 * typical top-level entry into the Contacts application, showing you the
141 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700142 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700143 * being used to start an activity to display that person.</p>
144 * </li>
145 * </ul>
146 *
147 * <p>In addition to these primary attributes, there are a number of secondary
148 * attributes that you can also include with an intent:</p>
149 *
150 * <ul>
151 * <li> <p><b>category</b> -- Gives additional information about the action
152 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
153 * appear in the Launcher as a top-level application, while
154 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
155 * of alternative actions the user can perform on a piece of data.</p>
156 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
157 * intent data. Normally the type is inferred from the data itself.
158 * By setting this attribute, you disable that evaluation and force
159 * an explicit type.</p>
160 * <li> <p><b>component</b> -- Specifies an explicit name of a component
161 * class to use for the intent. Normally this is determined by looking
162 * at the other information in the intent (the action, data/type, and
163 * categories) and matching that with a component that can handle it.
164 * If this attribute is set then none of the evaluation is performed,
165 * and this component is used exactly as is. By specifying this attribute,
166 * all of the other Intent attributes become optional.</p>
167 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
168 * This can be used to provide extended information to the component.
169 * For example, if we have a action to send an e-mail message, we could
170 * also include extra pieces of data here to supply a subject, body,
171 * etc.</p>
172 * </ul>
173 *
174 * <p>Here are some examples of other operations you can specify as intents
175 * using these additional parameters:</p>
176 *
177 * <ul>
178 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
179 * Launch the home screen.</p>
180 * </li>
181 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
182 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
183 * vnd.android.cursor.item/phone}</i></b>
184 * -- Display the list of people's phone numbers, allowing the user to
185 * browse through them and pick one and return it to the parent activity.</p>
186 * </li>
187 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
188 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
189 * -- Display all pickers for data that can be opened with
190 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
191 * allowing the user to pick one of them and then some data inside of it
192 * and returning the resulting URI to the caller. This can be used,
193 * for example, in an e-mail application to allow the user to pick some
194 * data to include as an attachment.</p>
195 * </li>
196 * </ul>
197 *
198 * <p>There are a variety of standard Intent action and category constants
199 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700200 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700201 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700202 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700203 *
204 * <p>Put together, the set of actions, data types, categories, and extra data
205 * defines a language for the system allowing for the expression of phrases
206 * such as "call john smith's cell". As applications are added to the system,
207 * they can extend this language by adding new actions, types, and categories, or
208 * they can modify the behavior of existing phrases by supplying their own
209 * activities that handle them.</p>
210 *
211 * <a name="IntentResolution"></a>
212 * <h3>Intent Resolution</h3>
213 *
214 * <p>There are two primary forms of intents you will use.
215 *
216 * <ul>
217 * <li> <p><b>Explicit Intents</b> have specified a component (via
218 * {@link #setComponent} or {@link #setClass}), which provides the exact
219 * class to be run. Often these will not include any other information,
220 * simply being a way for an application to launch various internal
221 * activities it has as the user interacts with the application.
222 *
223 * <li> <p><b>Implicit Intents</b> have not specified a component;
224 * instead, they must include enough information for the system to
225 * determine which of the available components is best to run for that
226 * intent.
227 * </ul>
228 *
229 * <p>When using implicit intents, given such an arbitrary intent we need to
230 * know what to do with it. This is handled by the process of <em>Intent
231 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
232 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
233 * more activities/receivers) that can handle it.</p>
234 *
235 * <p>The intent resolution mechanism basically revolves around matching an
236 * Intent against all of the &lt;intent-filter&gt; descriptions in the
237 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
238 * objects explicitly registered with {@link Context#registerReceiver}.) More
239 * details on this can be found in the documentation on the {@link
240 * IntentFilter} class.</p>
241 *
242 * <p>There are three pieces of information in the Intent that are used for
243 * resolution: the action, type, and category. Using this information, a query
244 * is done on the {@link PackageManager} for a component that can handle the
245 * intent. The appropriate component is determined based on the intent
246 * information supplied in the <code>AndroidManifest.xml</code> file as
247 * follows:</p>
248 *
249 * <ul>
250 * <li> <p>The <b>action</b>, if given, must be listed by the component as
251 * one it handles.</p>
252 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
253 * already supplied in the Intent. Like the action, if a type is
254 * included in the intent (either explicitly or implicitly in its
255 * data), then this must be listed by the component as one it handles.</p>
256 * <li> For data that is not a <code>content:</code> URI and where no explicit
257 * type is included in the Intent, instead the <b>scheme</b> of the
258 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
259 * considered. Again like the action, if we are matching a scheme it
260 * must be listed by the component as one it can handle.
261 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
262 * by the activity as categories it handles. That is, if you include
263 * the categories {@link #CATEGORY_LAUNCHER} and
264 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
265 * with an intent that lists <em>both</em> of those categories.
266 * Activities will very often need to support the
267 * {@link #CATEGORY_DEFAULT} so that they can be found by
268 * {@link Context#startActivity Context.startActivity()}.</p>
269 * </ul>
270 *
271 * <p>For example, consider the Note Pad sample application that
Joshua Baxter9a841a62018-03-27 14:42:03 -0700272 * allows a user to browse through a list of notes data and view details about
273 * individual items. Text in italics indicates places where you would replace a
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700274 * name with one specific to your own package.</p>
275 *
276 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
277 * package="<i>com.android.notepad</i>"&gt;
278 * &lt;application android:icon="@drawable/app_notes"
279 * android:label="@string/app_name"&gt;
280 *
281 * &lt;provider class=".NotePadProvider"
282 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
283 *
284 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
285 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700286 * &lt;action android:name="android.intent.action.MAIN" /&gt;
287 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700288 * &lt;/intent-filter&gt;
289 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="android.intent.action.VIEW" /&gt;
291 * &lt;action android:name="android.intent.action.EDIT" /&gt;
292 * &lt;action android:name="android.intent.action.PICK" /&gt;
293 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700297 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
298 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
299 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700300 * &lt;/intent-filter&gt;
301 * &lt;/activity&gt;
302 *
303 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
304 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700305 * &lt;action android:name="android.intent.action.VIEW" /&gt;
306 * &lt;action android:name="android.intent.action.EDIT" /&gt;
307 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
308 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700309 * &lt;/intent-filter&gt;
310 *
311 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700312 * &lt;action android:name="android.intent.action.INSERT" /&gt;
313 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
314 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700315 * &lt;/intent-filter&gt;
316 *
317 * &lt;/activity&gt;
318 *
319 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
320 * android:theme="@android:style/Theme.Dialog"&gt;
321 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700322 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
323 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
324 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
325 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
326 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700327 * &lt;/intent-filter&gt;
328 * &lt;/activity&gt;
329 *
330 * &lt;/application&gt;
331 * &lt;/manifest&gt;</pre>
332 *
333 * <p>The first activity,
334 * <code>com.android.notepad.NotesList</code>, serves as our main
335 * entry into the app. It can do three things as described by its three intent
336 * templates:
337 * <ol>
338 * <li><pre>
339 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700340 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
341 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700342 * &lt;/intent-filter&gt;</pre>
343 * <p>This provides a top-level entry into the NotePad application: the standard
344 * MAIN action is a main entry point (not requiring any other information in
345 * the Intent), and the LAUNCHER category says that this entry point should be
346 * listed in the application launcher.</p>
347 * <li><pre>
348 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700349 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
350 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
351 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
352 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700353 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700354 * &lt;/intent-filter&gt;</pre>
355 * <p>This declares the things that the activity can do on a directory of
356 * notes. The type being supported is given with the &lt;type&gt; tag, where
357 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
358 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
359 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
360 * The activity allows the user to view or edit the directory of data (via
361 * the VIEW and EDIT actions), or to pick a particular note and return it
362 * to the caller (via the PICK action). Note also the DEFAULT category
363 * supplied here: this is <em>required</em> for the
364 * {@link Context#startActivity Context.startActivity} method to resolve your
365 * activity when its component name is not explicitly specified.</p>
366 * <li><pre>
367 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700368 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
369 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
370 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700371 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700372 * <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 -0700373 * the user without needing to know where it came from. The data type
374 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
375 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
376 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
377 * The GET_CONTENT action is similar to the PICK action, where the activity
378 * will return to its caller a piece of data selected by the user. Here,
379 * however, the caller specifies the type of data they desire instead of
380 * the type of data the user will be picking from.</p>
381 * </ol>
382 *
383 * <p>Given these capabilities, the following intents will resolve to the
384 * NotesList activity:</p>
385 *
386 * <ul>
387 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
388 * activities that can be used as top-level entry points into an
389 * application.</p>
390 * <li> <p><b>{ action=android.app.action.MAIN,
391 * category=android.app.category.LAUNCHER }</b> is the actual intent
392 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700393 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700394 * data=content://com.google.provider.NotePad/notes }</b>
395 * displays a list of all the notes under
396 * "content://com.google.provider.NotePad/notes", which
397 * the user can browse through and see the details on.</p>
398 * <li> <p><b>{ action=android.app.action.PICK
399 * data=content://com.google.provider.NotePad/notes }</b>
400 * provides a list of the notes under
401 * "content://com.google.provider.NotePad/notes", from which
402 * the user can pick a note whose data URL is returned back to the caller.</p>
403 * <li> <p><b>{ action=android.app.action.GET_CONTENT
404 * type=vnd.android.cursor.item/vnd.google.note }</b>
405 * is similar to the pick action, but allows the caller to specify the
406 * kind of data they want back so that the system can find the appropriate
407 * activity to pick something of that data type.</p>
408 * </ul>
409 *
410 * <p>The second activity,
411 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
412 * note entry and allows them to edit it. It can do two things as described
413 * by its two intent templates:
414 * <ol>
415 * <li><pre>
416 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700417 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
418 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
419 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
420 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700421 * &lt;/intent-filter&gt;</pre>
422 * <p>The first, primary, purpose of this activity is to let the user interact
423 * with a single note, as decribed by the MIME type
424 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
425 * either VIEW a note or allow the user to EDIT it. Again we support the
426 * DEFAULT category to allow the activity to be launched without explicitly
427 * specifying its component.</p>
428 * <li><pre>
429 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700430 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
431 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
432 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700433 * &lt;/intent-filter&gt;</pre>
434 * <p>The secondary use of this activity is to insert a new note entry into
435 * an existing directory of notes. This is used when the user creates a new
436 * note: the INSERT action is executed on the directory of notes, causing
437 * this activity to run and have the user create the new note data which
438 * it then adds to the content provider.</p>
439 * </ol>
440 *
441 * <p>Given these capabilities, the following intents will resolve to the
442 * NoteEditor activity:</p>
443 *
444 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700445 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700446 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
447 * shows the user the content of note <var>{ID}</var>.</p>
448 * <li> <p><b>{ action=android.app.action.EDIT
449 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
450 * allows the user to edit the content of note <var>{ID}</var>.</p>
451 * <li> <p><b>{ action=android.app.action.INSERT
452 * data=content://com.google.provider.NotePad/notes }</b>
453 * creates a new, empty note in the notes list at
454 * "content://com.google.provider.NotePad/notes"
455 * and allows the user to edit it. If they keep their changes, the URI
456 * of the newly created note is returned to the caller.</p>
457 * </ul>
458 *
459 * <p>The last activity,
460 * <code>com.android.notepad.TitleEditor</code>, allows the user to
461 * edit the title of a note. This could be implemented as a class that the
462 * application directly invokes (by explicitly setting its component in
463 * the Intent), but here we show a way you can publish alternative
464 * operations on existing data:</p>
465 *
466 * <pre>
467 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700468 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
469 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
470 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
471 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
472 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700473 * &lt;/intent-filter&gt;</pre>
474 *
475 * <p>In the single intent template here, we
476 * have created our own private action called
477 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
478 * edit the title of a note. It must be invoked on a specific note
479 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
480 * view and edit actions, but here displays and edits the title contained
481 * in the note data.
482 *
483 * <p>In addition to supporting the default category as usual, our title editor
484 * also supports two other standard categories: ALTERNATIVE and
485 * SELECTED_ALTERNATIVE. Implementing
486 * these categories allows others to find the special action it provides
487 * without directly knowing about it, through the
488 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
489 * more often to build dynamic menu items with
490 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
491 * template here was also supply an explicit name for the template
492 * (via <code>android:label="@string/resolve_title"</code>) to better control
493 * what the user sees when presented with this activity as an alternative
494 * action to the data they are viewing.
495 *
496 * <p>Given these capabilities, the following intent will resolve to the
497 * TitleEditor activity:</p>
498 *
499 * <ul>
500 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
501 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
502 * displays and allows the user to edit the title associated
503 * with note <var>{ID}</var>.</p>
504 * </ul>
505 *
506 * <h3>Standard Activity Actions</h3>
507 *
508 * <p>These are the current standard actions that Intent defines for launching
509 * activities (usually through {@link Context#startActivity}. The most
510 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
511 * {@link #ACTION_EDIT}.
512 *
513 * <ul>
514 * <li> {@link #ACTION_MAIN}
515 * <li> {@link #ACTION_VIEW}
516 * <li> {@link #ACTION_ATTACH_DATA}
517 * <li> {@link #ACTION_EDIT}
518 * <li> {@link #ACTION_PICK}
519 * <li> {@link #ACTION_CHOOSER}
520 * <li> {@link #ACTION_GET_CONTENT}
521 * <li> {@link #ACTION_DIAL}
522 * <li> {@link #ACTION_CALL}
523 * <li> {@link #ACTION_SEND}
524 * <li> {@link #ACTION_SENDTO}
525 * <li> {@link #ACTION_ANSWER}
526 * <li> {@link #ACTION_INSERT}
527 * <li> {@link #ACTION_DELETE}
528 * <li> {@link #ACTION_RUN}
529 * <li> {@link #ACTION_SYNC}
530 * <li> {@link #ACTION_PICK_ACTIVITY}
531 * <li> {@link #ACTION_SEARCH}
532 * <li> {@link #ACTION_WEB_SEARCH}
533 * <li> {@link #ACTION_FACTORY_TEST}
534 * </ul>
535 *
536 * <h3>Standard Broadcast Actions</h3>
537 *
538 * <p>These are the current standard actions that Intent defines for receiving
539 * broadcasts (usually through {@link Context#registerReceiver} or a
540 * &lt;receiver&gt; tag in a manifest).
541 *
542 * <ul>
543 * <li> {@link #ACTION_TIME_TICK}
544 * <li> {@link #ACTION_TIME_CHANGED}
545 * <li> {@link #ACTION_TIMEZONE_CHANGED}
546 * <li> {@link #ACTION_BOOT_COMPLETED}
547 * <li> {@link #ACTION_PACKAGE_ADDED}
548 * <li> {@link #ACTION_PACKAGE_CHANGED}
549 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800550 * <li> {@link #ACTION_PACKAGE_RESTARTED}
551 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000552 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
553 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700554 * <li> {@link #ACTION_UID_REMOVED}
555 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700556 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700557 * <li> {@link #ACTION_POWER_DISCONNECTED}
558 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700559 * </ul>
560 *
561 * <h3>Standard Categories</h3>
562 *
563 * <p>These are the current standard categories that can be used to further
564 * clarify an Intent via {@link #addCategory}.
565 *
566 * <ul>
567 * <li> {@link #CATEGORY_DEFAULT}
568 * <li> {@link #CATEGORY_BROWSABLE}
569 * <li> {@link #CATEGORY_TAB}
570 * <li> {@link #CATEGORY_ALTERNATIVE}
571 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
572 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800573 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700574 * <li> {@link #CATEGORY_HOME}
575 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700576 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400577 * <li> {@link #CATEGORY_CAR_DOCK}
578 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500579 * <li> {@link #CATEGORY_LE_DESK_DOCK}
580 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200581 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700582 * <li> {@link #CATEGORY_APP_MARKET}
Zak Cohendb6ca492017-01-26 14:09:00 -0800583 * <li> {@link #CATEGORY_VR_HOME}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700584 * </ul>
585 *
586 * <h3>Standard Extra Data</h3>
587 *
588 * <p>These are the current standard fields that can be used as extra data via
589 * {@link #putExtra}.
590 *
591 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800592 * <li> {@link #EXTRA_ALARM_COUNT}
593 * <li> {@link #EXTRA_BCC}
594 * <li> {@link #EXTRA_CC}
595 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
596 * <li> {@link #EXTRA_DATA_REMOVED}
597 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500598 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
599 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800600 * <li> {@link #EXTRA_DOCK_STATE_CAR}
601 * <li> {@link #EXTRA_DOCK_STATE_DESK}
602 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
603 * <li> {@link #EXTRA_DONT_KILL_APP}
604 * <li> {@link #EXTRA_EMAIL}
605 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700606 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800607 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700608 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800609 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700610 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800611 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
612 * <li> {@link #EXTRA_REPLACING}
613 * <li> {@link #EXTRA_SHORTCUT_ICON}
614 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
615 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700616 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800617 * <li> {@link #EXTRA_SHORTCUT_NAME}
618 * <li> {@link #EXTRA_SUBJECT}
619 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700620 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800621 * <li> {@link #EXTRA_TITLE}
622 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700623 * </ul>
624 *
625 * <h3>Flags</h3>
626 *
627 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800628 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
629 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800631public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700632 private static final String ATTR_ACTION = "action";
633 private static final String TAG_CATEGORIES = "categories";
634 private static final String ATTR_CATEGORY = "category";
635 private static final String TAG_EXTRA = "extra";
636 private static final String ATTR_TYPE = "type";
637 private static final String ATTR_COMPONENT = "component";
638 private static final String ATTR_DATA = "data";
639 private static final String ATTR_FLAGS = "flags";
640
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700641 // ---------------------------------------------------------------------
642 // ---------------------------------------------------------------------
643 // Standard intent activity actions (see action variable).
644
645 /**
646 * Activity Action: Start as a main entry point, does not expect to
647 * receive data.
648 * <p>Input: nothing
649 * <p>Output: nothing
650 */
651 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
652 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800653
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700654 /**
655 * Activity Action: Display the data to the user. This is the most common
656 * action performed on data -- it is the generic action you can use on
657 * a piece of data to get the most reasonable thing to occur. For example,
658 * when used on a contacts entry it will view the entry; when used on a
659 * mailto: URI it will bring up a compose window filled with the information
660 * supplied by the URI; when used with a tel: URI it will invoke the
661 * dialer.
662 * <p>Input: {@link #getData} is URI from which to retrieve data.
663 * <p>Output: nothing.
664 */
665 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
666 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800667
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700668 /**
Dianne Hackborna320f012017-04-07 13:57:48 -0700669 * Extra that can be included on activity intents coming from the storage UI
670 * when it launches sub-activities to manage various types of storage. For example,
671 * it may use {@link #ACTION_VIEW} with a "image/*" MIME type to have an app show
672 * the images on the device, and in that case also include this extra to tell the
673 * app it is coming from the storage UI so should help the user manage storage of
674 * this type.
675 */
676 public static final String EXTRA_FROM_STORAGE = "android.intent.extra.FROM_STORAGE";
677
678 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700679 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
680 * performed on a piece of data.
681 */
682 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800683
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700684 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900685 * Activity Action: Quick view the data. Launches a quick viewer for
686 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900687 * <p>Activities handling this intent action should handle the vast majority of
688 * MIME types rather than only specific ones.
Garfield Tance1d0e92017-03-23 10:52:48 -0700689 * <p>Quick viewers must render the quick view image locally, and must not send
690 * file content outside current device.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900691 * <p>Input: {@link #getData} is a mandatory content URI of the item to
692 * preview. {@link #getClipData} contains an optional list of content URIs
693 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
694 * optional index of the URI in the clip data to show first.
Garfield Tance1d0e92017-03-23 10:52:48 -0700695 * {@link #EXTRA_QUICK_VIEW_FEATURES} is an optional extra indicating the features
696 * that can be shown in the quick view UI.
Steve McKayc78bcb82015-07-31 14:35:22 -0700697 * <p>Output: nothing.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900698 * @see #EXTRA_INDEX
Garfield Tance1d0e92017-03-23 10:52:48 -0700699 * @see #EXTRA_QUICK_VIEW_FEATURES
Steve McKayc78bcb82015-07-31 14:35:22 -0700700 */
701 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
702 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
703
704 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700705 * Used to indicate that some piece of data should be attached to some other
706 * place. For example, image data could be attached to a contact. It is up
707 * to the recipient to decide where the data should be attached; the intent
708 * does not specify the ultimate destination.
709 * <p>Input: {@link #getData} is URI of data to be attached.
710 * <p>Output: nothing.
711 */
712 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
713 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 /**
716 * Activity Action: Provide explicit editable access to the given data.
717 * <p>Input: {@link #getData} is URI of data to be edited.
718 * <p>Output: nothing.
719 */
720 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
721 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800722
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700723 /**
724 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
725 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
726 * The extras can contain type specific data to pass through to the editing/creating
727 * activity.
728 * <p>Output: The URI of the item that was picked. This must be a content:
729 * URI so that any receiver can access it.
730 */
731 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
732 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800733
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700734 /**
735 * Activity Action: Pick an item from the data, returning what was selected.
736 * <p>Input: {@link #getData} is URI containing a directory of data
737 * (vnd.android.cursor.dir/*) from which to pick an item.
738 * <p>Output: The URI of the item that was picked.
739 */
740 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
741 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800742
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700743 /**
744 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800745 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800746 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
747 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700748 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
749 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800750 * (value: ShortcutIconResource).</p>
751 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800752 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700753 * @see #EXTRA_SHORTCUT_INTENT
754 * @see #EXTRA_SHORTCUT_NAME
755 * @see #EXTRA_SHORTCUT_ICON
756 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
757 * @see android.content.Intent.ShortcutIconResource
758 */
759 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
760 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
761
762 /**
763 * The name of the extra used to define the Intent of a shortcut.
764 *
765 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800766 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700767 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800768 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700769 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
770 /**
771 * The name of the extra used to define the name of a shortcut.
772 *
773 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800774 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700775 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800776 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700777 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
778 /**
779 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
780 *
781 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800782 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700783 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800784 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700785 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
786 /**
787 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
788 *
789 * @see #ACTION_CREATE_SHORTCUT
790 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800791 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700792 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800793 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700794 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
795 "android.intent.extra.shortcut.ICON_RESOURCE";
796
797 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500798 * An activity that provides a user interface for adjusting application preferences.
799 * Optional but recommended settings for all applications which have settings.
800 */
801 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
802 public static final String ACTION_APPLICATION_PREFERENCES
803 = "android.intent.action.APPLICATION_PREFERENCES";
804
805 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700806 * Activity Action: Launch an activity showing the app information.
807 * For applications which install other applications (such as app stores), it is recommended
808 * to handle this action for providing the app information to the user.
809 *
810 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
811 * to be displayed.
812 * <p>Output: Nothing.
813 */
814 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
815 public static final String ACTION_SHOW_APP_INFO
816 = "android.intent.action.SHOW_APP_INFO";
817
818 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800819 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700820 *
821 * @see Intent#ACTION_CREATE_SHORTCUT
822 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800823 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
824 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700825 */
826 public static class ShortcutIconResource implements Parcelable {
827 /**
828 * The package name of the application containing the icon.
829 */
830 public String packageName;
831
832 /**
833 * The resource name of the icon, including package, name and type.
834 */
835 public String resourceName;
836
837 /**
838 * Creates a new ShortcutIconResource for the specified context and resource
839 * identifier.
840 *
841 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700842 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700843 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700844 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700845 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700846 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700847 ShortcutIconResource icon = new ShortcutIconResource();
848 icon.packageName = context.getPackageName();
849 icon.resourceName = context.getResources().getResourceName(resourceId);
850 return icon;
851 }
852
853 /**
854 * Used to read a ShortcutIconResource from a Parcel.
855 */
856 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
857 new Parcelable.Creator<ShortcutIconResource>() {
858
859 public ShortcutIconResource createFromParcel(Parcel source) {
860 ShortcutIconResource icon = new ShortcutIconResource();
861 icon.packageName = source.readString();
862 icon.resourceName = source.readString();
863 return icon;
864 }
865
866 public ShortcutIconResource[] newArray(int size) {
867 return new ShortcutIconResource[size];
868 }
869 };
870
871 /**
872 * No special parcel contents.
873 */
874 public int describeContents() {
875 return 0;
876 }
877
878 public void writeToParcel(Parcel dest, int flags) {
879 dest.writeString(packageName);
880 dest.writeString(resourceName);
881 }
882
883 @Override
884 public String toString() {
885 return resourceName;
886 }
887 }
888
889 /**
890 * Activity Action: Display an activity chooser, allowing the user to pick
891 * what they want to before proceeding. This can be used as an alternative
892 * to the standard activity picker that is displayed by the system when
893 * you try to start an activity with multiple possible matches, with these
894 * differences in behavior:
895 * <ul>
896 * <li>You can specify the title that will appear in the activity chooser.
897 * <li>The user does not have the option to make one of the matching
898 * activities a preferred activity, and all possible activities will
899 * always be shown even if one of them is currently marked as the
900 * preferred activity.
901 * </ul>
902 * <p>
903 * This action should be used when the user will naturally expect to
904 * select an activity in order to proceed. An example if when not to use
905 * it is when the user clicks on a "mailto:" link. They would naturally
906 * expect to go directly to their mail app, so startActivity() should be
907 * called directly: it will
908 * either launch the current preferred app, or put up a dialog allowing the
909 * user to pick an app to use and optionally marking that as preferred.
910 * <p>
911 * In contrast, if the user is selecting a menu item to send a picture
912 * they are viewing to someone else, there are many different things they
913 * may want to do at this point: send it through e-mail, upload it to a
914 * web service, etc. In this case the CHOOSER action should be used, to
915 * always present to the user a list of the things they can do, with a
916 * nice title given by the caller such as "Send this photo with:".
917 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700918 * If you need to grant URI permissions through a chooser, you must specify
919 * the permissions to be granted on the ACTION_CHOOSER Intent
920 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
921 * {@link #setClipData} to specify the URIs to be granted as well as
922 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
923 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
924 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700925 * As a convenience, an Intent of this form can be created with the
926 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700927 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700928 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700929 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
930 * and can optionally have a {@link #EXTRA_TITLE} field containing the
931 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700932 * <p>
933 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700934 */
935 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
936 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
937
938 /**
939 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
940 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700941 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
942 * target intent, also optionally supplying a title. If the target
943 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
944 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
945 * set in the returned chooser intent, with its ClipData set appropriately:
946 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500947 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700948 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700949 * @param target The Intent that the user will be selecting an activity
950 * to perform.
951 * @param title Optional title that will be displayed in the chooser.
952 * @return Return a new Intent object that you can hand to
953 * {@link Context#startActivity(Intent) Context.startActivity()} and
954 * related methods.
955 */
956 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700957 return createChooser(target, title, null);
958 }
959
960 /**
961 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
962 *
963 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
964 * target intent, also optionally supplying a title. If the target
965 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
966 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
967 * set in the returned chooser intent, with its ClipData set appropriately:
968 * either a direct reflection of {@link #getClipData()} if that is non-null,
969 * or a new ClipData built from {@link #getData()}.</p>
970 *
971 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
972 * when the user makes a choice. This can be useful if the calling application wants
973 * to remember the last chosen target and surface it as a more prominent or one-touch
974 * affordance elsewhere in the UI for next time.</p>
975 *
976 * @param target The Intent that the user will be selecting an activity
977 * to perform.
978 * @param title Optional title that will be displayed in the chooser.
979 * @param sender Optional IntentSender to be called when a choice is made.
980 * @return Return a new Intent object that you can hand to
981 * {@link Context#startActivity(Intent) Context.startActivity()} and
982 * related methods.
983 */
984 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700985 Intent intent = new Intent(ACTION_CHOOSER);
986 intent.putExtra(EXTRA_INTENT, target);
987 if (title != null) {
988 intent.putExtra(EXTRA_TITLE, title);
989 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700990
Adam Powell0b3c1122014-10-09 12:50:14 -0700991 if (sender != null) {
992 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
993 }
994
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700995 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700996 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
997 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
998 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700999 if (permFlags != 0) {
1000 ClipData targetClipData = target.getClipData();
1001 if (targetClipData == null && target.getData() != null) {
1002 ClipData.Item item = new ClipData.Item(target.getData());
1003 String[] mimeTypes;
1004 if (target.getType() != null) {
1005 mimeTypes = new String[] { target.getType() };
1006 } else {
1007 mimeTypes = new String[] { };
1008 }
1009 targetClipData = new ClipData(null, mimeTypes, item);
1010 }
1011 if (targetClipData != null) {
1012 intent.setClipData(targetClipData);
1013 intent.addFlags(permFlags);
1014 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001015 }
Dianne Hackborne302a162012-05-15 14:58:32 -07001016
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001017 return intent;
1018 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001019
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001020 /**
1021 * Activity Action: Allow the user to select a particular kind of data and
1022 * return it. This is different than {@link #ACTION_PICK} in that here we
1023 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001024 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001025 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001026 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001027 * etc.
1028 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001029 * 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 -07001030 * of data, such as a person contact, you set the MIME type to the kind of
1031 * data you want and launch it with {@link Context#startActivity(Intent)}.
1032 * The system will then launch the best application to select that kind
1033 * of data for you.
1034 * <p>
1035 * You may also be interested in any of a set of types of content the user
1036 * can pick. For example, an e-mail application that wants to allow the
1037 * user to add an attachment to an e-mail message can use this action to
1038 * bring up a list of all of the types of content the user can attach.
1039 * <p>
1040 * In this case, you should wrap the GET_CONTENT intent with a chooser
1041 * (through {@link #createChooser}), which will give the proper interface
1042 * for the user to pick how to send your data and allow you to specify
1043 * a prompt indicating what they are doing. You will usually specify a
1044 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1045 * broad range of content types the user can select from.
1046 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001047 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001048 * only pick from data that can be represented as a stream. This is
1049 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1050 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001051 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001052 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001053 * is locally available on the device. For example, if this extra is set
1054 * to true then an image picker should not show any pictures that are available
1055 * from a remote server but not already on the local device (thus requiring
1056 * they be downloaded when opened).
1057 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001058 * If the caller can handle multiple returned items (the user performing
1059 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1060 * to indicate this.
1061 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001062 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1063 * that no URI is supplied in the intent, as there are no constraints on
1064 * where the returned data originally comes from. You may also include the
1065 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001066 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001067 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1068 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001069 * <p>
1070 * Output: The URI of the item that was picked. This must be a content:
1071 * URI so that any receiver can access it.
1072 */
1073 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1074 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1075 /**
1076 * Activity Action: Dial a number as specified by the data. This shows a
1077 * UI with the number being dialed, allowing the user to explicitly
1078 * initiate the call.
1079 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1080 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1081 * number.
1082 * <p>Output: nothing.
1083 */
1084 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1085 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1086 /**
1087 * Activity Action: Perform a call to someone specified by the data.
1088 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1089 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1090 * number.
1091 * <p>Output: nothing.
1092 *
1093 * <p>Note: there will be restrictions on which applications can initiate a
1094 * call; most applications should use the {@link #ACTION_DIAL}.
1095 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1096 * numbers. Applications can <strong>dial</strong> emergency numbers using
1097 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001098 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001099 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001100 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001101 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001102 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001103 */
1104 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1105 public static final String ACTION_CALL = "android.intent.action.CALL";
1106 /**
1107 * Activity Action: Perform a call to an emergency number specified by the
1108 * data.
1109 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1110 * tel: URI of an explicit phone number.
1111 * <p>Output: nothing.
1112 * @hide
1113 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001114 @SystemApi
1115 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001116 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1117 /**
1118 * Activity action: Perform a call to any number (emergency or not)
1119 * specified by the data.
1120 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1121 * tel: URI of an explicit phone number.
1122 * <p>Output: nothing.
1123 * @hide
1124 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001125 @SystemApi
1126 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001127 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
fionaxu77a744c2017-03-17 14:35:39 -07001128
Santos Cordon15a13782015-03-31 18:32:31 -07001129 /**
fionaxuadfe7002017-02-17 17:20:46 -08001130 * Activity Action: Main entry point for carrier setup apps.
1131 * <p>Carrier apps that provide an implementation for this action may be invoked to configure
1132 * carrier service and typically require
1133 * {@link android.telephony.TelephonyManager#hasCarrierPrivileges() carrier privileges} to
1134 * fulfill their duties.
1135 */
1136 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1137 public static final String ACTION_CARRIER_SETUP = "android.intent.action.CARRIER_SETUP";
1138 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001139 * Activity Action: Send a message to someone specified by the data.
1140 * <p>Input: {@link #getData} is URI describing the target.
1141 * <p>Output: nothing.
1142 */
1143 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1144 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1145 /**
1146 * Activity Action: Deliver some data to someone else. Who the data is
1147 * being delivered to is not specified; it is up to the receiver of this
1148 * action to ask the user where the data should be sent.
1149 * <p>
1150 * When launching a SEND intent, you should usually wrap it in a chooser
1151 * (through {@link #createChooser}), which will give the proper interface
1152 * for the user to pick how to send your data and allow you to specify
1153 * a prompt indicating what they are doing.
1154 * <p>
1155 * Input: {@link #getType} is the MIME type of the data being sent.
1156 * get*Extra can have either a {@link #EXTRA_TEXT}
1157 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1158 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1159 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1160 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001161 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1162 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1163 * your text with HTML formatting.
1164 * <p>
1165 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1166 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1167 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1168 * content: URIs and other advanced features of {@link ClipData}. If
1169 * using this approach, you still must supply the same data through the
1170 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1171 * for compatibility with old applications. If you don't set a ClipData,
1172 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001173 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001174 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1175 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1176 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1177 * be openable only as asset typed files using
1178 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1179 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001180 * Optional standard extras, which may be interpreted by some recipients as
1181 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1182 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1183 * <p>
1184 * Output: nothing.
1185 */
1186 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1187 public static final String ACTION_SEND = "android.intent.action.SEND";
1188 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001189 * Activity Action: Deliver multiple data to someone else.
1190 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001191 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001192 * <p>
1193 * Input: {@link #getType} is the MIME type of the data being sent.
1194 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001195 * #EXTRA_STREAM} field, containing the data to be sent. If using
1196 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1197 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001198 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001199 * Multiple types are supported, and receivers should handle mixed types
1200 * whenever possible. The right way for the receiver to check them is to
1201 * use the content resolver on each URI. The intent sender should try to
1202 * put the most concrete mime type in the intent type, but it can fall
1203 * back to {@literal <type>/*} or {@literal *}/* as needed.
1204 * <p>
1205 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1206 * be image/jpg, but if you are sending image/jpg and image/png, then the
1207 * intent's type should be image/*.
1208 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001209 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1210 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1211 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1212 * content: URIs and other advanced features of {@link ClipData}. If
1213 * using this approach, you still must supply the same data through the
1214 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1215 * for compatibility with old applications. If you don't set a ClipData,
1216 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1217 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001218 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1219 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1220 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1221 * be openable only as asset typed files using
1222 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1223 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001224 * Optional standard extras, which may be interpreted by some recipients as
1225 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1226 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1227 * <p>
1228 * Output: nothing.
1229 */
1230 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1231 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1232 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001233 * Activity Action: Handle an incoming phone call.
1234 * <p>Input: nothing.
1235 * <p>Output: nothing.
1236 */
1237 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1238 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1239 /**
1240 * Activity Action: Insert an empty item into the given container.
1241 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1242 * in which to place the data.
1243 * <p>Output: URI of the new data that was created.
1244 */
1245 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1246 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1247 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001248 * Activity Action: Create a new item in the given container, initializing it
1249 * from the current contents of the clipboard.
1250 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1251 * in which to place the data.
1252 * <p>Output: URI of the new data that was created.
1253 */
1254 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1255 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1256 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001257 * Activity Action: Delete the given data from its container.
1258 * <p>Input: {@link #getData} is URI of data to be deleted.
1259 * <p>Output: nothing.
1260 */
1261 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1262 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1263 /**
1264 * Activity Action: Run the data, whatever that means.
1265 * <p>Input: ? (Note: this is currently specific to the test harness.)
1266 * <p>Output: nothing.
1267 */
1268 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1269 public static final String ACTION_RUN = "android.intent.action.RUN";
1270 /**
1271 * Activity Action: Perform a data synchronization.
1272 * <p>Input: ?
1273 * <p>Output: ?
1274 */
1275 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1276 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1277 /**
1278 * Activity Action: Pick an activity given an intent, returning the class
1279 * selected.
1280 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1281 * used with {@link PackageManager#queryIntentActivities} to determine the
1282 * set of activities from which to pick.
1283 * <p>Output: Class name of the activity that was selected.
1284 */
1285 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1286 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1287 /**
1288 * Activity Action: Perform a search.
1289 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1290 * is the text to search for. If empty, simply
1291 * enter your search results Activity with the search UI activated.
1292 * <p>Output: nothing.
1293 */
1294 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1295 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1296 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001297 * Activity Action: Start the platform-defined tutorial
1298 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1299 * is the text to search for. If empty, simply
1300 * enter your search results Activity with the search UI activated.
1301 * <p>Output: nothing.
1302 */
1303 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1304 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1305 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001306 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001307 * <p>
1308 * Input: {@link android.app.SearchManager#QUERY
1309 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1310 * a url starts with http or https, the site will be opened. If it is plain
1311 * text, Google search will be applied.
1312 * <p>
1313 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001314 */
1315 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1316 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001317
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001318 /**
Jim Miller07994402012-05-02 14:22:27 -07001319 * Activity Action: Perform assist action.
1320 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001321 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1322 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001323 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1324 * information.
Jim Miller07994402012-05-02 14:22:27 -07001325 * Output: nothing.
1326 */
1327 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1328 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001329
1330 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001331 * Activity Action: Perform voice assist action.
1332 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001333 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1334 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001335 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001336 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001337 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001338 */
Amith Yamasani16452032017-03-03 10:15:57 -08001339 @SystemApi
Bjorn Bringertbc086862013-03-01 12:59:24 +00001340 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1341 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1342
1343 /**
Adam Skory7140a252013-09-11 12:04:58 +01001344 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1345 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001346 */
1347 public static final String EXTRA_ASSIST_PACKAGE
1348 = "android.intent.extra.ASSIST_PACKAGE";
1349
1350 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001351 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1352 * application package at the time the assist was invoked.
1353 */
1354 public static final String EXTRA_ASSIST_UID
1355 = "android.intent.extra.ASSIST_UID";
1356
1357 /**
Adam Skory7140a252013-09-11 12:04:58 +01001358 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1359 * information supplied by the current foreground app at the time of the assist request.
1360 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001361 */
1362 public static final String EXTRA_ASSIST_CONTEXT
1363 = "android.intent.extra.ASSIST_CONTEXT";
1364
Jim Miller07994402012-05-02 14:22:27 -07001365 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001366 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1367 * keyboard as the primary input device for assistance.
1368 */
1369 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1370 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1371
1372 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001373 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1374 * that was used to invoke the assist.
1375 */
1376 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1377 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1378
1379 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001380 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001381 * <p>Input: Nothing.
1382 * <p>Output: nothing.
1383 */
1384 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1385 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1386 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001387 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001388 * <p>Input: Nothing.
1389 * <p>Output: Nothing.
1390 */
1391 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1392 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1393
1394 /**
1395 * Activity Action: Show activity for reporting a bug.
1396 * <p>Input: Nothing.
1397 * <p>Output: Nothing.
1398 */
1399 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1400 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1401
1402 /**
1403 * Activity Action: Main entry point for factory tests. Only used when
1404 * the device is booting in factory test node. The implementing package
1405 * must be installed in the system image.
1406 * <p>Input: nothing
1407 * <p>Output: nothing
1408 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06001409 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001410 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1411
1412 /**
1413 * Activity Action: The user pressed the "call" button to go to the dialer
1414 * or other appropriate UI for placing a call.
1415 * <p>Input: Nothing.
1416 * <p>Output: Nothing.
1417 */
1418 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1419 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1420
1421 /**
1422 * Activity Action: Start Voice Command.
1423 * <p>Input: Nothing.
1424 * <p>Output: Nothing.
Christopher Tate72da1e62018-05-10 13:09:48 -07001425 * <p class="note">
1426 * In some cases, a matching Activity may not exist, so ensure you
1427 * safeguard against this.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001428 */
1429 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1430 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001431
1432 /**
1433 * Activity Action: Start action associated with long pressing on the
1434 * search key.
1435 * <p>Input: Nothing.
1436 * <p>Output: Nothing.
1437 */
1438 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1439 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001440
Jacek Surazski86b6c532009-05-13 14:38:28 +02001441 /**
1442 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1443 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001444 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001445 * <p>Input: No data is specified. The bug report is passed in using
1446 * an {@link #EXTRA_BUG_REPORT} field.
1447 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001448 *
1449 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001450 */
1451 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1452 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001453
1454 /**
1455 * Activity Action: Show power usage information to the user.
1456 * <p>Input: Nothing.
1457 * <p>Output: Nothing.
1458 */
1459 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1460 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001461
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001462 /**
Russell Brenner4cd32e52017-02-24 11:11:47 -08001463 * Activity Action: Setup wizard action provided for OTA provisioning to determine if it needs
1464 * to run.
1465 * <p>Input: Nothing.
1466 * <p>Output: Nothing.
1467 * @deprecated As of {@link android.os.Build.VERSION_CODES#M}, setup wizard can be identified
1468 * using {@link #ACTION_MAIN} and {@link #CATEGORY_SETUP_WIZARD}
1469 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001470 * @removed
Russell Brenner4cd32e52017-02-24 11:11:47 -08001471 */
1472 @Deprecated
1473 @SystemApi
1474 public static final String ACTION_DEVICE_INITIALIZATION_WIZARD =
1475 "android.intent.action.DEVICE_INITIALIZATION_WIZARD";
1476
1477 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001478 * Activity Action: Setup wizard to launch after a platform update. This
1479 * activity should have a string meta-data field associated with it,
1480 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1481 * the platform for setup. The activity will be launched only if
1482 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1483 * same value.
1484 * <p>Input: Nothing.
1485 * <p>Output: Nothing.
1486 * @hide
1487 */
Russell Brenner4cd32e52017-02-24 11:11:47 -08001488 @SystemApi
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001489 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1490 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001491
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001492 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001493 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1494 * <p>Input: Nothing.
1495 * <p>Output: Nothing.
1496 * @hide
1497 */
1498 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1499 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001500 "com.android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001501
1502 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001503 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1504 * <p>Input: Nothing.
1505 * <p>Output: Nothing.
1506 * @hide
1507 */
1508 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1509 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001510 "com.android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001511
1512 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001513 * Activity Action: Show settings for managing network data usage of a
1514 * specific application. Applications should define an activity that offers
1515 * options to control data usage.
1516 */
1517 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1518 public static final String ACTION_MANAGE_NETWORK_USAGE =
1519 "android.intent.action.MANAGE_NETWORK_USAGE";
1520
1521 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001522 * Activity Action: Launch application installer.
1523 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001524 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001525 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1526 * you can also use "package:<package-name>" to install an application for the
1527 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001528 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1529 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1530 * <p>
1531 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1532 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001533 * <p>
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001534 * <strong>Note:</strong>If your app is targeting API level higher than 25 you
Svet Ganov86877e42015-05-28 08:19:48 -07001535 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1536 * in order to launch the application installer.
1537 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001538 *
1539 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1540 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1541 * @see #EXTRA_RETURN_RESULT
Philip P. Moltmannfe460102018-09-25 10:22:32 -07001542 *
1543 * @deprecated use {@link android.content.pm.PackageInstaller} instead
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001544 */
Philip P. Moltmannfe460102018-09-25 10:22:32 -07001545 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001546 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1547 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1548
1549 /**
Todd Kennedyd0084f72017-07-28 13:56:14 -07001550 * Activity Action: Activity to handle split installation failures.
1551 * <p>Splits may be installed dynamically. This happens when an Activity is launched,
1552 * but the split that contains the application isn't installed. When a split is
1553 * installed in this manner, the containing package usually doesn't know this is
1554 * happening. However, if an error occurs during installation, the containing
1555 * package can define a single activity handling this action to deal with such
1556 * failures.
1557 * <p>The activity handling this action must be in the base package.
1558 * <p>
1559 * Input: {@link #EXTRA_INTENT} the original intent that started split installation.
1560 * {@link #EXTRA_SPLIT_NAME} the name of the split that failed to be installed.
1561 */
1562 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1563 public static final String ACTION_INSTALL_FAILURE = "android.intent.action.INSTALL_FAILURE";
1564
1565 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001566 * 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 * Service Action: Resolve instant application.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001580 * <p>
1581 * The system will have a persistent connection to this service.
1582 * This is a protected intent that can only be sent by the system.
1583 * </p>
1584 *
1585 * @hide
1586 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001587 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001588 @SdkConstant(SdkConstantType.SERVICE_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001589 public static final String ACTION_RESOLVE_INSTANT_APP_PACKAGE
1590 = "android.intent.action.RESOLVE_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001591
1592 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001593 * Activity Action: Launch instant app settings.
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001594 *
1595 * <p class="note">
1596 * This is a protected intent that can only be sent by the system.
1597 * </p>
1598 *
1599 * @hide
1600 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001601 @SystemApi
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001602 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001603 public static final String ACTION_INSTANT_APP_RESOLVER_SETTINGS
1604 = "android.intent.action.INSTANT_APP_RESOLVER_SETTINGS";
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001605
1606 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001607 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1608 * package. Specifies the installer package name; this package will receive the
1609 * {@link #ACTION_APP_ERROR} intent.
1610 */
1611 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1612 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1613
1614 /**
1615 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1616 * package. Specifies that the application being installed should not be
1617 * treated as coming from an unknown source, but as coming from the app
1618 * invoking the Intent. For this to work you must start the installer with
1619 * startActivityForResult().
1620 */
1621 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1622 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1623
1624 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001625 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1626 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001627 * data field originated from.
1628 */
rich cannings706e8ba2012-08-20 13:20:14 -07001629 public static final String EXTRA_ORIGINATING_URI
1630 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001631
1632 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001633 * This extra can be used with any Intent used to launch an activity, supplying information
1634 * about who is launching that activity. This field contains a {@link android.net.Uri}
1635 * object, typically an http: or https: URI of the web site that the referral came from;
1636 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1637 * a native application that it came from.
1638 *
1639 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1640 * instead of directly retrieving the extra. It is also valid for applications to
1641 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1642 * a string, not a Uri; the field here, if supplied, will always take precedence,
1643 * however.</p>
1644 *
1645 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001646 */
1647 public static final String EXTRA_REFERRER
1648 = "android.intent.extra.REFERRER";
1649
1650 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001651 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1652 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1653 * not be created, in particular when Intent extras are supplied through the
1654 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1655 * schemes.
1656 *
1657 * @see #EXTRA_REFERRER
1658 */
1659 public static final String EXTRA_REFERRER_NAME
1660 = "android.intent.extra.REFERRER_NAME";
1661
1662 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001663 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001664 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001665 * Currently only a system app that hosts the provider authority "downloads" or holds the
1666 * permission {@link android.Manifest.permission.MANAGE_DOCUMENTS} can use this.
Ben Gruver37d83a32012-09-27 13:02:06 -07001667 * @hide
1668 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001669 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001670 public static final String EXTRA_ORIGINATING_UID
1671 = "android.intent.extra.ORIGINATING_UID";
1672
1673 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001674 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1675 * package. Tells the installer UI to skip the confirmation with the user
1676 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001677 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1678 * will no longer show an interstitial message about updating existing
1679 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001680 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001681 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001682 public static final String EXTRA_ALLOW_REPLACE
1683 = "android.intent.extra.ALLOW_REPLACE";
1684
1685 /**
1686 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1687 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1688 * return to the application the result code of the install/uninstall. The returned result
1689 * code will be {@link android.app.Activity#RESULT_OK} on success or
1690 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1691 */
1692 public static final String EXTRA_RETURN_RESULT
1693 = "android.intent.extra.RETURN_RESULT";
1694
1695 /**
1696 * Package manager install result code. @hide because result codes are not
1697 * yet ready to be exposed.
1698 */
1699 public static final String EXTRA_INSTALL_RESULT
1700 = "android.intent.extra.INSTALL_RESULT";
1701
1702 /**
1703 * Activity Action: Launch application uninstaller.
1704 * <p>
1705 * Input: The data must be a package: URI whose scheme specific part is
1706 * the package name of the current installed package to be uninstalled.
1707 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1708 * <p>
1709 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1710 * succeeded.
Philip P. Moltmannd9bb39a2017-09-05 12:41:15 -07001711 * <p>
1712 * Requires {@link android.Manifest.permission#REQUEST_DELETE_PACKAGES}
1713 * since {@link Build.VERSION_CODES#P}.
Philip P. Moltmannfe460102018-09-25 10:22:32 -07001714 *
1715 * @deprecated Use {@link android.content.pm.PackageInstaller#uninstall(String, IntentSender)}
1716 * instead
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001717 */
Philip P. Moltmannfe460102018-09-25 10:22:32 -07001718 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001719 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1720 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1721
1722 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001723 * Specify whether the package should be uninstalled for all users.
1724 * @hide because these should not be part of normal application flow.
1725 */
1726 public static final String EXTRA_UNINSTALL_ALL_USERS
1727 = "android.intent.extra.UNINSTALL_ALL_USERS";
1728
1729 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001730 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1731 * describing the last run version of the platform that was setup.
1732 * @hide
1733 */
1734 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1735
Svet Ganov3695b8a2015-03-24 16:30:25 -07001736 /**
1737 * Activity action: Launch UI to manage the permissions of an app.
1738 * <p>
1739 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1740 * will be managed by the launched UI.
1741 * </p>
1742 * <p>
1743 * Output: Nothing.
1744 * </p>
1745 *
1746 * @see #EXTRA_PACKAGE_NAME
1747 *
1748 * @hide
1749 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001750 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001751 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1752 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1753 "android.intent.action.MANAGE_APP_PERMISSIONS";
1754
1755 /**
Philip P. Moltmanned988282018-11-07 16:19:42 -08001756 * Activity action: Launch UI to manage a specific permissions of an app.
1757 * <p>
1758 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permission
1759 * will be managed by the launched UI.
1760 * </p>
1761 * <p>
1762 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the (individual) permission
1763 * that should be managed by the launched UI.
1764 * </p>
1765 * <p>
1766 * Output: Nothing.
1767 * </p>
1768 *
1769 * @see #EXTRA_PACKAGE_NAME
1770 * @see #EXTRA_PERMISSION_NAME
1771 *
1772 * @hide
1773 */
1774 @SystemApi
1775 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1776 public static final String ACTION_MANAGE_APP_PERMISSION =
1777 "android.intent.action.MANAGE_APP_PERMISSION";
1778
1779 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001780 * Activity action: Launch UI to manage permissions.
1781 * <p>
1782 * Input: Nothing.
1783 * </p>
1784 * <p>
1785 * Output: Nothing.
1786 * </p>
1787 *
1788 * @hide
1789 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001790 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001791 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1792 public static final String ACTION_MANAGE_PERMISSIONS =
1793 "android.intent.action.MANAGE_PERMISSIONS";
1794
1795 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001796 * Activity action: Launch UI to review permissions for an app.
1797 * The system uses this intent if permission review for apps not
1798 * supporting the new runtime permissions model is enabled. In
1799 * this mode a permission review is required before any of the
1800 * app components can run.
1801 * <p>
1802 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1803 * permissions will be reviewed (mandatory).
1804 * </p>
1805 * <p>
1806 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1807 * be fired after the permission review (optional).
1808 * </p>
1809 * <p>
1810 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1811 * be invoked after the permission review (optional).
1812 * </p>
1813 * <p>
1814 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1815 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1816 * </p>
1817 * <p>
1818 * Output: Nothing.
1819 * </p>
1820 *
1821 * @see #EXTRA_PACKAGE_NAME
1822 * @see #EXTRA_INTENT
1823 * @see #EXTRA_REMOTE_CALLBACK
1824 * @see #EXTRA_RESULT_NEEDED
1825 *
1826 * @hide
1827 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001828 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001829 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1830 public static final String ACTION_REVIEW_PERMISSIONS =
1831 "android.intent.action.REVIEW_PERMISSIONS";
1832
1833 /**
1834 * Intent extra: A callback for reporting remote result as a bundle.
1835 * <p>
1836 * Type: IRemoteCallback
1837 * </p>
1838 *
1839 * @hide
1840 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001841 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001842 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1843
1844 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001845 * Intent extra: An app package name.
1846 * <p>
1847 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001848 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001849 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001850 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001851 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1852
1853 /**
Suprabh Shukla96212bc2018-04-10 15:04:51 -07001854 * Intent extra: A {@link Bundle} of extras for a package being suspended. Will be sent as an
1855 * extra with {@link #ACTION_MY_PACKAGE_SUSPENDED}.
1856 *
1857 * <p>The contents of this {@link Bundle} are a contract between the suspended app and the
1858 * suspending app, i.e. any app with the permission {@code android.permission.SUSPEND_APPS}.
1859 * This is meant to enable the suspended app to better handle the state of being suspended.
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07001860 *
1861 * @see #ACTION_MY_PACKAGE_SUSPENDED
1862 * @see #ACTION_MY_PACKAGE_UNSUSPENDED
1863 * @see PackageManager#isPackageSuspended()
1864 * @see PackageManager#getSuspendedPackageAppExtras()
1865 */
1866 public static final String EXTRA_SUSPENDED_PACKAGE_EXTRAS = "android.intent.extra.SUSPENDED_PACKAGE_EXTRAS";
1867
1868 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001869 * Intent extra: An app split name.
1870 * <p>
1871 * Type: String
1872 * </p>
Todd Kennedye5195dd2016-10-19 15:29:19 -07001873 */
Todd Kennedye5195dd2016-10-19 15:29:19 -07001874 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1875
1876 /**
Jeff Sharkey1a749422017-04-28 14:19:50 -06001877 * Intent extra: A {@link ComponentName} value.
1878 * <p>
1879 * Type: String
1880 * </p>
1881 */
1882 public static final String EXTRA_COMPONENT_NAME = "android.intent.extra.COMPONENT_NAME";
1883
1884 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001885 * Intent extra: An extra for specifying whether a result is needed.
1886 * <p>
1887 * Type: boolean
1888 * </p>
1889 *
1890 * @hide
1891 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001892 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001893 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1894
1895 /**
Suprabh Shukla19b41f32018-03-26 22:35:13 -07001896 * Intent extra: A {@link Bundle} of extras supplied for the launcher when any packages on
1897 * device are suspended. Will be sent with {@link #ACTION_PACKAGES_SUSPENDED}.
1898 *
1899 * @see PackageManager#isPackageSuspended()
1900 * @see #ACTION_PACKAGES_SUSPENDED
1901 *
1902 * @hide
1903 */
1904 public static final String EXTRA_LAUNCHER_EXTRAS = "android.intent.extra.LAUNCHER_EXTRAS";
1905
1906 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001907 * Activity action: Launch UI to manage which apps have a given permission.
1908 * <p>
Philip P. Moltmanned988282018-11-07 16:19:42 -08001909 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission group
1910 * which will be managed by the launched UI.
Svet Ganov3695b8a2015-03-24 16:30:25 -07001911 * </p>
1912 * <p>
1913 * Output: Nothing.
1914 * </p>
1915 *
1916 * @see #EXTRA_PERMISSION_NAME
1917 *
1918 * @hide
1919 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001920 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001921 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1922 public static final String ACTION_MANAGE_PERMISSION_APPS =
1923 "android.intent.action.MANAGE_PERMISSION_APPS";
1924
1925 /**
1926 * Intent extra: The name of a permission.
1927 * <p>
1928 * Type: String
1929 * </p>
1930 *
1931 * @hide
1932 */
1933 @SystemApi
1934 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1935
Joel Galenson13096ea2018-09-27 11:18:44 -07001936 /**
1937 * Activity action: Launch UI to review app uses of permissions.
1938 * <p>
1939 * Input: Nothing
1940 * </p>
1941 * <p>
1942 * Output: Nothing.
1943 * </p>
1944 *
1945 * @hide
1946 */
1947 @SystemApi
1948 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1949 public static final String ACTION_REVIEW_PERMISSION_USAGE =
1950 "android.intent.action.REVIEW_PERMISSION_USAGE";
1951
Joel Galenson78ec58d2018-10-24 10:06:25 -07001952 /**
1953 * Activity action: Launch UI to review uses of permissions for a single app.
1954 * <p>
1955 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1956 * permissions will be reviewed (mandatory).
1957 * </p>
1958 * <p>
1959 * Output: Nothing.
1960 * </p>
1961 * <p class="note">
1962 * This requires {@link android.Manifest.permission#GRANT_RUNTIME_PERMISSIONS} permission.
1963 * </p>
1964 *
1965 * @see #EXTRA_PACKAGE_NAME
1966 *
1967 * @hide
1968 */
1969 @SystemApi
1970 @RequiresPermission(android.Manifest.permission.GRANT_RUNTIME_PERMISSIONS)
1971 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1972 public static final String ACTION_REVIEW_APP_PERMISSION_USAGE =
1973 "android.intent.action.REVIEW_APP_PERMISSION_USAGE";
1974
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001975 // ---------------------------------------------------------------------
1976 // ---------------------------------------------------------------------
1977 // Standard intent broadcast actions (see action variable).
1978
1979 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001980 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1981 * <p>
1982 * For historical reasons, the name of this broadcast action refers to the power
1983 * state of the screen but it is actually sent in response to changes in the
1984 * overall interactive state of the device.
1985 * </p><p>
1986 * This broadcast is sent when the device becomes non-interactive which may have
1987 * nothing to do with the screen turning off. To determine the
1988 * actual state of the screen, use {@link android.view.Display#getState}.
1989 * </p><p>
1990 * See {@link android.os.PowerManager#isInteractive} for details.
1991 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001992 * You <em>cannot</em> receive this through components declared in
1993 * manifests, only by explicitly registering for it with
1994 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1995 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001996 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001997 * <p class="note">This is a protected intent that can only be sent
1998 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07002002
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002003 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07002004 * Broadcast Action: Sent when the device wakes up and becomes interactive.
2005 * <p>
2006 * For historical reasons, the name of this broadcast action refers to the power
2007 * state of the screen but it is actually sent in response to changes in the
2008 * overall interactive state of the device.
2009 * </p><p>
2010 * This broadcast is sent when the device becomes interactive which may have
2011 * nothing to do with the screen turning on. To determine the
2012 * actual state of the screen, use {@link android.view.Display#getState}.
2013 * </p><p>
2014 * See {@link android.os.PowerManager#isInteractive} for details.
2015 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07002016 * You <em>cannot</em> receive this through components declared in
2017 * manifests, only by explicitly registering for it with
2018 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2019 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002020 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002021 * <p class="note">This is a protected intent that can only be sent
2022 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002023 */
2024 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2025 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07002026
2027 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07002028 * Broadcast Action: Sent after the system stops dreaming.
2029 *
2030 * <p class="note">This is a protected intent that can only be sent by the system.
2031 * It is only sent to registered receivers.</p>
2032 */
2033 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2034 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
2035
2036 /**
2037 * Broadcast Action: Sent after the system starts dreaming.
2038 *
2039 * <p class="note">This is a protected intent that can only be sent by the system.
2040 * It is only sent to registered receivers.</p>
2041 */
2042 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2043 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
2044
2045 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07002046 * 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 -07002047 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08002048 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002049 * <p class="note">This is a protected intent that can only be sent
2050 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07002051 */
2052 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002053 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07002054
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002055 /**
2056 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07002057 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04002058 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002059 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2060 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002061 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002062 * <p class="note">This is a protected intent that can only be sent
2063 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002064 */
2065 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2066 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
2067 /**
2068 * Broadcast Action: The time was set.
2069 */
2070 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2071 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
2072 /**
2073 * Broadcast Action: The date has changed.
2074 */
2075 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2076 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
2077 /**
2078 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
2079 * <ul>
2080 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
2081 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002082 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002083 * <p class="note">This is a protected intent that can only be sent
2084 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002085 */
2086 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2087 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
2088 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07002089 * Clear DNS Cache Action: This is broadcast when networks have changed and old
2090 * DNS entries should be tossed.
2091 * @hide
2092 */
2093 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2094 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
2095 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002096 * Alarm Changed Action: This is broadcast when the AlarmClock
2097 * application's alarm is set or unset. It is used by the
2098 * AlarmClock application and the StatusBar service.
2099 * @hide
2100 */
2101 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002102 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002103 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002104
2105 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002106 * Broadcast Action: This is broadcast once, after the user has finished
2107 * booting, but while still in the "locked" state. It can be used to perform
2108 * application-specific initialization, such as installing alarms. You must
2109 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
2110 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002111 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002112 * This broadcast is sent immediately at boot by all devices (regardless of
2113 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
2114 * higher. Upon receipt of this broadcast, the user is still locked and only
2115 * device-protected storage can be accessed safely. If you want to access
2116 * credential-protected storage, you need to wait for the user to be
2117 * unlocked (typically by entering their lock pattern or PIN for the first
2118 * time), after which the {@link #ACTION_USER_UNLOCKED} and
2119 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
2120 * <p>
2121 * To receive this broadcast, your receiver component must be marked as
2122 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002123 * <p class="note">
2124 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002125 *
2126 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002127 */
2128 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2129 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2130
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002131 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002132 * Broadcast Action: This is broadcast once, after the user has finished
2133 * booting. It can be used to perform application-specific initialization,
2134 * such as installing alarms. You must hold the
2135 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2136 * order to receive this broadcast.
2137 * <p>
2138 * This broadcast is sent at boot by all devices (both with and without
2139 * direct boot support). Upon receipt of this broadcast, the user is
2140 * unlocked and both device-protected and credential-protected storage can
2141 * accessed safely.
2142 * <p>
2143 * If you need to run while the user is still locked (before they've entered
2144 * their lock pattern or PIN for the first time), you can listen for the
2145 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2146 * <p class="note">
2147 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002148 */
2149 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002150 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002151 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002152
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002153 /**
2154 * Broadcast Action: This is broadcast when a user action should request a
2155 * temporary system dialog to dismiss. Some examples of temporary system
2156 * dialogs are the notification window-shade and the recent tasks dialog.
2157 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002158 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002159 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2160 /**
2161 * Broadcast Action: Trigger the download and eventual installation
2162 * of a package.
2163 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002164 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002165 * <p class="note">This is a protected intent that can only be sent
2166 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002167 *
2168 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002169 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002170 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002171 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2172 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2173 /**
Christopher Tate94b91db2017-04-19 15:49:17 -07002174 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002175 * device. The data contains the name of the package. Note that the
2176 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002177 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002178 * <ul>
Christopher Tate94b91db2017-04-19 15:49:17 -07002179 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2180 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002181 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2182 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002183 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002184 * <p class="note">This is a protected intent that can only be sent
2185 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002186 */
2187 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2188 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2189 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002190 * Broadcast Action: A new version of an application package has been
2191 * installed, replacing an existing version that was previously installed.
2192 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002193 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002194 * <ul>
2195 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2196 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002197 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002198 * <p class="note">This is a protected intent that can only be sent
2199 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002200 */
2201 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2202 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2203 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002204 * Broadcast Action: A new version of your application has been installed
2205 * over an existing one. This is only sent to the application that was
2206 * replaced. It does not contain any additional data; to receive it, just
2207 * use an intent filter for this action.
2208 *
2209 * <p class="note">This is a protected intent that can only be sent
2210 * by the system.
2211 */
2212 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2213 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2214 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002215 * Broadcast Action: An existing application package has been removed from
2216 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002217 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002218 * <ul>
2219 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2220 * to the package.
2221 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2222 * application -- data and code -- is being removed.
2223 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2224 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2225 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002226 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002227 * <p class="note">This is a protected intent that can only be sent
2228 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002229 */
2230 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2231 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2232 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002233 * Broadcast Action: An existing application package has been completely
2234 * removed from the device. The data contains the name of the package.
2235 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2236 * {@link #EXTRA_DATA_REMOVED} is true and
2237 * {@link #EXTRA_REPLACING} is false of that broadcast.
2238 *
2239 * <ul>
2240 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2241 * to the package.
2242 * </ul>
2243 *
2244 * <p class="note">This is a protected intent that can only be sent
2245 * by the system.
2246 */
2247 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2248 public static final String ACTION_PACKAGE_FULLY_REMOVED
2249 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2250 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002251 * Broadcast Action: An existing application package has been changed (for
2252 * example, a component has been enabled or disabled). The data contains
2253 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002254 * <ul>
2255 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002256 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002257 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002258 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2259 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002260 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002261 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002262 * <p class="note">This is a protected intent that can only be sent
2263 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002264 */
2265 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2266 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2267 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002268 * @hide
2269 * Broadcast Action: Ask system services if there is any reason to
2270 * restart the given package. The data contains the name of the
2271 * package.
2272 * <ul>
2273 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2274 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2275 * </ul>
2276 *
2277 * <p class="note">This is a protected intent that can only be sent
2278 * by the system.
2279 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002280 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002281 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2282 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2283 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002284 * Broadcast Action: The user has restarted a package, and all of its
2285 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002286 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002287 * be removed. Note that the restarted package does <em>not</em>
2288 * receive this broadcast.
2289 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002290 * <ul>
2291 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2292 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002293 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002294 * <p class="note">This is a protected intent that can only be sent
2295 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002296 */
2297 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2298 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2299 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002300 * Broadcast Action: The user has cleared the data of a package. This should
2301 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002302 * its persistent data is erased and this broadcast sent.
2303 * Note that the cleared package does <em>not</em>
2304 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002305 * <ul>
Svet Ganovf935a702017-08-22 12:15:58 -07002306 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package. If the
2307 * package whose data was cleared is an uninstalled instant app, then the UID
2308 * will be -1. The platform keeps some meta-data associated with instant apps
2309 * after they are uninstalled.
2310 * <li> {@link #EXTRA_PACKAGE_NAME} containing the package name only if the cleared
2311 * data was for an instant app.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002312 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002313 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002314 * <p class="note">This is a protected intent that can only be sent
2315 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002316 */
2317 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2318 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2319 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002320 * Broadcast Action: Packages have been suspended.
2321 * <p>Includes the following extras:
2322 * <ul>
2323 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
Julia Reynolds4bc42b92018-08-14 11:27:35 -04002324 * <li> {@link #EXTRA_CHANGED_UID_LIST} is the set of uids which have been suspended
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002325 * </ul>
2326 *
2327 * <p class="note">This is a protected intent that can only be sent
2328 * by the system. It is only sent to registered receivers.
2329 */
2330 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2331 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2332 /**
2333 * Broadcast Action: Packages have been unsuspended.
2334 * <p>Includes the following extras:
2335 * <ul>
2336 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
Julia Reynolds4bc42b92018-08-14 11:27:35 -04002337 * <li> {@link #EXTRA_CHANGED_UID_LIST} is the set of uids which have been unsuspended
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002338 * </ul>
2339 *
2340 * <p class="note">This is a protected intent that can only be sent
2341 * by the system. It is only sent to registered receivers.
2342 */
2343 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2344 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002345
2346 /**
2347 * Broadcast Action: Sent to a package that has been suspended by the system. This is sent
Suprabh Shukla19b41f32018-03-26 22:35:13 -07002348 * whenever a package is put into a suspended state or any of its app extras change while in the
2349 * suspended state.
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002350 * <p> Optionally includes the following extras:
2351 * <ul>
2352 * <li> {@link #EXTRA_SUSPENDED_PACKAGE_EXTRAS} which is a {@link Bundle} which will contain
2353 * useful information for the app being suspended.
2354 * </ul>
2355 * <p class="note">This is a protected intent that can only be sent
2356 * by the system. <em>This will be delivered to {@link BroadcastReceiver} components declared in
2357 * the manifest.</em>
2358 *
2359 * @see #ACTION_MY_PACKAGE_UNSUSPENDED
2360 * @see #EXTRA_SUSPENDED_PACKAGE_EXTRAS
2361 * @see PackageManager#isPackageSuspended()
2362 * @see PackageManager#getSuspendedPackageAppExtras()
2363 */
2364 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2365 public static final String ACTION_MY_PACKAGE_SUSPENDED = "android.intent.action.MY_PACKAGE_SUSPENDED";
2366
2367 /**
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002368 * Activity Action: Started to show more details about why an application was suspended.
2369 *
Suprabh Shukla3e03ab92018-04-11 16:03:49 -07002370 * <p>Whenever the system detects an activity launch for a suspended app, this action can
2371 * be used to show more details about the reason for suspension.
Suprabh Shukla96212bc2018-04-10 15:04:51 -07002372 *
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002373 * <p>Apps holding {@link android.Manifest.permission#SUSPEND_APPS} must declare an activity
2374 * handling this intent and protect it with
2375 * {@link android.Manifest.permission#SEND_SHOW_SUSPENDED_APP_DETAILS}.
2376 *
2377 * <p>Includes an extra {@link #EXTRA_PACKAGE_NAME} which is the name of the suspended package.
2378 *
2379 * <p class="note">This is a protected intent that can only be sent
2380 * by the system.
2381 *
Suprabh Shukla96212bc2018-04-10 15:04:51 -07002382 * @see PackageManager#setPackagesSuspended(String[], boolean, PersistableBundle,
2383 * PersistableBundle, String)
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002384 * @see PackageManager#isPackageSuspended()
2385 * @see #ACTION_PACKAGES_SUSPENDED
2386 *
2387 * @hide
2388 */
2389 @SystemApi
2390 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2391 public static final String ACTION_SHOW_SUSPENDED_APP_DETAILS =
2392 "android.intent.action.SHOW_SUSPENDED_APP_DETAILS";
2393
2394 /**
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002395 * Broadcast Action: Sent to a package that has been unsuspended.
2396 *
2397 * <p class="note">This is a protected intent that can only be sent
2398 * by the system. <em>This will be delivered to {@link BroadcastReceiver} components declared in
2399 * the manifest.</em>
2400 *
2401 * @see #ACTION_MY_PACKAGE_SUSPENDED
2402 * @see #EXTRA_SUSPENDED_PACKAGE_EXTRAS
2403 * @see PackageManager#isPackageSuspended()
2404 * @see PackageManager#getSuspendedPackageAppExtras()
2405 */
2406 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2407 public static final String ACTION_MY_PACKAGE_UNSUSPENDED = "android.intent.action.MY_PACKAGE_UNSUSPENDED";
2408
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002409 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002410 * Broadcast Action: A user ID has been removed from the system. The user
2411 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002412 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002413 * <p class="note">This is a protected intent that can only be sent
2414 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002415 */
2416 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2417 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002418
2419 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002420 * Broadcast Action: Sent to the installer package of an application when
2421 * that application is first launched (that is the first time it is moved
2422 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002423 *
2424 * <p class="note">This is a protected intent that can only be sent
2425 * by the system.
2426 */
2427 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2428 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2429
2430 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002431 * Broadcast Action: Sent to the system package verifier when a package
2432 * needs to be verified. The data contains the package URI.
2433 * <p class="note">
2434 * This is a protected intent that can only be sent by the system.
2435 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002436 */
2437 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2438 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2439
2440 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002441 * Broadcast Action: Sent to the system package verifier when a package is
2442 * verified. The data contains the package URI.
2443 * <p class="note">
2444 * This is a protected intent that can only be sent by the system.
2445 */
2446 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2447 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2448
2449 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002450 * Broadcast Action: Sent to the system intent filter verifier when an
2451 * intent filter needs to be verified. The data contains the filter data
2452 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002453 * <p class="note">
2454 * This is a protected intent that can only be sent by the system.
2455 * </p>
2456 *
2457 * @hide
2458 */
2459 @SystemApi
2460 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2461 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2462
2463 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002464 * Broadcast Action: Resources for a set of packages (which were
2465 * previously unavailable) are currently
2466 * available since the media on which they exist is available.
2467 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2468 * list of packages whose availability changed.
2469 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2470 * list of uids of packages whose availability changed.
2471 * Note that the
2472 * packages in this list do <em>not</em> receive this broadcast.
2473 * The specified set of packages are now available on the system.
2474 * <p>Includes the following extras:
2475 * <ul>
2476 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2477 * whose resources(were previously unavailable) are currently available.
2478 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2479 * packages whose resources(were previously unavailable)
2480 * are currently available.
2481 * </ul>
2482 *
2483 * <p class="note">This is a protected intent that can only be sent
2484 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002485 */
2486 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002487 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2488 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002489
2490 /**
2491 * Broadcast Action: Resources for a set of packages are currently
2492 * unavailable since the media on which they exist is unavailable.
2493 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2494 * list of packages whose availability changed.
2495 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2496 * list of uids of packages whose availability changed.
2497 * The specified set of packages can no longer be
2498 * launched and are practically unavailable on the system.
2499 * <p>Inclues the following extras:
2500 * <ul>
2501 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2502 * whose resources are no longer available.
2503 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2504 * whose resources are no longer available.
2505 * </ul>
2506 *
2507 * <p class="note">This is a protected intent that can only be sent
2508 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002509 */
2510 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002511 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002512 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002513
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002514 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002515 * Broadcast Action: preferred activities have changed *explicitly*.
2516 *
2517 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2518 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2519 * be sent.
2520 *
2521 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2522 *
2523 * @hide
2524 */
2525 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2526 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2527 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2528
2529
2530 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002531 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002532 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002533 * This should <em>only</em> be used to determine when the wallpaper
2534 * has changed to show the new wallpaper to the user. You should certainly
2535 * never, in response to this, change the wallpaper or other attributes of
2536 * it such as the suggested size. That would be crazy, right? You'd cause
2537 * all kinds of loops, especially if other apps are doing similar things,
2538 * right? Of course. So please don't do this.
2539 *
2540 * @deprecated Modern applications should use
2541 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2542 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2543 * shown behind their UI, rather than watching for this broadcast and
2544 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002545 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002546 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002547 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2548 /**
2549 * Broadcast Action: The current device {@link android.content.res.Configuration}
2550 * (orientation, locale, etc) has changed. When such a change happens, the
2551 * UIs (view hierarchy) will need to be rebuilt based on this new
2552 * information; for the most part, applications don't need to worry about
2553 * this, because the system will take care of stopping and restarting the
2554 * application to make sure it sees the new changes. Some system code that
2555 * can not be restarted will need to watch for this action and handle it
2556 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002557 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002558 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002559 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002560 * in manifests, only by explicitly registering for it with
2561 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2562 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002563 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002564 * <p class="note">This is a protected intent that can only be sent
2565 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002566 *
2567 * @see android.content.res.Configuration
2568 */
2569 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2570 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
Adam Lesinski57fccd62018-01-25 13:03:57 -08002571
2572 /**
2573 * Broadcast Action: The current device {@link android.content.res.Configuration} has changed
2574 * such that the device may be eligible for the installation of additional configuration splits.
2575 * Configuration properties that can trigger this broadcast include locale and display density.
2576 *
2577 * <p class="note">
2578 * Unlike {@link #ACTION_CONFIGURATION_CHANGED}, you <em>can</em> receive this through
2579 * components declared in manifests. However, the receiver <em>must</em> hold the
2580 * {@link android.Manifest.permission#INSTALL_PACKAGES} permission.
2581 *
2582 * <p class="note">
2583 * This is a protected intent that can only be sent by the system.
2584 *
2585 * @hide
2586 */
2587 @SystemApi
2588 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2589 public static final String ACTION_SPLIT_CONFIGURATION_CHANGED =
2590 "android.intent.action.SPLIT_CONFIGURATION_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002591 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002592 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002593 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002594 * <p class="note">This is a protected intent that can only be sent
2595 * by the system.
2596 */
2597 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2598 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2599 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002600 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2601 * charging state, level, and other information about the battery.
2602 * See {@link android.os.BatteryManager} for documentation on the
2603 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002604 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002605 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002606 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002607 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002608 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002609 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2610 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2611 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2612 * broadcasts that are sent and can be received through manifest
2613 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002614 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002615 * <p class="note">This is a protected intent that can only be sent
2616 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002617 */
2618 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2619 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
Fyodor Kupolov70e75432018-03-01 18:29:06 -08002620
2621
2622 /**
2623 * Broadcast Action: Sent when the current battery level changes.
2624 *
2625 * It has {@link android.os.BatteryManager#EXTRA_EVENTS} that carries a list of {@link Bundle}
2626 * instances representing individual battery level changes with associated
2627 * extras from {@link #ACTION_BATTERY_CHANGED}.
2628 *
2629 * <p class="note">
2630 * This broadcast requires {@link android.Manifest.permission#BATTERY_STATS} permission.
2631 *
2632 * @hide
2633 */
2634 @SystemApi
2635 public static final String ACTION_BATTERY_LEVEL_CHANGED =
2636 "android.intent.action.BATTERY_LEVEL_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002637 /**
2638 * Broadcast Action: Indicates low battery condition on the device.
2639 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002640 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002641 * <p class="note">This is a protected intent that can only be sent
2642 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002643 */
2644 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2645 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2646 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002647 * Broadcast Action: Indicates the battery is now okay after being low.
2648 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2649 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002650 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002651 * <p class="note">This is a protected intent that can only be sent
2652 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002653 */
2654 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2655 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2656 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002657 * Broadcast Action: External power has been connected to the device.
2658 * This is intended for applications that wish to register specifically to this notification.
2659 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2660 * stay active to receive this notification. This action can be used to implement actions
2661 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002662 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002663 * <p class="note">This is a protected intent that can only be sent
2664 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002665 */
2666 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002667 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002668 /**
2669 * Broadcast Action: External power has been removed from the device.
2670 * This is intended for applications that wish to register specifically to this notification.
2671 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2672 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002673 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002674 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002675 * <p class="note">This is a protected intent that can only be sent
2676 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002677 */
2678 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002679 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002680 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002681 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002682 * Broadcast Action: Device is shutting down.
2683 * This is broadcast when the device is being shut down (completely turned
2684 * off, not sleeping). Once the broadcast is complete, the final shutdown
2685 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002686 * to handle this, since the foreground activity will be paused as well.
Fyodor Kupolov1fc62602018-02-01 15:48:53 -08002687 * <p>As of {@link Build.VERSION_CODES#P} this broadcast is only sent to receivers registered
2688 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2689 * Context.registerReceiver}.
Tom Taylord4a47292009-12-21 13:59:18 -08002690 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002691 * <p class="note">This is a protected intent that can only be sent
2692 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002693 * <p>May include the following extras:
2694 * <ul>
2695 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2696 * shutdown is only for userspace processes. If not set, assumed to be false.
2697 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002698 */
2699 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002700 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002701 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002702 * Activity Action: Start this activity to request system shutdown.
2703 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002704 * to request confirmation from the user before shutting down. The optional boolean
2705 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2706 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002707 *
2708 * <p class="note">This is a protected intent that can only be sent
2709 * by the system.
2710 *
2711 * {@hide}
2712 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002713 public static final String ACTION_REQUEST_SHUTDOWN
2714 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002715 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002716 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002717 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002718 * <p class="note">
2719 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002720 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002721 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2722 * or above, this broadcast will no longer be delivered to any
2723 * {@link BroadcastReceiver} defined in your manifest. Instead,
2724 * apps are strongly encouraged to use the improved
2725 * {@link Context#getCacheDir()} behavior so the system can
2726 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002727 */
2728 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002729 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002730 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2731 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002732 * Broadcast Action: Indicates low storage space condition on the device no
2733 * longer exists
2734 * <p class="note">
2735 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002736 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002737 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2738 * or above, this broadcast will no longer be delivered to any
2739 * {@link BroadcastReceiver} defined in your manifest. Instead,
2740 * apps are strongly encouraged to use the improved
2741 * {@link Context#getCacheDir()} behavior so the system can
2742 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002743 */
2744 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002745 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002746 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2747 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002748 * Broadcast Action: A sticky broadcast that indicates a storage space full
2749 * condition on the device. This is intended for activities that want to be
2750 * able to fill the data partition completely, leaving only enough free
2751 * space to prevent system-wide SQLite failures.
2752 * <p class="note">
2753 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002754 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002755 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2756 * or above, this broadcast will no longer be delivered to any
2757 * {@link BroadcastReceiver} defined in your manifest. Instead,
2758 * apps are strongly encouraged to use the improved
2759 * {@link Context#getCacheDir()} behavior so the system can
2760 * automatically free up storage when needed.
2761 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002762 */
2763 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002764 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002765 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2766 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002767 * Broadcast Action: Indicates storage space full condition on the device no
2768 * longer exists.
2769 * <p class="note">
2770 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002771 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002772 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2773 * or above, this broadcast will no longer be delivered to any
2774 * {@link BroadcastReceiver} defined in your manifest. Instead,
2775 * apps are strongly encouraged to use the improved
2776 * {@link Context#getCacheDir()} behavior so the system can
2777 * automatically free up storage when needed.
2778 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002779 */
2780 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002781 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002782 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2783 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002784 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2785 * and package management should be started.
2786 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2787 * notification.
2788 */
2789 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2790 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2791 /**
2792 * Broadcast Action: The device has entered USB Mass Storage mode.
2793 * This is used mainly for the USB Settings panel.
2794 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2795 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002796 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002797 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002798 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002799 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002800 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2801
2802 /**
2803 * Broadcast Action: The device has exited USB Mass Storage mode.
2804 * This is used mainly for the USB Settings panel.
2805 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2806 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002807 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002808 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002809 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002810 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002811 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2812
2813 /**
2814 * Broadcast Action: External media has been removed.
2815 * The path to the mount point for the removed media is contained in the Intent.mData field.
2816 */
2817 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2818 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2819
2820 /**
2821 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002822 * 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 -07002823 */
2824 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2825 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2826
2827 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002828 * Broadcast Action: External media is present, and being disk-checked
2829 * 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 -08002830 */
2831 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2832 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2833
2834 /**
2835 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2836 * 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 -08002837 */
2838 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2839 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2840
2841 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002842 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002843 * 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 -07002844 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2845 * media was mounted read only.
2846 */
2847 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2848 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2849
2850 /**
2851 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002852 * 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 -07002853 */
2854 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2855 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2856
2857 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002858 * Broadcast Action: External media is no longer being shared via USB mass storage.
2859 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2860 *
2861 * @hide
2862 */
2863 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2864
2865 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002866 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2867 * The path to the mount point for the removed media is contained in the Intent.mData field.
2868 */
2869 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2870 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2871
2872 /**
2873 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002874 * 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 -07002875 */
2876 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2877 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2878
2879 /**
2880 * Broadcast Action: User has expressed the desire to remove the external storage media.
2881 * Applications should close all files they have open within the mount point when they receive this intent.
2882 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2883 */
2884 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2885 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2886
2887 /**
2888 * Broadcast Action: The media scanner has started scanning a directory.
2889 * The path to the directory being scanned is contained in the Intent.mData field.
2890 */
2891 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2892 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2893
2894 /**
2895 * Broadcast Action: The media scanner has finished scanning a directory.
2896 * The path to the scanned directory is contained in the Intent.mData field.
2897 */
2898 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2899 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2900
2901 /**
2902 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2903 * The path to the file is contained in the Intent.mData field.
2904 */
2905 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2906 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2907
2908 /**
2909 * Broadcast Action: The "Media Button" was pressed. Includes a single
2910 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2911 * caused the broadcast.
2912 */
2913 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2914 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2915
2916 /**
2917 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2918 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2919 * caused the broadcast.
2920 */
2921 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2922 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2923
2924 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2925 // location; they are not general-purpose actions.
2926
2927 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002928 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002929 */
2930 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2931 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2932 "android.intent.action.GTALK_CONNECTED";
2933
2934 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002935 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002936 */
2937 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2938 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2939 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002940
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002941 /**
2942 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002943 */
2944 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2945 public static final String ACTION_INPUT_METHOD_CHANGED =
2946 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002947
2948 /**
2949 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2950 * more radios have been turned off or on. The intent will have the following extra value:</p>
2951 * <ul>
2952 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2953 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2954 * turned off</li>
2955 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002956 *
Peng Xua35b5532016-01-20 00:05:45 -08002957 * <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 -07002958 */
2959 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2960 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2961
2962 /**
2963 * Broadcast Action: Some content providers have parts of their namespace
2964 * where they publish new events or items that the user may be especially
2965 * interested in. For these things, they may broadcast this action when the
2966 * set of interesting items change.
2967 *
2968 * For example, GmailProvider sends this notification when the set of unread
2969 * mail in the inbox changes.
2970 *
2971 * <p>The data of the intent identifies which part of which provider
2972 * changed. When queried through the content resolver, the data URI will
2973 * return the data set in question.
2974 *
2975 * <p>The intent will have the following extra values:
2976 * <ul>
2977 * <li><em>count</em> - The number of items in the data set. This is the
2978 * same as the number of items in the cursor returned by querying the
2979 * data URI. </li>
2980 * </ul>
2981 *
2982 * This intent will be sent at boot (if the count is non-zero) and when the
2983 * data set changes. It is possible for the data set to change without the
2984 * count changing (for example, if a new unread message arrives in the same
2985 * sync operation in which a message is archived). The phone should still
2986 * ring/vibrate/etc as normal in this case.
2987 */
2988 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2989 public static final String ACTION_PROVIDER_CHANGED =
2990 "android.intent.action.PROVIDER_CHANGED";
2991
2992 /**
2993 * Broadcast Action: Wired Headset plugged in or unplugged.
2994 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002995 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2996 * and documentation.
2997 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002998 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002999 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003000 */
3001 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07003002 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07003003
3004 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07003005 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
3006 * <ul>
3007 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
3008 * </ul>
3009 *
3010 * <p class="note">This is a protected intent that can only be sent
3011 * by the system.
3012 *
3013 * @hide
3014 */
3015 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3016 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
3017 = "android.intent.action.ADVANCED_SETTINGS";
3018
3019 /**
Robin Lee66e5d962014-04-09 16:44:21 +01003020 * Broadcast Action: Sent after application restrictions are changed.
3021 *
3022 * <p class="note">This is a protected intent that can only be sent
3023 * by the system.</p>
3024 */
3025 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3026 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
3027 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
3028
3029 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003030 * Broadcast Action: An outgoing call is about to be placed.
3031 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07003032 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003033 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07003034 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003035 * the phone number originally intended to be dialed.</li>
3036 * </ul>
3037 * <p>Once the broadcast is finished, the resultData is used as the actual
3038 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07003039 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003040 * outgoing call in turn: for example, a parental control application
3041 * might verify that the user is authorized to place the call at that
3042 * time, then a number-rewriting application might add an area code if
3043 * one was not specified.</p>
3044 * <p>For consistency, any receiver whose purpose is to prohibit phone
3045 * calls should have a priority of 0, to ensure it will see the final
3046 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07003047 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003048 * should have a positive priority.
3049 * Negative priorities are reserved for the system for this broadcast;
3050 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07003051 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
3052 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003053 * <p>Emergency calls cannot be intercepted using this mechanism, and
3054 * other calls cannot be modified to call emergency numbers using this
3055 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07003056 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
3057 * call to use their own service instead. Those apps should first prevent
3058 * the call from being placed by setting resultData to <code>null</code>
3059 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07003060 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003061 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
3062 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08003063 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07003064 * <p class="note">This is a protected intent that can only be sent
3065 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003066 */
3067 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3068 public static final String ACTION_NEW_OUTGOING_CALL =
3069 "android.intent.action.NEW_OUTGOING_CALL";
3070
3071 /**
3072 * Broadcast Action: Have the device reboot. This is only for use by
3073 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08003074 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07003075 * <p class="note">This is a protected intent that can only be sent
3076 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003077 */
3078 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3079 public static final String ACTION_REBOOT =
3080 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003081
Wei Huang97ecc9c2009-05-11 17:44:20 -07003082 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08003083 * Broadcast Action: A sticky broadcast for changes in the physical
3084 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08003085 *
3086 * <p>The intent will have the following extra values:
3087 * <ul>
3088 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08003089 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08003090 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08003091 * <p>This is intended for monitoring the current physical dock state.
3092 * See {@link android.app.UiModeManager} for the normal API dealing with
3093 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07003094 */
3095 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3096 public static final String ACTION_DOCK_EVENT =
3097 "android.intent.action.DOCK_EVENT";
3098
3099 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08003100 * Broadcast Action: A broadcast when idle maintenance can be started.
3101 * This means that the user is not interacting with the device and is
3102 * not expected to do so soon. Typical use of the idle maintenance is
3103 * to perform somehow expensive tasks that can be postponed at a moment
3104 * when they will not degrade user experience.
3105 * <p>
3106 * <p class="note">In order to keep the device responsive in case of an
3107 * unexpected user interaction, implementations of a maintenance task
3108 * should be interruptible. In such a scenario a broadcast with action
3109 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
3110 * should not do the maintenance work in
3111 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
3112 * maintenance service by {@link Context#startService(Intent)}. Also
3113 * you should hold a wake lock while your maintenance service is running
3114 * to prevent the device going to sleep.
3115 * </p>
3116 * <p>
3117 * <p class="note">This is a protected intent that can only be sent by
3118 * the system.
3119 * </p>
3120 *
3121 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07003122 *
3123 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08003124 */
3125 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3126 public static final String ACTION_IDLE_MAINTENANCE_START =
3127 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
3128
3129 /**
3130 * Broadcast Action: A broadcast when idle maintenance should be stopped.
3131 * This means that the user was not interacting with the device as a result
3132 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
3133 * was sent and now the user started interacting with the device. Typical
3134 * use of the idle maintenance is to perform somehow expensive tasks that
3135 * can be postponed at a moment when they will not degrade user experience.
3136 * <p>
3137 * <p class="note">In order to keep the device responsive in case of an
3138 * unexpected user interaction, implementations of a maintenance task
3139 * should be interruptible. Hence, on receiving a broadcast with this
3140 * action, the maintenance task should be interrupted as soon as possible.
3141 * In other words, you should not do the maintenance work in
3142 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
3143 * maintenance service that was started on receiving of
3144 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
3145 * lock you acquired when your maintenance service started.
3146 * </p>
3147 * <p class="note">This is a protected intent that can only be sent
3148 * by the system.
3149 *
3150 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07003151 *
3152 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08003153 */
3154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3155 public static final String ACTION_IDLE_MAINTENANCE_END =
3156 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
3157
3158 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003159 * Broadcast Action: a remote intent is to be broadcasted.
3160 *
3161 * A remote intent is used for remote RPC between devices. The remote intent
3162 * is serialized and sent from one device to another device. The receiving
3163 * device parses the remote intent and broadcasts it. Note that anyone can
3164 * broadcast a remote intent. However, if the intent receiver of the remote intent
3165 * does not trust intent broadcasts from arbitrary intent senders, it should require
3166 * the sender to hold certain permissions so only trusted sender's broadcast will be
3167 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07003168 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07003169 */
3170 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07003171 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07003172
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003173 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06003174 * Broadcast Action: This is broadcast once when the user is booting after a
3175 * system update. It can be used to perform cleanup or upgrades after a
3176 * system update.
3177 * <p>
3178 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
3179 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
3180 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
3181 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003182 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003183 * @hide
3184 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003185 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003186 public static final String ACTION_PRE_BOOT_COMPLETED =
3187 "android.intent.action.PRE_BOOT_COMPLETED";
3188
Amith Yamasani13593602012-03-22 16:16:17 -07003189 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003190 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003191 * on restricted users. The broadcast intent contains an extra
3192 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
3193 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
3194 * String[] depending on the restriction type.<p/>
3195 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07003196 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
3197 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
3198 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003199 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
3200 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003201 * @see RestrictionEntry
3202 */
3203 public static final String ACTION_GET_RESTRICTION_ENTRIES =
3204 "android.intent.action.GET_RESTRICTION_ENTRIES";
3205
3206 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003207 * Sent the first time a user is starting, to allow system apps to
3208 * perform one time initialization. (This will not be seen by third
3209 * party applications because a newly initialized user does not have any
3210 * third party applications installed for it.) This is sent early in
3211 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003212 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3213 * broadcast, since it is part of a visible user interaction; be as quick
3214 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003215 */
3216 public static final String ACTION_USER_INITIALIZE =
3217 "android.intent.action.USER_INITIALIZE";
3218
3219 /**
3220 * Sent when a user switch is happening, causing the process's user to be
3221 * brought to the foreground. This is only sent to receivers registered
3222 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3223 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003224 * foreground. This is sent as a foreground
3225 * broadcast, since it is part of a visible user interaction; be as quick
3226 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003227 */
3228 public static final String ACTION_USER_FOREGROUND =
3229 "android.intent.action.USER_FOREGROUND";
3230
3231 /**
3232 * Sent when a user switch is happening, causing the process's user to be
3233 * sent to the background. This is only sent to receivers registered
3234 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3235 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003236 * background. This is sent as a foreground
3237 * broadcast, since it is part of a visible user interaction; be as quick
3238 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003239 */
3240 public static final String ACTION_USER_BACKGROUND =
3241 "android.intent.action.USER_BACKGROUND";
3242
3243 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003244 * Broadcast sent to the system when a user is added. Carries an extra
3245 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3246 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003247 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003248 * @hide
3249 */
3250 public static final String ACTION_USER_ADDED =
3251 "android.intent.action.USER_ADDED";
3252
3253 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003254 * Broadcast sent by the system when a user is started. Carries an extra
3255 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003256 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003257 * that has been started. This is sent as a foreground
3258 * broadcast, since it is part of a visible user interaction; be as quick
3259 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003260 * @hide
3261 */
3262 public static final String ACTION_USER_STARTED =
3263 "android.intent.action.USER_STARTED";
3264
3265 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003266 * Broadcast sent when a user is in the process of starting. Carries an extra
3267 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3268 * sent to registered receivers, not manifest receivers. It is sent to all
3269 * users (including the one that is being started). You must hold
3270 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3271 * this broadcast. This is sent as a background broadcast, since
3272 * its result is not part of the primary UX flow; to safely keep track of
3273 * started/stopped state of a user you can use this in conjunction with
3274 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3275 * other user state broadcasts since those are foreground broadcasts so can
3276 * execute in a different order.
3277 * @hide
3278 */
3279 public static final String ACTION_USER_STARTING =
3280 "android.intent.action.USER_STARTING";
3281
3282 /**
3283 * Broadcast sent when a user is going to be stopped. Carries an extra
3284 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3285 * sent to registered receivers, not manifest receivers. It is sent to all
3286 * users (including the one that is being stopped). You must hold
3287 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3288 * this broadcast. The user will not stop until all receivers have
3289 * handled the broadcast. This is sent as a background broadcast, since
3290 * its result is not part of the primary UX flow; to safely keep track of
3291 * started/stopped state of a user you can use this in conjunction with
3292 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3293 * other user state broadcasts since those are foreground broadcasts so can
3294 * execute in a different order.
3295 * @hide
3296 */
3297 public static final String ACTION_USER_STOPPING =
3298 "android.intent.action.USER_STOPPING";
3299
3300 /**
3301 * Broadcast sent to the system when a user is stopped. Carries an extra
3302 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3303 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3304 * specific package. This is only sent to registered receivers, not manifest
3305 * receivers. It is sent to all running users <em>except</em> the one that
3306 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003307 * @hide
3308 */
3309 public static final String ACTION_USER_STOPPED =
3310 "android.intent.action.USER_STOPPED";
3311
3312 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003313 * 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 -07003314 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003315 * one that has been removed. The user will not be completely removed until all receivers have
3316 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003317 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003318 * @hide
3319 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003320 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003321 public static final String ACTION_USER_REMOVED =
3322 "android.intent.action.USER_REMOVED";
3323
3324 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003325 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003326 * the userHandle of the user to become the current one. This is only sent to
3327 * registered receivers, not manifest receivers. It is sent to all running users.
3328 * You must hold
3329 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003330 * @hide
3331 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01003332 @UnsupportedAppUsage
Amith Yamasani13593602012-03-22 16:16:17 -07003333 public static final String ACTION_USER_SWITCHED =
3334 "android.intent.action.USER_SWITCHED";
3335
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003336 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003337 * Broadcast Action: Sent when the credential-encrypted private storage has
3338 * become unlocked for the target user. This is only sent to registered
3339 * receivers, not manifest receivers.
3340 */
3341 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3342 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3343
3344 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003345 * Broadcast sent to the system when a user's information changes. Carries an extra
3346 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003347 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003348 * @hide
3349 */
3350 public static final String ACTION_USER_INFO_CHANGED =
3351 "android.intent.action.USER_INFO_CHANGED";
3352
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003353 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003354 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3355 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003356 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3357 * that need to display merged content across both primary and managed profiles need to
3358 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003359 * not manifest receivers.
3360 */
3361 public static final String ACTION_MANAGED_PROFILE_ADDED =
3362 "android.intent.action.MANAGED_PROFILE_ADDED";
3363
3364 /**
3365 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003366 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3367 * Only applications (for example Launchers) that need to display merged content across both
3368 * primary and managed profiles need to worry about this broadcast. This is only sent to
3369 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003370 */
3371 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3372 "android.intent.action.MANAGED_PROFILE_REMOVED";
3373
3374 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003375 * Broadcast sent to the primary user when the credential-encrypted private storage for
3376 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3377 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3378 * Launchers) that need to display merged content across both primary and managed profiles
3379 * need to worry about this broadcast. This is only sent to registered receivers,
3380 * not manifest receivers.
3381 */
3382 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3383 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3384
3385 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003386 * Broadcast sent to the primary user when an associated managed profile has become available.
3387 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003388 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3389 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3390 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003391 */
Rubin Xue95057a2016-04-01 16:49:25 +01003392 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3393 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3394
3395 /**
3396 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3397 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3398 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3399 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3400 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3401 */
3402 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3403 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003404
3405 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003406 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3407 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3408 * the device was locked or unlocked.
3409 *
3410 * This is only sent to registered receivers.
3411 *
3412 * @hide
3413 */
3414 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3415 "android.intent.action.DEVICE_LOCKED_CHANGED";
3416
3417 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003418 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3419 */
3420 public static final String ACTION_QUICK_CLOCK =
3421 "android.intent.action.QUICK_CLOCK";
3422
Michael Wright0087a142013-02-05 16:29:39 -08003423 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003424 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003425 * @hide
3426 */
3427 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003428 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003429
Justin Kohd378ad72013-04-01 12:18:26 -07003430 /**
3431 * Broadcast Action: A global button was pressed. Includes a single
3432 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3433 * caused the broadcast.
3434 * @hide
3435 */
Sujith Ramakrishnan48e19c82017-04-24 15:57:58 -07003436 @SystemApi
Justin Kohd378ad72013-04-01 12:18:26 -07003437 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3438
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003439 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003440 * Broadcast Action: Sent when media resource is granted.
3441 * <p>
3442 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3443 * granted.
3444 * </p>
3445 * <p class="note">
3446 * This is a protected intent that can only be sent by the system.
3447 * </p>
3448 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003449 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003450 * </p>
3451 *
3452 * @hide
3453 */
3454 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3455 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3456
3457 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003458 * Broadcast Action: An overlay package has changed. The data contains the
3459 * name of the overlay package which has changed. This is broadcast on all
3460 * changes to the OverlayInfo returned by {@link
3461 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3462 * most common change is a state change that will change whether the
3463 * overlay is enabled or not.
3464 * @hide
3465 */
3466 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3467
3468 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003469 * Activity Action: Allow the user to select and return one or more existing
3470 * documents. When invoked, the system will display the various
3471 * {@link DocumentsProvider} instances installed on the device, letting the
3472 * user interactively navigate through them. These documents include local
3473 * media, such as photos and video, and documents provided by installed
3474 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003475 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003476 * Each document is represented as a {@code content://} URI backed by a
3477 * {@link DocumentsProvider}, which can be opened as a stream with
3478 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3479 * {@link android.provider.DocumentsContract.Document} metadata.
3480 * <p>
3481 * All selected documents are returned to the calling application with
3482 * persistable read and write permission grants. If you want to maintain
3483 * access to the documents across device reboots, you need to explicitly
3484 * take the persistable permissions using
3485 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3486 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003487 * Callers must indicate the acceptable document MIME types through
3488 * {@link #setType(String)}. For example, to select photos, use
3489 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3490 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3491 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003492 * <p>
3493 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003494 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3495 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003496 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003497 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3498 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003499 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003500 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003501 * Callers can set a document URI through
3502 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3503 * location of documents navigator. System will do its best to launch the
3504 * navigator in the specified document if it's a folder, or the folder that
3505 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003506 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003507 * Output: The URI of the item that was picked, returned in
3508 * {@link #getData()}. This must be a {@code content://} URI so that any
3509 * receiver can access it. If multiple documents were selected, they are
3510 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003511 *
3512 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003513 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003514 * @see #ACTION_CREATE_DOCUMENT
3515 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003516 */
3517 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3518 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3519
3520 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003521 * Activity Action: Allow the user to create a new document. When invoked,
3522 * the system will display the various {@link DocumentsProvider} instances
3523 * installed on the device, letting the user navigate through them. The
3524 * returned document may be a newly created document with no content, or it
3525 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003526 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003527 * Each document is represented as a {@code content://} URI backed by a
3528 * {@link DocumentsProvider}, which can be opened as a stream with
3529 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3530 * {@link android.provider.DocumentsContract.Document} metadata.
3531 * <p>
3532 * Callers must indicate the concrete MIME type of the document being
3533 * created by setting {@link #setType(String)}. This MIME type cannot be
3534 * changed after the document is created.
3535 * <p>
3536 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3537 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003538 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003539 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3540 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003541 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003542 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003543 * Callers can set a document URI through
3544 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3545 * location of documents navigator. System will do its best to launch the
3546 * navigator in the specified document if it's a folder, or the folder that
3547 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003548 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003549 * Output: The URI of the item that was created. This must be a
3550 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003551 *
3552 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003553 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003554 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003555 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003556 */
3557 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3558 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3559
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003560 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003561 * Activity Action: Allow the user to pick a directory subtree. When
3562 * invoked, the system will display the various {@link DocumentsProvider}
3563 * instances installed on the device, letting the user navigate through
3564 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003565 * <p>
3566 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003567 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3568 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3569 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003570 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003571 * Callers can set a document URI through
3572 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3573 * location of documents navigator. System will do its best to launch the
3574 * navigator in the specified document if it's a folder, or the folder that
3575 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003576 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003577 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003578 *
3579 * @see DocumentsContract
3580 */
3581 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003582 public static final String
3583 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003584
Felipe Lemec7b1f892016-01-15 15:02:31 -08003585 /**
Peng Xua35b5532016-01-20 00:05:45 -08003586 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3587 * exisiting sensor being disconnected.
3588 *
3589 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3590 *
3591 * {@hide}
3592 */
3593 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3594 public static final String
3595 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3596
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003597 /**
Sam Line707f832017-04-13 17:00:55 -07003598 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003599 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003600 * @removed
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003601 */
3602 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003603 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003604 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3605
Christopher Tate6597e342015-02-17 12:15:25 -08003606 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003607 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3608 * is about to be performed.
3609 * @hide
3610 */
3611 @SystemApi
3612 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3613 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3614 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3615
3616 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003617 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3618 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3619 *
3620 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3621 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003622 * @hide
3623 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003624 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003625 public static final String EXTRA_FORCE_MASTER_CLEAR =
3626 "android.intent.extra.FORCE_MASTER_CLEAR";
3627
3628 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003629 * A broadcast action to trigger a factory reset.
3630 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003631 * <p>The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission. The
3632 * reason for the factory reset should be specified as {@link #EXTRA_REASON}.
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003633 *
3634 * <p>Not for use by third-party applications.
3635 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003636 * @see #EXTRA_FORCE_FACTORY_RESET
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003637 *
3638 * {@hide}
3639 */
3640 @SystemApi
3641 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3642 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3643
3644 /**
3645 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3646 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3647 *
3648 * <p>Not for use by third-party applications.
3649 *
3650 * @hide
3651 */
3652 @SystemApi
3653 public static final String EXTRA_FORCE_FACTORY_RESET =
3654 "android.intent.extra.FORCE_FACTORY_RESET";
3655
3656 /**
Michal Karpinski6135a262017-08-11 10:45:58 +01003657 * Broadcast action: report that a settings element is being restored from backup. The intent
3658 * contains four extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3659 * EXTRA_SETTING_NEW_VALUE is the value being restored, EXTRA_SETTING_PREVIOUS_VALUE
3660 * is the value of that settings entry prior to the restore operation, and
3661 * EXTRA_SETTING_RESTORED_FROM_SDK_INT is the version of the SDK that the setting has been
3662 * restored from (corresponds to {@link android.os.Build.VERSION#SDK_INT}). The first three
3663 * values are represented as strings, the fourth one as int.
Christopher Tate6597e342015-02-17 12:15:25 -08003664 *
3665 * <p>This broadcast is sent only for settings provider entries known to require special handling
3666 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3667 * the provider's backup agent implementation.
3668 *
3669 * @see #EXTRA_SETTING_NAME
3670 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3671 * @see #EXTRA_SETTING_NEW_VALUE
Michal Karpinski6135a262017-08-11 10:45:58 +01003672 * @see #EXTRA_SETTING_RESTORED_FROM_SDK_INT
Christopher Tate6597e342015-02-17 12:15:25 -08003673 * {@hide}
3674 */
3675 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3676
3677 /** {@hide} */
3678 public static final String EXTRA_SETTING_NAME = "setting_name";
3679 /** {@hide} */
3680 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3681 /** {@hide} */
3682 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
Michal Karpinski6135a262017-08-11 10:45:58 +01003683 /** {@hide} */
3684 public static final String EXTRA_SETTING_RESTORED_FROM_SDK_INT = "restored_from_sdk_int";
Christopher Tate6597e342015-02-17 12:15:25 -08003685
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003686 /**
3687 * Activity Action: Process a piece of text.
3688 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3689 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3690 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3691 */
3692 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3693 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003694
3695 /**
3696 * Broadcast Action: The sim card state has changed.
3697 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3698 * because TelephonyIntents is an internal class.
3699 * @hide
Amit Mahajan052e1e22018-01-12 17:40:29 -08003700 * @deprecated Use {@link #ACTION_SIM_CARD_STATE_CHANGED} or
3701 * {@link #ACTION_SIM_APPLICATION_STATE_CHANGED}
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003702 */
Amit Mahajan052e1e22018-01-12 17:40:29 -08003703 @Deprecated
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003704 @SystemApi
3705 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3706 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3707
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003708 /**
fionaxu90fee272017-03-31 12:45:12 -07003709 * Broadcast Action: indicate that the phone service state has changed.
3710 * The intent will have the following extra values:</p>
3711 * <p>
3712 * @see #EXTRA_VOICE_REG_STATE
3713 * @see #EXTRA_DATA_REG_STATE
3714 * @see #EXTRA_VOICE_ROAMING_TYPE
3715 * @see #EXTRA_DATA_ROAMING_TYPE
3716 * @see #EXTRA_OPERATOR_ALPHA_LONG
3717 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3718 * @see #EXTRA_OPERATOR_NUMERIC
3719 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3720 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3721 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3722 * @see #EXTRA_MANUAL
3723 * @see #EXTRA_VOICE_RADIO_TECH
3724 * @see #EXTRA_DATA_RADIO_TECH
3725 * @see #EXTRA_CSS_INDICATOR
3726 * @see #EXTRA_NETWORK_ID
3727 * @see #EXTRA_SYSTEM_ID
3728 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3729 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3730 * @see #EXTRA_EMERGENCY_ONLY
3731 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3732 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3733 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3734 *
3735 * <p class="note">
3736 * Requires the READ_PHONE_STATE permission.
3737 *
3738 * <p class="note">This is a protected intent that can only be sent by the system.
3739 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003740 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003741 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable} and the helper
3742 * functions {@code ServiceStateTable.getUriForSubscriptionIdAndField} and
3743 * {@code ServiceStateTable.getUriForSubscriptionId} to subscribe to changes to the ServiceState
3744 * for a given subscription id and field with a ContentObserver or using JobScheduler.
fionaxu90fee272017-03-31 12:45:12 -07003745 */
3746 @Deprecated
3747 @SystemApi
3748 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3749 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3750
3751 /**
3752 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3753 * state.
3754 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3755 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3756 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3757 * @see android.telephony.ServiceState#STATE_POWER_OFF
3758 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003759 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003760 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_REG_STATE}.
fionaxu90fee272017-03-31 12:45:12 -07003761 */
3762 @Deprecated
3763 @SystemApi
3764 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3765
3766 /**
3767 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3768 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3769 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3770 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3771 * @see android.telephony.ServiceState#STATE_POWER_OFF
3772 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003773 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003774 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_REG_STATE}.
fionaxu90fee272017-03-31 12:45:12 -07003775 */
3776 @Deprecated
3777 @SystemApi
3778 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3779
3780 /**
3781 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3782 * type.
3783 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003784 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003785 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_ROAMING_TYPE}.
fionaxu90fee272017-03-31 12:45:12 -07003786 */
3787 @Deprecated
3788 @SystemApi
3789 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3790
3791 /**
3792 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3793 * type.
3794 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003795 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003796 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_ROAMING_TYPE}.
fionaxu90fee272017-03-31 12:45:12 -07003797 */
3798 @Deprecated
3799 @SystemApi
3800 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3801
3802 /**
3803 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3804 * registered voice operator name in long alphanumeric format.
3805 * {@code null} if the operator name is not known or unregistered.
3806 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003807 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003808 * @deprecated Use
3809 * {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_ALPHA_LONG}.
fionaxu90fee272017-03-31 12:45:12 -07003810 */
3811 @Deprecated
3812 @SystemApi
3813 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3814
3815 /**
3816 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3817 * registered voice operator name in short alphanumeric format.
3818 * {@code null} if the operator name is not known or unregistered.
3819 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003820 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003821 * @deprecated Use
3822 * {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_ALPHA_SHORT}.
fionaxu90fee272017-03-31 12:45:12 -07003823 */
3824 @Deprecated
3825 @SystemApi
3826 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3827
3828 /**
3829 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3830 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3831 * network.
3832 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003833 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003834 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_NUMERIC}.
fionaxu90fee272017-03-31 12:45:12 -07003835 */
3836 @Deprecated
3837 @SystemApi
3838 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3839
3840 /**
3841 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3842 * registered data operator name in long alphanumeric format.
3843 * {@code null} if the operator name is not known or unregistered.
3844 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003845 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003846 * @deprecated Use
3847 * {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_ALPHA_LONG}.
fionaxu90fee272017-03-31 12:45:12 -07003848 */
3849 @Deprecated
3850 @SystemApi
3851 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3852
3853 /**
3854 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3855 * registered data operator name in short alphanumeric format.
3856 * {@code null} if the operator name is not known or unregistered.
3857 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003858 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003859 * @deprecated Use
3860 * {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_ALPHA_SHORT}.
fionaxu90fee272017-03-31 12:45:12 -07003861 */
3862 @Deprecated
3863 @SystemApi
3864 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3865
3866 /**
3867 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3868 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3869 * data operator.
3870 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003871 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003872 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_NUMERIC}.
fionaxu90fee272017-03-31 12:45:12 -07003873 */
3874 @Deprecated
3875 @SystemApi
3876 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3877
3878 /**
3879 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3880 * network selection mode is manual.
3881 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3882 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003883 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003884 * @deprecated Use
3885 * {@link android.provider.Telephony.ServiceStateTable#IS_MANUAL_NETWORK_SELECTION}.
fionaxu90fee272017-03-31 12:45:12 -07003886 */
3887 @Deprecated
3888 @SystemApi
3889 public static final String EXTRA_MANUAL = "manual";
3890
3891 /**
3892 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3893 * radio technology.
3894 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003895 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003896 * @deprecated Use
3897 * {@link android.provider.Telephony.ServiceStateTable#RIL_VOICE_RADIO_TECHNOLOGY}.
fionaxu90fee272017-03-31 12:45:12 -07003898 */
3899 @Deprecated
3900 @SystemApi
3901 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3902
3903 /**
3904 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3905 * radio technology.
3906 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003907 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003908 * @deprecated Use
3909 * {@link android.provider.Telephony.ServiceStateTable#RIL_DATA_RADIO_TECHNOLOGY}.
fionaxu90fee272017-03-31 12:45:12 -07003910 */
3911 @Deprecated
3912 @SystemApi
3913 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3914
3915 /**
3916 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3917 * support on CDMA network.
3918 * Will be {@code true} if support, {@code false} otherwise.
3919 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003920 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003921 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#CSS_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003922 */
3923 @Deprecated
3924 @SystemApi
3925 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3926
3927 /**
3928 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3929 * id. {@code Integer.MAX_VALUE} if unknown.
3930 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003931 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003932 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#NETWORK_ID}.
fionaxu90fee272017-03-31 12:45:12 -07003933 */
3934 @Deprecated
3935 @SystemApi
3936 public static final String EXTRA_NETWORK_ID = "networkId";
3937
3938 /**
3939 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3940 * {@code Integer.MAX_VALUE} if unknown.
3941 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003942 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003943 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#SYSTEM_ID}.
fionaxu90fee272017-03-31 12:45:12 -07003944 */
3945 @Deprecated
3946 @SystemApi
3947 public static final String EXTRA_SYSTEM_ID = "systemId";
3948
3949 /**
3950 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3951 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3952 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003953 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003954 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#CDMA_ROAMING_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003955 */
3956 @Deprecated
3957 @SystemApi
3958 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3959
3960 /**
3961 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3962 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3963 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003964 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003965 * @deprecated Use
3966 * {@link android.provider.Telephony.ServiceStateTable#CDMA_DEFAULT_ROAMING_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003967 */
3968 @Deprecated
3969 @SystemApi
3970 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3971
3972 /**
3973 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3974 * only mode.
3975 * {@code true} if in emergency only mode, {@code false} otherwise.
3976 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003977 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003978 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#IS_EMERGENCY_ONLY}.
fionaxu90fee272017-03-31 12:45:12 -07003979 */
3980 @Deprecated
3981 @SystemApi
3982 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3983
3984 /**
3985 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3986 * registration state is roaming.
3987 * {@code true} if registration indicates roaming, {@code false} otherwise
3988 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003989 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003990 * @deprecated Use
3991 * {@link android.provider.Telephony.ServiceStateTable#IS_DATA_ROAMING_FROM_REGISTRATION}.
fionaxu90fee272017-03-31 12:45:12 -07003992 */
3993 @Deprecated
3994 @SystemApi
3995 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
3996 "isDataRoamingFromRegistration";
3997
3998 /**
3999 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
4000 * aggregation is in use.
4001 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
4002 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06004003 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07004004 * @deprecated Use
4005 * {@link android.provider.Telephony.ServiceStateTable#IS_USING_CARRIER_AGGREGATION}.
fionaxu90fee272017-03-31 12:45:12 -07004006 */
4007 @Deprecated
4008 @SystemApi
4009 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
4010
4011 /**
4012 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
4013 * is reduced from the rsrp threshold while calculating signal strength level.
4014 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06004015 * @removed
fionaxu90fee272017-03-31 12:45:12 -07004016 */
4017 @Deprecated
4018 @SystemApi
4019 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
4020
4021 /**
chen xu02811692018-10-03 19:07:09 -07004022 * An parcelable extra used with {@link #ACTION_SERVICE_STATE} representing the service state.
4023 * @hide
4024 */
4025 public static final String EXTRA_SERVICE_STATE = "android.intent.extra.SERVICE_STATE";
4026
4027 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01004028 * The name of the extra used to define the text to be processed, as a
4029 * CharSequence. Note that this may be a styled CharSequence, so you must use
4030 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00004031 */
4032 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
4033 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01004034 * 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 +00004035 */
4036 public static final String EXTRA_PROCESS_TEXT_READONLY =
4037 "android.intent.extra.PROCESS_TEXT_READONLY";
4038
Bryce Leebc58f592015-09-25 16:43:01 -07004039 /**
4040 * Broadcast action: reports when a new thermal event has been reached. When the device
4041 * is reaching its maximum temperatue, the thermal level reported
4042 * {@hide}
4043 */
4044 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
4045 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
4046
4047 /** {@hide} */
4048 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
4049
4050 /**
4051 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08004052 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07004053 * {@hide}
4054 */
4055 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
4056
4057 /**
4058 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08004059 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07004060 * {@hide}
4061 */
4062 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
4063
4064 /**
4065 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08004066 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07004067 * {@hide}
4068 */
4069 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
4070
lpeter318abc92018-05-04 16:13:14 +08004071 /**
4072 * Broadcast Action: Indicates the dock in idle state while device is docked.
4073 *
4074 * <p class="note">This is a protected intent that can only be sent
4075 * by the system.
4076 *
4077 * @hide
4078 */
4079 public static final String ACTION_DOCK_IDLE = "android.intent.action.DOCK_IDLE";
4080
4081 /**
4082 * Broadcast Action: Indicates the dock in active state while device is docked.
4083 *
4084 * <p class="note">This is a protected intent that can only be sent
4085 * by the system.
4086 *
4087 * @hide
4088 */
4089 public static final String ACTION_DOCK_ACTIVE = "android.intent.action.DOCK_ACTIVE";
4090
Bryce Leebc58f592015-09-25 16:43:01 -07004091
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004092 // ---------------------------------------------------------------------
4093 // ---------------------------------------------------------------------
4094 // Standard intent categories (see addCategory()).
4095
4096 /**
4097 * Set if the activity should be an option for the default action
4098 * (center press) to perform on a piece of data. Setting this will
4099 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04004100 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004101 * Intent when initiating an action -- it is for use in intent filters
4102 * specified in packages.
4103 */
4104 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4105 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
4106 /**
4107 * Activities that can be safely invoked from a browser must support this
4108 * category. For example, if the user is viewing a web page or an e-mail
4109 * and clicks on a link in the text, the Intent generated execute that
4110 * link will require the BROWSABLE category, so that only activities
4111 * supporting this category will be considered as possible actions. By
4112 * supporting this category, you are promising that there is nothing
4113 * damaging (without user intervention) that can happen by invoking any
4114 * matching Intent.
4115 */
4116 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4117 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
4118 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07004119 * Categories for activities that can participate in voice interaction.
4120 * An activity that supports this category must be prepared to run with
4121 * no UI shown at all (though in some case it may have a UI shown), and
4122 * rely on {@link android.app.VoiceInteractor} to interact with the user.
4123 */
4124 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4125 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
4126 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004127 * Set if the activity should be considered as an alternative action to
4128 * the data the user is currently viewing. See also
4129 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
4130 * applies to the selection in a list of items.
4131 *
4132 * <p>Supporting this category means that you would like your activity to be
4133 * displayed in the set of alternative things the user can do, usually as
4134 * part of the current activity's options menu. You will usually want to
4135 * include a specific label in the &lt;intent-filter&gt; of this action
4136 * describing to the user what it does.
4137 *
4138 * <p>The action of IntentFilter with this category is important in that it
4139 * describes the specific action the target will perform. This generally
4140 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
4141 * a specific name such as "com.android.camera.action.CROP. Only one
4142 * alternative of any particular action will be shown to the user, so using
4143 * a specific action like this makes sure that your alternative will be
4144 * displayed while also allowing other applications to provide their own
4145 * overrides of that particular action.
4146 */
4147 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4148 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
4149 /**
4150 * Set if the activity should be considered as an alternative selection
4151 * action to the data the user has currently selected. This is like
4152 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
4153 * of items from which the user can select, giving them alternatives to the
4154 * default action that will be performed on it.
4155 */
4156 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4157 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
4158 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004159 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004160 */
4161 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4162 public static final String CATEGORY_TAB = "android.intent.category.TAB";
4163 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004164 * Should be displayed in the top-level launcher.
4165 */
4166 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4167 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
4168 /**
Jose Lima38b75b62014-03-11 10:41:39 -07004169 * Indicates an activity optimized for Leanback mode, and that should
4170 * be displayed in the Leanback launcher.
4171 */
4172 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4173 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
4174 /**
Roberto Perez7ee1a7a2017-12-04 17:14:33 -08004175 * Indicates the preferred entry-point activity when an application is launched from a Car
4176 * launcher. If not present, Car launcher can optionally use {@link #CATEGORY_LAUNCHER} as a
4177 * fallback, or exclude the application entirely.
4178 * @hide
4179 */
4180 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4181 public static final String CATEGORY_CAR_LAUNCHER = "android.intent.category.CAR_LAUNCHER";
4182 /**
Jose Lima73915cf2014-07-29 17:16:31 -07004183 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
4184 * @hide
4185 */
4186 @SystemApi
4187 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
4188 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004189 * Provides information about the package it is in; typically used if
4190 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
4191 * a front-door to the user without having to be shown in the all apps list.
4192 */
4193 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4194 public static final String CATEGORY_INFO = "android.intent.category.INFO";
4195 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004196 * This is the home activity, that is the first activity that is displayed
4197 * when the device boots.
4198 */
4199 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4200 public static final String CATEGORY_HOME = "android.intent.category.HOME";
4201 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07004202 * This is the home activity that is displayed when the device is finished setting up and ready
4203 * for use.
4204 * @hide
4205 */
4206 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4207 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
4208 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07004209 * This is the setup wizard activity, that is the first activity that is displayed
4210 * when the user sets up the device for the first time.
4211 * @hide
4212 */
4213 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4214 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
4215 /**
Svet Ganov5bb6bc62017-08-28 12:39:35 -07004216 * This is the home activity, that is the activity that serves as the launcher app
4217 * from there the user can start other apps. Often components with lower/higher
4218 * priority intent filters handle the home intent, for example SetupWizard, to
4219 * setup the device and we need to be able to distinguish the home app from these
4220 * setup helpers.
4221 * @hide
4222 */
4223 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4224 public static final String CATEGORY_LAUNCHER_APP = "android.intent.category.LAUNCHER_APP";
4225 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004226 * This activity is a preference panel.
4227 */
4228 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4229 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
4230 /**
4231 * This activity is a development preference panel.
4232 */
4233 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4234 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
4235 /**
4236 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004237 */
4238 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4239 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
4240 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07004241 * This activity allows the user to browse and download new applications.
4242 */
4243 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4244 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
4245 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004246 * This activity may be exercised by the monkey or other automated test tools.
4247 */
4248 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4249 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
4250 /**
4251 * To be used as a test (not part of the normal user experience).
4252 */
4253 public static final String CATEGORY_TEST = "android.intent.category.TEST";
4254 /**
4255 * To be used as a unit test (run through the Test Harness).
4256 */
4257 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
4258 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004259 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004260 * experience).
4261 */
4262 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004263
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004264 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004265 * Used to indicate that an intent only wants URIs that can be opened with
4266 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
4267 * must support at least the columns defined in {@link OpenableColumns} when
4268 * queried.
4269 *
4270 * @see #ACTION_GET_CONTENT
4271 * @see #ACTION_OPEN_DOCUMENT
4272 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004273 */
4274 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4275 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
4276
4277 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09004278 * Used to indicate that an intent filter can accept files which are not necessarily
4279 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
4280 * at least streamable via
4281 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
4282 * using one of the stream types exposed via
4283 * {@link ContentResolver#getStreamTypes(Uri, String)}.
4284 *
4285 * @see #ACTION_SEND
4286 * @see #ACTION_SEND_MULTIPLE
4287 */
4288 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4289 public static final String CATEGORY_TYPED_OPENABLE =
4290 "android.intent.category.TYPED_OPENABLE";
4291
4292 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004293 * To be used as code under test for framework instrumentation tests.
4294 */
4295 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
4296 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04004297 /**
4298 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004299 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4300 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004301 */
4302 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4303 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
4304 /**
4305 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004306 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4307 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004308 */
4309 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4310 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004311 /**
4312 * An activity to run when device is inserted into a analog (low end) dock.
4313 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4314 * information, see {@link android.app.UiModeManager}.
4315 */
4316 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4317 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
4318
4319 /**
4320 * An activity to run when device is inserted into a digital (high end) dock.
4321 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4322 * information, see {@link android.app.UiModeManager}.
4323 */
4324 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4325 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004326
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004327 /**
4328 * Used to indicate that the activity can be used in a car environment.
4329 */
4330 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4331 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4332
Zak Cohendb6ca492017-01-26 14:09:00 -08004333 /**
4334 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4335 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4336 * information, see {@link android.app.UiModeManager}.
4337 */
4338 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4339 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004340 // ---------------------------------------------------------------------
4341 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004342 // Application launch intent categories (see addCategory()).
4343
4344 /**
4345 * Used with {@link #ACTION_MAIN} to launch the browser application.
4346 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004347 * <p>NOTE: This should not be used as the primary key of an Intent,
4348 * since it will not result in the app launching with the correct
4349 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004350 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004351 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004352 */
4353 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4354 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4355
4356 /**
4357 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4358 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004359 * <p>NOTE: This should not be used as the primary key of an Intent,
4360 * since it will not result in the app launching with the correct
4361 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004362 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004363 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004364 */
4365 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4366 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4367
4368 /**
4369 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4370 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004371 * <p>NOTE: This should not be used as the primary key of an Intent,
4372 * since it will not result in the app launching with the correct
4373 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004374 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004375 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004376 */
4377 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4378 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4379
4380 /**
4381 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4382 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004383 * <p>NOTE: This should not be used as the primary key of an Intent,
4384 * since it will not result in the app launching with the correct
4385 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004386 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004387 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004388 */
4389 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4390 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4391
4392 /**
4393 * Used with {@link #ACTION_MAIN} to launch the email application.
4394 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004395 * <p>NOTE: This should not be used as the primary key of an Intent,
4396 * since it will not result in the app launching with the correct
4397 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004398 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004399 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004400 */
4401 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4402 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4403
4404 /**
4405 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4406 * The activity should be able to view and manipulate image and video files
4407 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004408 * <p>NOTE: This should not be used as the primary key of an Intent,
4409 * since it will not result in the app launching with the correct
4410 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004411 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004412 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004413 */
4414 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4415 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4416
4417 /**
4418 * Used with {@link #ACTION_MAIN} to launch the maps application.
4419 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004420 * <p>NOTE: This should not be used as the primary key of an Intent,
4421 * since it will not result in the app launching with the correct
4422 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004423 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004424 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004425 */
4426 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4427 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4428
4429 /**
4430 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4431 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004432 * <p>NOTE: This should not be used as the primary key of an Intent,
4433 * since it will not result in the app launching with the correct
4434 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004435 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004436 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004437 */
4438 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4439 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4440
4441 /**
4442 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004443 * The activity should be able to play, browse, or manipulate music files
4444 * stored on the device.
4445 * <p>NOTE: This should not be used as the primary key of an Intent,
4446 * since it will not result in the app launching with the correct
4447 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004448 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004449 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004450 */
4451 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4452 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4453
4454 // ---------------------------------------------------------------------
4455 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004456 // Standard extra data keys.
4457
4458 /**
4459 * The initial data to place in a newly created record. Use with
4460 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4461 * fields as would be given to the underlying ContentProvider.insert()
4462 * call.
4463 */
4464 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4465
4466 /**
4467 * A constant CharSequence that is associated with the Intent, used with
4468 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4469 * this may be a styled CharSequence, so you must use
4470 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4471 * retrieve it.
4472 */
4473 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4474
4475 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004476 * A constant String that is associated with the Intent, used with
4477 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4478 * as HTML formatted text. Note that you <em>must</em> also supply
4479 * {@link #EXTRA_TEXT}.
4480 */
4481 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4482
4483 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004484 * A content: URI holding a stream of data associated with the Intent,
4485 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004486 */
4487 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4488
4489 /**
4490 * A String[] holding e-mail addresses that should be delivered to.
4491 */
4492 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4493
4494 /**
4495 * A String[] holding e-mail addresses that should be carbon copied.
4496 */
4497 public static final String EXTRA_CC = "android.intent.extra.CC";
4498
4499 /**
4500 * A String[] holding e-mail addresses that should be blind carbon copied.
4501 */
4502 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4503
4504 /**
4505 * A constant string holding the desired subject line of a message.
4506 */
4507 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4508
4509 /**
4510 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004511 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004512 */
4513 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4514
4515 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004516 * An int representing the user id to be used.
4517 *
4518 * @hide
4519 */
4520 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4521
4522 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004523 * An int representing the task id to be retrieved. This is used when a launch from recents is
4524 * intercepted by another action such as credentials confirmation to remember which task should
4525 * be resumed when complete.
4526 *
4527 * @hide
4528 */
4529 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4530
4531 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004532 * An Intent[] describing additional, alternate choices you would like shown with
4533 * {@link #ACTION_CHOOSER}.
4534 *
4535 * <p>An app may be capable of providing several different payload types to complete a
4536 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4537 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4538 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4539 * photo data or a hosted link where the photos can be viewed.</p>
4540 *
4541 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4542 * first/primary/preferred intent in the set. Additional intents specified in
4543 * this extra are ordered; by default intents that appear earlier in the array will be
4544 * preferred over intents that appear later in the array as matches for the same
4545 * target component. To alter this preference, a calling app may also supply
4546 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4547 */
4548 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4549
4550 /**
Adam Powell52c39212016-04-07 15:14:18 -07004551 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4552 * and omitted from a list of components presented to the user.
4553 *
4554 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4555 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4556 * from your own package or other apps from your organization if the idea of sending to those
4557 * targets would be redundant with other app functionality. Filtered components will not
4558 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4559 */
4560 public static final String EXTRA_EXCLUDE_COMPONENTS
4561 = "android.intent.extra.EXCLUDE_COMPONENTS";
4562
4563 /**
4564 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4565 * describing additional high-priority deep-link targets for the chooser to present to the user.
4566 *
4567 * <p>Targets provided in this way will be presented inline with all other targets provided
4568 * by services from other apps. They will be prioritized before other service targets, but
4569 * after those targets provided by sources that the user has manually pinned to the front.</p>
4570 *
4571 * @see #ACTION_CHOOSER
4572 */
4573 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4574
4575 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004576 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4577 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4578 *
4579 * <p>An app preparing an action for another app to complete may wish to allow the user to
4580 * disambiguate between several options for completing the action based on the chosen target
4581 * or otherwise refine the action before it is invoked.
4582 * </p>
4583 *
4584 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4585 * <ul>
4586 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4587 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4588 * chosen target beyond the first</li>
4589 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4590 * should fill in and send once the disambiguation is complete</li>
4591 * </ul>
4592 */
4593 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4594 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4595
4596 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004597 * An {@code ArrayList} of {@code String} annotations describing content for
4598 * {@link #ACTION_CHOOSER}.
4599 *
4600 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4601 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4602 *
4603 * <p>Annotations should describe the major components or topics of the content. It is up to
4604 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4605 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004606 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4607 * character. Performance on customized annotations can suffer, if they are rarely used for
4608 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4609 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004610 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004611 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004612 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004613 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004614 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004615 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004616 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004617 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004618 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004619 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4620 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4621 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4622 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4623 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004624 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004625 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4626 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004627 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004628 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004629 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004630 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004631 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004632 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004633 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004634 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004635 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004636 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004637 * Christmas and Thanksgiving.</li>
4638 * </ul>
4639 */
4640 public static final String EXTRA_CONTENT_ANNOTATIONS
4641 = "android.intent.extra.CONTENT_ANNOTATIONS";
4642
4643 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004644 * A {@link ResultReceiver} used to return data back to the sender.
4645 *
4646 * <p>Used to complete an app-specific
4647 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4648 *
4649 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4650 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4651 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4652 * when the user selects a target component from the chooser. It is up to the recipient
4653 * to send a result to this ResultReceiver to signal that disambiguation is complete
4654 * and that the chooser should invoke the user's choice.</p>
4655 *
4656 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4657 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4658 * to match and fill in the final Intent or ChooserTarget before starting it.
4659 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4660 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4661 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4662 *
4663 * <p>The result code passed to the ResultReceiver should be
4664 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4665 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4666 * the chooser should finish without starting a target.</p>
4667 */
4668 public static final String EXTRA_RESULT_RECEIVER
4669 = "android.intent.extra.RESULT_RECEIVER";
4670
4671 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004672 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004673 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004674 */
4675 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4676
4677 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004678 * A Parcelable[] of {@link Intent} or
4679 * {@link android.content.pm.LabeledIntent} objects as set with
4680 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4681 * a the front of the list of choices, when shown to the user with a
4682 * {@link #ACTION_CHOOSER}.
4683 */
4684 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4685
4686 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004687 * A {@link IntentSender} to start after instant app installation success.
Todd Kennedy7440f172015-12-09 14:31:22 -08004688 * @hide
4689 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004690 @SystemApi
4691 public static final String EXTRA_INSTANT_APP_SUCCESS =
4692 "android.intent.extra.INSTANT_APP_SUCCESS";
4693
4694 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004695 * A {@link IntentSender} to start after instant app installation failure.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004696 * @hide
4697 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004698 @SystemApi
4699 public static final String EXTRA_INSTANT_APP_FAILURE =
4700 "android.intent.extra.INSTANT_APP_FAILURE";
4701
4702 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004703 * The host name that triggered an instant app resolution.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004704 * @hide
4705 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004706 @SystemApi
4707 public static final String EXTRA_INSTANT_APP_HOSTNAME =
4708 "android.intent.extra.INSTANT_APP_HOSTNAME";
4709
4710 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004711 * An opaque token to track instant app resolution.
4712 * @hide
4713 */
4714 @SystemApi
4715 public static final String EXTRA_INSTANT_APP_TOKEN =
4716 "android.intent.extra.INSTANT_APP_TOKEN";
4717
4718 /**
Patrick Baumannb4165d72017-12-04 11:29:24 -08004719 * The action that triggered an instant application resolution.
4720 * @hide
4721 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004722 @SystemApi
Patrick Baumannb4165d72017-12-04 11:29:24 -08004723 public static final String EXTRA_INSTANT_APP_ACTION = "android.intent.extra.INSTANT_APP_ACTION";
4724
4725 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004726 * An array of {@link Bundle}s containing details about resolved instant apps..
4727 * @hide
4728 */
4729 @SystemApi
4730 public static final String EXTRA_INSTANT_APP_BUNDLES =
4731 "android.intent.extra.INSTANT_APP_BUNDLES";
4732
4733 /**
4734 * A {@link Bundle} of metadata that describes the instant application that needs to be
Patrick Baumann709ee152017-12-04 16:12:52 -08004735 * installed. This data is populated from the response to
4736 * {@link android.content.pm.InstantAppResolveInfo#getExtras()} as provided by the registered
4737 * instant application resolver.
4738 * @hide
4739 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004740 @SystemApi
Patrick Baumann709ee152017-12-04 16:12:52 -08004741 public static final String EXTRA_INSTANT_APP_EXTRAS =
4742 "android.intent.extra.INSTANT_APP_EXTRAS";
4743
4744 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004745 * A boolean value indicating that the instant app resolver was unable to state with certainty
4746 * that it did or did not have an app for the sanitized {@link Intent} defined at
4747 * {@link #EXTRA_INTENT}.
4748 * @hide
4749 */
4750 @SystemApi
4751 public static final String EXTRA_UNKNOWN_INSTANT_APP =
4752 "android.intent.extra.UNKNOWN_INSTANT_APP";
4753
4754 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004755 * The version code of the app to install components from.
Dianne Hackborn3accca02013-09-20 09:32:11 -07004756 * @deprecated Use {@link #EXTRA_LONG_VERSION_CODE).
Todd Kennedy316c2f22017-01-23 15:40:07 -08004757 * @hide
4758 */
Dianne Hackborn3accca02013-09-20 09:32:11 -07004759 @Deprecated
Todd Kennedy316c2f22017-01-23 15:40:07 -08004760 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4761
4762 /**
Dianne Hackborn3accca02013-09-20 09:32:11 -07004763 * The version code of the app to install components from.
4764 * @hide
4765 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004766 @SystemApi
Dianne Hackborn3accca02013-09-20 09:32:11 -07004767 public static final String EXTRA_LONG_VERSION_CODE = "android.intent.extra.LONG_VERSION_CODE";
4768
4769 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004770 * The app that triggered the instant app installation.
Chad Brubaker06068612017-04-06 09:43:47 -07004771 * @hide
4772 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004773 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004774 public static final String EXTRA_CALLING_PACKAGE
4775 = "android.intent.extra.CALLING_PACKAGE";
4776
4777 /**
4778 * Optional calling app provided bundle containing additional launch information the
4779 * installer may use.
4780 * @hide
4781 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004782 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004783 public static final String EXTRA_VERIFICATION_BUNDLE
4784 = "android.intent.extra.VERIFICATION_BUNDLE";
4785
4786 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004787 * A Bundle forming a mapping of potential target package names to different extras Bundles
4788 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4789 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4790 * be currently installed on the device.
4791 *
4792 * <p>An application may choose to provide alternate extras for the case where a user
4793 * selects an activity from a predetermined set of target packages. If the activity
4794 * the user selects from the chooser belongs to a package with its package name as
4795 * a key in this bundle, the corresponding extras for that package will be merged with
4796 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4797 * extra has the same key as an extra already present in the intent it will overwrite
4798 * the extra from the intent.</p>
4799 *
4800 * <p><em>Examples:</em>
4801 * <ul>
4802 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4803 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4804 * parameters for that target.</li>
4805 * <li>An application may offer additional metadata for known targets of a given intent
4806 * to pass along information only relevant to that target such as account or content
4807 * identifiers already known to that application.</li>
4808 * </ul></p>
4809 */
4810 public static final String EXTRA_REPLACEMENT_EXTRAS =
4811 "android.intent.extra.REPLACEMENT_EXTRAS";
4812
4813 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004814 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4815 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4816 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4817 * {@link ComponentName} of the chosen component.
4818 *
4819 * <p>In some situations this callback may never come, for example if the user abandons
4820 * the chooser, switches to another task or any number of other reasons. Apps should not
4821 * be written assuming that this callback will always occur.</p>
4822 */
4823 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4824 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4825
4826 /**
4827 * The {@link ComponentName} chosen by the user to complete an action.
4828 *
4829 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4830 */
4831 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4832
4833 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004834 * A {@link android.view.KeyEvent} object containing the event that
4835 * triggered the creation of the Intent it is in.
4836 */
4837 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4838
4839 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004840 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4841 * before shutting down.
4842 *
4843 * {@hide}
4844 */
4845 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4846
4847 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004848 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4849 * requested by the user.
4850 *
4851 * {@hide}
4852 */
4853 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4854 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4855
4856 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004857 * 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 -07004858 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4859 * of restarting the application.
4860 */
4861 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4862
4863 /**
4864 * A String holding the phone number originally entered in
4865 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4866 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4867 */
4868 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004869
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004870 /**
4871 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4872 * intents to supply the uid the package had been assigned. Also an optional
4873 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4874 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4875 * purpose.
4876 */
4877 public static final String EXTRA_UID = "android.intent.extra.UID";
4878
4879 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004880 * @hide String array of package names.
4881 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004882 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004883 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4884
4885 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004886 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4887 * intents to indicate whether this represents a full uninstall (removing
4888 * both the code and its data) or a partial uninstall (leaving its data,
4889 * implying that this is an update).
4890 */
4891 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004892
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004893 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004894 * @hide
4895 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4896 * intents to indicate that at this point the package has been removed for
4897 * all users on the device.
4898 */
4899 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4900 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4901
4902 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004903 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4904 * intents to indicate that this is a replacement of the package, so this
4905 * broadcast will immediately be followed by an add broadcast for a
4906 * different version of the same package.
4907 */
4908 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004909
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004910 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004911 * Used as an int extra field in {@link android.app.AlarmManager} intents
4912 * to tell the application being invoked how many pending alarms are being
4913 * delievered with the intent. For one-shot alarms this will always be 1.
4914 * For recurring alarms, this might be greater than 1 if the device was
4915 * asleep or powered off at the time an earlier alarm would have been
4916 * delivered.
4917 */
4918 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004919
Jacek Surazski86b6c532009-05-13 14:38:28 +02004920 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004921 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4922 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004923 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4924 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004925 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4926 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4927 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004928 */
4929 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4930
4931 /**
4932 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4933 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004934 */
4935 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4936
4937 /**
4938 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4939 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004940 */
4941 public static final int EXTRA_DOCK_STATE_DESK = 1;
4942
4943 /**
4944 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4945 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004946 */
4947 public static final int EXTRA_DOCK_STATE_CAR = 2;
4948
4949 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004950 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4951 * to represent that the phone is in a analog (low end) dock.
4952 */
4953 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4954
4955 /**
4956 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4957 * to represent that the phone is in a digital (high end) dock.
4958 */
4959 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4960
4961 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004962 * Boolean that can be supplied as meta-data with a dock activity, to
4963 * indicate that the dock should take over the home key when it is active.
4964 */
4965 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004966
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004967 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004968 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4969 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004970 */
4971 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4972
4973 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004974 * Used in the extra field in the remote intent. It's astring token passed with the
4975 * remote intent.
4976 */
4977 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4978 "android.intent.extra.remote_intent_token";
4979
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004980 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004981 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004982 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004983 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004984 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004985 "android.intent.extra.changed_component_name";
4986
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004987 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004988 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004989 * and contains a string array of all of the components that have changed. If
4990 * the state of the overall package has changed, then it will contain an entry
4991 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004992 */
4993 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4994 "android.intent.extra.changed_component_name_list";
4995
4996 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004997 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004998 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004999 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
5000 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
5001 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005002 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005003 */
5004 public static final String EXTRA_CHANGED_PACKAGE_LIST =
5005 "android.intent.extra.changed_package_list";
5006
5007 /**
5008 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08005009 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
5010 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005011 * and contains an integer array of uids of all of the components
5012 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005013 */
5014 public static final String EXTRA_CHANGED_UID_LIST =
5015 "android.intent.extra.changed_uid_list";
5016
5017 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07005018 * @hide
5019 * Magic extra system code can use when binding, to give a label for
5020 * who it is that has bound to a service. This is an integer giving
5021 * a framework string resource that can be displayed to the user.
5022 */
5023 public static final String EXTRA_CLIENT_LABEL =
5024 "android.intent.extra.client_label";
5025
5026 /**
5027 * @hide
5028 * Magic extra system code can use when binding, to give a PendingIntent object
5029 * that can be launched for the user to disable the system's use of this
5030 * service.
5031 */
5032 public static final String EXTRA_CLIENT_INTENT =
5033 "android.intent.extra.client_intent";
5034
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08005035 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005036 * Extra used to indicate that an intent should only return data that is on
5037 * the local device. This is a boolean extra; the default is false. If true,
5038 * an implementation should only allow the user to select data that is
5039 * already on the device, not requiring it be downloaded from a remote
5040 * service when opened.
5041 *
5042 * @see #ACTION_GET_CONTENT
5043 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07005044 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005045 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08005046 */
5047 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005048 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005049
Amith Yamasani13593602012-03-22 16:16:17 -07005050 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005051 * Extra used to indicate that an intent can allow the user to select and
5052 * return multiple items. This is a boolean extra; the default is false. If
5053 * true, an implementation is allowed to present the user with a UI where
5054 * they can pick multiple items that are all returned to the caller. When
5055 * this happens, they should be returned as the {@link #getClipData()} part
5056 * of the result Intent.
5057 *
5058 * @see #ACTION_GET_CONTENT
5059 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08005060 */
5061 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005062 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08005063
5064 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01005065 * The integer userHandle carried with broadcast intents related to addition, removal and
5066 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
5067 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
5068 *
Amith Yamasani13593602012-03-22 16:16:17 -07005069 * @hide
5070 */
Amith Yamasani2a003292012-08-14 18:25:45 -07005071 public static final String EXTRA_USER_HANDLE =
5072 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07005073
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005074 /**
Philip P. Moltmannc54c36d2018-10-08 15:51:07 -07005075 * The UserHandle carried with intents.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01005076 */
5077 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01005078 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01005079
5080 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005081 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07005082 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
5083 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005084 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07005085 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
5086
5087 /**
5088 * Extra sent in the intent to the BroadcastReceiver that handles
5089 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
5090 * the restrictions as key/value pairs.
5091 */
5092 public static final String EXTRA_RESTRICTIONS_BUNDLE =
5093 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005094
Amith Yamasani86118ba2013-03-28 14:33:16 -07005095 /**
5096 * Extra used in the response from a BroadcastReceiver that handles
5097 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
5098 */
5099 public static final String EXTRA_RESTRICTIONS_INTENT =
5100 "android.intent.extra.restrictions_intent";
5101
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07005102 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005103 * Extra used to communicate a set of acceptable MIME types. The type of the
5104 * extra is {@code String[]}. Values may be a combination of concrete MIME
5105 * types (such as "image/png") and/or partial MIME types (such as
5106 * "audio/*").
5107 *
5108 * @see #ACTION_GET_CONTENT
5109 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07005110 */
5111 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
5112
Dianne Hackborn57a7f592013-07-22 18:21:32 -07005113 /**
5114 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
5115 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07005116 * When this is true, hardware devices can use this information to determine that
5117 * they shouldn't do a complete shutdown of their device since this is not a
5118 * complete shutdown down to the kernel, but only user space restarting.
5119 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07005120 */
5121 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
5122 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
5123
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005124 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00005125 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
5126 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
5127 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
5128 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005129 *
5130 * @hide for internal use only.
5131 */
5132 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
5133 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00005134 /** @hide */
5135 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
5136 /** @hide */
5137 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
5138 /** @hide */
5139 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005140
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07005141 /**
5142 * Intent extra: the reason that the operation associated with this intent is being performed.
5143 *
5144 * <p>Type: String
5145 * @hide
5146 */
5147 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07005148 public static final String EXTRA_REASON = "android.intent.extra.REASON";
5149
qingxi240c2bb2017-04-12 17:31:18 -07005150 /**
5151 * {@hide}
5152 * This extra will be send together with {@link #ACTION_FACTORY_RESET}
5153 */
Rubin Xue8490f12015-06-25 12:17:48 +01005154 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
5155
Santos Cordon15a13782015-03-31 18:32:31 -07005156 /**
qingxi240c2bb2017-04-12 17:31:18 -07005157 * {@hide}
5158 * This extra will be set to true when the user choose to wipe the data on eSIM during factory
5159 * reset for the device with eSIM. This extra will be sent together with
5160 * {@link #ACTION_FACTORY_RESET}
5161 */
5162 public static final String EXTRA_WIPE_ESIMS = "com.android.internal.intent.extra.WIPE_ESIMS";
5163
5164 /**
Santos Cordon15a13782015-03-31 18:32:31 -07005165 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
5166 * activation request.
5167 * TODO: Add information about the structure and response data used with the pending intent.
5168 * @hide
5169 */
5170 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
5171 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
5172
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09005173 /**
5174 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09005175 *
5176 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07005177 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09005178 */
Steve McKay6eaf38632015-08-04 10:11:01 -07005179 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
5180
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005181 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09005182 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
5183 * such as opening in other apps, sharing, opening, editing, printing, deleting,
5184 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005185 *
5186 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07005187 * @see #ACTION_QUICK_VIEW
5188 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005189 */
Garfield Tance1d0e92017-03-23 10:52:48 -07005190 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09005191 public static final String EXTRA_QUICK_VIEW_ADVANCED =
5192 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005193
5194 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07005195 * An optional extra of {@code String[]} indicating which quick view features should be made
5196 * available to the user in the quick view UI while handing a
5197 * {@link Intent#ACTION_QUICK_VIEW} intent.
5198 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
5199 * Quick viewer can implement features not listed below.
5200 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
Geoffrey Pitschbc02b772017-12-06 11:24:15 -05005201 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DELETE},
5202 * {@link QuickViewConstants#FEATURE_DOWNLOAD}, {@link QuickViewConstants#FEATURE_SEND},
5203 * {@link QuickViewConstants#FEATURE_PRINT}.
Garfield Tance1d0e92017-03-23 10:52:48 -07005204 * <p>
5205 * Requirements:
5206 * <li>Quick viewer shouldn't show a feature if the feature is absent in
5207 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
5208 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
5209 * internal policies.
5210 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
5211 * requirement that the feature be shown. Quick viewer may, according to its own policies,
5212 * disable or hide features.
5213 *
5214 * @see #ACTION_QUICK_VIEW
5215 */
5216 public static final String EXTRA_QUICK_VIEW_FEATURES =
5217 "android.intent.extra.QUICK_VIEW_FEATURES";
5218
5219 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005220 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01005221 * When a profile goes into quiet mode, all apps in the profile are killed and the
5222 * profile user is stopped. Widgets originating from the profile are masked, and app
5223 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005224 */
5225 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005226
5227 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005228 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005229 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005230 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
5231 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005232 *
5233 * @hide
5234 */
5235 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
5236 "android.intent.extra.MEDIA_RESOURCE_TYPE";
5237
5238 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07005239 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
5240 * whether to show the chooser or not when there is only one application available
5241 * to choose from.
5242 *
5243 * @hide
5244 */
5245 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
5246 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
5247
5248 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005249 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005250 * to represent that a video codec is allowed to use.
5251 *
5252 * @hide
5253 */
5254 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
5255
5256 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005257 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005258 * to represent that a audio codec is allowed to use.
5259 *
5260 * @hide
5261 */
5262 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
5263
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005264 // ---------------------------------------------------------------------
5265 // ---------------------------------------------------------------------
5266 // Intent flags (see mFlags variable).
5267
Tor Norbyed9273d62013-05-30 15:59:53 -07005268 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005269 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005270 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
5271 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07005272 @Retention(RetentionPolicy.SOURCE)
5273 public @interface GrantUriMode {}
5274
Jeff Sharkey846318a2014-04-04 12:12:41 -07005275 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005276 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005277 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
5278 @Retention(RetentionPolicy.SOURCE)
5279 public @interface AccessUriMode {}
5280
5281 /**
5282 * Test if given mode flags specify an access mode, which must be at least
5283 * read and/or write.
5284 *
5285 * @hide
5286 */
5287 public static boolean isAccessUriMode(int modeFlags) {
5288 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
5289 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
5290 }
5291
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005292 /** @hide */
5293 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5294 FLAG_GRANT_READ_URI_PERMISSION,
5295 FLAG_GRANT_WRITE_URI_PERMISSION,
5296 FLAG_FROM_BACKGROUND,
5297 FLAG_DEBUG_LOG_RESOLUTION,
5298 FLAG_EXCLUDE_STOPPED_PACKAGES,
5299 FLAG_INCLUDE_STOPPED_PACKAGES,
5300 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
5301 FLAG_GRANT_PREFIX_URI_PERMISSION,
5302 FLAG_DEBUG_TRIAGED_MISSING,
5303 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005304 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005305 FLAG_ACTIVITY_NO_HISTORY,
5306 FLAG_ACTIVITY_SINGLE_TOP,
5307 FLAG_ACTIVITY_NEW_TASK,
5308 FLAG_ACTIVITY_MULTIPLE_TASK,
5309 FLAG_ACTIVITY_CLEAR_TOP,
5310 FLAG_ACTIVITY_FORWARD_RESULT,
5311 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5312 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5313 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5314 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5315 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5316 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5317 FLAG_ACTIVITY_NEW_DOCUMENT,
5318 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5319 FLAG_ACTIVITY_NO_USER_ACTION,
5320 FLAG_ACTIVITY_REORDER_TO_FRONT,
5321 FLAG_ACTIVITY_NO_ANIMATION,
5322 FLAG_ACTIVITY_CLEAR_TASK,
5323 FLAG_ACTIVITY_TASK_ON_HOME,
5324 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5325 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5326 FLAG_RECEIVER_REGISTERED_ONLY,
5327 FLAG_RECEIVER_REPLACE_PENDING,
5328 FLAG_RECEIVER_FOREGROUND,
5329 FLAG_RECEIVER_NO_ABORT,
5330 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5331 FLAG_RECEIVER_BOOT_UPGRADE,
5332 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5333 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5334 FLAG_RECEIVER_FROM_SHELL,
5335 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
Ng Zhi An150a6ba2018-08-13 09:08:11 -07005336 FLAG_RECEIVER_OFFLOAD,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005337 })
5338 @Retention(RetentionPolicy.SOURCE)
5339 public @interface Flags {}
5340
5341 /** @hide */
5342 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5343 FLAG_FROM_BACKGROUND,
5344 FLAG_DEBUG_LOG_RESOLUTION,
5345 FLAG_EXCLUDE_STOPPED_PACKAGES,
5346 FLAG_INCLUDE_STOPPED_PACKAGES,
5347 FLAG_DEBUG_TRIAGED_MISSING,
5348 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005349 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005350 FLAG_ACTIVITY_NO_HISTORY,
5351 FLAG_ACTIVITY_SINGLE_TOP,
5352 FLAG_ACTIVITY_NEW_TASK,
5353 FLAG_ACTIVITY_MULTIPLE_TASK,
5354 FLAG_ACTIVITY_CLEAR_TOP,
5355 FLAG_ACTIVITY_FORWARD_RESULT,
5356 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5357 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5358 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5359 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5360 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5361 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5362 FLAG_ACTIVITY_NEW_DOCUMENT,
5363 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5364 FLAG_ACTIVITY_NO_USER_ACTION,
5365 FLAG_ACTIVITY_REORDER_TO_FRONT,
5366 FLAG_ACTIVITY_NO_ANIMATION,
5367 FLAG_ACTIVITY_CLEAR_TASK,
5368 FLAG_ACTIVITY_TASK_ON_HOME,
5369 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5370 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5371 FLAG_RECEIVER_REGISTERED_ONLY,
5372 FLAG_RECEIVER_REPLACE_PENDING,
5373 FLAG_RECEIVER_FOREGROUND,
5374 FLAG_RECEIVER_NO_ABORT,
5375 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5376 FLAG_RECEIVER_BOOT_UPGRADE,
5377 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5378 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5379 FLAG_RECEIVER_FROM_SHELL,
5380 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
Ng Zhi An150a6ba2018-08-13 09:08:11 -07005381 FLAG_RECEIVER_OFFLOAD,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005382 })
5383 @Retention(RetentionPolicy.SOURCE)
5384 public @interface MutableFlags {}
5385
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005386 /**
5387 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005388 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005389 * specified in its ClipData. When applying to an Intent's ClipData,
5390 * all URIs as well as recursive traversals through data or other ClipData
5391 * in Intent items will be granted; only the grant flags of the top-level
5392 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005393 */
5394 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5395 /**
5396 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005397 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005398 * specified in its ClipData. When applying to an Intent's ClipData,
5399 * all URIs as well as recursive traversals through data or other ClipData
5400 * in Intent items will be granted; only the grant flags of the top-level
5401 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005402 */
5403 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5404 /**
5405 * Can be set by the caller to indicate that this Intent is coming from
5406 * a background operation, not from direct user interaction.
5407 */
5408 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5409 /**
5410 * A flag you can enable for debugging: when set, log messages will be
5411 * printed during the resolution of this intent to show you what has
5412 * been found to create the final resolved list.
5413 */
5414 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005415 /**
5416 * If set, this intent will not match any components in packages that
5417 * are currently stopped. If this is not set, then the default behavior
5418 * is to include such applications in the result.
5419 */
5420 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5421 /**
5422 * If set, this intent will always match any components in packages that
5423 * are currently stopped. This is the default behavior when
5424 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5425 * flags are set, this one wins (it allows overriding of exclude for
5426 * places where the framework may automatically set the exclude flag).
5427 */
5428 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005429
5430 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005431 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005432 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005433 * persisted across device reboots until explicitly revoked with
5434 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5435 * grant for possible persisting; the receiving application must call
5436 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5437 * actually persist.
5438 *
5439 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5440 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5441 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005442 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005443 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005444 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005445
5446 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005447 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5448 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5449 * applies to any URI that is a prefix match against the original granted
5450 * URI. (Without this flag, the URI must match exactly for access to be
5451 * granted.) Another URI is considered a prefix match only when scheme,
5452 * authority, and all path segments defined by the prefix are an exact
5453 * match.
5454 */
5455 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5456
5457 /**
Jeff Sharkeyc59a5e72018-06-21 19:14:58 -06005458 * Flag used to automatically match intents based on their Direct Boot
5459 * awareness and the current user state.
5460 * <p>
5461 * Since the default behavior is to automatically apply the current user
5462 * state, this is effectively a sentinel value that doesn't change the
5463 * output of any queries based on its presence or absence.
5464 * <p>
5465 * Instead, this value can be useful in conjunction with
5466 * {@link android.os.StrictMode.VmPolicy.Builder#detectImplicitDirectBoot()}
5467 * to detect when a caller is relying on implicit automatic matching,
5468 * instead of confirming the explicit behavior they want.
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005469 */
Jeff Sharkeyc59a5e72018-06-21 19:14:58 -06005470 public static final int FLAG_DIRECT_BOOT_AUTO = 0x00000100;
5471
5472 /** {@hide} */
5473 @Deprecated
5474 public static final int FLAG_DEBUG_TRIAGED_MISSING = FLAG_DIRECT_BOOT_AUTO;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005475
5476 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005477 * Internal flag used to indicate ephemeral applications should not be
5478 * considered when resolving the intent.
5479 *
5480 * @hide
5481 */
5482 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5483
5484 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005485 * If set, the new activity is not kept in the history stack. As soon as
5486 * the user navigates away from it, the activity is finished. This may also
5487 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5488 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005489 *
5490 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5491 * is never invoked when the current activity starts a new activity which
5492 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005493 */
5494 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5495 /**
5496 * If set, the activity will not be launched if it is already running
5497 * at the top of the history stack.
5498 */
5499 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5500 /**
5501 * If set, this activity will become the start of a new task on this
5502 * history stack. A task (from the activity that started it to the
5503 * next task activity) defines an atomic group of activities that the
5504 * user can move to. Tasks can be moved to the foreground and background;
5505 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005506 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005507 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5508 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005509 *
5510 * <p>This flag is generally used by activities that want
5511 * to present a "launcher" style behavior: they give the user a list of
5512 * separate things that can be done, which otherwise run completely
5513 * independently of the activity launching them.
5514 *
5515 * <p>When using this flag, if a task is already running for the activity
5516 * you are now starting, then a new activity will not be started; instead,
5517 * the current task will simply be brought to the front of the screen with
5518 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5519 * to disable this behavior.
5520 *
5521 * <p>This flag can not be used when the caller is requesting a result from
5522 * the activity being launched.
5523 */
5524 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5525 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005526 * This flag is used to create a new task and launch an activity into it.
5527 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5528 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5529 * search through existing tasks for ones matching this Intent. Only if no such
5530 * task is found would a new task be created. When paired with
5531 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5532 * the search for a matching task and unconditionally start a new task.
5533 *
5534 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5535 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005536 * top-level application launcher.</strong> Used in conjunction with
5537 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5538 * behavior of bringing an existing task to the foreground. When set,
5539 * a new task is <em>always</em> started to host the Activity for the
5540 * Intent, regardless of whether there is already an existing task running
5541 * the same thing.
5542 *
5543 * <p><strong>Because the default system does not include graphical task management,
5544 * you should not use this flag unless you provide some way for a user to
5545 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005546 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005547 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5548 * creating new document tasks.
5549 *
5550 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005551 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005552 *
Scott Main7aee61f2011-02-08 11:25:01 -08005553 * <p>See
5554 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5555 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005556 *
5557 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5558 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005559 */
5560 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5561 /**
5562 * If set, and the activity being launched is already running in the
5563 * current task, then instead of launching a new instance of that activity,
5564 * all of the other activities on top of it will be closed and this Intent
5565 * will be delivered to the (now on top) old activity as a new Intent.
5566 *
5567 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5568 * If D calls startActivity() with an Intent that resolves to the component
5569 * of activity B, then C and D will be finished and B receive the given
5570 * Intent, resulting in the stack now being: A, B.
5571 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005572 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005573 * either receive the new intent you are starting here in its
5574 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005575 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005576 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5577 * the same intent, then it will be finished and re-created; for all other
5578 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5579 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005580 *
5581 * <p>This launch mode can also be used to good effect in conjunction with
5582 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5583 * of a task, it will bring any currently running instance of that task
5584 * to the foreground, and then clear it to its root state. This is
5585 * especially useful, for example, when launching an activity from the
5586 * notification manager.
5587 *
Scott Main7aee61f2011-02-08 11:25:01 -08005588 * <p>See
5589 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5590 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005591 */
5592 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5593 /**
5594 * If set and this intent is being used to launch a new activity from an
5595 * existing one, then the reply target of the existing activity will be
kopriva219f7dc2018-10-09 13:42:28 -07005596 * transferred to the new activity. This way, the new activity can call
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005597 * {@link android.app.Activity#setResult} and have that result sent back to
5598 * the reply target of the original activity.
5599 */
5600 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5601 /**
5602 * If set and this intent is being used to launch a new activity from an
5603 * existing one, the current activity will not be counted as the top
5604 * activity for deciding whether the new intent should be delivered to
5605 * the top instead of starting a new one. The previous activity will
5606 * be used as the top, with the assumption being that the current activity
5607 * will finish itself immediately.
5608 */
5609 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5610 /**
5611 * If set, the new activity is not kept in the list of recently launched
5612 * activities.
5613 */
5614 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5615 /**
5616 * This flag is not normally set by application code, but set for you by
5617 * the system as described in the
5618 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5619 * launchMode} documentation for the singleTask mode.
5620 */
5621 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5622 /**
5623 * If set, and this activity is either being started in a new task or
5624 * bringing to the top an existing task, then it will be launched as
5625 * the front door of the task. This will result in the application of
5626 * any affinities needed to have that task in the proper state (either
5627 * moving activities to or from it), or simply resetting that task to
5628 * its initial state if needed.
5629 */
5630 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5631 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005632 * This flag is not normally set by application code, but set for you by
5633 * the system if this activity is being launched from history
5634 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005635 */
5636 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005637 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005638 * @deprecated As of API 21 this performs identically to
5639 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005640 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005641 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005642 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005643 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005644 * This flag is used to open a document into a new task rooted at the activity launched
5645 * by this Intent. Through the use of this flag, or its equivalent attribute,
5646 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005647 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005648 *
Craig Mautner026596b2014-05-21 15:35:44 -07005649 * <p>The use of the activity attribute form of this,
5650 * {@link android.R.attr#documentLaunchMode}, is
5651 * preferred over the Intent flag described here. The attribute form allows the
5652 * Activity to specify multiple document behavior for all launchers of the Activity
5653 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005654 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005655 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5656 * it is kept after the activity is finished is different than the use of
5657 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5658 * this flag is being used to create a new recents entry, then by default that entry
5659 * will be removed once the activity is finished. You can modify this behavior with
5660 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5661 *
Craig Mautner026596b2014-05-21 15:35:44 -07005662 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5663 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5664 * equivalent of the Activity manifest specifying {@link
5665 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5666 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5667 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005668 *
Craig Mautner026596b2014-05-21 15:35:44 -07005669 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005670 *
Craig Mautner026596b2014-05-21 15:35:44 -07005671 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005672 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5673 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005674 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005675 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005676 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005677 * callback from occurring on the current frontmost activity before it is
5678 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005679 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005680 * <p>Typically, an activity can rely on that callback to indicate that an
5681 * explicit user action has caused their activity to be moved out of the
5682 * foreground. The callback marks an appropriate point in the activity's
5683 * lifecycle for it to dismiss any notifications that it intends to display
5684 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005685 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005686 * <p>If an activity is ever started via any non-user-driven events such as
5687 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5688 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005689 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005690 */
5691 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005692 /**
5693 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5694 * this flag will cause the launched activity to be brought to the front of its
5695 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005696 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005697 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5698 * If D calls startActivity() with an Intent that resolves to the component
5699 * of activity B, then B will be brought to the front of the history stack,
5700 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005701 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005702 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005703 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005704 */
5705 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005706 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005707 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5708 * this flag will prevent the system from applying an activity transition
5709 * animation to go to the next activity state. This doesn't mean an
5710 * animation will never run -- if another activity change happens that doesn't
5711 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005712 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005713 * when you are going to do a series of activity operations but the
5714 * animation seen by the user shouldn't be driven by the first activity
5715 * change but rather a later one.
5716 */
5717 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5718 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005719 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5720 * this flag will cause any existing task that would be associated with the
5721 * activity to be cleared before the activity is started. That is, the activity
5722 * becomes the new root of an otherwise empty task, and any old activities
5723 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5724 */
5725 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5726 /**
5727 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5728 * this flag will cause a newly launching task to be placed on top of the current
5729 * home activity task (if there is one). That is, pressing back from the task
5730 * will always return the user to home even if that was not the last activity they
5731 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5732 */
5733 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5734 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005735 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5736 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005737 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005738 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005739 * this flag. When set and the task's activity is finished, the recents
5740 * entry will remain in the interface for the user to re-launch it, like a
5741 * recents entry for a top-level application.
5742 * <p>
5743 * The receiving activity can override this request with
5744 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5745 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005746 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005747 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005748 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005749
5750 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005751 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5752 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005753 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5754 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005755 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005756 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005757
Patrick Baumann577d4022018-01-31 16:55:10 +00005758
5759 /**
Patrick Baumann92ae2c62018-05-10 10:10:26 -07005760 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5761 * this flag will attempt to launch an instant app if no full app on the device can already
5762 * handle the intent.
5763 * <p>
5764 * When attempting to resolve instant apps externally, the following {@link Intent} properties
5765 * are supported:
5766 * <ul>
5767 * <li>{@link Intent#setAction(String)}</li>
5768 * <li>{@link Intent#addCategory(String)}</li>
5769 * <li>{@link Intent#setData(Uri)}</li>
5770 * <li>{@link Intent#setType(String)}</li>
5771 * <li>{@link Intent#setPackage(String)}</li>
5772 * <li>{@link Intent#addFlags(int)}</li>
5773 * </ul>
5774 * <p>
5775 * In the case that no instant app can be found, the installer will be launched to notify the
5776 * user that the intent could not be resolved. On devices that do not support instant apps,
5777 * the flag will be ignored.
Patrick Baumann577d4022018-01-31 16:55:10 +00005778 */
5779 public static final int FLAG_ACTIVITY_MATCH_EXTERNAL = 0x00000800;
5780
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005781 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005782 * If set, when sending a broadcast only registered receivers will be
5783 * called -- no BroadcastReceiver components will be launched.
5784 */
5785 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005786 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005787 * If set, when sending a broadcast the new broadcast will replace
5788 * any existing pending broadcast that matches it. Matching is defined
5789 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5790 * true for the intents of the two broadcasts. When a match is found,
5791 * the new broadcast (and receivers associated with it) will replace the
5792 * existing one in the pending broadcast list, remaining at the same
5793 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005794 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005795 * <p>This flag is most typically used with sticky broadcasts, which
5796 * only care about delivering the most recent values of the broadcast
5797 * to their receivers.
5798 */
5799 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5800 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005801 * If set, when sending a broadcast the recipient is allowed to run at
5802 * foreground priority, with a shorter timeout interval. During normal
5803 * broadcasts the receivers are not automatically hoisted out of the
5804 * background priority class.
5805 */
5806 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5807 /**
Ng Zhi An150a6ba2018-08-13 09:08:11 -07005808 * If set, when sending a broadcast the recipient will be run on the offload queue.
5809 *
5810 * @hide
5811 */
5812 public static final int FLAG_RECEIVER_OFFLOAD = 0x80000000;
5813 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005814 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5815 * They can still propagate results through to later receivers, but they can not prevent
5816 * later receivers from seeing the broadcast.
5817 */
5818 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5819 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005820 * If set, when sending a broadcast <i>before boot has completed</i> only
5821 * registered receivers will be called -- no BroadcastReceiver components
5822 * will be launched. Sticky intent state will be recorded properly even
5823 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5824 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005825 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005826 * <p>This flag is only for use by system sevices as a convenience to
5827 * avoid having to implement a more complex mechanism around detection
5828 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005829 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005830 * @hide
5831 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01005832 @UnsupportedAppUsage
Dianne Hackborn6285a322013-09-18 12:09:47 -07005833 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005834 /**
5835 * Set when this broadcast is for a boot upgrade, a special mode that
5836 * allows the broadcast to be sent before the system is ready and launches
5837 * the app process with no providers running in it.
5838 * @hide
5839 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005840 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005841 /**
5842 * If set, the broadcast will always go to manifest receivers in background (cached
5843 * or not running) apps, regardless of whether that would be done by default. By
5844 * default they will only receive broadcasts if the broadcast has specified an
5845 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005846 *
5847 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5848 * the broadcast code there must also be changed to match.
5849 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005850 * @hide
5851 */
5852 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5853 /**
5854 * If set, the broadcast will never go to manifest receivers in background (cached
5855 * or not running) apps, regardless of whether that would be done by default. By
5856 * default they will receive broadcasts if the broadcast has specified an
5857 * explicit component or package name.
5858 * @hide
5859 */
5860 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005861 /**
5862 * If set, this broadcast is being sent from the shell.
5863 * @hide
5864 */
5865 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005866
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005867 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005868 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5869 * will not receive broadcasts.
5870 *
5871 * <em>This flag has no effect when used by an Instant App.</em>
5872 */
5873 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5874
5875 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005876 * @hide Flags that can't be changed with PendingIntent.
5877 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005878 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5879 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5880 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005881
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005882 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005883 // ---------------------------------------------------------------------
5884 // toUri() and parseUri() options.
5885
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005886 /** @hide */
5887 @IntDef(flag = true, prefix = { "URI_" }, value = {
5888 URI_ALLOW_UNSAFE,
5889 URI_ANDROID_APP_SCHEME,
5890 URI_INTENT_SCHEME,
5891 })
5892 @Retention(RetentionPolicy.SOURCE)
5893 public @interface UriFlags {}
5894
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005895 /**
5896 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5897 * always has the "intent:" scheme. This syntax can be used when you want
5898 * to later disambiguate between URIs that are intended to describe an
5899 * Intent vs. all others that should be treated as raw URIs. When used
5900 * with {@link #parseUri}, any other scheme will result in a generic
5901 * VIEW action for that raw URI.
5902 */
5903 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005904
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005905 /**
5906 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5907 * always has the "android-app:" scheme. This is a variation of
5908 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5909 * http/https URI being delivered to a specific package name. The format
5910 * is:
5911 *
5912 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005913 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005914 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005915 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5916 * you must also include a scheme; including a path also requires both a host and a scheme.
5917 * The final #Intent; fragment can be used without a scheme, host, or path.
5918 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005919 * used with intents that have a {@link #setSelector}, since the base intent
5920 * will always have an explicit package name.</p>
5921 *
5922 * <p>Some examples of how this scheme maps to Intent objects:</p>
5923 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5924 * <colgroup align="left" />
5925 * <colgroup align="left" />
5926 * <thead>
5927 * <tr><th>URI</th> <th>Intent</th></tr>
5928 * </thead>
5929 *
5930 * <tbody>
5931 * <tr><td><code>android-app://com.example.app</code></td>
5932 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5933 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5934 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5935 * </table></td>
5936 * </tr>
5937 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5938 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5939 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5940 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5941 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5942 * </table></td>
5943 * </tr>
5944 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5945 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5946 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5947 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5948 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5949 * </table></td>
5950 * </tr>
5951 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5952 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5953 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5954 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5955 * </table></td>
5956 * </tr>
5957 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5958 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5959 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5960 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5961 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5962 * </table></td>
5963 * </tr>
5964 * <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>
5965 * <td><table border="" style="margin:0" >
5966 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5967 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5968 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5969 * </table></td>
5970 * </tr>
5971 * </tbody>
5972 * </table>
5973 */
5974 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5975
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005976 /**
5977 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5978 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5979 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5980 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5981 * generated Intent can not cause unexpected data access to happen.
5982 *
5983 * <p>If you do not trust the source of the URI being parsed, you should still do further
5984 * processing to protect yourself from it. In particular, when using it to start an
5985 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5986 * that can handle it.</p>
5987 */
5988 public static final int URI_ALLOW_UNSAFE = 1<<2;
5989
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005990 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005991
5992 private String mAction;
5993 private Uri mData;
5994 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005995 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005996 private ComponentName mComponent;
5997 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005998 private ArraySet<String> mCategories;
Mathew Inwood5c0d3542018-08-14 13:54:31 +01005999 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006000 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006001 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006002 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006003 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006004 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07006005 /** Token to track instant app launches. Local only; do not copy cross-process. */
6006 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006007
6008 // ---------------------------------------------------------------------
6009
Makoto Onuki97f82f22017-05-31 16:20:21 -07006010 private static final int COPY_MODE_ALL = 0;
6011 private static final int COPY_MODE_FILTER = 1;
6012 private static final int COPY_MODE_HISTORY = 2;
6013
6014 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07006015 @IntDef(prefix = { "COPY_MODE_" }, value = {
6016 COPY_MODE_ALL,
6017 COPY_MODE_FILTER,
6018 COPY_MODE_HISTORY
6019 })
Makoto Onuki97f82f22017-05-31 16:20:21 -07006020 @Retention(RetentionPolicy.SOURCE)
6021 public @interface CopyMode {}
6022
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006023 /**
6024 * Create an empty intent.
6025 */
6026 public Intent() {
6027 }
6028
6029 /**
6030 * Copy constructor.
6031 */
6032 public Intent(Intent o) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07006033 this(o, COPY_MODE_ALL);
6034 }
6035
6036 private Intent(Intent o, @CopyMode int copyMode) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006037 this.mAction = o.mAction;
6038 this.mData = o.mData;
6039 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006040 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006041 this.mComponent = o.mComponent;
Makoto Onuki97f82f22017-05-31 16:20:21 -07006042
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006043 if (o.mCategories != null) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07006044 this.mCategories = new ArraySet<>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006045 }
Makoto Onuki97f82f22017-05-31 16:20:21 -07006046
6047 if (copyMode != COPY_MODE_FILTER) {
6048 this.mFlags = o.mFlags;
6049 this.mContentUserHint = o.mContentUserHint;
6050 this.mLaunchToken = o.mLaunchToken;
6051 if (o.mSourceBounds != null) {
6052 this.mSourceBounds = new Rect(o.mSourceBounds);
6053 }
6054 if (o.mSelector != null) {
6055 this.mSelector = new Intent(o.mSelector);
6056 }
6057
6058 if (copyMode != COPY_MODE_HISTORY) {
6059 if (o.mExtras != null) {
6060 this.mExtras = new Bundle(o.mExtras);
6061 }
6062 if (o.mClipData != null) {
6063 this.mClipData = new ClipData(o.mClipData);
6064 }
6065 } else {
6066 if (o.mExtras != null && !o.mExtras.maybeIsEmpty()) {
6067 this.mExtras = Bundle.STRIPPED;
6068 }
6069
6070 // Also set "stripped" clip data when we ever log mClipData in the (broadcast)
6071 // history.
6072 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006073 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006074 }
6075
6076 @Override
6077 public Object clone() {
6078 return new Intent(this);
6079 }
6080
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006081 /**
6082 * Make a clone of only the parts of the Intent that are relevant for
6083 * filter matching: the action, data, type, component, and categories.
6084 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006085 public @NonNull Intent cloneFilter() {
Makoto Onuki97f82f22017-05-31 16:20:21 -07006086 return new Intent(this, COPY_MODE_FILTER);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006087 }
6088
6089 /**
6090 * Create an intent with a given action. All other fields (data, type,
6091 * class) are null. Note that the action <em>must</em> be in a
6092 * namespace because Intents are used globally in the system -- for
6093 * example the system VIEW action is android.intent.action.VIEW; an
6094 * application's custom action would be something like
6095 * com.google.app.myapp.CUSTOM_ACTION.
6096 *
6097 * @param action The Intent action, such as ACTION_VIEW.
6098 */
6099 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006100 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006101 }
6102
6103 /**
6104 * Create an intent with a given action and for a given data url. Note
6105 * that the action <em>must</em> be in a namespace because Intents are
6106 * used globally in the system -- for example the system VIEW action is
6107 * android.intent.action.VIEW; an application's custom action would be
6108 * something like com.google.app.myapp.CUSTOM_ACTION.
6109 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006110 * <p><em>Note: scheme and host name matching in the Android framework is
6111 * case-sensitive, unlike the formal RFC. As a result,
6112 * you should always ensure that you write your Uri with these elements
6113 * using lower case letters, and normalize any Uris you receive from
6114 * outside of Android to ensure the scheme and host is lower case.</em></p>
6115 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006116 * @param action The Intent action, such as ACTION_VIEW.
6117 * @param uri The Intent data URI.
6118 */
6119 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006120 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006121 mData = uri;
6122 }
6123
6124 /**
6125 * Create an intent for a specific component. All other fields (action, data,
6126 * type, class) are null, though they can be modified later with explicit
6127 * calls. This provides a convenient way to create an intent that is
6128 * intended to execute a hard-coded class name, rather than relying on the
6129 * system to find an appropriate class for you; see {@link #setComponent}
6130 * for more information on the repercussions of this.
6131 *
6132 * @param packageContext A Context of the application package implementing
6133 * this class.
6134 * @param cls The component class that is to be used for the intent.
6135 *
6136 * @see #setClass
6137 * @see #setComponent
6138 * @see #Intent(String, android.net.Uri , Context, Class)
6139 */
6140 public Intent(Context packageContext, Class<?> cls) {
6141 mComponent = new ComponentName(packageContext, cls);
6142 }
6143
6144 /**
6145 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07006146 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006147 * construct the Intent and then calling {@link #setClass} to set its
6148 * class.
6149 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006150 * <p><em>Note: scheme and host name matching in the Android framework is
6151 * case-sensitive, unlike the formal RFC. As a result,
6152 * you should always ensure that you write your Uri with these elements
6153 * using lower case letters, and normalize any Uris you receive from
6154 * outside of Android to ensure the scheme and host is lower case.</em></p>
6155 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006156 * @param action The Intent action, such as ACTION_VIEW.
6157 * @param uri The Intent data URI.
6158 * @param packageContext A Context of the application package implementing
6159 * this class.
6160 * @param cls The component class that is to be used for the intent.
6161 *
6162 * @see #Intent(String, android.net.Uri)
6163 * @see #Intent(Context, Class)
6164 * @see #setClass
6165 * @see #setComponent
6166 */
6167 public Intent(String action, Uri uri,
6168 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006169 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006170 mData = uri;
6171 mComponent = new ComponentName(packageContext, cls);
6172 }
6173
6174 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08006175 * Create an intent to launch the main (root) activity of a task. This
6176 * is the Intent that is started when the application's is launched from
6177 * Home. For anything else that wants to launch an application in the
6178 * same way, it is important that they use an Intent structured the same
6179 * way, and can use this function to ensure this is the case.
6180 *
6181 * <p>The returned Intent has the given Activity component as its explicit
6182 * component, {@link #ACTION_MAIN} as its action, and includes the
6183 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
6184 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
6185 * to do that through {@link #addFlags(int)} on the returned Intent.
6186 *
6187 * @param mainActivity The main activity component that this Intent will
6188 * launch.
6189 * @return Returns a newly created Intent that can be used to launch the
6190 * activity as a main application entry.
6191 *
6192 * @see #setClass
6193 * @see #setComponent
6194 */
6195 public static Intent makeMainActivity(ComponentName mainActivity) {
6196 Intent intent = new Intent(ACTION_MAIN);
6197 intent.setComponent(mainActivity);
6198 intent.addCategory(CATEGORY_LAUNCHER);
6199 return intent;
6200 }
6201
6202 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006203 * Make an Intent for the main activity of an application, without
6204 * specifying a specific activity to run but giving a selector to find
6205 * the activity. This results in a final Intent that is structured
6206 * the same as when the application is launched from
6207 * Home. For anything else that wants to launch an application in the
6208 * same way, it is important that they use an Intent structured the same
6209 * way, and can use this function to ensure this is the case.
6210 *
6211 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
6212 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
6213 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
6214 * to do that through {@link #addFlags(int)} on the returned Intent.
6215 *
6216 * @param selectorAction The action name of the Intent's selector.
6217 * @param selectorCategory The name of a category to add to the Intent's
6218 * selector.
6219 * @return Returns a newly created Intent that can be used to launch the
6220 * activity as a main application entry.
6221 *
6222 * @see #setSelector(Intent)
6223 */
6224 public static Intent makeMainSelectorActivity(String selectorAction,
6225 String selectorCategory) {
6226 Intent intent = new Intent(ACTION_MAIN);
6227 intent.addCategory(CATEGORY_LAUNCHER);
6228 Intent selector = new Intent();
6229 selector.setAction(selectorAction);
6230 selector.addCategory(selectorCategory);
6231 intent.setSelector(selector);
6232 return intent;
6233 }
6234
6235 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08006236 * Make an Intent that can be used to re-launch an application's task
6237 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
6238 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
6239 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
6240 *
6241 * @param mainActivity The activity component that is the root of the
6242 * task; this is the activity that has been published in the application's
6243 * manifest as the main launcher icon.
6244 *
6245 * @return Returns a newly created Intent that can be used to relaunch the
6246 * activity's task in its root state.
6247 */
6248 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
6249 Intent intent = makeMainActivity(mainActivity);
6250 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
6251 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
6252 return intent;
6253 }
6254
6255 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006256 * Call {@link #parseUri} with 0 flags.
6257 * @deprecated Use {@link #parseUri} instead.
6258 */
6259 @Deprecated
6260 public static Intent getIntent(String uri) throws URISyntaxException {
6261 return parseUri(uri, 0);
6262 }
Tom Taylord4a47292009-12-21 13:59:18 -08006263
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006264 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006265 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006266 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07006267 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006268 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006269 *
6270 * <p>The URI given here must not be relative -- that is, it must include
6271 * the scheme and full path.
6272 *
6273 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006274 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006275 *
6276 * @return Intent The newly created Intent object.
6277 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006278 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
6279 * it bad (as parsed by the Uri class) or the Intent data within the
6280 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08006281 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006282 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006283 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006284 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006285 int i = 0;
6286 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006287 final boolean androidApp = uri.startsWith("android-app:");
6288
6289 // Validate intent scheme if requested.
6290 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
6291 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006292 Intent intent = new Intent(ACTION_VIEW);
6293 try {
6294 intent.setData(Uri.parse(uri));
6295 } catch (IllegalArgumentException e) {
6296 throw new URISyntaxException(uri, e.getMessage());
6297 }
6298 return intent;
6299 }
6300 }
Tom Taylord4a47292009-12-21 13:59:18 -08006301
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006302 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006303 // simple case
6304 if (i == -1) {
6305 if (!androidApp) {
6306 return new Intent(ACTION_VIEW, Uri.parse(uri));
6307 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006308
6309 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006310 } else if (!uri.startsWith("#Intent;", i)) {
6311 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006312 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006313 } else {
6314 i = -1;
6315 }
6316 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006317
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006318 // new format
6319 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006320 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006321 boolean explicitAction = false;
6322 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006323
6324 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006325 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006326 String data;
6327 if (i >= 0) {
6328 data = uri.substring(0, i);
6329 i += 8; // length of "#Intent;"
6330 } else {
6331 data = uri;
6332 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006333
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006334 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006335 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006336 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006337 if (eq < 0) eq = i-1;
6338 int semi = uri.indexOf(';', i);
6339 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006340
6341 // action
6342 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006343 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006344 if (!inSelector) {
6345 explicitAction = true;
6346 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006347 }
6348
6349 // categories
6350 else if (uri.startsWith("category=", i)) {
6351 intent.addCategory(value);
6352 }
6353
6354 // type
6355 else if (uri.startsWith("type=", i)) {
6356 intent.mType = value;
6357 }
6358
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006359 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006360 else if (uri.startsWith("launchFlags=", i)) {
6361 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006362 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6363 intent.mFlags &= ~IMMUTABLE_FLAGS;
6364 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006365 }
6366
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006367 // package
6368 else if (uri.startsWith("package=", i)) {
6369 intent.mPackage = value;
6370 }
6371
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006372 // component
6373 else if (uri.startsWith("component=", i)) {
6374 intent.mComponent = ComponentName.unflattenFromString(value);
6375 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006376
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006377 // scheme
6378 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006379 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006380 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006381 } else {
6382 scheme = value;
6383 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006384 }
6385
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006386 // source bounds
6387 else if (uri.startsWith("sourceBounds=", i)) {
6388 intent.mSourceBounds = Rect.unflattenFromString(value);
6389 }
6390
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006391 // selector
6392 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
6393 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006394 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006395 }
6396
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006397 // extra
6398 else {
6399 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006400 // create Bundle if it doesn't already exist
6401 if (intent.mExtras == null) intent.mExtras = new Bundle();
6402 Bundle b = intent.mExtras;
6403 // add EXTRA
6404 if (uri.startsWith("S.", i)) b.putString(key, value);
6405 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
6406 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
6407 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
6408 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
6409 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
6410 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
6411 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
6412 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
6413 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
6414 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006415
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006416 // move to the next item
6417 i = semi + 1;
6418 }
6419
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006420 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006421 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006422 if (baseIntent.mPackage == null) {
6423 baseIntent.setSelector(intent);
6424 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006425 intent = baseIntent;
6426 }
6427
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006428 if (data != null) {
6429 if (data.startsWith("intent:")) {
6430 data = data.substring(7);
6431 if (scheme != null) {
6432 data = scheme + ':' + data;
6433 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006434 } else if (data.startsWith("android-app:")) {
6435 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
6436 // Correctly formed android-app, first part is package name.
6437 int end = data.indexOf('/', 14);
6438 if (end < 0) {
6439 // All we have is a package name.
6440 intent.mPackage = data.substring(14);
6441 if (!explicitAction) {
6442 intent.setAction(ACTION_MAIN);
6443 }
6444 data = "";
6445 } else {
6446 // Target the Intent at the given package name always.
6447 String authority = null;
6448 intent.mPackage = data.substring(14, end);
6449 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006450 if ((end+1) < data.length()) {
6451 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6452 // Found a scheme, remember it.
6453 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006454 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006455 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6456 // Found a authority, remember it.
6457 authority = data.substring(end+1, newEnd);
6458 end = newEnd;
6459 }
6460 } else {
6461 // All we have is a scheme.
6462 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006463 }
6464 }
6465 if (scheme == null) {
6466 // If there was no scheme, then this just targets the package.
6467 if (!explicitAction) {
6468 intent.setAction(ACTION_MAIN);
6469 }
6470 data = "";
6471 } else if (authority == null) {
6472 data = scheme + ":";
6473 } else {
6474 data = scheme + "://" + authority + data.substring(end);
6475 }
6476 }
6477 } else {
6478 data = "";
6479 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006480 }
Tom Taylord4a47292009-12-21 13:59:18 -08006481
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006482 if (data.length() > 0) {
6483 try {
6484 intent.mData = Uri.parse(data);
6485 } catch (IllegalArgumentException e) {
6486 throw new URISyntaxException(uri, e.getMessage());
6487 }
6488 }
6489 }
Tom Taylord4a47292009-12-21 13:59:18 -08006490
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006491 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006492
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006493 } catch (IndexOutOfBoundsException e) {
6494 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6495 }
6496 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006497
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006498 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006499 return getIntentOld(uri, 0);
6500 }
6501
6502 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006503 Intent intent;
6504
6505 int i = uri.lastIndexOf('#');
6506 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006507 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006508 final int intentFragmentStart = i;
6509 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006510
6511 i++;
6512
6513 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006514 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006515 i += 7;
6516 int j = uri.indexOf(')', i);
6517 action = uri.substring(i, j);
6518 i = j + 1;
6519 }
6520
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006521 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006522
6523 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006524 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006525 i += 11;
6526 int j = uri.indexOf(')', i);
6527 while (i < j) {
6528 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006529 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006530 if (i < sep) {
6531 intent.addCategory(uri.substring(i, sep));
6532 }
6533 i = sep + 1;
6534 }
6535 i = j + 1;
6536 }
6537
6538 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006539 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006540 i += 5;
6541 int j = uri.indexOf(')', i);
6542 intent.mType = uri.substring(i, j);
6543 i = j + 1;
6544 }
6545
6546 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006547 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006548 i += 12;
6549 int j = uri.indexOf(')', i);
6550 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006551 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6552 intent.mFlags &= ~IMMUTABLE_FLAGS;
6553 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006554 i = j + 1;
6555 }
6556
6557 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006558 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006559 i += 10;
6560 int j = uri.indexOf(')', i);
6561 int sep = uri.indexOf('!', i);
6562 if (sep >= 0 && sep < j) {
6563 String pkg = uri.substring(i, sep);
6564 String cls = uri.substring(sep + 1, j);
6565 intent.mComponent = new ComponentName(pkg, cls);
6566 }
6567 i = j + 1;
6568 }
6569
6570 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006571 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006572 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006573
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006574 final int closeParen = uri.indexOf(')', i);
6575 if (closeParen == -1) throw new URISyntaxException(uri,
6576 "EXTRA missing trailing ')'", i);
6577
6578 while (i < closeParen) {
6579 // fetch the key value
6580 int j = uri.indexOf('=', i);
6581 if (j <= i + 1 || i >= closeParen) {
6582 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6583 }
6584 char type = uri.charAt(i);
6585 i++;
6586 String key = uri.substring(i, j);
6587 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006588
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006589 // get type-value
6590 j = uri.indexOf('!', i);
6591 if (j == -1 || j >= closeParen) j = closeParen;
6592 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6593 String value = uri.substring(i, j);
6594 i = j;
6595
6596 // create Bundle if it doesn't already exist
6597 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006598
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006599 // add item to bundle
6600 try {
6601 switch (type) {
6602 case 'S':
6603 intent.mExtras.putString(key, Uri.decode(value));
6604 break;
6605 case 'B':
6606 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6607 break;
6608 case 'b':
6609 intent.mExtras.putByte(key, Byte.parseByte(value));
6610 break;
6611 case 'c':
6612 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6613 break;
6614 case 'd':
6615 intent.mExtras.putDouble(key, Double.parseDouble(value));
6616 break;
6617 case 'f':
6618 intent.mExtras.putFloat(key, Float.parseFloat(value));
6619 break;
6620 case 'i':
6621 intent.mExtras.putInt(key, Integer.parseInt(value));
6622 break;
6623 case 'l':
6624 intent.mExtras.putLong(key, Long.parseLong(value));
6625 break;
6626 case 's':
6627 intent.mExtras.putShort(key, Short.parseShort(value));
6628 break;
6629 default:
6630 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6631 }
6632 } catch (NumberFormatException e) {
6633 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6634 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006635
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006636 char ch = uri.charAt(i);
6637 if (ch == ')') break;
6638 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6639 i++;
6640 }
6641 }
6642
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006643 if (isIntentFragment) {
6644 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6645 } else {
6646 intent.mData = Uri.parse(uri);
6647 }
Tom Taylord4a47292009-12-21 13:59:18 -08006648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006649 if (intent.mAction == null) {
6650 // By default, if no action is specified, then use VIEW.
6651 intent.mAction = ACTION_VIEW;
6652 }
6653
6654 } else {
6655 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6656 }
6657
6658 return intent;
6659 }
6660
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006661 /** @hide */
6662 public interface CommandOptionHandler {
6663 boolean handleOption(String opt, ShellCommand cmd);
6664 }
6665
6666 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01006667 @UnsupportedAppUsage
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006668 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6669 throws URISyntaxException {
6670 Intent intent = new Intent();
6671 Intent baseIntent = intent;
6672 boolean hasIntentInfo = false;
6673
6674 Uri data = null;
6675 String type = null;
6676
6677 String opt;
6678 while ((opt=cmd.getNextOption()) != null) {
6679 switch (opt) {
6680 case "-a":
6681 intent.setAction(cmd.getNextArgRequired());
6682 if (intent == baseIntent) {
6683 hasIntentInfo = true;
6684 }
6685 break;
6686 case "-d":
6687 data = Uri.parse(cmd.getNextArgRequired());
6688 if (intent == baseIntent) {
6689 hasIntentInfo = true;
6690 }
6691 break;
6692 case "-t":
6693 type = cmd.getNextArgRequired();
6694 if (intent == baseIntent) {
6695 hasIntentInfo = true;
6696 }
6697 break;
6698 case "-c":
6699 intent.addCategory(cmd.getNextArgRequired());
6700 if (intent == baseIntent) {
6701 hasIntentInfo = true;
6702 }
6703 break;
6704 case "-e":
6705 case "--es": {
6706 String key = cmd.getNextArgRequired();
6707 String value = cmd.getNextArgRequired();
6708 intent.putExtra(key, value);
6709 }
6710 break;
6711 case "--esn": {
6712 String key = cmd.getNextArgRequired();
6713 intent.putExtra(key, (String) null);
6714 }
6715 break;
6716 case "--ei": {
6717 String key = cmd.getNextArgRequired();
6718 String value = cmd.getNextArgRequired();
6719 intent.putExtra(key, Integer.decode(value));
6720 }
6721 break;
6722 case "--eu": {
6723 String key = cmd.getNextArgRequired();
6724 String value = cmd.getNextArgRequired();
6725 intent.putExtra(key, Uri.parse(value));
6726 }
6727 break;
6728 case "--ecn": {
6729 String key = cmd.getNextArgRequired();
6730 String value = cmd.getNextArgRequired();
6731 ComponentName cn = ComponentName.unflattenFromString(value);
6732 if (cn == null)
6733 throw new IllegalArgumentException("Bad component name: " + value);
6734 intent.putExtra(key, cn);
6735 }
6736 break;
6737 case "--eia": {
6738 String key = cmd.getNextArgRequired();
6739 String value = cmd.getNextArgRequired();
6740 String[] strings = value.split(",");
6741 int[] list = new int[strings.length];
6742 for (int i = 0; i < strings.length; i++) {
6743 list[i] = Integer.decode(strings[i]);
6744 }
6745 intent.putExtra(key, list);
6746 }
6747 break;
6748 case "--eial": {
6749 String key = cmd.getNextArgRequired();
6750 String value = cmd.getNextArgRequired();
6751 String[] strings = value.split(",");
6752 ArrayList<Integer> list = new ArrayList<>(strings.length);
6753 for (int i = 0; i < strings.length; i++) {
6754 list.add(Integer.decode(strings[i]));
6755 }
6756 intent.putExtra(key, list);
6757 }
6758 break;
6759 case "--el": {
6760 String key = cmd.getNextArgRequired();
6761 String value = cmd.getNextArgRequired();
6762 intent.putExtra(key, Long.valueOf(value));
6763 }
6764 break;
6765 case "--ela": {
6766 String key = cmd.getNextArgRequired();
6767 String value = cmd.getNextArgRequired();
6768 String[] strings = value.split(",");
6769 long[] list = new long[strings.length];
6770 for (int i = 0; i < strings.length; i++) {
6771 list[i] = Long.valueOf(strings[i]);
6772 }
6773 intent.putExtra(key, list);
6774 hasIntentInfo = true;
6775 }
6776 break;
6777 case "--elal": {
6778 String key = cmd.getNextArgRequired();
6779 String value = cmd.getNextArgRequired();
6780 String[] strings = value.split(",");
6781 ArrayList<Long> list = new ArrayList<>(strings.length);
6782 for (int i = 0; i < strings.length; i++) {
6783 list.add(Long.valueOf(strings[i]));
6784 }
6785 intent.putExtra(key, list);
6786 hasIntentInfo = true;
6787 }
6788 break;
6789 case "--ef": {
6790 String key = cmd.getNextArgRequired();
6791 String value = cmd.getNextArgRequired();
6792 intent.putExtra(key, Float.valueOf(value));
6793 hasIntentInfo = true;
6794 }
6795 break;
6796 case "--efa": {
6797 String key = cmd.getNextArgRequired();
6798 String value = cmd.getNextArgRequired();
6799 String[] strings = value.split(",");
6800 float[] list = new float[strings.length];
6801 for (int i = 0; i < strings.length; i++) {
6802 list[i] = Float.valueOf(strings[i]);
6803 }
6804 intent.putExtra(key, list);
6805 hasIntentInfo = true;
6806 }
6807 break;
6808 case "--efal": {
6809 String key = cmd.getNextArgRequired();
6810 String value = cmd.getNextArgRequired();
6811 String[] strings = value.split(",");
6812 ArrayList<Float> list = new ArrayList<>(strings.length);
6813 for (int i = 0; i < strings.length; i++) {
6814 list.add(Float.valueOf(strings[i]));
6815 }
6816 intent.putExtra(key, list);
6817 hasIntentInfo = true;
6818 }
6819 break;
6820 case "--esa": {
6821 String key = cmd.getNextArgRequired();
6822 String value = cmd.getNextArgRequired();
6823 // Split on commas unless they are preceeded by an escape.
6824 // The escape character must be escaped for the string and
6825 // again for the regex, thus four escape characters become one.
6826 String[] strings = value.split("(?<!\\\\),");
6827 intent.putExtra(key, strings);
6828 hasIntentInfo = true;
6829 }
6830 break;
6831 case "--esal": {
6832 String key = cmd.getNextArgRequired();
6833 String value = cmd.getNextArgRequired();
6834 // Split on commas unless they are preceeded by an escape.
6835 // The escape character must be escaped for the string and
6836 // again for the regex, thus four escape characters become one.
6837 String[] strings = value.split("(?<!\\\\),");
6838 ArrayList<String> list = new ArrayList<>(strings.length);
6839 for (int i = 0; i < strings.length; i++) {
6840 list.add(strings[i]);
6841 }
6842 intent.putExtra(key, list);
6843 hasIntentInfo = true;
6844 }
6845 break;
6846 case "--ez": {
6847 String key = cmd.getNextArgRequired();
6848 String value = cmd.getNextArgRequired().toLowerCase();
6849 // Boolean.valueOf() results in false for anything that is not "true", which is
6850 // error-prone in shell commands
6851 boolean arg;
6852 if ("true".equals(value) || "t".equals(value)) {
6853 arg = true;
6854 } else if ("false".equals(value) || "f".equals(value)) {
6855 arg = false;
6856 } else {
6857 try {
6858 arg = Integer.decode(value) != 0;
6859 } catch (NumberFormatException ex) {
6860 throw new IllegalArgumentException("Invalid boolean value: " + value);
6861 }
6862 }
6863
6864 intent.putExtra(key, arg);
6865 }
6866 break;
6867 case "-n": {
6868 String str = cmd.getNextArgRequired();
6869 ComponentName cn = ComponentName.unflattenFromString(str);
6870 if (cn == null)
6871 throw new IllegalArgumentException("Bad component name: " + str);
6872 intent.setComponent(cn);
6873 if (intent == baseIntent) {
6874 hasIntentInfo = true;
6875 }
6876 }
6877 break;
6878 case "-p": {
6879 String str = cmd.getNextArgRequired();
6880 intent.setPackage(str);
6881 if (intent == baseIntent) {
6882 hasIntentInfo = true;
6883 }
6884 }
6885 break;
6886 case "-f":
6887 String str = cmd.getNextArgRequired();
6888 intent.setFlags(Integer.decode(str).intValue());
6889 break;
6890 case "--grant-read-uri-permission":
6891 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6892 break;
6893 case "--grant-write-uri-permission":
6894 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6895 break;
6896 case "--grant-persistable-uri-permission":
6897 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6898 break;
6899 case "--grant-prefix-uri-permission":
6900 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6901 break;
6902 case "--exclude-stopped-packages":
6903 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6904 break;
6905 case "--include-stopped-packages":
6906 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6907 break;
6908 case "--debug-log-resolution":
6909 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6910 break;
6911 case "--activity-brought-to-front":
6912 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6913 break;
6914 case "--activity-clear-top":
6915 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6916 break;
6917 case "--activity-clear-when-task-reset":
6918 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6919 break;
6920 case "--activity-exclude-from-recents":
6921 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6922 break;
6923 case "--activity-launched-from-history":
6924 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6925 break;
6926 case "--activity-multiple-task":
6927 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6928 break;
6929 case "--activity-no-animation":
6930 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6931 break;
6932 case "--activity-no-history":
6933 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6934 break;
6935 case "--activity-no-user-action":
6936 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6937 break;
6938 case "--activity-previous-is-top":
6939 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6940 break;
6941 case "--activity-reorder-to-front":
6942 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6943 break;
6944 case "--activity-reset-task-if-needed":
6945 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6946 break;
6947 case "--activity-single-top":
6948 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6949 break;
6950 case "--activity-clear-task":
6951 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6952 break;
6953 case "--activity-task-on-home":
6954 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6955 break;
Patrick Baumann229141f2018-04-06 13:53:25 -07006956 case "--activity-match-external":
6957 intent.addFlags(Intent.FLAG_ACTIVITY_MATCH_EXTERNAL);
6958 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006959 case "--receiver-registered-only":
6960 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6961 break;
6962 case "--receiver-replace-pending":
6963 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6964 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006965 case "--receiver-foreground":
6966 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6967 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006968 case "--receiver-no-abort":
6969 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6970 break;
6971 case "--receiver-include-background":
6972 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6973 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006974 case "--selector":
6975 intent.setDataAndType(data, type);
6976 intent = new Intent();
6977 break;
6978 default:
6979 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6980 // Okay, caller handled this option.
6981 } else {
6982 throw new IllegalArgumentException("Unknown option: " + opt);
6983 }
6984 break;
6985 }
6986 }
6987 intent.setDataAndType(data, type);
6988
6989 final boolean hasSelector = intent != baseIntent;
6990 if (hasSelector) {
6991 // A selector was specified; fix up.
6992 baseIntent.setSelector(intent);
6993 intent = baseIntent;
6994 }
6995
6996 String arg = cmd.getNextArg();
6997 baseIntent = null;
6998 if (arg == null) {
6999 if (hasSelector) {
7000 // If a selector has been specified, and no arguments
7001 // have been supplied for the main Intent, then we can
7002 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
7003 // need to have a component name specified yet, the
7004 // selector will take care of that.
7005 baseIntent = new Intent(Intent.ACTION_MAIN);
7006 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
7007 }
7008 } else if (arg.indexOf(':') >= 0) {
7009 // The argument is a URI. Fully parse it, and use that result
7010 // to fill in any data not specified so far.
7011 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
7012 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
7013 } else if (arg.indexOf('/') >= 0) {
7014 // The argument is a component name. Build an Intent to launch
7015 // it.
7016 baseIntent = new Intent(Intent.ACTION_MAIN);
7017 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
7018 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
7019 } else {
7020 // Assume the argument is a package name.
7021 baseIntent = new Intent(Intent.ACTION_MAIN);
7022 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
7023 baseIntent.setPackage(arg);
7024 }
7025 if (baseIntent != null) {
7026 Bundle extras = intent.getExtras();
7027 intent.replaceExtras((Bundle)null);
7028 Bundle uriExtras = baseIntent.getExtras();
7029 baseIntent.replaceExtras((Bundle)null);
7030 if (intent.getAction() != null && baseIntent.getCategories() != null) {
7031 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
7032 for (String c : cats) {
7033 baseIntent.removeCategory(c);
7034 }
7035 }
7036 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
7037 if (extras == null) {
7038 extras = uriExtras;
7039 } else if (uriExtras != null) {
7040 uriExtras.putAll(extras);
7041 extras = uriExtras;
7042 }
7043 intent.replaceExtras(extras);
7044 hasIntentInfo = true;
7045 }
7046
7047 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
7048 return intent;
7049 }
7050
7051 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007052 @UnsupportedAppUsage
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007053 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
7054 final String[] lines = new String[] {
7055 "<INTENT> specifications include these flags and arguments:",
7056 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
7057 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
Felipe Leme4e02e252018-04-20 11:25:59 -07007058 " [-n <COMPONENT_NAME>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007059 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
7060 " [--esn <EXTRA_KEY> ...]",
7061 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
7062 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
7063 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
7064 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
7065 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
7066 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
7067 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
7068 " (mutiple extras passed as Integer[])",
7069 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
7070 " (mutiple extras passed as List<Integer>)",
7071 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
7072 " (mutiple extras passed as Long[])",
7073 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
7074 " (mutiple extras passed as List<Long>)",
7075 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
7076 " (mutiple extras passed as Float[])",
7077 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
7078 " (mutiple extras passed as List<Float>)",
7079 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
7080 " (mutiple extras passed as String[]; to embed a comma into a string,",
7081 " escape it using \"\\,\")",
7082 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
7083 " (mutiple extras passed as List<String>; to embed a comma into a string,",
7084 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08007085 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007086 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
7087 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
7088 " [--debug-log-resolution] [--exclude-stopped-packages]",
7089 " [--include-stopped-packages]",
7090 " [--activity-brought-to-front] [--activity-clear-top]",
7091 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
7092 " [--activity-launched-from-history] [--activity-multiple-task]",
7093 " [--activity-no-animation] [--activity-no-history]",
7094 " [--activity-no-user-action] [--activity-previous-is-top]",
7095 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
7096 " [--activity-single-top] [--activity-clear-task]",
Patrick Baumann229141f2018-04-06 13:53:25 -07007097 " [--activity-task-on-home] [--activity-match-external]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007098 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08007099 " [--receiver-foreground] [--receiver-no-abort]",
7100 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007101 " [--selector]",
7102 " [<URI> | <PACKAGE> | <COMPONENT>]"
7103 };
7104 for (String line : lines) {
7105 pw.print(prefix);
7106 pw.println(line);
7107 }
7108 }
7109
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007110 /**
7111 * Retrieve the general action to be performed, such as
7112 * {@link #ACTION_VIEW}. The action describes the general way the rest of
7113 * the information in the intent should be interpreted -- most importantly,
7114 * what to do with the data returned by {@link #getData}.
7115 *
7116 * @return The action of this intent or null if none is specified.
7117 *
7118 * @see #setAction
7119 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007120 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007121 return mAction;
7122 }
7123
7124 /**
7125 * Retrieve data this intent is operating on. This URI specifies the name
7126 * of the data; often it uses the content: scheme, specifying data in a
7127 * content provider. Other schemes may be handled by specific activities,
7128 * such as http: by the web browser.
7129 *
7130 * @return The URI of the data this intent is targeting or null.
7131 *
7132 * @see #getScheme
7133 * @see #setData
7134 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007135 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007136 return mData;
7137 }
7138
7139 /**
7140 * The same as {@link #getData()}, but returns the URI as an encoded
7141 * String.
7142 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007143 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007144 return mData != null ? mData.toString() : null;
7145 }
7146
7147 /**
7148 * Return the scheme portion of the intent's data. If the data is null or
7149 * does not include a scheme, null is returned. Otherwise, the scheme
7150 * prefix without the final ':' is returned, i.e. "http".
7151 *
7152 * <p>This is the same as calling getData().getScheme() (and checking for
7153 * null data).
7154 *
7155 * @return The scheme of this intent.
7156 *
7157 * @see #getData
7158 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007159 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007160 return mData != null ? mData.getScheme() : null;
7161 }
7162
7163 /**
7164 * Retrieve any explicit MIME type included in the intent. This is usually
7165 * null, as the type is determined by the intent data.
7166 *
7167 * @return If a type was manually set, it is returned; else null is
7168 * returned.
7169 *
7170 * @see #resolveType(ContentResolver)
7171 * @see #setType
7172 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007173 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007174 return mType;
7175 }
7176
7177 /**
7178 * Return the MIME data type of this intent. If the type field is
7179 * explicitly set, that is simply returned. Otherwise, if the data is set,
7180 * the type of that data is returned. If neither fields are set, a null is
7181 * returned.
7182 *
7183 * @return The MIME type of this intent.
7184 *
7185 * @see #getType
7186 * @see #resolveType(ContentResolver)
7187 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007188 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007189 return resolveType(context.getContentResolver());
7190 }
7191
7192 /**
7193 * Return the MIME data type of this intent. If the type field is
7194 * explicitly set, that is simply returned. Otherwise, if the data is set,
7195 * the type of that data is returned. If neither fields are set, a null is
7196 * returned.
7197 *
7198 * @param resolver A ContentResolver that can be used to determine the MIME
7199 * type of the intent's data.
7200 *
7201 * @return The MIME type of this intent.
7202 *
7203 * @see #getType
7204 * @see #resolveType(Context)
7205 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007206 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007207 if (mType != null) {
7208 return mType;
7209 }
7210 if (mData != null) {
7211 if ("content".equals(mData.getScheme())) {
7212 return resolver.getType(mData);
7213 }
7214 }
7215 return null;
7216 }
7217
7218 /**
7219 * Return the MIME data type of this intent, only if it will be needed for
7220 * intent resolution. This is not generally useful for application code;
7221 * it is used by the frameworks for communicating with back-end system
7222 * services.
7223 *
7224 * @param resolver A ContentResolver that can be used to determine the MIME
7225 * type of the intent's data.
7226 *
7227 * @return The MIME type of this intent, or null if it is unknown or not
7228 * needed.
7229 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007230 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007231 if (mComponent != null) {
7232 return mType;
7233 }
7234 return resolveType(resolver);
7235 }
7236
7237 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007238 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007239 *
7240 * @param category The category to check.
7241 *
7242 * @return boolean True if the intent contains the category, else false.
7243 *
7244 * @see #getCategories
7245 * @see #addCategory
7246 */
7247 public boolean hasCategory(String category) {
7248 return mCategories != null && mCategories.contains(category);
7249 }
7250
7251 /**
7252 * Return the set of all categories in the intent. If there are no categories,
7253 * returns NULL.
7254 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007255 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007256 *
7257 * @see #hasCategory
7258 * @see #addCategory
7259 */
7260 public Set<String> getCategories() {
7261 return mCategories;
7262 }
7263
7264 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007265 * Return the specific selector associated with this Intent. If there is
7266 * none, returns null. See {@link #setSelector} for more information.
7267 *
7268 * @see #setSelector
7269 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007270 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007271 return mSelector;
7272 }
7273
7274 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007275 * Return the {@link ClipData} associated with this Intent. If there is
7276 * none, returns null. See {@link #setClipData} for more information.
7277 *
John Spurlock125d1332013-11-25 11:58:37 -05007278 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007279 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007280 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007281 return mClipData;
7282 }
7283
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007284 /** @hide */
7285 public int getContentUserHint() {
7286 return mContentUserHint;
7287 }
7288
Todd Kennedyb3b431302017-03-20 16:05:48 -07007289 /** @hide */
7290 public String getLaunchToken() {
7291 return mLaunchToken;
7292 }
7293
7294 /** @hide */
7295 public void setLaunchToken(String launchToken) {
7296 mLaunchToken = launchToken;
7297 }
7298
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007299 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007300 * Sets the ClassLoader that will be used when unmarshalling
7301 * any Parcelable values from the extras of this Intent.
7302 *
7303 * @param loader a ClassLoader, or null to use the default loader
7304 * at the time of unmarshalling.
7305 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007306 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007307 if (mExtras != null) {
7308 mExtras.setClassLoader(loader);
7309 }
7310 }
7311
7312 /**
7313 * Returns true if an extra value is associated with the given name.
7314 * @param name the extra's name
7315 * @return true if the given extra is present.
7316 */
7317 public boolean hasExtra(String name) {
7318 return mExtras != null && mExtras.containsKey(name);
7319 }
7320
7321 /**
7322 * Returns true if the Intent's extras contain a parcelled file descriptor.
7323 * @return true if the Intent contains a parcelled file descriptor.
7324 */
7325 public boolean hasFileDescriptors() {
7326 return mExtras != null && mExtras.hasFileDescriptors();
7327 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007328
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007329 /** {@hide} */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007330 @UnsupportedAppUsage
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04007331 public void setAllowFds(boolean allowFds) {
7332 if (mExtras != null) {
7333 mExtras.setAllowFds(allowFds);
7334 }
7335 }
7336
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007337 /** {@hide} */
7338 public void setDefusable(boolean defusable) {
7339 if (mExtras != null) {
7340 mExtras.setDefusable(defusable);
7341 }
7342 }
7343
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007344 /**
7345 * Retrieve extended data from the intent.
7346 *
7347 * @param name The name of the desired item.
7348 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007349 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007350 * or null if none was found.
7351 *
7352 * @deprecated
7353 * @hide
7354 */
7355 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007356 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007357 public Object getExtra(String name) {
7358 return getExtra(name, null);
7359 }
7360
7361 /**
7362 * Retrieve extended data from the intent.
7363 *
7364 * @param name The name of the desired item.
7365 * @param defaultValue the value to be returned if no value of the desired
7366 * type is stored with the given name.
7367 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007368 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007369 * or the default value if none was found.
7370 *
7371 * @see #putExtra(String, boolean)
7372 */
7373 public boolean getBooleanExtra(String name, boolean defaultValue) {
7374 return mExtras == null ? defaultValue :
7375 mExtras.getBoolean(name, defaultValue);
7376 }
7377
7378 /**
7379 * Retrieve extended data from the intent.
7380 *
7381 * @param name The name of the desired item.
7382 * @param defaultValue the value to be returned if no value of the desired
7383 * type is stored with the given name.
7384 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007385 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007386 * or the default value if none was found.
7387 *
7388 * @see #putExtra(String, byte)
7389 */
7390 public byte getByteExtra(String name, byte defaultValue) {
7391 return mExtras == null ? defaultValue :
7392 mExtras.getByte(name, defaultValue);
7393 }
7394
7395 /**
7396 * Retrieve extended data from the intent.
7397 *
7398 * @param name The name of the desired item.
7399 * @param defaultValue the value to be returned if no value of the desired
7400 * type is stored with the given name.
7401 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007402 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007403 * or the default value if none was found.
7404 *
7405 * @see #putExtra(String, short)
7406 */
7407 public short getShortExtra(String name, short defaultValue) {
7408 return mExtras == null ? defaultValue :
7409 mExtras.getShort(name, defaultValue);
7410 }
7411
7412 /**
7413 * Retrieve extended data from the intent.
7414 *
7415 * @param name The name of the desired item.
7416 * @param defaultValue the value to be returned if no value of the desired
7417 * type is stored with the given name.
7418 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007419 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007420 * or the default value if none was found.
7421 *
7422 * @see #putExtra(String, char)
7423 */
7424 public char getCharExtra(String name, char defaultValue) {
7425 return mExtras == null ? defaultValue :
7426 mExtras.getChar(name, defaultValue);
7427 }
7428
7429 /**
7430 * Retrieve extended data from the intent.
7431 *
7432 * @param name The name of the desired item.
7433 * @param defaultValue the value to be returned if no value of the desired
7434 * type is stored with the given name.
7435 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007436 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007437 * or the default value if none was found.
7438 *
7439 * @see #putExtra(String, int)
7440 */
7441 public int getIntExtra(String name, int defaultValue) {
7442 return mExtras == null ? defaultValue :
7443 mExtras.getInt(name, defaultValue);
7444 }
7445
7446 /**
7447 * Retrieve extended data from the intent.
7448 *
7449 * @param name The name of the desired item.
7450 * @param defaultValue the value to be returned if no value of the desired
7451 * type is stored with the given name.
7452 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007453 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007454 * or the default value if none was found.
7455 *
7456 * @see #putExtra(String, long)
7457 */
7458 public long getLongExtra(String name, long defaultValue) {
7459 return mExtras == null ? defaultValue :
7460 mExtras.getLong(name, defaultValue);
7461 }
7462
7463 /**
7464 * Retrieve extended data from the intent.
7465 *
7466 * @param name The name of the desired item.
7467 * @param defaultValue the value to be returned if no value of the desired
7468 * type is stored with the given name.
7469 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007470 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007471 * or the default value if no such item is present
7472 *
7473 * @see #putExtra(String, float)
7474 */
7475 public float getFloatExtra(String name, float defaultValue) {
7476 return mExtras == null ? defaultValue :
7477 mExtras.getFloat(name, defaultValue);
7478 }
7479
7480 /**
7481 * Retrieve extended data from the intent.
7482 *
7483 * @param name The name of the desired item.
7484 * @param defaultValue the value to be returned if no value of the desired
7485 * type is stored with the given name.
7486 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007487 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007488 * or the default value if none was found.
7489 *
7490 * @see #putExtra(String, double)
7491 */
7492 public double getDoubleExtra(String name, double defaultValue) {
7493 return mExtras == null ? defaultValue :
7494 mExtras.getDouble(name, defaultValue);
7495 }
7496
7497 /**
7498 * Retrieve extended data from the intent.
7499 *
7500 * @param name The name of the desired item.
7501 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007502 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007503 * or null if no String value was found.
7504 *
7505 * @see #putExtra(String, String)
7506 */
7507 public String getStringExtra(String name) {
7508 return mExtras == null ? null : mExtras.getString(name);
7509 }
7510
7511 /**
7512 * Retrieve extended data from the intent.
7513 *
7514 * @param name The name of the desired item.
7515 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007516 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007517 * or null if no CharSequence value was found.
7518 *
7519 * @see #putExtra(String, CharSequence)
7520 */
7521 public CharSequence getCharSequenceExtra(String name) {
7522 return mExtras == null ? null : mExtras.getCharSequence(name);
7523 }
7524
7525 /**
7526 * Retrieve extended data from the intent.
7527 *
7528 * @param name The name of the desired item.
7529 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007530 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007531 * or null if no Parcelable value was found.
7532 *
7533 * @see #putExtra(String, Parcelable)
7534 */
7535 public <T extends Parcelable> T getParcelableExtra(String name) {
7536 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7537 }
7538
7539 /**
7540 * Retrieve extended data from the intent.
7541 *
7542 * @param name The name of the desired item.
7543 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007544 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007545 * or null if no Parcelable[] value was found.
7546 *
7547 * @see #putExtra(String, Parcelable[])
7548 */
7549 public Parcelable[] getParcelableArrayExtra(String name) {
7550 return mExtras == null ? null : mExtras.getParcelableArray(name);
7551 }
7552
7553 /**
7554 * Retrieve extended data from the intent.
7555 *
7556 * @param name The name of the desired item.
7557 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007558 * @return the value of an item previously added with
7559 * putParcelableArrayListExtra(), or null if no
7560 * ArrayList<Parcelable> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007561 *
7562 * @see #putParcelableArrayListExtra(String, ArrayList)
7563 */
7564 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
7565 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7566 }
7567
7568 /**
7569 * Retrieve extended data from the intent.
7570 *
7571 * @param name The name of the desired item.
7572 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007573 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007574 * or null if no Serializable value was found.
7575 *
7576 * @see #putExtra(String, Serializable)
7577 */
7578 public Serializable getSerializableExtra(String name) {
7579 return mExtras == null ? null : mExtras.getSerializable(name);
7580 }
7581
7582 /**
7583 * Retrieve extended data from the intent.
7584 *
7585 * @param name The name of the desired item.
7586 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007587 * @return the value of an item previously added with
7588 * putIntegerArrayListExtra(), or null if no
7589 * ArrayList<Integer> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007590 *
7591 * @see #putIntegerArrayListExtra(String, ArrayList)
7592 */
7593 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
7594 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7595 }
7596
7597 /**
7598 * Retrieve extended data from the intent.
7599 *
7600 * @param name The name of the desired item.
7601 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007602 * @return the value of an item previously added with
7603 * putStringArrayListExtra(), or null if no
7604 * ArrayList<String> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007605 *
7606 * @see #putStringArrayListExtra(String, ArrayList)
7607 */
7608 public ArrayList<String> getStringArrayListExtra(String name) {
7609 return mExtras == null ? null : mExtras.getStringArrayList(name);
7610 }
7611
7612 /**
7613 * Retrieve extended data from the intent.
7614 *
7615 * @param name The name of the desired item.
7616 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007617 * @return the value of an item previously added with
7618 * putCharSequenceArrayListExtra, or null if no
7619 * ArrayList<CharSequence> value was found.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007620 *
7621 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7622 */
7623 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
7624 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7625 }
7626
7627 /**
7628 * Retrieve extended data from the intent.
7629 *
7630 * @param name The name of the desired item.
7631 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007632 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007633 * or null if no boolean array value was found.
7634 *
7635 * @see #putExtra(String, boolean[])
7636 */
7637 public boolean[] getBooleanArrayExtra(String name) {
7638 return mExtras == null ? null : mExtras.getBooleanArray(name);
7639 }
7640
7641 /**
7642 * Retrieve extended data from the intent.
7643 *
7644 * @param name The name of the desired item.
7645 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007646 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007647 * or null if no byte array value was found.
7648 *
7649 * @see #putExtra(String, byte[])
7650 */
7651 public byte[] getByteArrayExtra(String name) {
7652 return mExtras == null ? null : mExtras.getByteArray(name);
7653 }
7654
7655 /**
7656 * Retrieve extended data from the intent.
7657 *
7658 * @param name The name of the desired item.
7659 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007660 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007661 * or null if no short array value was found.
7662 *
7663 * @see #putExtra(String, short[])
7664 */
7665 public short[] getShortArrayExtra(String name) {
7666 return mExtras == null ? null : mExtras.getShortArray(name);
7667 }
7668
7669 /**
7670 * Retrieve extended data from the intent.
7671 *
7672 * @param name The name of the desired item.
7673 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007674 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007675 * or null if no char array value was found.
7676 *
7677 * @see #putExtra(String, char[])
7678 */
7679 public char[] getCharArrayExtra(String name) {
7680 return mExtras == null ? null : mExtras.getCharArray(name);
7681 }
7682
7683 /**
7684 * Retrieve extended data from the intent.
7685 *
7686 * @param name The name of the desired item.
7687 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007688 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007689 * or null if no int array value was found.
7690 *
7691 * @see #putExtra(String, int[])
7692 */
7693 public int[] getIntArrayExtra(String name) {
7694 return mExtras == null ? null : mExtras.getIntArray(name);
7695 }
7696
7697 /**
7698 * Retrieve extended data from the intent.
7699 *
7700 * @param name The name of the desired item.
7701 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007702 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007703 * or null if no long array value was found.
7704 *
7705 * @see #putExtra(String, long[])
7706 */
7707 public long[] getLongArrayExtra(String name) {
7708 return mExtras == null ? null : mExtras.getLongArray(name);
7709 }
7710
7711 /**
7712 * Retrieve extended data from the intent.
7713 *
7714 * @param name The name of the desired item.
7715 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007716 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007717 * or null if no float array value was found.
7718 *
7719 * @see #putExtra(String, float[])
7720 */
7721 public float[] getFloatArrayExtra(String name) {
7722 return mExtras == null ? null : mExtras.getFloatArray(name);
7723 }
7724
7725 /**
7726 * Retrieve extended data from the intent.
7727 *
7728 * @param name The name of the desired item.
7729 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007730 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007731 * or null if no double array value was found.
7732 *
7733 * @see #putExtra(String, double[])
7734 */
7735 public double[] getDoubleArrayExtra(String name) {
7736 return mExtras == null ? null : mExtras.getDoubleArray(name);
7737 }
7738
7739 /**
7740 * Retrieve extended data from the intent.
7741 *
7742 * @param name The name of the desired item.
7743 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007744 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007745 * or null if no String array value was found.
7746 *
7747 * @see #putExtra(String, String[])
7748 */
7749 public String[] getStringArrayExtra(String name) {
7750 return mExtras == null ? null : mExtras.getStringArray(name);
7751 }
7752
7753 /**
7754 * Retrieve extended data from the intent.
7755 *
7756 * @param name The name of the desired item.
7757 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007758 * @return the value of an item previously added with putExtra(),
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007759 * or null if no CharSequence array value was found.
7760 *
7761 * @see #putExtra(String, CharSequence[])
7762 */
7763 public CharSequence[] getCharSequenceArrayExtra(String name) {
7764 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7765 }
7766
7767 /**
7768 * Retrieve extended data from the intent.
7769 *
7770 * @param name The name of the desired item.
7771 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007772 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007773 * or null if no Bundle value was found.
7774 *
7775 * @see #putExtra(String, Bundle)
7776 */
7777 public Bundle getBundleExtra(String name) {
7778 return mExtras == null ? null : mExtras.getBundle(name);
7779 }
7780
7781 /**
7782 * Retrieve extended data from the intent.
7783 *
7784 * @param name The name of the desired item.
7785 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007786 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007787 * or null if no IBinder value was found.
7788 *
7789 * @see #putExtra(String, IBinder)
7790 *
7791 * @deprecated
7792 * @hide
7793 */
7794 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007795 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007796 public IBinder getIBinderExtra(String name) {
7797 return mExtras == null ? null : mExtras.getIBinder(name);
7798 }
7799
7800 /**
7801 * Retrieve extended data from the intent.
7802 *
7803 * @param name The name of the desired item.
7804 * @param defaultValue The default value to return in case no item is
7805 * associated with the key 'name'
7806 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007807 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007808 * or defaultValue if none was found.
7809 *
7810 * @see #putExtra
7811 *
7812 * @deprecated
7813 * @hide
7814 */
7815 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007816 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007817 public Object getExtra(String name, Object defaultValue) {
7818 Object result = defaultValue;
7819 if (mExtras != null) {
7820 Object result2 = mExtras.get(name);
7821 if (result2 != null) {
7822 result = result2;
7823 }
7824 }
7825
7826 return result;
7827 }
7828
7829 /**
7830 * Retrieves a map of extended data from the intent.
7831 *
7832 * @return the map of all extras previously added with putExtra(),
7833 * or null if none have been added.
7834 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007835 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007836 return (mExtras != null)
7837 ? new Bundle(mExtras)
7838 : null;
7839 }
7840
7841 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007842 * Filter extras to only basic types.
7843 * @hide
7844 */
7845 public void removeUnsafeExtras() {
7846 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007847 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007848 }
7849 }
7850
7851 /**
Makoto Onuki97f82f22017-05-31 16:20:21 -07007852 * @return Whether {@link #maybeStripForHistory} will return an lightened intent or
7853 * return itself as-is.
7854 * @hide
7855 */
7856 public boolean canStripForHistory() {
7857 return ((mExtras != null) && mExtras.isParcelled()) || (mClipData != null);
7858 }
7859
7860 /**
7861 * Call it when the system needs to keep an intent for logging purposes to remove fields
7862 * that are not needed for logging.
7863 * @hide
7864 */
7865 public Intent maybeStripForHistory() {
7866 // TODO Scan and remove possibly heavy instances like Bitmaps from unparcelled extras?
7867
7868 if (!canStripForHistory()) {
7869 return this;
7870 }
7871 return new Intent(this, COPY_MODE_HISTORY);
7872 }
7873
7874 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007875 * Retrieve any special flags associated with this intent. You will
7876 * normally just set them with {@link #setFlags} and let the system
7877 * take the appropriate action with them.
7878 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007879 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007880 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007881 * @see #addFlags
7882 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007883 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007884 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007885 return mFlags;
7886 }
7887
Dianne Hackborne7f97212011-02-24 14:40:20 -08007888 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007889 @UnsupportedAppUsage
Dianne Hackborne7f97212011-02-24 14:40:20 -08007890 public boolean isExcludingStopped() {
7891 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7892 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7893 }
7894
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007895 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007896 * Retrieve the application package name this Intent is limited to. When
7897 * resolving an Intent, if non-null this limits the resolution to only
7898 * components in the given application package.
7899 *
7900 * @return The name of the application package for the Intent.
7901 *
7902 * @see #resolveActivity
7903 * @see #setPackage
7904 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007905 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007906 return mPackage;
7907 }
7908
7909 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007910 * Retrieve the concrete component associated with the intent. When receiving
7911 * an intent, this is the component that was found to best handle it (that is,
7912 * yourself) and will always be non-null; in all other cases it will be
7913 * null unless explicitly set.
7914 *
7915 * @return The name of the application component to handle the intent.
7916 *
7917 * @see #resolveActivity
7918 * @see #setComponent
7919 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007920 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007921 return mComponent;
7922 }
7923
7924 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007925 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7926 * used as a hint to the receiver for animations and the like. Null means that there
7927 * is no source bounds.
7928 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007929 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007930 return mSourceBounds;
7931 }
7932
7933 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007934 * Return the Activity component that should be used to handle this intent.
7935 * The appropriate component is determined based on the information in the
7936 * intent, evaluated as follows:
7937 *
7938 * <p>If {@link #getComponent} returns an explicit class, that is returned
7939 * without any further consideration.
7940 *
7941 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7942 * category to be considered.
7943 *
7944 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7945 * action.
7946 *
7947 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7948 * this type.
7949 *
7950 * <p>If {@link #addCategory} has added any categories, the activity must
7951 * handle ALL of the categories specified.
7952 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007953 * <p>If {@link #getPackage} is non-NULL, only activity components in
7954 * that application package will be considered.
7955 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007956 * <p>If there are no activities that satisfy all of these conditions, a
7957 * null string is returned.
7958 *
7959 * <p>If multiple activities are found to satisfy the intent, the one with
7960 * the highest priority will be used. If there are multiple activities
7961 * with the same priority, the system will either pick the best activity
7962 * based on user preference, or resolve to a system class that will allow
7963 * the user to pick an activity and forward from there.
7964 *
7965 * <p>This method is implemented simply by calling
7966 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7967 * true.</p>
7968 * <p> This API is called for you as part of starting an activity from an
7969 * intent. You do not normally need to call it yourself.</p>
7970 *
7971 * @param pm The package manager with which to resolve the Intent.
7972 *
7973 * @return Name of the component implementing an activity that can
7974 * display the intent.
7975 *
7976 * @see #setComponent
7977 * @see #getComponent
7978 * @see #resolveActivityInfo
7979 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007980 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007981 if (mComponent != null) {
7982 return mComponent;
7983 }
7984
7985 ResolveInfo info = pm.resolveActivity(
7986 this, PackageManager.MATCH_DEFAULT_ONLY);
7987 if (info != null) {
7988 return new ComponentName(
7989 info.activityInfo.applicationInfo.packageName,
7990 info.activityInfo.name);
7991 }
7992
7993 return null;
7994 }
7995
7996 /**
7997 * Resolve the Intent into an {@link ActivityInfo}
7998 * describing the activity that should execute the intent. Resolution
7999 * follows the same rules as described for {@link #resolveActivity}, but
8000 * you get back the completely information about the resolved activity
8001 * instead of just its class name.
8002 *
8003 * @param pm The package manager with which to resolve the Intent.
8004 * @param flags Addition information to retrieve as per
8005 * {@link PackageManager#getActivityInfo(ComponentName, int)
8006 * PackageManager.getActivityInfo()}.
8007 *
8008 * @return PackageManager.ActivityInfo
8009 *
8010 * @see #resolveActivity
8011 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008012 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
8013 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008014 ActivityInfo ai = null;
8015 if (mComponent != null) {
8016 try {
8017 ai = pm.getActivityInfo(mComponent, flags);
8018 } catch (PackageManager.NameNotFoundException e) {
8019 // ignore
8020 }
8021 } else {
8022 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07008023 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008024 if (info != null) {
8025 ai = info.activityInfo;
8026 }
8027 }
8028
8029 return ai;
8030 }
8031
8032 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07008033 * Special function for use by the system to resolve service
8034 * intents to system apps. Throws an exception if there are
8035 * multiple potential matches to the Intent. Returns null if
8036 * there are no matches.
8037 * @hide
8038 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01008039 @UnsupportedAppUsage
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008040 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
8041 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07008042 if (mComponent != null) {
8043 return mComponent;
8044 }
8045
8046 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
8047 if (results == null) {
8048 return null;
8049 }
8050 ComponentName comp = null;
8051 for (int i=0; i<results.size(); i++) {
8052 ResolveInfo ri = results.get(i);
8053 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
8054 continue;
8055 }
8056 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
8057 ri.serviceInfo.name);
8058 if (comp != null) {
8059 throw new IllegalStateException("Multiple system services handle " + this
8060 + ": " + comp + ", " + foundComp);
8061 }
8062 comp = foundComp;
8063 }
8064 return comp;
8065 }
8066
8067 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008068 * Set the general action to be performed.
8069 *
8070 * @param action An action name, such as ACTION_VIEW. Application-specific
8071 * actions should be prefixed with the vendor's package name.
8072 *
8073 * @return Returns the same Intent object, for chaining multiple calls
8074 * into a single statement.
8075 *
8076 * @see #getAction
8077 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008078 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008079 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008080 return this;
8081 }
8082
8083 /**
8084 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08008085 * clears any type that was previously set by {@link #setType} or
8086 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008087 *
Nick Pellyccae4122012-01-09 14:12:58 -08008088 * <p><em>Note: scheme matching in the Android framework is
8089 * case-sensitive, unlike the formal RFC. As a result,
8090 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008091 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08008092 * {@link #setDataAndNormalize}
8093 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008094 *
Nick Pellyccae4122012-01-09 14:12:58 -08008095 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008096 *
8097 * @return Returns the same Intent object, for chaining multiple calls
8098 * into a single statement.
8099 *
8100 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08008101 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07008102 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008103 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008104 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008105 mData = data;
8106 mType = null;
8107 return this;
8108 }
8109
8110 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008111 * Normalize and set the data this intent is operating on.
8112 *
8113 * <p>This method automatically clears any type that was
8114 * previously set (for example, by {@link #setType}).
8115 *
8116 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008117 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08008118 * so really this is just a convenience method for
8119 * <pre>
8120 * setData(data.normalize())
8121 * </pre>
8122 *
8123 * @param data The Uri of the data this intent is now targeting.
8124 *
8125 * @return Returns the same Intent object, for chaining multiple calls
8126 * into a single statement.
8127 *
8128 * @see #getData
8129 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008130 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008131 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008132 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008133 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08008134 }
8135
8136 /**
8137 * Set an explicit MIME data type.
8138 *
8139 * <p>This is used to create intents that only specify a type and not data,
8140 * for example to indicate the type of data to return.
8141 *
8142 * <p>This method automatically clears any data that was
8143 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07008144 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008145 * <p><em>Note: MIME type matching in the Android framework is
8146 * case-sensitive, unlike formal RFC MIME types. As a result,
8147 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08008148 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
8149 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008150 *
8151 * @param type The MIME type of the data being handled by this intent.
8152 *
8153 * @return Returns the same Intent object, for chaining multiple calls
8154 * into a single statement.
8155 *
8156 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08008157 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008158 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08008159 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008160 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008161 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008162 mData = null;
8163 mType = type;
8164 return this;
8165 }
8166
8167 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008168 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008169 *
Nick Pellyccae4122012-01-09 14:12:58 -08008170 * <p>This is used to create intents that only specify a type and not data,
8171 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008172 *
Nick Pellyccae4122012-01-09 14:12:58 -08008173 * <p>This method automatically clears any data that was
8174 * previously set (for example by {@link #setData}).
8175 *
8176 * <p>The MIME type is normalized using
8177 * {@link #normalizeMimeType} before it is set,
8178 * so really this is just a convenience method for
8179 * <pre>
8180 * setType(Intent.normalizeMimeType(type))
8181 * </pre>
8182 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008183 * @param type The MIME type of the data being handled by this intent.
8184 *
8185 * @return Returns the same Intent object, for chaining multiple calls
8186 * into a single statement.
8187 *
Nick Pellyccae4122012-01-09 14:12:58 -08008188 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008189 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08008190 * @see #normalizeMimeType
8191 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008192 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08008193 return setType(normalizeMimeType(type));
8194 }
8195
8196 /**
8197 * (Usually optional) Set the data for the intent along with an explicit
8198 * MIME data type. This method should very rarely be used -- it allows you
8199 * to override the MIME type that would ordinarily be inferred from the
8200 * data with your own type given here.
8201 *
8202 * <p><em>Note: MIME type and Uri scheme matching in the
8203 * Android framework is case-sensitive, unlike the formal RFC definitions.
8204 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008205 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08008206 * {@link #setDataAndTypeAndNormalize}
8207 * to ensure that they are converted to lower case.</em>
8208 *
8209 * @param data The Uri of the data this intent is now targeting.
8210 * @param type The MIME type of the data being handled by this intent.
8211 *
8212 * @return Returns the same Intent object, for chaining multiple calls
8213 * into a single statement.
8214 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008215 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08008216 * @see #setData
8217 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008218 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008219 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008220 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008221 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008222 mData = data;
8223 mType = type;
8224 return this;
8225 }
8226
8227 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008228 * (Usually optional) Normalize and set both the data Uri and an explicit
8229 * MIME data type. This method should very rarely be used -- it allows you
8230 * to override the MIME type that would ordinarily be inferred from the
8231 * data with your own type given here.
8232 *
8233 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008234 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08008235 * before they are set, so really this is just a convenience method for
8236 * <pre>
8237 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
8238 * </pre>
8239 *
8240 * @param data The Uri of the data this intent is now targeting.
8241 * @param type The MIME type of the data being handled by this intent.
8242 *
8243 * @return Returns the same Intent object, for chaining multiple calls
8244 * into a single statement.
8245 *
8246 * @see #setType
8247 * @see #setData
8248 * @see #setDataAndType
8249 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008250 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008251 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008252 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008253 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08008254 }
8255
8256 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008257 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008258 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008259 * activities that provide <em>all</em> of the requested categories will be
8260 * used.
8261 *
8262 * @param category The desired category. This can be either one of the
8263 * predefined Intent categories, or a custom category in your own
8264 * namespace.
8265 *
8266 * @return Returns the same Intent object, for chaining multiple calls
8267 * into a single statement.
8268 *
8269 * @see #hasCategory
8270 * @see #removeCategory
8271 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008272 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008273 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008274 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008275 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08008276 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008277 return this;
8278 }
8279
8280 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008281 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008282 *
8283 * @param category The category to remove.
8284 *
8285 * @see #addCategory
8286 */
8287 public void removeCategory(String category) {
8288 if (mCategories != null) {
8289 mCategories.remove(category);
8290 if (mCategories.size() == 0) {
8291 mCategories = null;
8292 }
8293 }
8294 }
8295
8296 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008297 * Set a selector for this Intent. This is a modification to the kinds of
8298 * things the Intent will match. If the selector is set, it will be used
8299 * when trying to find entities that can handle the Intent, instead of the
8300 * main contents of the Intent. This allows you build an Intent containing
8301 * a generic protocol while targeting it more specifically.
8302 *
8303 * <p>An example of where this may be used is with things like
8304 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
8305 * Intent that will launch the Browser application. However, the correct
8306 * main entry point of an application is actually {@link #ACTION_MAIN}
8307 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
8308 * used to specify the actual Activity to launch. If you launch the browser
8309 * with something different, undesired behavior may happen if the user has
8310 * previously or later launches it the normal way, since they do not match.
8311 * Instead, you can build an Intent with the MAIN action (but no ComponentName
8312 * yet specified) and set a selector with {@link #ACTION_MAIN} and
8313 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
8314 *
8315 * <p>Setting a selector does not impact the behavior of
8316 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
8317 * desired behavior of a selector -- it does not impact the base meaning
8318 * of the Intent, just what kinds of things will be matched against it
8319 * when determining who can handle it.</p>
8320 *
8321 * <p>You can not use both a selector and {@link #setPackage(String)} on
8322 * the same base Intent.</p>
8323 *
8324 * @param selector The desired selector Intent; set to null to not use
8325 * a special selector.
8326 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008327 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008328 if (selector == this) {
8329 throw new IllegalArgumentException(
8330 "Intent being set as a selector of itself");
8331 }
8332 if (selector != null && mPackage != null) {
8333 throw new IllegalArgumentException(
8334 "Can't set selector when package name is already set");
8335 }
8336 mSelector = selector;
8337 }
8338
8339 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008340 * Set a {@link ClipData} associated with this Intent. This replaces any
8341 * previously set ClipData.
8342 *
8343 * <p>The ClipData in an intent is not used for Intent matching or other
8344 * such operations. Semantically it is like extras, used to transmit
8345 * additional data with the Intent. The main feature of using this over
8346 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
8347 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
8348 * items included in the clip data. This is useful, in particular, if
8349 * you want to transmit an Intent containing multiple <code>content:</code>
8350 * URIs for which the recipient may not have global permission to access the
8351 * content provider.
8352 *
8353 * <p>If the ClipData contains items that are themselves Intents, any
8354 * grant flags in those Intents will be ignored. Only the top-level flags
8355 * of the main Intent are respected, and will be applied to all Uri or
8356 * Intent items in the clip (or sub-items of the clip).
8357 *
8358 * <p>The MIME type, label, and icon in the ClipData object are not
8359 * directly used by Intent. Applications should generally rely on the
8360 * MIME type of the Intent itself, not what it may find in the ClipData.
8361 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05008362 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008363 *
8364 * @param clip The new clip to set. May be null to clear the current clip.
8365 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008366 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008367 mClipData = clip;
8368 }
8369
8370 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008371 * This is NOT a secure mechanism to identify the user who sent the intent.
8372 * When the intent is sent to a different user, it is used to fix uris by adding the userId
8373 * who sent the intent.
8374 * @hide
8375 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01008376 public void prepareToLeaveUser(int userId) {
8377 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
8378 // We want mContentUserHint to refer to the original user, so don't do anything.
8379 if (mContentUserHint == UserHandle.USER_CURRENT) {
8380 mContentUserHint = userId;
8381 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008382 }
8383
8384 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008385 * Add extended data to the intent. The name must include a package
8386 * prefix, for example the app com.android.contacts would use names
8387 * like "com.android.contacts.ShowAll".
8388 *
8389 * @param name The name of the extra data, with package prefix.
8390 * @param value The boolean data value.
8391 *
8392 * @return Returns the same Intent object, for chaining multiple calls
8393 * into a single statement.
8394 *
8395 * @see #putExtras
8396 * @see #removeExtra
8397 * @see #getBooleanExtra(String, boolean)
8398 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008399 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008400 if (mExtras == null) {
8401 mExtras = new Bundle();
8402 }
8403 mExtras.putBoolean(name, value);
8404 return this;
8405 }
8406
8407 /**
8408 * Add extended data to the intent. The name must include a package
8409 * prefix, for example the app com.android.contacts would use names
8410 * like "com.android.contacts.ShowAll".
8411 *
8412 * @param name The name of the extra data, with package prefix.
8413 * @param value The byte data value.
8414 *
8415 * @return Returns the same Intent object, for chaining multiple calls
8416 * into a single statement.
8417 *
8418 * @see #putExtras
8419 * @see #removeExtra
8420 * @see #getByteExtra(String, byte)
8421 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008422 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008423 if (mExtras == null) {
8424 mExtras = new Bundle();
8425 }
8426 mExtras.putByte(name, value);
8427 return this;
8428 }
8429
8430 /**
8431 * Add extended data to the intent. The name must include a package
8432 * prefix, for example the app com.android.contacts would use names
8433 * like "com.android.contacts.ShowAll".
8434 *
8435 * @param name The name of the extra data, with package prefix.
8436 * @param value The char data value.
8437 *
8438 * @return Returns the same Intent object, for chaining multiple calls
8439 * into a single statement.
8440 *
8441 * @see #putExtras
8442 * @see #removeExtra
8443 * @see #getCharExtra(String, char)
8444 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008445 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008446 if (mExtras == null) {
8447 mExtras = new Bundle();
8448 }
8449 mExtras.putChar(name, value);
8450 return this;
8451 }
8452
8453 /**
8454 * Add extended data to the intent. The name must include a package
8455 * prefix, for example the app com.android.contacts would use names
8456 * like "com.android.contacts.ShowAll".
8457 *
8458 * @param name The name of the extra data, with package prefix.
8459 * @param value The short data value.
8460 *
8461 * @return Returns the same Intent object, for chaining multiple calls
8462 * into a single statement.
8463 *
8464 * @see #putExtras
8465 * @see #removeExtra
8466 * @see #getShortExtra(String, short)
8467 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008468 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008469 if (mExtras == null) {
8470 mExtras = new Bundle();
8471 }
8472 mExtras.putShort(name, value);
8473 return this;
8474 }
8475
8476 /**
8477 * Add extended data to the intent. The name must include a package
8478 * prefix, for example the app com.android.contacts would use names
8479 * like "com.android.contacts.ShowAll".
8480 *
8481 * @param name The name of the extra data, with package prefix.
8482 * @param value The integer data value.
8483 *
8484 * @return Returns the same Intent object, for chaining multiple calls
8485 * into a single statement.
8486 *
8487 * @see #putExtras
8488 * @see #removeExtra
8489 * @see #getIntExtra(String, int)
8490 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008491 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008492 if (mExtras == null) {
8493 mExtras = new Bundle();
8494 }
8495 mExtras.putInt(name, value);
8496 return this;
8497 }
8498
8499 /**
8500 * Add extended data to the intent. The name must include a package
8501 * prefix, for example the app com.android.contacts would use names
8502 * like "com.android.contacts.ShowAll".
8503 *
8504 * @param name The name of the extra data, with package prefix.
8505 * @param value The long data value.
8506 *
8507 * @return Returns the same Intent object, for chaining multiple calls
8508 * into a single statement.
8509 *
8510 * @see #putExtras
8511 * @see #removeExtra
8512 * @see #getLongExtra(String, long)
8513 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008514 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008515 if (mExtras == null) {
8516 mExtras = new Bundle();
8517 }
8518 mExtras.putLong(name, value);
8519 return this;
8520 }
8521
8522 /**
8523 * Add extended data to the intent. The name must include a package
8524 * prefix, for example the app com.android.contacts would use names
8525 * like "com.android.contacts.ShowAll".
8526 *
8527 * @param name The name of the extra data, with package prefix.
8528 * @param value The float data value.
8529 *
8530 * @return Returns the same Intent object, for chaining multiple calls
8531 * into a single statement.
8532 *
8533 * @see #putExtras
8534 * @see #removeExtra
8535 * @see #getFloatExtra(String, float)
8536 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008537 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008538 if (mExtras == null) {
8539 mExtras = new Bundle();
8540 }
8541 mExtras.putFloat(name, value);
8542 return this;
8543 }
8544
8545 /**
8546 * Add extended data to the intent. The name must include a package
8547 * prefix, for example the app com.android.contacts would use names
8548 * like "com.android.contacts.ShowAll".
8549 *
8550 * @param name The name of the extra data, with package prefix.
8551 * @param value The double data value.
8552 *
8553 * @return Returns the same Intent object, for chaining multiple calls
8554 * into a single statement.
8555 *
8556 * @see #putExtras
8557 * @see #removeExtra
8558 * @see #getDoubleExtra(String, double)
8559 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008560 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008561 if (mExtras == null) {
8562 mExtras = new Bundle();
8563 }
8564 mExtras.putDouble(name, value);
8565 return this;
8566 }
8567
8568 /**
8569 * Add extended data to the intent. The name must include a package
8570 * prefix, for example the app com.android.contacts would use names
8571 * like "com.android.contacts.ShowAll".
8572 *
8573 * @param name The name of the extra data, with package prefix.
8574 * @param value The String data value.
8575 *
8576 * @return Returns the same Intent object, for chaining multiple calls
8577 * into a single statement.
8578 *
8579 * @see #putExtras
8580 * @see #removeExtra
8581 * @see #getStringExtra(String)
8582 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008583 public @NonNull Intent putExtra(String name, String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008584 if (mExtras == null) {
8585 mExtras = new Bundle();
8586 }
8587 mExtras.putString(name, value);
8588 return this;
8589 }
8590
8591 /**
8592 * Add extended data to the intent. The name must include a package
8593 * prefix, for example the app com.android.contacts would use names
8594 * like "com.android.contacts.ShowAll".
8595 *
8596 * @param name The name of the extra data, with package prefix.
8597 * @param value The CharSequence data value.
8598 *
8599 * @return Returns the same Intent object, for chaining multiple calls
8600 * into a single statement.
8601 *
8602 * @see #putExtras
8603 * @see #removeExtra
8604 * @see #getCharSequenceExtra(String)
8605 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008606 public @NonNull Intent putExtra(String name, CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008607 if (mExtras == null) {
8608 mExtras = new Bundle();
8609 }
8610 mExtras.putCharSequence(name, value);
8611 return this;
8612 }
8613
8614 /**
8615 * Add extended data to the intent. The name must include a package
8616 * prefix, for example the app com.android.contacts would use names
8617 * like "com.android.contacts.ShowAll".
8618 *
8619 * @param name The name of the extra data, with package prefix.
8620 * @param value The Parcelable data value.
8621 *
8622 * @return Returns the same Intent object, for chaining multiple calls
8623 * into a single statement.
8624 *
8625 * @see #putExtras
8626 * @see #removeExtra
8627 * @see #getParcelableExtra(String)
8628 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008629 public @NonNull Intent putExtra(String name, Parcelable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008630 if (mExtras == null) {
8631 mExtras = new Bundle();
8632 }
8633 mExtras.putParcelable(name, value);
8634 return this;
8635 }
8636
8637 /**
8638 * Add extended data to the intent. The name must include a package
8639 * prefix, for example the app com.android.contacts would use names
8640 * like "com.android.contacts.ShowAll".
8641 *
8642 * @param name The name of the extra data, with package prefix.
8643 * @param value The Parcelable[] data value.
8644 *
8645 * @return Returns the same Intent object, for chaining multiple calls
8646 * into a single statement.
8647 *
8648 * @see #putExtras
8649 * @see #removeExtra
8650 * @see #getParcelableArrayExtra(String)
8651 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008652 public @NonNull Intent putExtra(String name, Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008653 if (mExtras == null) {
8654 mExtras = new Bundle();
8655 }
8656 mExtras.putParcelableArray(name, value);
8657 return this;
8658 }
8659
8660 /**
8661 * Add extended data to the intent. The name must include a package
8662 * prefix, for example the app com.android.contacts would use names
8663 * like "com.android.contacts.ShowAll".
8664 *
8665 * @param name The name of the extra data, with package prefix.
8666 * @param value The ArrayList<Parcelable> data value.
8667 *
8668 * @return Returns the same Intent object, for chaining multiple calls
8669 * into a single statement.
8670 *
8671 * @see #putExtras
8672 * @see #removeExtra
8673 * @see #getParcelableArrayListExtra(String)
8674 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008675 public @NonNull Intent putParcelableArrayListExtra(String name,
8676 ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008677 if (mExtras == null) {
8678 mExtras = new Bundle();
8679 }
8680 mExtras.putParcelableArrayList(name, value);
8681 return this;
8682 }
8683
8684 /**
8685 * Add extended data to the intent. The name must include a package
8686 * prefix, for example the app com.android.contacts would use names
8687 * like "com.android.contacts.ShowAll".
8688 *
8689 * @param name The name of the extra data, with package prefix.
8690 * @param value The ArrayList<Integer> data value.
8691 *
8692 * @return Returns the same Intent object, for chaining multiple calls
8693 * into a single statement.
8694 *
8695 * @see #putExtras
8696 * @see #removeExtra
8697 * @see #getIntegerArrayListExtra(String)
8698 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008699 public @NonNull Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008700 if (mExtras == null) {
8701 mExtras = new Bundle();
8702 }
8703 mExtras.putIntegerArrayList(name, value);
8704 return this;
8705 }
8706
8707 /**
8708 * Add extended data to the intent. The name must include a package
8709 * prefix, for example the app com.android.contacts would use names
8710 * like "com.android.contacts.ShowAll".
8711 *
8712 * @param name The name of the extra data, with package prefix.
8713 * @param value The ArrayList<String> data value.
8714 *
8715 * @return Returns the same Intent object, for chaining multiple calls
8716 * into a single statement.
8717 *
8718 * @see #putExtras
8719 * @see #removeExtra
8720 * @see #getStringArrayListExtra(String)
8721 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008722 public @NonNull Intent putStringArrayListExtra(String name, ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008723 if (mExtras == null) {
8724 mExtras = new Bundle();
8725 }
8726 mExtras.putStringArrayList(name, value);
8727 return this;
8728 }
8729
8730 /**
8731 * Add extended data to the intent. The name must include a package
8732 * prefix, for example the app com.android.contacts would use names
8733 * like "com.android.contacts.ShowAll".
8734 *
8735 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008736 * @param value The ArrayList<CharSequence> data value.
8737 *
8738 * @return Returns the same Intent object, for chaining multiple calls
8739 * into a single statement.
8740 *
8741 * @see #putExtras
8742 * @see #removeExtra
8743 * @see #getCharSequenceArrayListExtra(String)
8744 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008745 public @NonNull Intent putCharSequenceArrayListExtra(String name,
8746 ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008747 if (mExtras == null) {
8748 mExtras = new Bundle();
8749 }
8750 mExtras.putCharSequenceArrayList(name, value);
8751 return this;
8752 }
8753
8754 /**
8755 * Add extended data to the intent. The name must include a package
8756 * prefix, for example the app com.android.contacts would use names
8757 * like "com.android.contacts.ShowAll".
8758 *
8759 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008760 * @param value The Serializable data value.
8761 *
8762 * @return Returns the same Intent object, for chaining multiple calls
8763 * into a single statement.
8764 *
8765 * @see #putExtras
8766 * @see #removeExtra
8767 * @see #getSerializableExtra(String)
8768 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008769 public @NonNull Intent putExtra(String name, Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008770 if (mExtras == null) {
8771 mExtras = new Bundle();
8772 }
8773 mExtras.putSerializable(name, value);
8774 return this;
8775 }
8776
8777 /**
8778 * Add extended data to the intent. The name must include a package
8779 * prefix, for example the app com.android.contacts would use names
8780 * like "com.android.contacts.ShowAll".
8781 *
8782 * @param name The name of the extra data, with package prefix.
8783 * @param value The boolean array data value.
8784 *
8785 * @return Returns the same Intent object, for chaining multiple calls
8786 * into a single statement.
8787 *
8788 * @see #putExtras
8789 * @see #removeExtra
8790 * @see #getBooleanArrayExtra(String)
8791 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008792 public @NonNull Intent putExtra(String name, boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008793 if (mExtras == null) {
8794 mExtras = new Bundle();
8795 }
8796 mExtras.putBooleanArray(name, value);
8797 return this;
8798 }
8799
8800 /**
8801 * Add extended data to the intent. The name must include a package
8802 * prefix, for example the app com.android.contacts would use names
8803 * like "com.android.contacts.ShowAll".
8804 *
8805 * @param name The name of the extra data, with package prefix.
8806 * @param value The byte array data value.
8807 *
8808 * @return Returns the same Intent object, for chaining multiple calls
8809 * into a single statement.
8810 *
8811 * @see #putExtras
8812 * @see #removeExtra
8813 * @see #getByteArrayExtra(String)
8814 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008815 public @NonNull Intent putExtra(String name, byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008816 if (mExtras == null) {
8817 mExtras = new Bundle();
8818 }
8819 mExtras.putByteArray(name, value);
8820 return this;
8821 }
8822
8823 /**
8824 * Add extended data to the intent. The name must include a package
8825 * prefix, for example the app com.android.contacts would use names
8826 * like "com.android.contacts.ShowAll".
8827 *
8828 * @param name The name of the extra data, with package prefix.
8829 * @param value The short array data value.
8830 *
8831 * @return Returns the same Intent object, for chaining multiple calls
8832 * into a single statement.
8833 *
8834 * @see #putExtras
8835 * @see #removeExtra
8836 * @see #getShortArrayExtra(String)
8837 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008838 public @NonNull Intent putExtra(String name, short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008839 if (mExtras == null) {
8840 mExtras = new Bundle();
8841 }
8842 mExtras.putShortArray(name, value);
8843 return this;
8844 }
8845
8846 /**
8847 * Add extended data to the intent. The name must include a package
8848 * prefix, for example the app com.android.contacts would use names
8849 * like "com.android.contacts.ShowAll".
8850 *
8851 * @param name The name of the extra data, with package prefix.
8852 * @param value The char array data value.
8853 *
8854 * @return Returns the same Intent object, for chaining multiple calls
8855 * into a single statement.
8856 *
8857 * @see #putExtras
8858 * @see #removeExtra
8859 * @see #getCharArrayExtra(String)
8860 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008861 public @NonNull Intent putExtra(String name, char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008862 if (mExtras == null) {
8863 mExtras = new Bundle();
8864 }
8865 mExtras.putCharArray(name, value);
8866 return this;
8867 }
8868
8869 /**
8870 * Add extended data to the intent. The name must include a package
8871 * prefix, for example the app com.android.contacts would use names
8872 * like "com.android.contacts.ShowAll".
8873 *
8874 * @param name The name of the extra data, with package prefix.
8875 * @param value The int array data value.
8876 *
8877 * @return Returns the same Intent object, for chaining multiple calls
8878 * into a single statement.
8879 *
8880 * @see #putExtras
8881 * @see #removeExtra
8882 * @see #getIntArrayExtra(String)
8883 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008884 public @NonNull Intent putExtra(String name, int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008885 if (mExtras == null) {
8886 mExtras = new Bundle();
8887 }
8888 mExtras.putIntArray(name, value);
8889 return this;
8890 }
8891
8892 /**
8893 * Add extended data to the intent. The name must include a package
8894 * prefix, for example the app com.android.contacts would use names
8895 * like "com.android.contacts.ShowAll".
8896 *
8897 * @param name The name of the extra data, with package prefix.
8898 * @param value The byte array data value.
8899 *
8900 * @return Returns the same Intent object, for chaining multiple calls
8901 * into a single statement.
8902 *
8903 * @see #putExtras
8904 * @see #removeExtra
8905 * @see #getLongArrayExtra(String)
8906 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008907 public @NonNull Intent putExtra(String name, long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008908 if (mExtras == null) {
8909 mExtras = new Bundle();
8910 }
8911 mExtras.putLongArray(name, value);
8912 return this;
8913 }
8914
8915 /**
8916 * Add extended data to the intent. The name must include a package
8917 * prefix, for example the app com.android.contacts would use names
8918 * like "com.android.contacts.ShowAll".
8919 *
8920 * @param name The name of the extra data, with package prefix.
8921 * @param value The float array data value.
8922 *
8923 * @return Returns the same Intent object, for chaining multiple calls
8924 * into a single statement.
8925 *
8926 * @see #putExtras
8927 * @see #removeExtra
8928 * @see #getFloatArrayExtra(String)
8929 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008930 public @NonNull Intent putExtra(String name, float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008931 if (mExtras == null) {
8932 mExtras = new Bundle();
8933 }
8934 mExtras.putFloatArray(name, value);
8935 return this;
8936 }
8937
8938 /**
8939 * Add extended data to the intent. The name must include a package
8940 * prefix, for example the app com.android.contacts would use names
8941 * like "com.android.contacts.ShowAll".
8942 *
8943 * @param name The name of the extra data, with package prefix.
8944 * @param value The double array data value.
8945 *
8946 * @return Returns the same Intent object, for chaining multiple calls
8947 * into a single statement.
8948 *
8949 * @see #putExtras
8950 * @see #removeExtra
8951 * @see #getDoubleArrayExtra(String)
8952 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008953 public @NonNull Intent putExtra(String name, double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008954 if (mExtras == null) {
8955 mExtras = new Bundle();
8956 }
8957 mExtras.putDoubleArray(name, value);
8958 return this;
8959 }
8960
8961 /**
8962 * Add extended data to the intent. The name must include a package
8963 * prefix, for example the app com.android.contacts would use names
8964 * like "com.android.contacts.ShowAll".
8965 *
8966 * @param name The name of the extra data, with package prefix.
8967 * @param value The String array data value.
8968 *
8969 * @return Returns the same Intent object, for chaining multiple calls
8970 * into a single statement.
8971 *
8972 * @see #putExtras
8973 * @see #removeExtra
8974 * @see #getStringArrayExtra(String)
8975 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008976 public @NonNull Intent putExtra(String name, String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008977 if (mExtras == null) {
8978 mExtras = new Bundle();
8979 }
8980 mExtras.putStringArray(name, value);
8981 return this;
8982 }
8983
8984 /**
8985 * Add extended data to the intent. The name must include a package
8986 * prefix, for example the app com.android.contacts would use names
8987 * like "com.android.contacts.ShowAll".
8988 *
8989 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008990 * @param value The CharSequence array data value.
8991 *
8992 * @return Returns the same Intent object, for chaining multiple calls
8993 * into a single statement.
8994 *
8995 * @see #putExtras
8996 * @see #removeExtra
8997 * @see #getCharSequenceArrayExtra(String)
8998 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008999 public @NonNull Intent putExtra(String name, CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00009000 if (mExtras == null) {
9001 mExtras = new Bundle();
9002 }
9003 mExtras.putCharSequenceArray(name, value);
9004 return this;
9005 }
9006
9007 /**
9008 * Add extended data to the intent. The name must include a package
9009 * prefix, for example the app com.android.contacts would use names
9010 * like "com.android.contacts.ShowAll".
9011 *
9012 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009013 * @param value The Bundle data value.
9014 *
9015 * @return Returns the same Intent object, for chaining multiple calls
9016 * into a single statement.
9017 *
9018 * @see #putExtras
9019 * @see #removeExtra
9020 * @see #getBundleExtra(String)
9021 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009022 public @NonNull Intent putExtra(String name, Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009023 if (mExtras == null) {
9024 mExtras = new Bundle();
9025 }
9026 mExtras.putBundle(name, value);
9027 return this;
9028 }
9029
9030 /**
9031 * Add extended data to the intent. The name must include a package
9032 * prefix, for example the app com.android.contacts would use names
9033 * like "com.android.contacts.ShowAll".
9034 *
9035 * @param name The name of the extra data, with package prefix.
9036 * @param value The IBinder data value.
9037 *
9038 * @return Returns the same Intent object, for chaining multiple calls
9039 * into a single statement.
9040 *
9041 * @see #putExtras
9042 * @see #removeExtra
9043 * @see #getIBinderExtra(String)
9044 *
9045 * @deprecated
9046 * @hide
9047 */
9048 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01009049 @UnsupportedAppUsage
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009050 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009051 if (mExtras == null) {
9052 mExtras = new Bundle();
9053 }
9054 mExtras.putIBinder(name, value);
9055 return this;
9056 }
9057
9058 /**
9059 * Copy all extras in 'src' in to this intent.
9060 *
9061 * @param src Contains the extras to copy.
9062 *
9063 * @see #putExtra
9064 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009065 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009066 if (src.mExtras != null) {
9067 if (mExtras == null) {
9068 mExtras = new Bundle(src.mExtras);
9069 } else {
9070 mExtras.putAll(src.mExtras);
9071 }
9072 }
9073 return this;
9074 }
9075
9076 /**
9077 * Add a set of extended data to the intent. The keys must include a package
9078 * prefix, for example the app com.android.contacts would use names
9079 * like "com.android.contacts.ShowAll".
9080 *
9081 * @param extras The Bundle of extras to add to this intent.
9082 *
9083 * @see #putExtra
9084 * @see #removeExtra
9085 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009086 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009087 if (mExtras == null) {
9088 mExtras = new Bundle();
9089 }
9090 mExtras.putAll(extras);
9091 return this;
9092 }
9093
9094 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009095 * Completely replace the extras in the Intent with the extras in the
9096 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07009097 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009098 * @param src The exact extras contained in this Intent are copied
9099 * into the target intent, replacing any that were previously there.
9100 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009101 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009102 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
9103 return this;
9104 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009105
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009106 /**
9107 * Completely replace the extras in the Intent with the given Bundle of
9108 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07009109 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009110 * @param extras The new set of extras in the Intent, or null to erase
9111 * all extras.
9112 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009113 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009114 mExtras = extras != null ? new Bundle(extras) : null;
9115 return this;
9116 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009117
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009118 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009119 * Remove extended data from the intent.
9120 *
9121 * @see #putExtra
9122 */
9123 public void removeExtra(String name) {
9124 if (mExtras != null) {
9125 mExtras.remove(name);
9126 if (mExtras.size() == 0) {
9127 mExtras = null;
9128 }
9129 }
9130 }
9131
9132 /**
9133 * Set special flags controlling how this intent is handled. Most values
9134 * here depend on the type of component being executed by the Intent,
9135 * specifically the FLAG_ACTIVITY_* flags are all for use with
9136 * {@link Context#startActivity Context.startActivity()} and the
9137 * FLAG_RECEIVER_* flags are all for use with
9138 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
9139 *
Scott Main7aee61f2011-02-08 11:25:01 -08009140 * <p>See the
9141 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
9142 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009143 * the behavior of your application.
9144 *
9145 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009146 * @return Returns the same Intent object, for chaining multiple calls
9147 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009148 * @see #getFlags
9149 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009150 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009151 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009152 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009153 mFlags = flags;
9154 return this;
9155 }
9156
9157 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009158 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009159 *
9160 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009161 * @return Returns the same Intent object, for chaining multiple calls into
9162 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009163 * @see #setFlags
9164 * @see #getFlags
9165 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009166 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009167 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009168 mFlags |= flags;
9169 return this;
9170 }
9171
9172 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009173 * Remove these flags from the intent.
9174 *
9175 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009176 * @see #setFlags
9177 * @see #getFlags
9178 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009179 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009180 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009181 mFlags &= ~flags;
9182 }
9183
9184 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009185 * (Usually optional) Set an explicit application package name that limits
9186 * the components this Intent will resolve to. If left to the default
9187 * value of null, all components in all applications will considered.
9188 * If non-null, the Intent can only match the components in the given
9189 * application package.
9190 *
9191 * @param packageName The name of the application package to handle the
9192 * intent, or null to allow any application package.
9193 *
9194 * @return Returns the same Intent object, for chaining multiple calls
9195 * into a single statement.
9196 *
9197 * @see #getPackage
9198 * @see #resolveActivity
9199 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009200 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009201 if (packageName != null && mSelector != null) {
9202 throw new IllegalArgumentException(
9203 "Can't set package name when selector is already set");
9204 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009205 mPackage = packageName;
9206 return this;
9207 }
9208
9209 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009210 * (Usually optional) Explicitly set the component to handle the intent.
9211 * If left with the default value of null, the system will determine the
9212 * appropriate class to use based on the other fields (action, data,
9213 * type, categories) in the Intent. If this class is defined, the
9214 * specified class will always be used regardless of the other fields. You
9215 * should only set this value when you know you absolutely want a specific
9216 * class to be used; otherwise it is better to let the system find the
9217 * appropriate class so that you will respect the installed applications
9218 * and user preferences.
9219 *
9220 * @param component The name of the application component to handle the
9221 * intent, or null to let the system find one for you.
9222 *
9223 * @return Returns the same Intent object, for chaining multiple calls
9224 * into a single statement.
9225 *
9226 * @see #setClass
9227 * @see #setClassName(Context, String)
9228 * @see #setClassName(String, String)
9229 * @see #getComponent
9230 * @see #resolveActivity
9231 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009232 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009233 mComponent = component;
9234 return this;
9235 }
9236
9237 /**
9238 * Convenience for calling {@link #setComponent} with an
9239 * explicit class name.
9240 *
9241 * @param packageContext A Context of the application package implementing
9242 * this class.
9243 * @param className The name of a class inside of the application package
9244 * that will be used as the component for this Intent.
9245 *
9246 * @return Returns the same Intent object, for chaining multiple calls
9247 * into a single statement.
9248 *
9249 * @see #setComponent
9250 * @see #setClass
9251 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009252 public @NonNull Intent setClassName(@NonNull Context packageContext,
9253 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009254 mComponent = new ComponentName(packageContext, className);
9255 return this;
9256 }
9257
9258 /**
9259 * Convenience for calling {@link #setComponent} with an
9260 * explicit application package name and class name.
9261 *
9262 * @param packageName The name of the package implementing the desired
9263 * component.
9264 * @param className The name of a class inside of the application package
9265 * that will be used as the component for this Intent.
9266 *
9267 * @return Returns the same Intent object, for chaining multiple calls
9268 * into a single statement.
9269 *
9270 * @see #setComponent
9271 * @see #setClass
9272 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009273 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009274 mComponent = new ComponentName(packageName, className);
9275 return this;
9276 }
9277
9278 /**
9279 * Convenience for calling {@link #setComponent(ComponentName)} with the
9280 * name returned by a {@link Class} object.
9281 *
9282 * @param packageContext A Context of the application package implementing
9283 * this class.
9284 * @param cls The class name to set, equivalent to
9285 * <code>setClassName(context, cls.getName())</code>.
9286 *
9287 * @return Returns the same Intent object, for chaining multiple calls
9288 * into a single statement.
9289 *
9290 * @see #setComponent
9291 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009292 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009293 mComponent = new ComponentName(packageContext, cls);
9294 return this;
9295 }
9296
9297 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009298 * Set the bounds of the sender of this intent, in screen coordinates. This can be
9299 * used as a hint to the receiver for animations and the like. Null means that there
9300 * is no source bounds.
9301 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009302 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009303 if (r != null) {
9304 mSourceBounds = new Rect(r);
9305 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07009306 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009307 }
9308 }
9309
Tor Norbyed9273d62013-05-30 15:59:53 -07009310 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07009311 @IntDef(flag = true, prefix = { "FILL_IN_" }, value = {
9312 FILL_IN_ACTION,
9313 FILL_IN_DATA,
9314 FILL_IN_CATEGORIES,
9315 FILL_IN_COMPONENT,
9316 FILL_IN_PACKAGE,
9317 FILL_IN_SOURCE_BOUNDS,
9318 FILL_IN_SELECTOR,
9319 FILL_IN_CLIP_DATA
9320 })
Tor Norbyed9273d62013-05-30 15:59:53 -07009321 @Retention(RetentionPolicy.SOURCE)
9322 public @interface FillInFlags {}
9323
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009324 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009325 * Use with {@link #fillIn} to allow the current action value to be
9326 * overwritten, even if it is already set.
9327 */
9328 public static final int FILL_IN_ACTION = 1<<0;
9329
9330 /**
9331 * Use with {@link #fillIn} to allow the current data or type value
9332 * overwritten, even if it is already set.
9333 */
9334 public static final int FILL_IN_DATA = 1<<1;
9335
9336 /**
9337 * Use with {@link #fillIn} to allow the current categories to be
9338 * overwritten, even if they are already set.
9339 */
9340 public static final int FILL_IN_CATEGORIES = 1<<2;
9341
9342 /**
9343 * Use with {@link #fillIn} to allow the current component value to be
9344 * overwritten, even if it is already set.
9345 */
9346 public static final int FILL_IN_COMPONENT = 1<<3;
9347
9348 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009349 * Use with {@link #fillIn} to allow the current package value to be
9350 * overwritten, even if it is already set.
9351 */
9352 public static final int FILL_IN_PACKAGE = 1<<4;
9353
9354 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009355 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009356 * overwritten, even if it is already set.
9357 */
9358 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
9359
9360 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009361 * Use with {@link #fillIn} to allow the current selector to be
9362 * overwritten, even if it is already set.
9363 */
9364 public static final int FILL_IN_SELECTOR = 1<<6;
9365
9366 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009367 * Use with {@link #fillIn} to allow the current ClipData to be
9368 * overwritten, even if it is already set.
9369 */
9370 public static final int FILL_IN_CLIP_DATA = 1<<7;
9371
9372 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009373 * Copy the contents of <var>other</var> in to this object, but only
9374 * where fields are not defined by this object. For purposes of a field
9375 * being defined, the following pieces of data in the Intent are
9376 * considered to be separate fields:
9377 *
9378 * <ul>
9379 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08009380 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009381 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
9382 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009383 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009384 * <li> component, as set by {@link #setComponent(ComponentName)} or
9385 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009386 * <li> source bounds, as set by {@link #setSourceBounds}.
9387 * <li> selector, as set by {@link #setSelector(Intent)}.
9388 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009389 * <li> each top-level name in the associated extras.
9390 * </ul>
9391 *
9392 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009393 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009394 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
9395 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
9396 * the restriction where the corresponding field will not be replaced if
9397 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009398 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009399 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
9400 * is explicitly specified. The selector will only be copied if
9401 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07009402 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009403 * <p>For example, consider Intent A with {data="foo", categories="bar"}
9404 * and Intent B with {action="gotit", data-type="some/thing",
9405 * categories="one","two"}.
9406 *
9407 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
9408 * containing: {action="gotit", data-type="some/thing",
9409 * categories="bar"}.
9410 *
9411 * @param other Another Intent whose values are to be used to fill in
9412 * the current one.
9413 * @param flags Options to control which fields can be filled in.
9414 *
9415 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009416 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07009417 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08009418 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07009419 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009420 */
Tor Norbyed9273d62013-05-30 15:59:53 -07009421 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009422 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009423 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009424 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009425 if (other.mAction != null
9426 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009427 mAction = other.mAction;
9428 changes |= FILL_IN_ACTION;
9429 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009430 if ((other.mData != null || other.mType != null)
9431 && ((mData == null && mType == null)
9432 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009433 mData = other.mData;
9434 mType = other.mType;
9435 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009436 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009437 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009438 if (other.mCategories != null
9439 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009440 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009441 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009442 }
9443 changes |= FILL_IN_CATEGORIES;
9444 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009445 if (other.mPackage != null
9446 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009447 // Only do this if mSelector is not set.
9448 if (mSelector == null) {
9449 mPackage = other.mPackage;
9450 changes |= FILL_IN_PACKAGE;
9451 }
9452 }
9453 // Selector is special: it can only be set if explicitly allowed,
9454 // for the same reason as the component name.
9455 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
9456 if (mPackage == null) {
9457 mSelector = new Intent(other.mSelector);
9458 mPackage = null;
9459 changes |= FILL_IN_SELECTOR;
9460 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009461 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009462 if (other.mClipData != null
9463 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
9464 mClipData = other.mClipData;
9465 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009466 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009467 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009468 // Component is special: it can -only- be set if explicitly allowed,
9469 // since otherwise the sender could force the intent somewhere the
9470 // originator didn't intend.
9471 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009472 mComponent = other.mComponent;
9473 changes |= FILL_IN_COMPONENT;
9474 }
9475 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009476 if (other.mSourceBounds != null
9477 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
9478 mSourceBounds = new Rect(other.mSourceBounds);
9479 changes |= FILL_IN_SOURCE_BOUNDS;
9480 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009481 if (mExtras == null) {
9482 if (other.mExtras != null) {
9483 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009484 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009485 }
9486 } else if (other.mExtras != null) {
9487 try {
9488 Bundle newb = new Bundle(other.mExtras);
9489 newb.putAll(mExtras);
9490 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009491 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009492 } catch (RuntimeException e) {
9493 // Modifying the extras can cause us to unparcel the contents
9494 // of the bundle, and if we do this in the system process that
9495 // may fail. We really should handle this (i.e., the Bundle
9496 // impl shouldn't be on top of a plain map), but for now just
9497 // ignore it and keep the original contents. :(
9498 Log.w("Intent", "Failure filling in extras", e);
9499 }
9500 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009501 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9502 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9503 mContentUserHint = other.mContentUserHint;
9504 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009505 return changes;
9506 }
9507
9508 /**
9509 * Wrapper class holding an Intent and implementing comparisons on it for
9510 * the purpose of filtering. The class implements its
9511 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9512 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9513 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9514 * on the wrapped Intent.
9515 */
9516 public static final class FilterComparison {
9517 private final Intent mIntent;
9518 private final int mHashCode;
9519
9520 public FilterComparison(Intent intent) {
9521 mIntent = intent;
9522 mHashCode = intent.filterHashCode();
9523 }
9524
9525 /**
9526 * Return the Intent that this FilterComparison represents.
9527 * @return Returns the Intent held by the FilterComparison. Do
9528 * not modify!
9529 */
9530 public Intent getIntent() {
9531 return mIntent;
9532 }
9533
9534 @Override
9535 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009536 if (obj instanceof FilterComparison) {
9537 Intent other = ((FilterComparison)obj).mIntent;
9538 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009539 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009540 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009541 }
9542
9543 @Override
9544 public int hashCode() {
9545 return mHashCode;
9546 }
9547 }
9548
9549 /**
9550 * Determine if two intents are the same for the purposes of intent
9551 * resolution (filtering). That is, if their action, data, type,
9552 * class, and categories are the same. This does <em>not</em> compare
9553 * any extra data included in the intents.
9554 *
9555 * @param other The other Intent to compare against.
9556 *
9557 * @return Returns true if action, data, type, class, and categories
9558 * are the same.
9559 */
9560 public boolean filterEquals(Intent other) {
9561 if (other == null) {
9562 return false;
9563 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009564 if (!Objects.equals(this.mAction, other.mAction)) return false;
9565 if (!Objects.equals(this.mData, other.mData)) return false;
9566 if (!Objects.equals(this.mType, other.mType)) return false;
9567 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9568 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9569 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009570
9571 return true;
9572 }
9573
9574 /**
9575 * Generate hash code that matches semantics of filterEquals().
9576 *
9577 * @return Returns the hash value of the action, data, type, class, and
9578 * categories.
9579 *
9580 * @see #filterEquals
9581 */
9582 public int filterHashCode() {
9583 int code = 0;
9584 if (mAction != null) {
9585 code += mAction.hashCode();
9586 }
9587 if (mData != null) {
9588 code += mData.hashCode();
9589 }
9590 if (mType != null) {
9591 code += mType.hashCode();
9592 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009593 if (mPackage != null) {
9594 code += mPackage.hashCode();
9595 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009596 if (mComponent != null) {
9597 code += mComponent.hashCode();
9598 }
9599 if (mCategories != null) {
9600 code += mCategories.hashCode();
9601 }
9602 return code;
9603 }
9604
9605 @Override
9606 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009607 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009608
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009609 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009610 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009611 b.append(" }");
9612
9613 return b.toString();
9614 }
9615
9616 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01009617 @UnsupportedAppUsage
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009618 public String toInsecureString() {
9619 StringBuilder b = new StringBuilder(128);
9620
9621 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009622 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009623 b.append(" }");
9624
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009625 return b.toString();
9626 }
Romain Guy4969af72009-06-17 10:53:19 -07009627
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009628 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009629 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009630 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009631
9632 b.append("Intent { ");
9633 toShortString(b, false, true, true, true);
9634 b.append(" }");
9635
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009636 return b.toString();
9637 }
9638
9639 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009640 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9641 StringBuilder b = new StringBuilder(128);
9642 toShortString(b, secure, comp, extras, clip);
9643 return b.toString();
9644 }
9645
9646 /** @hide */
9647 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9648 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009649 boolean first = true;
9650 if (mAction != null) {
9651 b.append("act=").append(mAction);
9652 first = false;
9653 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009654 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009655 if (!first) {
9656 b.append(' ');
9657 }
9658 first = false;
9659 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009660 for (int i=0; i<mCategories.size(); i++) {
9661 if (i > 0) b.append(',');
9662 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009663 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009664 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009665 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009666 if (mData != null) {
9667 if (!first) {
9668 b.append(' ');
9669 }
9670 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009671 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009672 if (secure) {
9673 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009674 } else {
9675 b.append(mData);
9676 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009677 }
9678 if (mType != null) {
9679 if (!first) {
9680 b.append(' ');
9681 }
9682 first = false;
9683 b.append("typ=").append(mType);
9684 }
9685 if (mFlags != 0) {
9686 if (!first) {
9687 b.append(' ');
9688 }
9689 first = false;
9690 b.append("flg=0x").append(Integer.toHexString(mFlags));
9691 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009692 if (mPackage != null) {
9693 if (!first) {
9694 b.append(' ');
9695 }
9696 first = false;
9697 b.append("pkg=").append(mPackage);
9698 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009699 if (comp && mComponent != null) {
9700 if (!first) {
9701 b.append(' ');
9702 }
9703 first = false;
9704 b.append("cmp=").append(mComponent.flattenToShortString());
9705 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009706 if (mSourceBounds != null) {
9707 if (!first) {
9708 b.append(' ');
9709 }
9710 first = false;
9711 b.append("bnds=").append(mSourceBounds.toShortString());
9712 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009713 if (mClipData != null) {
9714 if (!first) {
9715 b.append(' ');
9716 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009717 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009718 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009719 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009720 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009721 if (mClipData.getDescription() != null) {
9722 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9723 } else {
9724 first = true;
9725 }
9726 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009727 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009728 first = false;
9729 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009730 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009731 if (extras && mExtras != null) {
9732 if (!first) {
9733 b.append(' ');
9734 }
9735 first = false;
9736 b.append("(has extras)");
9737 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009738 if (mContentUserHint != UserHandle.USER_CURRENT) {
9739 if (!first) {
9740 b.append(' ');
9741 }
9742 first = false;
9743 b.append("u=").append(mContentUserHint);
9744 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009745 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009746 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009747 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009748 b.append("}");
9749 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009750 }
9751
Yi Jin129fc6c2017-09-28 15:48:38 -07009752 /** @hide */
Kweku Adams85f2fbc2017-12-18 12:04:12 -08009753 public void writeToProto(ProtoOutputStream proto, long fieldId) {
9754 // Same input parameters that toString() gives to toShortString().
9755 writeToProto(proto, fieldId, true, true, true, false);
9756 }
9757
9758 /** @hide */
Yi Jin129fc6c2017-09-28 15:48:38 -07009759 public void writeToProto(ProtoOutputStream proto, long fieldId, boolean secure, boolean comp,
9760 boolean extras, boolean clip) {
9761 long token = proto.start(fieldId);
9762 if (mAction != null) {
9763 proto.write(IntentProto.ACTION, mAction);
9764 }
9765 if (mCategories != null) {
9766 for (String category : mCategories) {
9767 proto.write(IntentProto.CATEGORIES, category);
9768 }
9769 }
9770 if (mData != null) {
9771 proto.write(IntentProto.DATA, secure ? mData.toSafeString() : mData.toString());
9772 }
9773 if (mType != null) {
9774 proto.write(IntentProto.TYPE, mType);
9775 }
9776 if (mFlags != 0) {
9777 proto.write(IntentProto.FLAG, "0x" + Integer.toHexString(mFlags));
9778 }
9779 if (mPackage != null) {
9780 proto.write(IntentProto.PACKAGE, mPackage);
9781 }
9782 if (comp && mComponent != null) {
Yi Jin676d1ac2018-01-25 15:40:28 -08009783 mComponent.writeToProto(proto, IntentProto.COMPONENT);
Yi Jin129fc6c2017-09-28 15:48:38 -07009784 }
9785 if (mSourceBounds != null) {
9786 proto.write(IntentProto.SOURCE_BOUNDS, mSourceBounds.toShortString());
9787 }
9788 if (mClipData != null) {
9789 StringBuilder b = new StringBuilder();
9790 if (clip) {
9791 mClipData.toShortString(b);
9792 } else {
9793 mClipData.toShortStringShortItems(b, false);
9794 }
9795 proto.write(IntentProto.CLIP_DATA, b.toString());
9796 }
9797 if (extras && mExtras != null) {
9798 proto.write(IntentProto.EXTRAS, mExtras.toShortString());
9799 }
9800 if (mContentUserHint != 0) {
9801 proto.write(IntentProto.CONTENT_USER_HINT, mContentUserHint);
9802 }
9803 if (mSelector != null) {
9804 proto.write(IntentProto.SELECTOR, mSelector.toShortString(secure, comp, extras, clip));
9805 }
9806 proto.end(token);
9807 }
9808
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009809 /**
9810 * Call {@link #toUri} with 0 flags.
9811 * @deprecated Use {@link #toUri} instead.
9812 */
9813 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009814 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009815 return toUri(0);
9816 }
9817
9818 /**
9819 * Convert this Intent into a String holding a URI representation of it.
9820 * The returned URI string has been properly URI encoded, so it can be
9821 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9822 * Intent's data as the base URI, with an additional fragment describing
9823 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009824 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009825 * <p>You can convert the returned string back to an Intent with
9826 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009827 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009828 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009829 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009830 * @return Returns a URI encoding URI string describing the entire contents
9831 * of the Intent.
9832 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009833 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009834 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009835 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9836 if (mPackage == null) {
9837 throw new IllegalArgumentException(
9838 "Intent must include an explicit package name to build an android-app: "
9839 + this);
9840 }
9841 uri.append("android-app://");
9842 uri.append(mPackage);
9843 String scheme = null;
9844 if (mData != null) {
9845 scheme = mData.getScheme();
9846 if (scheme != null) {
9847 uri.append('/');
9848 uri.append(scheme);
9849 String authority = mData.getEncodedAuthority();
9850 if (authority != null) {
9851 uri.append('/');
9852 uri.append(authority);
9853 String path = mData.getEncodedPath();
9854 if (path != null) {
9855 uri.append(path);
9856 }
9857 String queryParams = mData.getEncodedQuery();
9858 if (queryParams != null) {
9859 uri.append('?');
9860 uri.append(queryParams);
9861 }
9862 String fragment = mData.getEncodedFragment();
9863 if (fragment != null) {
9864 uri.append('#');
9865 uri.append(fragment);
9866 }
9867 }
9868 }
9869 }
9870 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9871 mPackage, flags);
9872 return uri.toString();
9873 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009874 String scheme = null;
9875 if (mData != null) {
9876 String data = mData.toString();
9877 if ((flags&URI_INTENT_SCHEME) != 0) {
9878 final int N = data.length();
9879 for (int i=0; i<N; i++) {
9880 char c = data.charAt(i);
9881 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
Christopher Schuster42c3a6e2017-07-21 14:53:52 -07009882 || (c >= '0' && c <= '9') || c == '.' || c == '-' || c == '+') {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009883 continue;
9884 }
9885 if (c == ':' && i > 0) {
9886 // Valid scheme.
9887 scheme = data.substring(0, i);
9888 uri.append("intent:");
9889 data = data.substring(i+1);
9890 break;
9891 }
Tom Taylord4a47292009-12-21 13:59:18 -08009892
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009893 // No scheme.
9894 break;
9895 }
9896 }
9897 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009898
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009899 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9900 uri.append("intent:");
9901 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009902
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009903 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009904
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009905 return uri.toString();
9906 }
9907
9908 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9909 String defPackage, int flags) {
9910 StringBuilder frag = new StringBuilder(128);
9911
9912 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009913 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009914 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009915 // Note that for now we are not going to try to handle the
9916 // data part; not clear how to represent this as a URI, and
9917 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009918 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9919 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009920 }
9921
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009922 if (frag.length() > 0) {
9923 uri.append("#Intent;");
9924 uri.append(frag);
9925 uri.append("end");
9926 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009927 }
9928
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009929 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9930 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009931 if (scheme != null) {
9932 uri.append("scheme=").append(scheme).append(';');
9933 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009934 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009935 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009936 }
9937 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009938 for (int i=0; i<mCategories.size(); i++) {
9939 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009940 }
9941 }
9942 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009943 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009944 }
9945 if (mFlags != 0) {
9946 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9947 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009948 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009949 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9950 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009951 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009952 uri.append("component=").append(Uri.encode(
9953 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009954 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009955 if (mSourceBounds != null) {
9956 uri.append("sourceBounds=")
9957 .append(Uri.encode(mSourceBounds.flattenToString()))
9958 .append(';');
9959 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009960 if (mExtras != null) {
9961 for (String key : mExtras.keySet()) {
9962 final Object value = mExtras.get(key);
9963 char entryType =
9964 value instanceof String ? 'S' :
9965 value instanceof Boolean ? 'B' :
9966 value instanceof Byte ? 'b' :
9967 value instanceof Character ? 'c' :
9968 value instanceof Double ? 'd' :
9969 value instanceof Float ? 'f' :
9970 value instanceof Integer ? 'i' :
9971 value instanceof Long ? 'l' :
9972 value instanceof Short ? 's' :
9973 '\0';
9974
9975 if (entryType != '\0') {
9976 uri.append(entryType);
9977 uri.append('.');
9978 uri.append(Uri.encode(key));
9979 uri.append('=');
9980 uri.append(Uri.encode(value.toString()));
9981 uri.append(';');
9982 }
9983 }
9984 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009985 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009986
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009987 public int describeContents() {
9988 return (mExtras != null) ? mExtras.describeContents() : 0;
9989 }
9990
9991 public void writeToParcel(Parcel out, int flags) {
9992 out.writeString(mAction);
9993 Uri.writeToParcel(out, mData);
9994 out.writeString(mType);
9995 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009996 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009997 ComponentName.writeToParcel(mComponent, out);
9998
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009999 if (mSourceBounds != null) {
10000 out.writeInt(1);
10001 mSourceBounds.writeToParcel(out, flags);
10002 } else {
10003 out.writeInt(0);
10004 }
10005
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010006 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -070010007 final int N = mCategories.size();
10008 out.writeInt(N);
10009 for (int i=0; i<N; i++) {
10010 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010011 }
10012 } else {
10013 out.writeInt(0);
10014 }
10015
Dianne Hackbornf5b86712011-12-05 17:42:41 -080010016 if (mSelector != null) {
10017 out.writeInt(1);
10018 mSelector.writeToParcel(out, flags);
10019 } else {
10020 out.writeInt(0);
10021 }
10022
Dianne Hackborn21c241e2012-03-08 13:57:23 -080010023 if (mClipData != null) {
10024 out.writeInt(1);
10025 mClipData.writeToParcel(out, flags);
10026 } else {
10027 out.writeInt(0);
10028 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010029 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010030 out.writeBundle(mExtras);
10031 }
10032
10033 public static final Parcelable.Creator<Intent> CREATOR
10034 = new Parcelable.Creator<Intent>() {
10035 public Intent createFromParcel(Parcel in) {
10036 return new Intent(in);
10037 }
10038 public Intent[] newArray(int size) {
10039 return new Intent[size];
10040 }
10041 };
10042
Dianne Hackborneb034652009-09-07 00:49:58 -070010043 /** @hide */
10044 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010045 readFromParcel(in);
10046 }
10047
10048 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -080010049 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010050 mData = Uri.CREATOR.createFromParcel(in);
10051 mType = in.readString();
10052 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -070010053 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010054 mComponent = ComponentName.readFromParcel(in);
10055
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080010056 if (in.readInt() != 0) {
10057 mSourceBounds = Rect.CREATOR.createFromParcel(in);
10058 }
10059
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010060 int N = in.readInt();
10061 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -070010062 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010063 int i;
10064 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -080010065 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010066 }
10067 } else {
10068 mCategories = null;
10069 }
10070
Dianne Hackbornf5b86712011-12-05 17:42:41 -080010071 if (in.readInt() != 0) {
10072 mSelector = new Intent(in);
10073 }
10074
Dianne Hackborn21c241e2012-03-08 13:57:23 -080010075 if (in.readInt() != 0) {
10076 mClipData = new ClipData(in);
10077 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010078 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010079 mExtras = in.readBundle();
10080 }
10081
10082 /**
10083 * Parses the "intent" element (and its children) from XML and instantiates
10084 * an Intent object. The given XML parser should be located at the tag
10085 * where parsing should start (often named "intent"), from which the
10086 * basic action, data, type, and package and class name will be
10087 * retrieved. The function will then parse in to any child elements,
10088 * looking for <category android:name="xxx"> tags to add categories and
10089 * <extra android:name="xxx" android:value="yyy"> to attach extra data
10090 * to the intent.
10091 *
10092 * @param resources The Resources to use when inflating resources.
10093 * @param parser The XML parser pointing at an "intent" tag.
10094 * @param attrs The AttributeSet interface for retrieving extended
10095 * attribute data at the current <var>parser</var> location.
10096 * @return An Intent object matching the XML data.
10097 * @throws XmlPullParserException If there was an XML parsing error.
10098 * @throws IOException If there was an I/O error.
10099 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060010100 public static @NonNull Intent parseIntent(@NonNull Resources resources,
10101 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010102 throws XmlPullParserException, IOException {
10103 Intent intent = new Intent();
10104
10105 TypedArray sa = resources.obtainAttributes(attrs,
10106 com.android.internal.R.styleable.Intent);
10107
10108 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
10109
10110 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
10111 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
10112 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
10113
10114 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
10115 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
10116 if (packageName != null && className != null) {
10117 intent.setComponent(new ComponentName(packageName, className));
10118 }
10119
10120 sa.recycle();
10121
10122 int outerDepth = parser.getDepth();
10123 int type;
10124 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
10125 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
10126 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
10127 continue;
10128 }
10129
10130 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -070010131 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010132 sa = resources.obtainAttributes(attrs,
10133 com.android.internal.R.styleable.IntentCategory);
10134 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
10135 sa.recycle();
10136
10137 if (cat != null) {
10138 intent.addCategory(cat);
10139 }
10140 XmlUtils.skipCurrentTag(parser);
10141
Craig Mautner21d24a22014-04-23 11:45:37 -070010142 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -080010143 if (intent.mExtras == null) {
10144 intent.mExtras = new Bundle();
10145 }
Craig Mautner21d24a22014-04-23 11:45:37 -070010146 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -080010147 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010148
10149 } else {
10150 XmlUtils.skipCurrentTag(parser);
10151 }
10152 }
10153
10154 return intent;
10155 }
Nick Pellyccae4122012-01-09 14:12:58 -080010156
Craig Mautner21d24a22014-04-23 11:45:37 -070010157 /** @hide */
10158 public void saveToXml(XmlSerializer out) throws IOException {
10159 if (mAction != null) {
10160 out.attribute(null, ATTR_ACTION, mAction);
10161 }
10162 if (mData != null) {
10163 out.attribute(null, ATTR_DATA, mData.toString());
10164 }
10165 if (mType != null) {
10166 out.attribute(null, ATTR_TYPE, mType);
10167 }
10168 if (mComponent != null) {
10169 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
10170 }
10171 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
10172
10173 if (mCategories != null) {
10174 out.startTag(null, TAG_CATEGORIES);
10175 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
10176 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
10177 }
Craig Mautner43e52ed2014-06-16 17:18:52 -070010178 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -070010179 }
10180 }
10181
10182 /** @hide */
10183 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
10184 XmlPullParserException {
10185 Intent intent = new Intent();
10186 final int outerDepth = in.getDepth();
10187
10188 int attrCount = in.getAttributeCount();
10189 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
10190 final String attrName = in.getAttributeName(attrNdx);
10191 final String attrValue = in.getAttributeValue(attrNdx);
10192 if (ATTR_ACTION.equals(attrName)) {
10193 intent.setAction(attrValue);
10194 } else if (ATTR_DATA.equals(attrName)) {
10195 intent.setData(Uri.parse(attrValue));
10196 } else if (ATTR_TYPE.equals(attrName)) {
10197 intent.setType(attrValue);
10198 } else if (ATTR_COMPONENT.equals(attrName)) {
10199 intent.setComponent(ComponentName.unflattenFromString(attrValue));
10200 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +010010201 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -070010202 } else {
10203 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
10204 }
10205 }
10206
10207 int event;
10208 String name;
10209 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
10210 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
10211 if (event == XmlPullParser.START_TAG) {
10212 name = in.getName();
10213 if (TAG_CATEGORIES.equals(name)) {
10214 attrCount = in.getAttributeCount();
10215 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
10216 intent.addCategory(in.getAttributeValue(attrNdx));
10217 }
10218 } else {
10219 Log.w("Intent", "restoreFromXml: unknown name=" + name);
10220 XmlUtils.skipCurrentTag(in);
10221 }
10222 }
10223 }
10224
10225 return intent;
10226 }
10227
Nick Pellyccae4122012-01-09 14:12:58 -080010228 /**
10229 * Normalize a MIME data type.
10230 *
10231 * <p>A normalized MIME type has white-space trimmed,
10232 * content-type parameters removed, and is lower-case.
10233 * This aligns the type with Android best practices for
10234 * intent filtering.
10235 *
10236 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
10237 * "text/x-vCard" becomes "text/x-vcard".
10238 *
10239 * <p>All MIME types received from outside Android (such as user input,
10240 * or external sources like Bluetooth, NFC, or the Internet) should
10241 * be normalized before they are used to create an Intent.
10242 *
10243 * @param type MIME data type to normalize
10244 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -050010245 * @see #setType
10246 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -080010247 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060010248 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -080010249 if (type == null) {
10250 return null;
10251 }
10252
Elliott Hughescb64d432013-08-02 10:00:44 -070010253 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -080010254
10255 final int semicolonIndex = type.indexOf(';');
10256 if (semicolonIndex != -1) {
10257 type = type.substring(0, semicolonIndex);
10258 }
10259 return type;
10260 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010261
10262 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010263 * Prepare this {@link Intent} to leave an app process.
10264 *
10265 * @hide
10266 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +010010267 @UnsupportedAppUsage
Jeff Sharkey344744b2016-01-28 19:03:30 -070010268 public void prepareToLeaveProcess(Context context) {
10269 final boolean leavingPackage = (mComponent == null)
10270 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
10271 prepareToLeaveProcess(leavingPackage);
10272 }
10273
10274 /**
10275 * Prepare this {@link Intent} to leave an app process.
10276 *
10277 * @hide
10278 */
10279 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010280 setAllowFds(false);
10281
10282 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010283 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010284 }
10285 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010286 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010287 }
10288
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -070010289 if (mExtras != null && !mExtras.isParcelled()) {
10290 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
10291 if (intent instanceof Intent) {
10292 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
10293 }
10294 }
10295
Jeff Sharkeya8b42782016-01-30 17:58:09 -070010296 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
10297 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010298 switch (mAction) {
10299 case ACTION_MEDIA_REMOVED:
10300 case ACTION_MEDIA_UNMOUNTED:
10301 case ACTION_MEDIA_CHECKING:
10302 case ACTION_MEDIA_NOFS:
10303 case ACTION_MEDIA_MOUNTED:
10304 case ACTION_MEDIA_SHARED:
10305 case ACTION_MEDIA_UNSHARED:
10306 case ACTION_MEDIA_BAD_REMOVAL:
10307 case ACTION_MEDIA_UNMOUNTABLE:
10308 case ACTION_MEDIA_EJECT:
10309 case ACTION_MEDIA_SCANNER_STARTED:
10310 case ACTION_MEDIA_SCANNER_FINISHED:
10311 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -070010312 case ACTION_PACKAGE_NEEDS_VERIFICATION:
10313 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -070010314 // Ignore legacy actions
10315 break;
10316 default:
10317 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010318 }
10319 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010320
10321 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
10322 && leavingPackage) {
10323 switch (mAction) {
10324 case ACTION_PROVIDER_CHANGED:
Makoto Onuki7d1911f2017-06-09 12:30:09 -070010325 case QuickContact.ACTION_QUICK_CONTACT:
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010326 // Ignore actions that don't need to grant
10327 break;
10328 default:
10329 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
10330 }
10331 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010332 }
10333
10334 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010335 * @hide
10336 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010337 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -070010338 // We just entered destination process, so we should be able to read all
10339 // parcelables inside.
10340 setDefusable(true);
10341
10342 if (mSelector != null) {
10343 mSelector.prepareToEnterProcess();
10344 }
10345 if (mClipData != null) {
10346 mClipData.prepareToEnterProcess();
10347 }
10348
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010349 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000010350 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
10351 fixUris(mContentUserHint);
10352 mContentUserHint = UserHandle.USER_CURRENT;
10353 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010354 }
10355 }
10356
Patrick Baumann577d4022018-01-31 16:55:10 +000010357 /** @hide */
10358 public boolean hasWebURI() {
10359 if (getData() == null) {
10360 return false;
10361 }
10362 final String scheme = getScheme();
10363 if (TextUtils.isEmpty(scheme)) {
10364 return false;
10365 }
10366 return scheme.equals(IntentFilter.SCHEME_HTTP) || scheme.equals(IntentFilter.SCHEME_HTTPS);
10367 }
10368
10369 /** @hide */
Patrick Baumann0da85372018-02-02 16:07:35 -080010370 public boolean isWebIntent() {
Patrick Baumann577d4022018-01-31 16:55:10 +000010371 return ACTION_VIEW.equals(mAction)
Patrick Baumann577d4022018-01-31 16:55:10 +000010372 && hasWebURI();
10373 }
10374
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010375 /**
10376 * @hide
10377 */
10378 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010379 Uri data = getData();
10380 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010381 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010382 }
10383 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010384 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010385 }
10386 String action = getAction();
10387 if (ACTION_SEND.equals(action)) {
10388 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10389 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010390 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010391 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010392 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010393 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10394 if (streams != null) {
10395 ArrayList<Uri> newStreams = new ArrayList<Uri>();
10396 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010397 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010398 }
10399 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
10400 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010401 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10402 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10403 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10404 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10405 if (output != null) {
10406 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
10407 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010408 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010409 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010410
10411 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010412 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010413 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
10414 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010415 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010416 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010417 * @hide
10418 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010419 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010420 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010421 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010422
10423 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010424 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010425
10426 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010427 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010428 // Inspect contained intents to see if we need to migrate extras. We
10429 // don't promote ClipData to the parent, since ChooserActivity will
10430 // already start the picked item as the caller, and we can't combine
10431 // the flags in a safe way.
10432
10433 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -070010434 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010435 final Intent intent = getParcelableExtra(EXTRA_INTENT);
10436 if (intent != null) {
10437 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -070010438 }
10439 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010440 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010441 try {
10442 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
10443 if (intents != null) {
10444 for (int i = 0; i < intents.length; i++) {
10445 final Intent intent = (Intent) intents[i];
10446 if (intent != null) {
10447 migrated |= intent.migrateExtraStreamToClipData();
10448 }
10449 }
10450 }
10451 } catch (ClassCastException e) {
10452 }
10453 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010454
10455 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010456 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010457 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10458 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
10459 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
10460 if (stream != null || text != null || htmlText != null) {
10461 final ClipData clipData = new ClipData(
10462 null, new String[] { getType() },
10463 new ClipData.Item(text, htmlText, null, stream));
10464 setClipData(clipData);
10465 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010466 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010467 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010468 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010469 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010470
10471 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010472 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010473 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10474 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
10475 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
10476 int num = -1;
10477 if (streams != null) {
10478 num = streams.size();
10479 }
10480 if (texts != null) {
10481 if (num >= 0 && num != texts.size()) {
10482 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010483 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010484 }
10485 num = texts.size();
10486 }
10487 if (htmlTexts != null) {
10488 if (num >= 0 && num != htmlTexts.size()) {
10489 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010490 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010491 }
10492 num = htmlTexts.size();
10493 }
10494 if (num > 0) {
10495 final ClipData clipData = new ClipData(
10496 null, new String[] { getType() },
10497 makeClipItem(streams, texts, htmlTexts, 0));
10498
10499 for (int i = 1; i < num; i++) {
10500 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
10501 }
10502
10503 setClipData(clipData);
10504 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010505 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010506 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010507 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010508 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010509 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10510 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10511 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10512 final Uri output;
10513 try {
10514 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10515 } catch (ClassCastException e) {
10516 return false;
10517 }
10518 if (output != null) {
10519 setClipData(ClipData.newRawUri("", output));
10520 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
10521 return true;
10522 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010523 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010524
10525 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010526 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010527
Michael Wright19859762017-09-18 20:57:58 +010010528 /**
10529 * Convert the dock state to a human readable format.
10530 * @hide
10531 */
10532 public static String dockStateToString(int dock) {
10533 switch (dock) {
10534 case EXTRA_DOCK_STATE_HE_DESK:
10535 return "EXTRA_DOCK_STATE_HE_DESK";
10536 case EXTRA_DOCK_STATE_LE_DESK:
10537 return "EXTRA_DOCK_STATE_LE_DESK";
10538 case EXTRA_DOCK_STATE_CAR:
10539 return "EXTRA_DOCK_STATE_CAR";
10540 case EXTRA_DOCK_STATE_DESK:
10541 return "EXTRA_DOCK_STATE_DESK";
10542 case EXTRA_DOCK_STATE_UNDOCKED:
10543 return "EXTRA_DOCK_STATE_UNDOCKED";
10544 default:
10545 return Integer.toString(dock);
10546 }
10547 }
10548
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010549 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
10550 ArrayList<String> htmlTexts, int which) {
10551 Uri uri = streams != null ? streams.get(which) : null;
10552 CharSequence text = texts != null ? texts.get(which) : null;
10553 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
10554 return new ClipData.Item(text, htmlText, null, uri);
10555 }
Craig Mautnerd00f4742014-03-12 14:17:26 -070010556
10557 /** @hide */
10558 public boolean isDocument() {
10559 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
10560 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010561}