blob: e9b240448eed5dfceeb32a095f5dc2225a1fca5b [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 /**
Varun Shahb9fd6be2018-10-22 19:16:33 -07001730 * A string that associates with a metadata entry, indicating the last run version of the
1731 * platform that was setup.
1732 *
1733 * @see #ACTION_UPGRADE_SETUP
1734 *
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001735 * @hide
1736 */
Varun Shahb9fd6be2018-10-22 19:16:33 -07001737 @SystemApi
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001738 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1739
Svet Ganov3695b8a2015-03-24 16:30:25 -07001740 /**
1741 * Activity action: Launch UI to manage the permissions of an app.
1742 * <p>
1743 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1744 * will be managed by the launched UI.
1745 * </p>
1746 * <p>
1747 * Output: Nothing.
1748 * </p>
1749 *
1750 * @see #EXTRA_PACKAGE_NAME
1751 *
1752 * @hide
1753 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001754 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001755 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1756 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1757 "android.intent.action.MANAGE_APP_PERMISSIONS";
1758
1759 /**
Philip P. Moltmanned988282018-11-07 16:19:42 -08001760 * Activity action: Launch UI to manage a specific permissions of an app.
1761 * <p>
1762 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permission
1763 * will be managed by the launched UI.
1764 * </p>
1765 * <p>
1766 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the (individual) permission
1767 * that should be managed by the launched UI.
1768 * </p>
1769 * <p>
1770 * Output: Nothing.
1771 * </p>
1772 *
1773 * @see #EXTRA_PACKAGE_NAME
1774 * @see #EXTRA_PERMISSION_NAME
1775 *
1776 * @hide
1777 */
1778 @SystemApi
1779 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1780 public static final String ACTION_MANAGE_APP_PERMISSION =
1781 "android.intent.action.MANAGE_APP_PERMISSION";
1782
1783 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001784 * Activity action: Launch UI to manage permissions.
1785 * <p>
1786 * Input: Nothing.
1787 * </p>
1788 * <p>
1789 * Output: Nothing.
1790 * </p>
1791 *
1792 * @hide
1793 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001794 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001795 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1796 public static final String ACTION_MANAGE_PERMISSIONS =
1797 "android.intent.action.MANAGE_PERMISSIONS";
1798
1799 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001800 * Activity action: Launch UI to review permissions for an app.
1801 * The system uses this intent if permission review for apps not
1802 * supporting the new runtime permissions model is enabled. In
1803 * this mode a permission review is required before any of the
1804 * app components can run.
1805 * <p>
1806 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1807 * permissions will be reviewed (mandatory).
1808 * </p>
1809 * <p>
1810 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1811 * be fired after the permission review (optional).
1812 * </p>
1813 * <p>
1814 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1815 * be invoked after the permission review (optional).
1816 * </p>
1817 * <p>
1818 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1819 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1820 * </p>
1821 * <p>
1822 * Output: Nothing.
1823 * </p>
1824 *
1825 * @see #EXTRA_PACKAGE_NAME
1826 * @see #EXTRA_INTENT
1827 * @see #EXTRA_REMOTE_CALLBACK
1828 * @see #EXTRA_RESULT_NEEDED
1829 *
1830 * @hide
1831 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001832 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001833 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1834 public static final String ACTION_REVIEW_PERMISSIONS =
1835 "android.intent.action.REVIEW_PERMISSIONS";
1836
1837 /**
1838 * Intent extra: A callback for reporting remote result as a bundle.
1839 * <p>
1840 * Type: IRemoteCallback
1841 * </p>
1842 *
1843 * @hide
1844 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001845 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001846 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1847
1848 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001849 * Intent extra: An app package name.
1850 * <p>
1851 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001852 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001853 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001854 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001855 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1856
1857 /**
Suprabh Shukla96212bc2018-04-10 15:04:51 -07001858 * Intent extra: A {@link Bundle} of extras for a package being suspended. Will be sent as an
1859 * extra with {@link #ACTION_MY_PACKAGE_SUSPENDED}.
1860 *
1861 * <p>The contents of this {@link Bundle} are a contract between the suspended app and the
1862 * suspending app, i.e. any app with the permission {@code android.permission.SUSPEND_APPS}.
1863 * This is meant to enable the suspended app to better handle the state of being suspended.
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07001864 *
1865 * @see #ACTION_MY_PACKAGE_SUSPENDED
1866 * @see #ACTION_MY_PACKAGE_UNSUSPENDED
1867 * @see PackageManager#isPackageSuspended()
1868 * @see PackageManager#getSuspendedPackageAppExtras()
1869 */
1870 public static final String EXTRA_SUSPENDED_PACKAGE_EXTRAS = "android.intent.extra.SUSPENDED_PACKAGE_EXTRAS";
1871
1872 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001873 * Intent extra: An app split name.
1874 * <p>
1875 * Type: String
1876 * </p>
Todd Kennedye5195dd2016-10-19 15:29:19 -07001877 */
Todd Kennedye5195dd2016-10-19 15:29:19 -07001878 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1879
1880 /**
Jeff Sharkey1a749422017-04-28 14:19:50 -06001881 * Intent extra: A {@link ComponentName} value.
1882 * <p>
1883 * Type: String
1884 * </p>
1885 */
1886 public static final String EXTRA_COMPONENT_NAME = "android.intent.extra.COMPONENT_NAME";
1887
1888 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001889 * Intent extra: An extra for specifying whether a result is needed.
1890 * <p>
1891 * Type: boolean
1892 * </p>
1893 *
1894 * @hide
1895 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001896 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001897 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1898
1899 /**
Suprabh Shukla19b41f32018-03-26 22:35:13 -07001900 * Intent extra: A {@link Bundle} of extras supplied for the launcher when any packages on
1901 * device are suspended. Will be sent with {@link #ACTION_PACKAGES_SUSPENDED}.
1902 *
1903 * @see PackageManager#isPackageSuspended()
1904 * @see #ACTION_PACKAGES_SUSPENDED
1905 *
1906 * @hide
1907 */
1908 public static final String EXTRA_LAUNCHER_EXTRAS = "android.intent.extra.LAUNCHER_EXTRAS";
1909
1910 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001911 * Activity action: Launch UI to manage which apps have a given permission.
1912 * <p>
Philip P. Moltmanned988282018-11-07 16:19:42 -08001913 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission group
1914 * which will be managed by the launched UI.
Svet Ganov3695b8a2015-03-24 16:30:25 -07001915 * </p>
1916 * <p>
1917 * Output: Nothing.
1918 * </p>
1919 *
1920 * @see #EXTRA_PERMISSION_NAME
1921 *
1922 * @hide
1923 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001924 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001925 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1926 public static final String ACTION_MANAGE_PERMISSION_APPS =
1927 "android.intent.action.MANAGE_PERMISSION_APPS";
1928
1929 /**
1930 * Intent extra: The name of a permission.
1931 * <p>
1932 * Type: String
1933 * </p>
1934 *
1935 * @hide
1936 */
1937 @SystemApi
1938 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1939
Joel Galenson13096ea2018-09-27 11:18:44 -07001940 /**
1941 * Activity action: Launch UI to review app uses of permissions.
1942 * <p>
1943 * Input: Nothing
1944 * </p>
1945 * <p>
1946 * Output: Nothing.
1947 * </p>
1948 *
1949 * @hide
1950 */
1951 @SystemApi
1952 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1953 public static final String ACTION_REVIEW_PERMISSION_USAGE =
1954 "android.intent.action.REVIEW_PERMISSION_USAGE";
1955
Joel Galenson78ec58d2018-10-24 10:06:25 -07001956 /**
1957 * Activity action: Launch UI to review uses of permissions for a single app.
1958 * <p>
1959 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1960 * permissions will be reviewed (mandatory).
1961 * </p>
1962 * <p>
1963 * Output: Nothing.
1964 * </p>
1965 * <p class="note">
1966 * This requires {@link android.Manifest.permission#GRANT_RUNTIME_PERMISSIONS} permission.
1967 * </p>
1968 *
1969 * @see #EXTRA_PACKAGE_NAME
1970 *
1971 * @hide
1972 */
1973 @SystemApi
1974 @RequiresPermission(android.Manifest.permission.GRANT_RUNTIME_PERMISSIONS)
1975 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1976 public static final String ACTION_REVIEW_APP_PERMISSION_USAGE =
1977 "android.intent.action.REVIEW_APP_PERMISSION_USAGE";
1978
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001979 // ---------------------------------------------------------------------
1980 // ---------------------------------------------------------------------
1981 // Standard intent broadcast actions (see action variable).
1982
1983 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001984 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1985 * <p>
1986 * For historical reasons, the name of this broadcast action refers to the power
1987 * state of the screen but it is actually sent in response to changes in the
1988 * overall interactive state of the device.
1989 * </p><p>
1990 * This broadcast is sent when the device becomes non-interactive which may have
1991 * nothing to do with the screen turning off. To determine the
1992 * actual state of the screen, use {@link android.view.Display#getState}.
1993 * </p><p>
1994 * See {@link android.os.PowerManager#isInteractive} for details.
1995 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001996 * You <em>cannot</em> receive this through components declared in
1997 * manifests, only by explicitly registering for it with
1998 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1999 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002000 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002001 * <p class="note">This is a protected intent that can only be sent
2002 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002003 */
2004 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2005 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07002006
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002007 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07002008 * Broadcast Action: Sent when the device wakes up and becomes interactive.
2009 * <p>
2010 * For historical reasons, the name of this broadcast action refers to the power
2011 * state of the screen but it is actually sent in response to changes in the
2012 * overall interactive state of the device.
2013 * </p><p>
2014 * This broadcast is sent when the device becomes interactive which may have
2015 * nothing to do with the screen turning on. To determine the
2016 * actual state of the screen, use {@link android.view.Display#getState}.
2017 * </p><p>
2018 * See {@link android.os.PowerManager#isInteractive} for details.
2019 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07002020 * You <em>cannot</em> receive this through components declared in
2021 * manifests, only by explicitly registering for it with
2022 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2023 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002024 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002025 * <p class="note">This is a protected intent that can only be sent
2026 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002027 */
2028 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2029 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07002030
2031 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07002032 * Broadcast Action: Sent after the system stops dreaming.
2033 *
2034 * <p class="note">This is a protected intent that can only be sent by the system.
2035 * It is only sent to registered receivers.</p>
2036 */
2037 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2038 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
2039
2040 /**
2041 * Broadcast Action: Sent after the system starts dreaming.
2042 *
2043 * <p class="note">This is a protected intent that can only be sent by the system.
2044 * It is only sent to registered receivers.</p>
2045 */
2046 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2047 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
2048
2049 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07002050 * 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 -07002051 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08002052 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002053 * <p class="note">This is a protected intent that can only be sent
2054 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07002055 */
2056 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002057 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07002058
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002059 /**
2060 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07002061 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04002062 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002063 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2064 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002065 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002066 * <p class="note">This is a protected intent that can only be sent
2067 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002068 */
2069 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2070 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
2071 /**
2072 * Broadcast Action: The time was set.
2073 */
2074 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2075 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
2076 /**
2077 * Broadcast Action: The date has changed.
2078 */
2079 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2080 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
2081 /**
2082 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
2083 * <ul>
2084 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
2085 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002086 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002087 * <p class="note">This is a protected intent that can only be sent
2088 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002089 */
2090 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2091 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
2092 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07002093 * Clear DNS Cache Action: This is broadcast when networks have changed and old
2094 * DNS entries should be tossed.
2095 * @hide
2096 */
2097 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2098 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
2099 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002100 * Alarm Changed Action: This is broadcast when the AlarmClock
2101 * application's alarm is set or unset. It is used by the
2102 * AlarmClock application and the StatusBar service.
2103 * @hide
2104 */
2105 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002106 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002107 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002108
2109 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002110 * Broadcast Action: This is broadcast once, after the user has finished
2111 * booting, but while still in the "locked" state. It can be used to perform
2112 * application-specific initialization, such as installing alarms. You must
2113 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
2114 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002115 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002116 * This broadcast is sent immediately at boot by all devices (regardless of
2117 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
2118 * higher. Upon receipt of this broadcast, the user is still locked and only
2119 * device-protected storage can be accessed safely. If you want to access
2120 * credential-protected storage, you need to wait for the user to be
2121 * unlocked (typically by entering their lock pattern or PIN for the first
2122 * time), after which the {@link #ACTION_USER_UNLOCKED} and
2123 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
2124 * <p>
2125 * To receive this broadcast, your receiver component must be marked as
2126 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002127 * <p class="note">
2128 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002129 *
2130 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002131 */
2132 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2133 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2134
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002135 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002136 * Broadcast Action: This is broadcast once, after the user has finished
2137 * booting. It can be used to perform application-specific initialization,
2138 * such as installing alarms. You must hold the
2139 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2140 * order to receive this broadcast.
2141 * <p>
2142 * This broadcast is sent at boot by all devices (both with and without
2143 * direct boot support). Upon receipt of this broadcast, the user is
2144 * unlocked and both device-protected and credential-protected storage can
2145 * accessed safely.
2146 * <p>
2147 * If you need to run while the user is still locked (before they've entered
2148 * their lock pattern or PIN for the first time), you can listen for the
2149 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2150 * <p class="note">
2151 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002152 */
2153 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002154 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002155 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002156
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002157 /**
2158 * Broadcast Action: This is broadcast when a user action should request a
2159 * temporary system dialog to dismiss. Some examples of temporary system
2160 * dialogs are the notification window-shade and the recent tasks dialog.
2161 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002162 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002163 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2164 /**
2165 * Broadcast Action: Trigger the download and eventual installation
2166 * of a package.
2167 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002168 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002169 * <p class="note">This is a protected intent that can only be sent
2170 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002171 *
2172 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002173 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002174 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002175 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2176 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2177 /**
Christopher Tate94b91db2017-04-19 15:49:17 -07002178 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002179 * device. The data contains the name of the package. Note that the
2180 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002181 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002182 * <ul>
Christopher Tate94b91db2017-04-19 15:49:17 -07002183 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2184 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002185 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2186 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002187 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002188 * <p class="note">This is a protected intent that can only be sent
2189 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002190 */
2191 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2192 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2193 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002194 * Broadcast Action: A new version of an application package has been
2195 * installed, replacing an existing version that was previously installed.
2196 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002197 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002198 * <ul>
2199 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2200 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002201 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002202 * <p class="note">This is a protected intent that can only be sent
2203 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002204 */
2205 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2206 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2207 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002208 * Broadcast Action: A new version of your application has been installed
2209 * over an existing one. This is only sent to the application that was
2210 * replaced. It does not contain any additional data; to receive it, just
2211 * use an intent filter for this action.
2212 *
2213 * <p class="note">This is a protected intent that can only be sent
2214 * by the system.
2215 */
2216 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2217 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2218 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002219 * Broadcast Action: An existing application package has been removed from
2220 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002221 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002222 * <ul>
2223 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2224 * to the package.
2225 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2226 * application -- data and code -- is being removed.
2227 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2228 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2229 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002230 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002231 * <p class="note">This is a protected intent that can only be sent
2232 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002233 */
2234 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2235 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2236 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002237 * Broadcast Action: An existing application package has been completely
2238 * removed from the device. The data contains the name of the package.
2239 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2240 * {@link #EXTRA_DATA_REMOVED} is true and
2241 * {@link #EXTRA_REPLACING} is false of that broadcast.
2242 *
2243 * <ul>
2244 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2245 * to the package.
2246 * </ul>
2247 *
2248 * <p class="note">This is a protected intent that can only be sent
2249 * by the system.
2250 */
2251 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2252 public static final String ACTION_PACKAGE_FULLY_REMOVED
2253 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2254 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002255 * Broadcast Action: An existing application package has been changed (for
2256 * example, a component has been enabled or disabled). The data contains
2257 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002258 * <ul>
2259 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002260 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002261 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002262 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2263 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002264 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002265 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002266 * <p class="note">This is a protected intent that can only be sent
2267 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002268 */
2269 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2270 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2271 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002272 * @hide
2273 * Broadcast Action: Ask system services if there is any reason to
2274 * restart the given package. The data contains the name of the
2275 * package.
2276 * <ul>
2277 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2278 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2279 * </ul>
2280 *
2281 * <p class="note">This is a protected intent that can only be sent
2282 * by the system.
2283 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002284 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002285 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2286 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2287 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002288 * Broadcast Action: The user has restarted a package, and all of its
2289 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002290 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002291 * be removed. Note that the restarted package does <em>not</em>
2292 * receive this broadcast.
2293 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002294 * <ul>
2295 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2296 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002297 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002298 * <p class="note">This is a protected intent that can only be sent
2299 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002300 */
2301 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2302 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2303 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002304 * Broadcast Action: The user has cleared the data of a package. This should
2305 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002306 * its persistent data is erased and this broadcast sent.
2307 * Note that the cleared package does <em>not</em>
2308 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002309 * <ul>
Svet Ganovf935a702017-08-22 12:15:58 -07002310 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package. If the
2311 * package whose data was cleared is an uninstalled instant app, then the UID
2312 * will be -1. The platform keeps some meta-data associated with instant apps
2313 * after they are uninstalled.
2314 * <li> {@link #EXTRA_PACKAGE_NAME} containing the package name only if the cleared
2315 * data was for an instant app.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002316 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002317 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002318 * <p class="note">This is a protected intent that can only be sent
2319 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002320 */
2321 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2322 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2323 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002324 * Broadcast Action: Packages have been suspended.
2325 * <p>Includes the following extras:
2326 * <ul>
2327 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
Julia Reynolds4bc42b92018-08-14 11:27:35 -04002328 * <li> {@link #EXTRA_CHANGED_UID_LIST} is the set of uids which have been suspended
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002329 * </ul>
2330 *
2331 * <p class="note">This is a protected intent that can only be sent
2332 * by the system. It is only sent to registered receivers.
2333 */
2334 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2335 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2336 /**
2337 * Broadcast Action: Packages have been unsuspended.
2338 * <p>Includes the following extras:
2339 * <ul>
2340 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
Julia Reynolds4bc42b92018-08-14 11:27:35 -04002341 * <li> {@link #EXTRA_CHANGED_UID_LIST} is the set of uids which have been unsuspended
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002342 * </ul>
2343 *
2344 * <p class="note">This is a protected intent that can only be sent
2345 * by the system. It is only sent to registered receivers.
2346 */
2347 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2348 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002349
2350 /**
2351 * Broadcast Action: Sent to a package that has been suspended by the system. This is sent
Suprabh Shukla19b41f32018-03-26 22:35:13 -07002352 * whenever a package is put into a suspended state or any of its app extras change while in the
2353 * suspended state.
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002354 * <p> Optionally includes the following extras:
2355 * <ul>
2356 * <li> {@link #EXTRA_SUSPENDED_PACKAGE_EXTRAS} which is a {@link Bundle} which will contain
2357 * useful information for the app being suspended.
2358 * </ul>
2359 * <p class="note">This is a protected intent that can only be sent
2360 * by the system. <em>This will be delivered to {@link BroadcastReceiver} components declared in
2361 * the manifest.</em>
2362 *
2363 * @see #ACTION_MY_PACKAGE_UNSUSPENDED
2364 * @see #EXTRA_SUSPENDED_PACKAGE_EXTRAS
2365 * @see PackageManager#isPackageSuspended()
2366 * @see PackageManager#getSuspendedPackageAppExtras()
2367 */
2368 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2369 public static final String ACTION_MY_PACKAGE_SUSPENDED = "android.intent.action.MY_PACKAGE_SUSPENDED";
2370
2371 /**
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002372 * Activity Action: Started to show more details about why an application was suspended.
2373 *
Suprabh Shukla3e03ab92018-04-11 16:03:49 -07002374 * <p>Whenever the system detects an activity launch for a suspended app, this action can
2375 * be used to show more details about the reason for suspension.
Suprabh Shukla96212bc2018-04-10 15:04:51 -07002376 *
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002377 * <p>Apps holding {@link android.Manifest.permission#SUSPEND_APPS} must declare an activity
2378 * handling this intent and protect it with
2379 * {@link android.Manifest.permission#SEND_SHOW_SUSPENDED_APP_DETAILS}.
2380 *
2381 * <p>Includes an extra {@link #EXTRA_PACKAGE_NAME} which is the name of the suspended package.
2382 *
2383 * <p class="note">This is a protected intent that can only be sent
2384 * by the system.
2385 *
Suprabh Shukla96212bc2018-04-10 15:04:51 -07002386 * @see PackageManager#setPackagesSuspended(String[], boolean, PersistableBundle,
2387 * PersistableBundle, String)
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002388 * @see PackageManager#isPackageSuspended()
2389 * @see #ACTION_PACKAGES_SUSPENDED
2390 *
2391 * @hide
2392 */
2393 @SystemApi
2394 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2395 public static final String ACTION_SHOW_SUSPENDED_APP_DETAILS =
2396 "android.intent.action.SHOW_SUSPENDED_APP_DETAILS";
2397
2398 /**
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002399 * Broadcast Action: Sent to a package that has been unsuspended.
2400 *
2401 * <p class="note">This is a protected intent that can only be sent
2402 * by the system. <em>This will be delivered to {@link BroadcastReceiver} components declared in
2403 * the manifest.</em>
2404 *
2405 * @see #ACTION_MY_PACKAGE_SUSPENDED
2406 * @see #EXTRA_SUSPENDED_PACKAGE_EXTRAS
2407 * @see PackageManager#isPackageSuspended()
2408 * @see PackageManager#getSuspendedPackageAppExtras()
2409 */
2410 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2411 public static final String ACTION_MY_PACKAGE_UNSUSPENDED = "android.intent.action.MY_PACKAGE_UNSUSPENDED";
2412
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002413 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002414 * Broadcast Action: A user ID has been removed from the system. The user
2415 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002416 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002417 * <p class="note">This is a protected intent that can only be sent
2418 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002419 */
2420 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2421 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002422
2423 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002424 * Broadcast Action: Sent to the installer package of an application when
2425 * that application is first launched (that is the first time it is moved
2426 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002427 *
2428 * <p class="note">This is a protected intent that can only be sent
2429 * by the system.
2430 */
2431 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2432 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2433
2434 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002435 * Broadcast Action: Sent to the system package verifier when a package
2436 * needs to be verified. The data contains the package URI.
2437 * <p class="note">
2438 * This is a protected intent that can only be sent by the system.
2439 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002440 */
2441 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2442 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2443
2444 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002445 * Broadcast Action: Sent to the system package verifier when a package is
2446 * verified. The data contains the package URI.
2447 * <p class="note">
2448 * This is a protected intent that can only be sent by the system.
2449 */
2450 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2451 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2452
2453 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002454 * Broadcast Action: Sent to the system intent filter verifier when an
2455 * intent filter needs to be verified. The data contains the filter data
2456 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002457 * <p class="note">
2458 * This is a protected intent that can only be sent by the system.
2459 * </p>
2460 *
2461 * @hide
2462 */
2463 @SystemApi
2464 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2465 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2466
2467 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002468 * Broadcast Action: Resources for a set of packages (which were
2469 * previously unavailable) are currently
2470 * available since the media on which they exist is available.
2471 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2472 * list of packages whose availability changed.
2473 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2474 * list of uids of packages whose availability changed.
2475 * Note that the
2476 * packages in this list do <em>not</em> receive this broadcast.
2477 * The specified set of packages are now available on the system.
2478 * <p>Includes the following extras:
2479 * <ul>
2480 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2481 * whose resources(were previously unavailable) are currently available.
2482 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2483 * packages whose resources(were previously unavailable)
2484 * are currently available.
2485 * </ul>
2486 *
2487 * <p class="note">This is a protected intent that can only be sent
2488 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002489 */
2490 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002491 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2492 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002493
2494 /**
2495 * Broadcast Action: Resources for a set of packages are currently
2496 * unavailable since the media on which they exist is unavailable.
2497 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2498 * list of packages whose availability changed.
2499 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2500 * list of uids of packages whose availability changed.
2501 * The specified set of packages can no longer be
2502 * launched and are practically unavailable on the system.
2503 * <p>Inclues the following extras:
2504 * <ul>
2505 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2506 * whose resources are no longer available.
2507 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2508 * whose resources are no longer available.
2509 * </ul>
2510 *
2511 * <p class="note">This is a protected intent that can only be sent
2512 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002513 */
2514 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002515 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002516 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002517
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002518 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002519 * Broadcast Action: preferred activities have changed *explicitly*.
2520 *
2521 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2522 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2523 * be sent.
2524 *
2525 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2526 *
2527 * @hide
2528 */
2529 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2530 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2531 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2532
2533
2534 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002535 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002536 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002537 * This should <em>only</em> be used to determine when the wallpaper
2538 * has changed to show the new wallpaper to the user. You should certainly
2539 * never, in response to this, change the wallpaper or other attributes of
2540 * it such as the suggested size. That would be crazy, right? You'd cause
2541 * all kinds of loops, especially if other apps are doing similar things,
2542 * right? Of course. So please don't do this.
2543 *
2544 * @deprecated Modern applications should use
2545 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2546 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2547 * shown behind their UI, rather than watching for this broadcast and
2548 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002549 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002550 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002551 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2552 /**
2553 * Broadcast Action: The current device {@link android.content.res.Configuration}
2554 * (orientation, locale, etc) has changed. When such a change happens, the
2555 * UIs (view hierarchy) will need to be rebuilt based on this new
2556 * information; for the most part, applications don't need to worry about
2557 * this, because the system will take care of stopping and restarting the
2558 * application to make sure it sees the new changes. Some system code that
2559 * can not be restarted will need to watch for this action and handle it
2560 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002561 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002562 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002563 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002564 * in manifests, only by explicitly registering for it with
2565 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2566 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002567 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002568 * <p class="note">This is a protected intent that can only be sent
2569 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002570 *
2571 * @see android.content.res.Configuration
2572 */
2573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2574 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
Adam Lesinski57fccd62018-01-25 13:03:57 -08002575
2576 /**
2577 * Broadcast Action: The current device {@link android.content.res.Configuration} has changed
2578 * such that the device may be eligible for the installation of additional configuration splits.
2579 * Configuration properties that can trigger this broadcast include locale and display density.
2580 *
2581 * <p class="note">
2582 * Unlike {@link #ACTION_CONFIGURATION_CHANGED}, you <em>can</em> receive this through
2583 * components declared in manifests. However, the receiver <em>must</em> hold the
2584 * {@link android.Manifest.permission#INSTALL_PACKAGES} permission.
2585 *
2586 * <p class="note">
2587 * This is a protected intent that can only be sent by the system.
2588 *
2589 * @hide
2590 */
2591 @SystemApi
2592 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2593 public static final String ACTION_SPLIT_CONFIGURATION_CHANGED =
2594 "android.intent.action.SPLIT_CONFIGURATION_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002595 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002596 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002597 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002598 * <p class="note">This is a protected intent that can only be sent
2599 * by the system.
2600 */
2601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2602 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2603 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002604 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2605 * charging state, level, and other information about the battery.
2606 * See {@link android.os.BatteryManager} for documentation on the
2607 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002608 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002609 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002610 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002611 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002612 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002613 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2614 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2615 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2616 * broadcasts that are sent and can be received through manifest
2617 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002618 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002619 * <p class="note">This is a protected intent that can only be sent
2620 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002621 */
2622 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2623 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
Fyodor Kupolov70e75432018-03-01 18:29:06 -08002624
2625
2626 /**
2627 * Broadcast Action: Sent when the current battery level changes.
2628 *
2629 * It has {@link android.os.BatteryManager#EXTRA_EVENTS} that carries a list of {@link Bundle}
2630 * instances representing individual battery level changes with associated
2631 * extras from {@link #ACTION_BATTERY_CHANGED}.
2632 *
2633 * <p class="note">
2634 * This broadcast requires {@link android.Manifest.permission#BATTERY_STATS} permission.
2635 *
2636 * @hide
2637 */
2638 @SystemApi
2639 public static final String ACTION_BATTERY_LEVEL_CHANGED =
2640 "android.intent.action.BATTERY_LEVEL_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002641 /**
2642 * Broadcast Action: Indicates low battery condition on the device.
2643 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002644 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002645 * <p class="note">This is a protected intent that can only be sent
2646 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002647 */
2648 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2649 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2650 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002651 * Broadcast Action: Indicates the battery is now okay after being low.
2652 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2653 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002654 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002655 * <p class="note">This is a protected intent that can only be sent
2656 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002657 */
2658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2659 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2660 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002661 * Broadcast Action: External power has been connected to the device.
2662 * This is intended for applications that wish to register specifically to this notification.
2663 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2664 * stay active to receive this notification. This action can be used to implement actions
2665 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002666 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002667 * <p class="note">This is a protected intent that can only be sent
2668 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002669 */
2670 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002671 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002672 /**
2673 * Broadcast Action: External power has been removed from the device.
2674 * This is intended for applications that wish to register specifically to this notification.
2675 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2676 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002677 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002678 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002679 * <p class="note">This is a protected intent that can only be sent
2680 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002681 */
2682 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002683 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002684 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002685 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002686 * Broadcast Action: Device is shutting down.
2687 * This is broadcast when the device is being shut down (completely turned
2688 * off, not sleeping). Once the broadcast is complete, the final shutdown
2689 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002690 * to handle this, since the foreground activity will be paused as well.
Fyodor Kupolov1fc62602018-02-01 15:48:53 -08002691 * <p>As of {@link Build.VERSION_CODES#P} this broadcast is only sent to receivers registered
2692 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2693 * Context.registerReceiver}.
Tom Taylord4a47292009-12-21 13:59:18 -08002694 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002695 * <p class="note">This is a protected intent that can only be sent
2696 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002697 * <p>May include the following extras:
2698 * <ul>
2699 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2700 * shutdown is only for userspace processes. If not set, assumed to be false.
2701 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002702 */
2703 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002704 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002705 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002706 * Activity Action: Start this activity to request system shutdown.
2707 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002708 * to request confirmation from the user before shutting down. The optional boolean
2709 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2710 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002711 *
2712 * <p class="note">This is a protected intent that can only be sent
2713 * by the system.
2714 *
2715 * {@hide}
2716 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002717 public static final String ACTION_REQUEST_SHUTDOWN
2718 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002719 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002720 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002721 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002722 * <p class="note">
2723 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002724 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002725 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2726 * or above, this broadcast will no longer be delivered to any
2727 * {@link BroadcastReceiver} defined in your manifest. Instead,
2728 * apps are strongly encouraged to use the improved
2729 * {@link Context#getCacheDir()} behavior so the system can
2730 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002731 */
2732 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002733 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002734 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2735 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002736 * Broadcast Action: Indicates low storage space condition on the device no
2737 * longer exists
2738 * <p class="note">
2739 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002740 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002741 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2742 * or above, this broadcast will no longer be delivered to any
2743 * {@link BroadcastReceiver} defined in your manifest. Instead,
2744 * apps are strongly encouraged to use the improved
2745 * {@link Context#getCacheDir()} behavior so the system can
2746 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002747 */
2748 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002749 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002750 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2751 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002752 * Broadcast Action: A sticky broadcast that indicates a storage space full
2753 * condition on the device. This is intended for activities that want to be
2754 * able to fill the data partition completely, leaving only enough free
2755 * space to prevent system-wide SQLite failures.
2756 * <p class="note">
2757 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002758 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002759 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2760 * or above, this broadcast will no longer be delivered to any
2761 * {@link BroadcastReceiver} defined in your manifest. Instead,
2762 * apps are strongly encouraged to use the improved
2763 * {@link Context#getCacheDir()} behavior so the system can
2764 * automatically free up storage when needed.
2765 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002766 */
2767 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002768 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002769 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2770 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002771 * Broadcast Action: Indicates storage space full condition on the device no
2772 * longer exists.
2773 * <p class="note">
2774 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002775 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002776 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2777 * or above, this broadcast will no longer be delivered to any
2778 * {@link BroadcastReceiver} defined in your manifest. Instead,
2779 * apps are strongly encouraged to use the improved
2780 * {@link Context#getCacheDir()} behavior so the system can
2781 * automatically free up storage when needed.
2782 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002783 */
2784 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002785 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002786 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2787 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002788 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2789 * and package management should be started.
2790 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2791 * notification.
2792 */
2793 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2794 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2795 /**
2796 * Broadcast Action: The device has entered USB Mass Storage mode.
2797 * This is used mainly for the USB Settings panel.
2798 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2799 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002800 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002801 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002802 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002803 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002804 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2805
2806 /**
2807 * Broadcast Action: The device has exited USB Mass Storage mode.
2808 * This is used mainly for the USB Settings panel.
2809 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2810 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002811 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002812 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002813 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002815 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2816
2817 /**
2818 * Broadcast Action: External media has been removed.
2819 * The path to the mount point for the removed media is contained in the Intent.mData field.
2820 */
2821 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2822 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2823
2824 /**
2825 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002826 * 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 -07002827 */
2828 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2829 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2830
2831 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002832 * Broadcast Action: External media is present, and being disk-checked
2833 * 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 -08002834 */
2835 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2836 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2837
2838 /**
2839 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2840 * 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 -08002841 */
2842 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2843 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2844
2845 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002846 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002847 * 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 -07002848 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2849 * media was mounted read only.
2850 */
2851 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2852 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2853
2854 /**
2855 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002856 * 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 -07002857 */
2858 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2859 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2860
2861 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002862 * Broadcast Action: External media is no longer being shared via USB mass storage.
2863 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2864 *
2865 * @hide
2866 */
2867 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2868
2869 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002870 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2871 * The path to the mount point for the removed media is contained in the Intent.mData field.
2872 */
2873 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2874 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2875
2876 /**
2877 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002878 * 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 -07002879 */
2880 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2881 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2882
2883 /**
2884 * Broadcast Action: User has expressed the desire to remove the external storage media.
2885 * Applications should close all files they have open within the mount point when they receive this intent.
2886 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2887 */
2888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2889 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2890
2891 /**
2892 * Broadcast Action: The media scanner has started scanning a directory.
2893 * The path to the directory being scanned is contained in the Intent.mData field.
2894 */
2895 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2896 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2897
2898 /**
2899 * Broadcast Action: The media scanner has finished scanning a directory.
2900 * The path to the scanned directory is contained in the Intent.mData field.
2901 */
2902 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2903 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2904
2905 /**
2906 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2907 * The path to the file is contained in the Intent.mData field.
2908 */
2909 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2910 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2911
2912 /**
2913 * Broadcast Action: The "Media Button" was pressed. Includes a single
2914 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2915 * caused the broadcast.
2916 */
2917 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2918 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2919
2920 /**
2921 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2922 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2923 * caused the broadcast.
2924 */
2925 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2926 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2927
2928 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2929 // location; they are not general-purpose actions.
2930
2931 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002932 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002933 */
2934 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2935 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2936 "android.intent.action.GTALK_CONNECTED";
2937
2938 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002939 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002940 */
2941 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2942 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2943 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002944
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002945 /**
2946 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002947 */
2948 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2949 public static final String ACTION_INPUT_METHOD_CHANGED =
2950 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002951
2952 /**
2953 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2954 * more radios have been turned off or on. The intent will have the following extra value:</p>
2955 * <ul>
2956 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2957 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2958 * turned off</li>
2959 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002960 *
Peng Xua35b5532016-01-20 00:05:45 -08002961 * <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 -07002962 */
2963 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2964 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2965
2966 /**
2967 * Broadcast Action: Some content providers have parts of their namespace
2968 * where they publish new events or items that the user may be especially
2969 * interested in. For these things, they may broadcast this action when the
2970 * set of interesting items change.
2971 *
2972 * For example, GmailProvider sends this notification when the set of unread
2973 * mail in the inbox changes.
2974 *
2975 * <p>The data of the intent identifies which part of which provider
2976 * changed. When queried through the content resolver, the data URI will
2977 * return the data set in question.
2978 *
2979 * <p>The intent will have the following extra values:
2980 * <ul>
2981 * <li><em>count</em> - The number of items in the data set. This is the
2982 * same as the number of items in the cursor returned by querying the
2983 * data URI. </li>
2984 * </ul>
2985 *
2986 * This intent will be sent at boot (if the count is non-zero) and when the
2987 * data set changes. It is possible for the data set to change without the
2988 * count changing (for example, if a new unread message arrives in the same
2989 * sync operation in which a message is archived). The phone should still
2990 * ring/vibrate/etc as normal in this case.
2991 */
2992 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2993 public static final String ACTION_PROVIDER_CHANGED =
2994 "android.intent.action.PROVIDER_CHANGED";
2995
2996 /**
2997 * Broadcast Action: Wired Headset plugged in or unplugged.
2998 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002999 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
3000 * and documentation.
3001 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07003002 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07003003 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003004 */
3005 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07003006 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07003007
3008 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07003009 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
3010 * <ul>
3011 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
3012 * </ul>
3013 *
3014 * <p class="note">This is a protected intent that can only be sent
3015 * by the system.
3016 *
3017 * @hide
3018 */
3019 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3020 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
3021 = "android.intent.action.ADVANCED_SETTINGS";
3022
3023 /**
Robin Lee66e5d962014-04-09 16:44:21 +01003024 * Broadcast Action: Sent after application restrictions are changed.
3025 *
3026 * <p class="note">This is a protected intent that can only be sent
3027 * by the system.</p>
3028 */
3029 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3030 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
3031 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
3032
3033 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003034 * Broadcast Action: An outgoing call is about to be placed.
3035 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07003036 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003037 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07003038 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003039 * the phone number originally intended to be dialed.</li>
3040 * </ul>
3041 * <p>Once the broadcast is finished, the resultData is used as the actual
3042 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07003043 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003044 * outgoing call in turn: for example, a parental control application
3045 * might verify that the user is authorized to place the call at that
3046 * time, then a number-rewriting application might add an area code if
3047 * one was not specified.</p>
3048 * <p>For consistency, any receiver whose purpose is to prohibit phone
3049 * calls should have a priority of 0, to ensure it will see the final
3050 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07003051 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003052 * should have a positive priority.
3053 * Negative priorities are reserved for the system for this broadcast;
3054 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07003055 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
3056 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003057 * <p>Emergency calls cannot be intercepted using this mechanism, and
3058 * other calls cannot be modified to call emergency numbers using this
3059 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07003060 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
3061 * call to use their own service instead. Those apps should first prevent
3062 * the call from being placed by setting resultData to <code>null</code>
3063 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07003064 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003065 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
3066 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08003067 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07003068 * <p class="note">This is a protected intent that can only be sent
3069 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003070 */
3071 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3072 public static final String ACTION_NEW_OUTGOING_CALL =
3073 "android.intent.action.NEW_OUTGOING_CALL";
3074
3075 /**
3076 * Broadcast Action: Have the device reboot. This is only for use by
3077 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08003078 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07003079 * <p class="note">This is a protected intent that can only be sent
3080 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003081 */
3082 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3083 public static final String ACTION_REBOOT =
3084 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003085
Wei Huang97ecc9c2009-05-11 17:44:20 -07003086 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08003087 * Broadcast Action: A sticky broadcast for changes in the physical
3088 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08003089 *
3090 * <p>The intent will have the following extra values:
3091 * <ul>
3092 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08003093 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08003094 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08003095 * <p>This is intended for monitoring the current physical dock state.
3096 * See {@link android.app.UiModeManager} for the normal API dealing with
3097 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07003098 */
3099 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3100 public static final String ACTION_DOCK_EVENT =
3101 "android.intent.action.DOCK_EVENT";
3102
3103 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08003104 * Broadcast Action: A broadcast when idle maintenance can be started.
3105 * This means that the user is not interacting with the device and is
3106 * not expected to do so soon. Typical use of the idle maintenance is
3107 * to perform somehow expensive tasks that can be postponed at a moment
3108 * when they will not degrade user experience.
3109 * <p>
3110 * <p class="note">In order to keep the device responsive in case of an
3111 * unexpected user interaction, implementations of a maintenance task
3112 * should be interruptible. In such a scenario a broadcast with action
3113 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
3114 * should not do the maintenance work in
3115 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
3116 * maintenance service by {@link Context#startService(Intent)}. Also
3117 * you should hold a wake lock while your maintenance service is running
3118 * to prevent the device going to sleep.
3119 * </p>
3120 * <p>
3121 * <p class="note">This is a protected intent that can only be sent by
3122 * the system.
3123 * </p>
3124 *
3125 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07003126 *
3127 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08003128 */
3129 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3130 public static final String ACTION_IDLE_MAINTENANCE_START =
3131 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
3132
3133 /**
3134 * Broadcast Action: A broadcast when idle maintenance should be stopped.
3135 * This means that the user was not interacting with the device as a result
3136 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
3137 * was sent and now the user started interacting with the device. Typical
3138 * use of the idle maintenance is to perform somehow expensive tasks that
3139 * can be postponed at a moment when they will not degrade user experience.
3140 * <p>
3141 * <p class="note">In order to keep the device responsive in case of an
3142 * unexpected user interaction, implementations of a maintenance task
3143 * should be interruptible. Hence, on receiving a broadcast with this
3144 * action, the maintenance task should be interrupted as soon as possible.
3145 * In other words, you should not do the maintenance work in
3146 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
3147 * maintenance service that was started on receiving of
3148 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
3149 * lock you acquired when your maintenance service started.
3150 * </p>
3151 * <p class="note">This is a protected intent that can only be sent
3152 * by the system.
3153 *
3154 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07003155 *
3156 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08003157 */
3158 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3159 public static final String ACTION_IDLE_MAINTENANCE_END =
3160 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
3161
3162 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003163 * Broadcast Action: a remote intent is to be broadcasted.
3164 *
3165 * A remote intent is used for remote RPC between devices. The remote intent
3166 * is serialized and sent from one device to another device. The receiving
3167 * device parses the remote intent and broadcasts it. Note that anyone can
3168 * broadcast a remote intent. However, if the intent receiver of the remote intent
3169 * does not trust intent broadcasts from arbitrary intent senders, it should require
3170 * the sender to hold certain permissions so only trusted sender's broadcast will be
3171 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07003172 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07003173 */
3174 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07003175 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07003176
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003177 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06003178 * Broadcast Action: This is broadcast once when the user is booting after a
3179 * system update. It can be used to perform cleanup or upgrades after a
3180 * system update.
3181 * <p>
3182 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
3183 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
3184 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
3185 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003186 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003187 * @hide
3188 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003189 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003190 public static final String ACTION_PRE_BOOT_COMPLETED =
3191 "android.intent.action.PRE_BOOT_COMPLETED";
3192
Amith Yamasani13593602012-03-22 16:16:17 -07003193 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003194 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003195 * on restricted users. The broadcast intent contains an extra
3196 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
3197 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
3198 * String[] depending on the restriction type.<p/>
3199 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07003200 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
3201 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
3202 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003203 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
3204 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003205 * @see RestrictionEntry
3206 */
3207 public static final String ACTION_GET_RESTRICTION_ENTRIES =
3208 "android.intent.action.GET_RESTRICTION_ENTRIES";
3209
3210 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003211 * Sent the first time a user is starting, to allow system apps to
3212 * perform one time initialization. (This will not be seen by third
3213 * party applications because a newly initialized user does not have any
3214 * third party applications installed for it.) This is sent early in
3215 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003216 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3217 * broadcast, since it is part of a visible user interaction; be as quick
3218 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003219 */
3220 public static final String ACTION_USER_INITIALIZE =
3221 "android.intent.action.USER_INITIALIZE";
3222
3223 /**
3224 * Sent when a user switch is happening, causing the process's user to be
3225 * brought to the foreground. This is only sent to receivers registered
3226 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3227 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003228 * foreground. This is sent as a foreground
3229 * broadcast, since it is part of a visible user interaction; be as quick
3230 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003231 */
3232 public static final String ACTION_USER_FOREGROUND =
3233 "android.intent.action.USER_FOREGROUND";
3234
3235 /**
3236 * Sent when a user switch is happening, causing the process's user to be
3237 * sent to the background. This is only sent to receivers registered
3238 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3239 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003240 * background. This is sent as a foreground
3241 * broadcast, since it is part of a visible user interaction; be as quick
3242 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003243 */
3244 public static final String ACTION_USER_BACKGROUND =
3245 "android.intent.action.USER_BACKGROUND";
3246
3247 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003248 * Broadcast sent to the system when a user is added. Carries an extra
3249 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3250 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003251 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003252 * @hide
3253 */
3254 public static final String ACTION_USER_ADDED =
3255 "android.intent.action.USER_ADDED";
3256
3257 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003258 * Broadcast sent by the system when a user is started. Carries an extra
3259 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003260 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003261 * that has been started. This is sent as a foreground
3262 * broadcast, since it is part of a visible user interaction; be as quick
3263 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003264 * @hide
3265 */
3266 public static final String ACTION_USER_STARTED =
3267 "android.intent.action.USER_STARTED";
3268
3269 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003270 * Broadcast sent when a user is in the process of starting. Carries an extra
3271 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3272 * sent to registered receivers, not manifest receivers. It is sent to all
3273 * users (including the one that is being started). You must hold
3274 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3275 * this broadcast. This is sent as a background broadcast, since
3276 * its result is not part of the primary UX flow; to safely keep track of
3277 * started/stopped state of a user you can use this in conjunction with
3278 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3279 * other user state broadcasts since those are foreground broadcasts so can
3280 * execute in a different order.
3281 * @hide
3282 */
3283 public static final String ACTION_USER_STARTING =
3284 "android.intent.action.USER_STARTING";
3285
3286 /**
3287 * Broadcast sent when a user is going to be stopped. Carries an extra
3288 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3289 * sent to registered receivers, not manifest receivers. It is sent to all
3290 * users (including the one that is being stopped). You must hold
3291 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3292 * this broadcast. The user will not stop until all receivers have
3293 * handled the broadcast. This is sent as a background broadcast, since
3294 * its result is not part of the primary UX flow; to safely keep track of
3295 * started/stopped state of a user you can use this in conjunction with
3296 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3297 * other user state broadcasts since those are foreground broadcasts so can
3298 * execute in a different order.
3299 * @hide
3300 */
3301 public static final String ACTION_USER_STOPPING =
3302 "android.intent.action.USER_STOPPING";
3303
3304 /**
3305 * Broadcast sent to the system when a user is stopped. Carries an extra
3306 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3307 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3308 * specific package. This is only sent to registered receivers, not manifest
3309 * receivers. It is sent to all running users <em>except</em> the one that
3310 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003311 * @hide
3312 */
3313 public static final String ACTION_USER_STOPPED =
3314 "android.intent.action.USER_STOPPED";
3315
3316 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003317 * 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 -07003318 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003319 * one that has been removed. The user will not be completely removed until all receivers have
3320 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003321 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003322 * @hide
3323 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003324 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003325 public static final String ACTION_USER_REMOVED =
3326 "android.intent.action.USER_REMOVED";
3327
3328 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003329 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003330 * the userHandle of the user to become the current one. This is only sent to
3331 * registered receivers, not manifest receivers. It is sent to all running users.
3332 * You must hold
3333 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003334 * @hide
3335 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01003336 @UnsupportedAppUsage
Amith Yamasani13593602012-03-22 16:16:17 -07003337 public static final String ACTION_USER_SWITCHED =
3338 "android.intent.action.USER_SWITCHED";
3339
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003340 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003341 * Broadcast Action: Sent when the credential-encrypted private storage has
3342 * become unlocked for the target user. This is only sent to registered
3343 * receivers, not manifest receivers.
3344 */
3345 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3346 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3347
3348 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003349 * Broadcast sent to the system when a user's information changes. Carries an extra
3350 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003351 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003352 * @hide
3353 */
3354 public static final String ACTION_USER_INFO_CHANGED =
3355 "android.intent.action.USER_INFO_CHANGED";
3356
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003357 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003358 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3359 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003360 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3361 * that need to display merged content across both primary and managed profiles need to
3362 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003363 * not manifest receivers.
3364 */
3365 public static final String ACTION_MANAGED_PROFILE_ADDED =
3366 "android.intent.action.MANAGED_PROFILE_ADDED";
3367
3368 /**
3369 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003370 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3371 * Only applications (for example Launchers) that need to display merged content across both
3372 * primary and managed profiles need to worry about this broadcast. This is only sent to
3373 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003374 */
3375 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3376 "android.intent.action.MANAGED_PROFILE_REMOVED";
3377
3378 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003379 * Broadcast sent to the primary user when the credential-encrypted private storage for
3380 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3381 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3382 * Launchers) that need to display merged content across both primary and managed profiles
3383 * need to worry about this broadcast. This is only sent to registered receivers,
3384 * not manifest receivers.
3385 */
3386 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3387 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3388
3389 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003390 * Broadcast sent to the primary user when an associated managed profile has become available.
3391 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003392 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3393 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3394 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003395 */
Rubin Xue95057a2016-04-01 16:49:25 +01003396 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3397 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3398
3399 /**
3400 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3401 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3402 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3403 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3404 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3405 */
3406 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3407 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003408
3409 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003410 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3411 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3412 * the device was locked or unlocked.
3413 *
3414 * This is only sent to registered receivers.
3415 *
3416 * @hide
3417 */
3418 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3419 "android.intent.action.DEVICE_LOCKED_CHANGED";
3420
3421 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003422 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3423 */
3424 public static final String ACTION_QUICK_CLOCK =
3425 "android.intent.action.QUICK_CLOCK";
3426
Michael Wright0087a142013-02-05 16:29:39 -08003427 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003428 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003429 * @hide
3430 */
3431 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003432 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003433
Justin Kohd378ad72013-04-01 12:18:26 -07003434 /**
3435 * Broadcast Action: A global button was pressed. Includes a single
3436 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3437 * caused the broadcast.
3438 * @hide
3439 */
Sujith Ramakrishnan48e19c82017-04-24 15:57:58 -07003440 @SystemApi
Justin Kohd378ad72013-04-01 12:18:26 -07003441 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3442
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003443 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003444 * Broadcast Action: Sent when media resource is granted.
3445 * <p>
3446 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3447 * granted.
3448 * </p>
3449 * <p class="note">
3450 * This is a protected intent that can only be sent by the system.
3451 * </p>
3452 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003453 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003454 * </p>
3455 *
3456 * @hide
3457 */
3458 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3459 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3460
3461 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003462 * Broadcast Action: An overlay package has changed. The data contains the
3463 * name of the overlay package which has changed. This is broadcast on all
3464 * changes to the OverlayInfo returned by {@link
3465 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3466 * most common change is a state change that will change whether the
3467 * overlay is enabled or not.
3468 * @hide
3469 */
3470 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3471
3472 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003473 * Activity Action: Allow the user to select and return one or more existing
3474 * documents. When invoked, the system will display the various
3475 * {@link DocumentsProvider} instances installed on the device, letting the
3476 * user interactively navigate through them. These documents include local
3477 * media, such as photos and video, and documents provided by installed
3478 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003479 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003480 * Each document is represented as a {@code content://} URI backed by a
3481 * {@link DocumentsProvider}, which can be opened as a stream with
3482 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3483 * {@link android.provider.DocumentsContract.Document} metadata.
3484 * <p>
3485 * All selected documents are returned to the calling application with
3486 * persistable read and write permission grants. If you want to maintain
3487 * access to the documents across device reboots, you need to explicitly
3488 * take the persistable permissions using
3489 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3490 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003491 * Callers must indicate the acceptable document MIME types through
3492 * {@link #setType(String)}. For example, to select photos, use
3493 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3494 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3495 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003496 * <p>
3497 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003498 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3499 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003500 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003501 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3502 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003503 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003504 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003505 * Callers can set a document URI through
3506 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3507 * location of documents navigator. System will do its best to launch the
3508 * navigator in the specified document if it's a folder, or the folder that
3509 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003510 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003511 * Output: The URI of the item that was picked, returned in
3512 * {@link #getData()}. This must be a {@code content://} URI so that any
3513 * receiver can access it. If multiple documents were selected, they are
3514 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003515 *
3516 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003517 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003518 * @see #ACTION_CREATE_DOCUMENT
3519 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003520 */
3521 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3522 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3523
3524 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003525 * Activity Action: Allow the user to create a new document. When invoked,
3526 * the system will display the various {@link DocumentsProvider} instances
3527 * installed on the device, letting the user navigate through them. The
3528 * returned document may be a newly created document with no content, or it
3529 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003530 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003531 * Each document is represented as a {@code content://} URI backed by a
3532 * {@link DocumentsProvider}, which can be opened as a stream with
3533 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3534 * {@link android.provider.DocumentsContract.Document} metadata.
3535 * <p>
3536 * Callers must indicate the concrete MIME type of the document being
3537 * created by setting {@link #setType(String)}. This MIME type cannot be
3538 * changed after the document is created.
3539 * <p>
3540 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3541 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003542 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003543 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3544 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003545 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003546 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003547 * Callers can set a document URI through
3548 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3549 * location of documents navigator. System will do its best to launch the
3550 * navigator in the specified document if it's a folder, or the folder that
3551 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003552 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003553 * Output: The URI of the item that was created. This must be a
3554 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003555 *
3556 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003557 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003558 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003559 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003560 */
3561 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3562 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3563
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003564 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003565 * Activity Action: Allow the user to pick a directory subtree. When
3566 * invoked, the system will display the various {@link DocumentsProvider}
3567 * instances installed on the device, letting the user navigate through
3568 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003569 * <p>
3570 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003571 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3572 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3573 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003574 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003575 * Callers can set a document URI through
3576 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3577 * location of documents navigator. System will do its best to launch the
3578 * navigator in the specified document if it's a folder, or the folder that
3579 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003580 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003581 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003582 *
3583 * @see DocumentsContract
3584 */
3585 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003586 public static final String
3587 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003588
Felipe Lemec7b1f892016-01-15 15:02:31 -08003589 /**
Peng Xua35b5532016-01-20 00:05:45 -08003590 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3591 * exisiting sensor being disconnected.
3592 *
3593 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3594 *
3595 * {@hide}
3596 */
3597 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3598 public static final String
3599 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3600
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003601 /**
Sam Line707f832017-04-13 17:00:55 -07003602 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003603 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003604 * @removed
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003605 */
3606 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003607 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003608 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3609
Christopher Tate6597e342015-02-17 12:15:25 -08003610 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003611 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3612 * is about to be performed.
3613 * @hide
3614 */
3615 @SystemApi
3616 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3617 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3618 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3619
3620 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003621 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3622 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3623 *
3624 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3625 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003626 * @hide
3627 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003628 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003629 public static final String EXTRA_FORCE_MASTER_CLEAR =
3630 "android.intent.extra.FORCE_MASTER_CLEAR";
3631
3632 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003633 * A broadcast action to trigger a factory reset.
3634 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003635 * <p>The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission. The
3636 * reason for the factory reset should be specified as {@link #EXTRA_REASON}.
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003637 *
3638 * <p>Not for use by third-party applications.
3639 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003640 * @see #EXTRA_FORCE_FACTORY_RESET
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003641 *
3642 * {@hide}
3643 */
3644 @SystemApi
3645 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3646 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3647
3648 /**
3649 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3650 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3651 *
3652 * <p>Not for use by third-party applications.
3653 *
3654 * @hide
3655 */
3656 @SystemApi
3657 public static final String EXTRA_FORCE_FACTORY_RESET =
3658 "android.intent.extra.FORCE_FACTORY_RESET";
3659
3660 /**
Michal Karpinski6135a262017-08-11 10:45:58 +01003661 * Broadcast action: report that a settings element is being restored from backup. The intent
3662 * contains four extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3663 * EXTRA_SETTING_NEW_VALUE is the value being restored, EXTRA_SETTING_PREVIOUS_VALUE
3664 * is the value of that settings entry prior to the restore operation, and
3665 * EXTRA_SETTING_RESTORED_FROM_SDK_INT is the version of the SDK that the setting has been
3666 * restored from (corresponds to {@link android.os.Build.VERSION#SDK_INT}). The first three
3667 * values are represented as strings, the fourth one as int.
Christopher Tate6597e342015-02-17 12:15:25 -08003668 *
3669 * <p>This broadcast is sent only for settings provider entries known to require special handling
3670 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3671 * the provider's backup agent implementation.
3672 *
3673 * @see #EXTRA_SETTING_NAME
3674 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3675 * @see #EXTRA_SETTING_NEW_VALUE
Michal Karpinski6135a262017-08-11 10:45:58 +01003676 * @see #EXTRA_SETTING_RESTORED_FROM_SDK_INT
Christopher Tate6597e342015-02-17 12:15:25 -08003677 * {@hide}
3678 */
3679 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3680
3681 /** {@hide} */
3682 public static final String EXTRA_SETTING_NAME = "setting_name";
3683 /** {@hide} */
3684 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3685 /** {@hide} */
3686 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
Michal Karpinski6135a262017-08-11 10:45:58 +01003687 /** {@hide} */
3688 public static final String EXTRA_SETTING_RESTORED_FROM_SDK_INT = "restored_from_sdk_int";
Christopher Tate6597e342015-02-17 12:15:25 -08003689
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003690 /**
3691 * Activity Action: Process a piece of text.
3692 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3693 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3694 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3695 */
3696 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3697 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003698
3699 /**
3700 * Broadcast Action: The sim card state has changed.
3701 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3702 * because TelephonyIntents is an internal class.
3703 * @hide
Amit Mahajan052e1e22018-01-12 17:40:29 -08003704 * @deprecated Use {@link #ACTION_SIM_CARD_STATE_CHANGED} or
3705 * {@link #ACTION_SIM_APPLICATION_STATE_CHANGED}
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003706 */
Amit Mahajan052e1e22018-01-12 17:40:29 -08003707 @Deprecated
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003708 @SystemApi
3709 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3710 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3711
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003712 /**
fionaxu90fee272017-03-31 12:45:12 -07003713 * Broadcast Action: indicate that the phone service state has changed.
3714 * The intent will have the following extra values:</p>
3715 * <p>
3716 * @see #EXTRA_VOICE_REG_STATE
3717 * @see #EXTRA_DATA_REG_STATE
3718 * @see #EXTRA_VOICE_ROAMING_TYPE
3719 * @see #EXTRA_DATA_ROAMING_TYPE
3720 * @see #EXTRA_OPERATOR_ALPHA_LONG
3721 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3722 * @see #EXTRA_OPERATOR_NUMERIC
3723 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3724 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3725 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3726 * @see #EXTRA_MANUAL
3727 * @see #EXTRA_VOICE_RADIO_TECH
3728 * @see #EXTRA_DATA_RADIO_TECH
3729 * @see #EXTRA_CSS_INDICATOR
3730 * @see #EXTRA_NETWORK_ID
3731 * @see #EXTRA_SYSTEM_ID
3732 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3733 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3734 * @see #EXTRA_EMERGENCY_ONLY
3735 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3736 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3737 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3738 *
3739 * <p class="note">
3740 * Requires the READ_PHONE_STATE permission.
3741 *
3742 * <p class="note">This is a protected intent that can only be sent by the system.
3743 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003744 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003745 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable} and the helper
3746 * functions {@code ServiceStateTable.getUriForSubscriptionIdAndField} and
3747 * {@code ServiceStateTable.getUriForSubscriptionId} to subscribe to changes to the ServiceState
3748 * for a given subscription id and field with a ContentObserver or using JobScheduler.
fionaxu90fee272017-03-31 12:45:12 -07003749 */
3750 @Deprecated
3751 @SystemApi
3752 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3753 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3754
3755 /**
3756 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3757 * state.
3758 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3759 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3760 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3761 * @see android.telephony.ServiceState#STATE_POWER_OFF
3762 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003763 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003764 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_REG_STATE}.
fionaxu90fee272017-03-31 12:45:12 -07003765 */
3766 @Deprecated
3767 @SystemApi
3768 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3769
3770 /**
3771 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3772 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3773 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3774 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3775 * @see android.telephony.ServiceState#STATE_POWER_OFF
3776 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003777 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003778 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_REG_STATE}.
fionaxu90fee272017-03-31 12:45:12 -07003779 */
3780 @Deprecated
3781 @SystemApi
3782 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3783
3784 /**
3785 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3786 * type.
3787 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003788 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003789 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_ROAMING_TYPE}.
fionaxu90fee272017-03-31 12:45:12 -07003790 */
3791 @Deprecated
3792 @SystemApi
3793 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3794
3795 /**
3796 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3797 * type.
3798 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003799 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003800 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_ROAMING_TYPE}.
fionaxu90fee272017-03-31 12:45:12 -07003801 */
3802 @Deprecated
3803 @SystemApi
3804 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3805
3806 /**
3807 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3808 * registered voice operator name in long alphanumeric format.
3809 * {@code null} if the operator name is not known or unregistered.
3810 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003811 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003812 * @deprecated Use
3813 * {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_ALPHA_LONG}.
fionaxu90fee272017-03-31 12:45:12 -07003814 */
3815 @Deprecated
3816 @SystemApi
3817 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3818
3819 /**
3820 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3821 * registered voice operator name in short alphanumeric format.
3822 * {@code null} if the operator name is not known or unregistered.
3823 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003824 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003825 * @deprecated Use
3826 * {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_ALPHA_SHORT}.
fionaxu90fee272017-03-31 12:45:12 -07003827 */
3828 @Deprecated
3829 @SystemApi
3830 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3831
3832 /**
3833 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3834 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3835 * network.
3836 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003837 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003838 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_NUMERIC}.
fionaxu90fee272017-03-31 12:45:12 -07003839 */
3840 @Deprecated
3841 @SystemApi
3842 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3843
3844 /**
3845 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3846 * registered data operator name in long alphanumeric format.
3847 * {@code null} if the operator name is not known or unregistered.
3848 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003849 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003850 * @deprecated Use
3851 * {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_ALPHA_LONG}.
fionaxu90fee272017-03-31 12:45:12 -07003852 */
3853 @Deprecated
3854 @SystemApi
3855 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3856
3857 /**
3858 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3859 * registered data operator name in short alphanumeric format.
3860 * {@code null} if the operator name is not known or unregistered.
3861 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003862 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003863 * @deprecated Use
3864 * {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_ALPHA_SHORT}.
fionaxu90fee272017-03-31 12:45:12 -07003865 */
3866 @Deprecated
3867 @SystemApi
3868 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3869
3870 /**
3871 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3872 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3873 * data operator.
3874 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003875 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003876 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_NUMERIC}.
fionaxu90fee272017-03-31 12:45:12 -07003877 */
3878 @Deprecated
3879 @SystemApi
3880 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3881
3882 /**
3883 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3884 * network selection mode is manual.
3885 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3886 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003887 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003888 * @deprecated Use
3889 * {@link android.provider.Telephony.ServiceStateTable#IS_MANUAL_NETWORK_SELECTION}.
fionaxu90fee272017-03-31 12:45:12 -07003890 */
3891 @Deprecated
3892 @SystemApi
3893 public static final String EXTRA_MANUAL = "manual";
3894
3895 /**
3896 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3897 * radio technology.
3898 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003899 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003900 * @deprecated Use
3901 * {@link android.provider.Telephony.ServiceStateTable#RIL_VOICE_RADIO_TECHNOLOGY}.
fionaxu90fee272017-03-31 12:45:12 -07003902 */
3903 @Deprecated
3904 @SystemApi
3905 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3906
3907 /**
3908 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3909 * radio technology.
3910 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003911 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003912 * @deprecated Use
3913 * {@link android.provider.Telephony.ServiceStateTable#RIL_DATA_RADIO_TECHNOLOGY}.
fionaxu90fee272017-03-31 12:45:12 -07003914 */
3915 @Deprecated
3916 @SystemApi
3917 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3918
3919 /**
3920 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3921 * support on CDMA network.
3922 * Will be {@code true} if support, {@code false} otherwise.
3923 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003924 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003925 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#CSS_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003926 */
3927 @Deprecated
3928 @SystemApi
3929 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3930
3931 /**
3932 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3933 * id. {@code Integer.MAX_VALUE} if unknown.
3934 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003935 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003936 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#NETWORK_ID}.
fionaxu90fee272017-03-31 12:45:12 -07003937 */
3938 @Deprecated
3939 @SystemApi
3940 public static final String EXTRA_NETWORK_ID = "networkId";
3941
3942 /**
3943 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3944 * {@code Integer.MAX_VALUE} if unknown.
3945 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003946 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003947 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#SYSTEM_ID}.
fionaxu90fee272017-03-31 12:45:12 -07003948 */
3949 @Deprecated
3950 @SystemApi
3951 public static final String EXTRA_SYSTEM_ID = "systemId";
3952
3953 /**
3954 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3955 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3956 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003957 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003958 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#CDMA_ROAMING_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003959 */
3960 @Deprecated
3961 @SystemApi
3962 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3963
3964 /**
3965 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3966 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3967 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003968 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003969 * @deprecated Use
3970 * {@link android.provider.Telephony.ServiceStateTable#CDMA_DEFAULT_ROAMING_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003971 */
3972 @Deprecated
3973 @SystemApi
3974 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3975
3976 /**
3977 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3978 * only mode.
3979 * {@code true} if in emergency only mode, {@code false} otherwise.
3980 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003981 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003982 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#IS_EMERGENCY_ONLY}.
fionaxu90fee272017-03-31 12:45:12 -07003983 */
3984 @Deprecated
3985 @SystemApi
3986 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3987
3988 /**
3989 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3990 * registration state is roaming.
3991 * {@code true} if registration indicates roaming, {@code false} otherwise
3992 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003993 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003994 * @deprecated Use
3995 * {@link android.provider.Telephony.ServiceStateTable#IS_DATA_ROAMING_FROM_REGISTRATION}.
fionaxu90fee272017-03-31 12:45:12 -07003996 */
3997 @Deprecated
3998 @SystemApi
3999 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
4000 "isDataRoamingFromRegistration";
4001
4002 /**
4003 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
4004 * aggregation is in use.
4005 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
4006 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06004007 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07004008 * @deprecated Use
4009 * {@link android.provider.Telephony.ServiceStateTable#IS_USING_CARRIER_AGGREGATION}.
fionaxu90fee272017-03-31 12:45:12 -07004010 */
4011 @Deprecated
4012 @SystemApi
4013 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
4014
4015 /**
4016 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
4017 * is reduced from the rsrp threshold while calculating signal strength level.
4018 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06004019 * @removed
fionaxu90fee272017-03-31 12:45:12 -07004020 */
4021 @Deprecated
4022 @SystemApi
4023 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
4024
4025 /**
chen xu02811692018-10-03 19:07:09 -07004026 * An parcelable extra used with {@link #ACTION_SERVICE_STATE} representing the service state.
4027 * @hide
4028 */
4029 public static final String EXTRA_SERVICE_STATE = "android.intent.extra.SERVICE_STATE";
4030
4031 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01004032 * The name of the extra used to define the text to be processed, as a
4033 * CharSequence. Note that this may be a styled CharSequence, so you must use
4034 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00004035 */
4036 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
4037 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01004038 * 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 +00004039 */
4040 public static final String EXTRA_PROCESS_TEXT_READONLY =
4041 "android.intent.extra.PROCESS_TEXT_READONLY";
4042
Bryce Leebc58f592015-09-25 16:43:01 -07004043 /**
4044 * Broadcast action: reports when a new thermal event has been reached. When the device
4045 * is reaching its maximum temperatue, the thermal level reported
4046 * {@hide}
4047 */
4048 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
4049 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
4050
4051 /** {@hide} */
4052 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
4053
4054 /**
4055 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08004056 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07004057 * {@hide}
4058 */
4059 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
4060
4061 /**
4062 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08004063 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07004064 * {@hide}
4065 */
4066 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
4067
4068 /**
4069 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08004070 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07004071 * {@hide}
4072 */
4073 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
4074
lpeter318abc92018-05-04 16:13:14 +08004075 /**
4076 * Broadcast Action: Indicates the dock in idle state while device is docked.
4077 *
4078 * <p class="note">This is a protected intent that can only be sent
4079 * by the system.
4080 *
4081 * @hide
4082 */
4083 public static final String ACTION_DOCK_IDLE = "android.intent.action.DOCK_IDLE";
4084
4085 /**
4086 * Broadcast Action: Indicates the dock in active state while device is docked.
4087 *
4088 * <p class="note">This is a protected intent that can only be sent
4089 * by the system.
4090 *
4091 * @hide
4092 */
4093 public static final String ACTION_DOCK_ACTIVE = "android.intent.action.DOCK_ACTIVE";
4094
Bryce Leebc58f592015-09-25 16:43:01 -07004095
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004096 // ---------------------------------------------------------------------
4097 // ---------------------------------------------------------------------
4098 // Standard intent categories (see addCategory()).
4099
4100 /**
4101 * Set if the activity should be an option for the default action
4102 * (center press) to perform on a piece of data. Setting this will
4103 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04004104 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004105 * Intent when initiating an action -- it is for use in intent filters
4106 * specified in packages.
4107 */
4108 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4109 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
4110 /**
4111 * Activities that can be safely invoked from a browser must support this
4112 * category. For example, if the user is viewing a web page or an e-mail
4113 * and clicks on a link in the text, the Intent generated execute that
4114 * link will require the BROWSABLE category, so that only activities
4115 * supporting this category will be considered as possible actions. By
4116 * supporting this category, you are promising that there is nothing
4117 * damaging (without user intervention) that can happen by invoking any
4118 * matching Intent.
4119 */
4120 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4121 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
4122 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07004123 * Categories for activities that can participate in voice interaction.
4124 * An activity that supports this category must be prepared to run with
4125 * no UI shown at all (though in some case it may have a UI shown), and
4126 * rely on {@link android.app.VoiceInteractor} to interact with the user.
4127 */
4128 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4129 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
4130 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004131 * Set if the activity should be considered as an alternative action to
4132 * the data the user is currently viewing. See also
4133 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
4134 * applies to the selection in a list of items.
4135 *
4136 * <p>Supporting this category means that you would like your activity to be
4137 * displayed in the set of alternative things the user can do, usually as
4138 * part of the current activity's options menu. You will usually want to
4139 * include a specific label in the &lt;intent-filter&gt; of this action
4140 * describing to the user what it does.
4141 *
4142 * <p>The action of IntentFilter with this category is important in that it
4143 * describes the specific action the target will perform. This generally
4144 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
4145 * a specific name such as "com.android.camera.action.CROP. Only one
4146 * alternative of any particular action will be shown to the user, so using
4147 * a specific action like this makes sure that your alternative will be
4148 * displayed while also allowing other applications to provide their own
4149 * overrides of that particular action.
4150 */
4151 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4152 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
4153 /**
4154 * Set if the activity should be considered as an alternative selection
4155 * action to the data the user has currently selected. This is like
4156 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
4157 * of items from which the user can select, giving them alternatives to the
4158 * default action that will be performed on it.
4159 */
4160 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4161 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
4162 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004163 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004164 */
4165 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4166 public static final String CATEGORY_TAB = "android.intent.category.TAB";
4167 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004168 * Should be displayed in the top-level launcher.
4169 */
4170 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4171 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
4172 /**
Jose Lima38b75b62014-03-11 10:41:39 -07004173 * Indicates an activity optimized for Leanback mode, and that should
4174 * be displayed in the Leanback launcher.
4175 */
4176 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4177 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
4178 /**
Roberto Perez7ee1a7a2017-12-04 17:14:33 -08004179 * Indicates the preferred entry-point activity when an application is launched from a Car
4180 * launcher. If not present, Car launcher can optionally use {@link #CATEGORY_LAUNCHER} as a
4181 * fallback, or exclude the application entirely.
4182 * @hide
4183 */
4184 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4185 public static final String CATEGORY_CAR_LAUNCHER = "android.intent.category.CAR_LAUNCHER";
4186 /**
Jose Lima73915cf2014-07-29 17:16:31 -07004187 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
4188 * @hide
4189 */
4190 @SystemApi
4191 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
4192 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004193 * Provides information about the package it is in; typically used if
4194 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
4195 * a front-door to the user without having to be shown in the all apps list.
4196 */
4197 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4198 public static final String CATEGORY_INFO = "android.intent.category.INFO";
4199 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004200 * This is the home activity, that is the first activity that is displayed
4201 * when the device boots.
4202 */
4203 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4204 public static final String CATEGORY_HOME = "android.intent.category.HOME";
4205 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07004206 * This is the home activity that is displayed when the device is finished setting up and ready
4207 * for use.
4208 * @hide
4209 */
4210 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4211 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
4212 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07004213 * This is the setup wizard activity, that is the first activity that is displayed
4214 * when the user sets up the device for the first time.
4215 * @hide
4216 */
4217 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4218 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
4219 /**
Svet Ganov5bb6bc62017-08-28 12:39:35 -07004220 * This is the home activity, that is the activity that serves as the launcher app
4221 * from there the user can start other apps. Often components with lower/higher
4222 * priority intent filters handle the home intent, for example SetupWizard, to
4223 * setup the device and we need to be able to distinguish the home app from these
4224 * setup helpers.
4225 * @hide
4226 */
4227 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4228 public static final String CATEGORY_LAUNCHER_APP = "android.intent.category.LAUNCHER_APP";
4229 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004230 * This activity is a preference panel.
4231 */
4232 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4233 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
4234 /**
4235 * This activity is a development preference panel.
4236 */
4237 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4238 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
4239 /**
4240 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004241 */
4242 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4243 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
4244 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07004245 * This activity allows the user to browse and download new applications.
4246 */
4247 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4248 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
4249 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004250 * This activity may be exercised by the monkey or other automated test tools.
4251 */
4252 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4253 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
4254 /**
4255 * To be used as a test (not part of the normal user experience).
4256 */
4257 public static final String CATEGORY_TEST = "android.intent.category.TEST";
4258 /**
4259 * To be used as a unit test (run through the Test Harness).
4260 */
4261 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
4262 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004263 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004264 * experience).
4265 */
4266 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004267
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004268 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004269 * Used to indicate that an intent only wants URIs that can be opened with
4270 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
4271 * must support at least the columns defined in {@link OpenableColumns} when
4272 * queried.
4273 *
4274 * @see #ACTION_GET_CONTENT
4275 * @see #ACTION_OPEN_DOCUMENT
4276 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004277 */
4278 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4279 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
4280
4281 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09004282 * Used to indicate that an intent filter can accept files which are not necessarily
4283 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
4284 * at least streamable via
4285 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
4286 * using one of the stream types exposed via
4287 * {@link ContentResolver#getStreamTypes(Uri, String)}.
4288 *
4289 * @see #ACTION_SEND
4290 * @see #ACTION_SEND_MULTIPLE
4291 */
4292 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4293 public static final String CATEGORY_TYPED_OPENABLE =
4294 "android.intent.category.TYPED_OPENABLE";
4295
4296 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004297 * To be used as code under test for framework instrumentation tests.
4298 */
4299 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
4300 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04004301 /**
4302 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004303 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4304 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004305 */
4306 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4307 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
4308 /**
4309 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004310 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4311 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004312 */
4313 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4314 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004315 /**
4316 * An activity to run when device is inserted into a analog (low end) dock.
4317 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4318 * information, see {@link android.app.UiModeManager}.
4319 */
4320 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4321 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
4322
4323 /**
4324 * An activity to run when device is inserted into a digital (high end) dock.
4325 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4326 * information, see {@link android.app.UiModeManager}.
4327 */
4328 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4329 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004330
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004331 /**
4332 * Used to indicate that the activity can be used in a car environment.
4333 */
4334 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4335 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4336
Zak Cohendb6ca492017-01-26 14:09:00 -08004337 /**
4338 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4339 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4340 * information, see {@link android.app.UiModeManager}.
4341 */
4342 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4343 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004344 // ---------------------------------------------------------------------
4345 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004346 // Application launch intent categories (see addCategory()).
4347
4348 /**
4349 * Used with {@link #ACTION_MAIN} to launch the browser application.
4350 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004351 * <p>NOTE: This should not be used as the primary key of an Intent,
4352 * since it will not result in the app launching with the correct
4353 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004354 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004355 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004356 */
4357 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4358 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4359
4360 /**
4361 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4362 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004363 * <p>NOTE: This should not be used as the primary key of an Intent,
4364 * since it will not result in the app launching with the correct
4365 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004366 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004367 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004368 */
4369 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4370 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4371
4372 /**
4373 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4374 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004375 * <p>NOTE: This should not be used as the primary key of an Intent,
4376 * since it will not result in the app launching with the correct
4377 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004378 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004379 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004380 */
4381 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4382 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4383
4384 /**
4385 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4386 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004387 * <p>NOTE: This should not be used as the primary key of an Intent,
4388 * since it will not result in the app launching with the correct
4389 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004390 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004391 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004392 */
4393 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4394 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4395
4396 /**
4397 * Used with {@link #ACTION_MAIN} to launch the email application.
4398 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004399 * <p>NOTE: This should not be used as the primary key of an Intent,
4400 * since it will not result in the app launching with the correct
4401 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004402 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004403 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004404 */
4405 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4406 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4407
4408 /**
4409 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4410 * The activity should be able to view and manipulate image and video files
4411 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004412 * <p>NOTE: This should not be used as the primary key of an Intent,
4413 * since it will not result in the app launching with the correct
4414 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004415 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004416 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004417 */
4418 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4419 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4420
4421 /**
4422 * Used with {@link #ACTION_MAIN} to launch the maps application.
4423 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004424 * <p>NOTE: This should not be used as the primary key of an Intent,
4425 * since it will not result in the app launching with the correct
4426 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004427 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004428 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004429 */
4430 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4431 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4432
4433 /**
4434 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4435 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004436 * <p>NOTE: This should not be used as the primary key of an Intent,
4437 * since it will not result in the app launching with the correct
4438 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004439 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004440 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004441 */
4442 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4443 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4444
4445 /**
4446 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004447 * The activity should be able to play, browse, or manipulate music files
4448 * stored on the device.
4449 * <p>NOTE: This should not be used as the primary key of an Intent,
4450 * since it will not result in the app launching with the correct
4451 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004452 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004453 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004454 */
4455 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4456 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4457
4458 // ---------------------------------------------------------------------
4459 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004460 // Standard extra data keys.
4461
4462 /**
4463 * The initial data to place in a newly created record. Use with
4464 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4465 * fields as would be given to the underlying ContentProvider.insert()
4466 * call.
4467 */
4468 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4469
4470 /**
4471 * A constant CharSequence that is associated with the Intent, used with
4472 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4473 * this may be a styled CharSequence, so you must use
4474 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4475 * retrieve it.
4476 */
4477 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4478
4479 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004480 * A constant String that is associated with the Intent, used with
4481 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4482 * as HTML formatted text. Note that you <em>must</em> also supply
4483 * {@link #EXTRA_TEXT}.
4484 */
4485 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4486
4487 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004488 * A content: URI holding a stream of data associated with the Intent,
4489 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004490 */
4491 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4492
4493 /**
4494 * A String[] holding e-mail addresses that should be delivered to.
4495 */
4496 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4497
4498 /**
4499 * A String[] holding e-mail addresses that should be carbon copied.
4500 */
4501 public static final String EXTRA_CC = "android.intent.extra.CC";
4502
4503 /**
4504 * A String[] holding e-mail addresses that should be blind carbon copied.
4505 */
4506 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4507
4508 /**
4509 * A constant string holding the desired subject line of a message.
4510 */
4511 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4512
4513 /**
4514 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004515 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004516 */
4517 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4518
4519 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004520 * An int representing the user id to be used.
4521 *
4522 * @hide
4523 */
4524 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4525
4526 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004527 * An int representing the task id to be retrieved. This is used when a launch from recents is
4528 * intercepted by another action such as credentials confirmation to remember which task should
4529 * be resumed when complete.
4530 *
4531 * @hide
4532 */
4533 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4534
4535 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004536 * An Intent[] describing additional, alternate choices you would like shown with
4537 * {@link #ACTION_CHOOSER}.
4538 *
4539 * <p>An app may be capable of providing several different payload types to complete a
4540 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4541 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4542 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4543 * photo data or a hosted link where the photos can be viewed.</p>
4544 *
4545 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4546 * first/primary/preferred intent in the set. Additional intents specified in
4547 * this extra are ordered; by default intents that appear earlier in the array will be
4548 * preferred over intents that appear later in the array as matches for the same
4549 * target component. To alter this preference, a calling app may also supply
4550 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4551 */
4552 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4553
4554 /**
Adam Powell52c39212016-04-07 15:14:18 -07004555 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4556 * and omitted from a list of components presented to the user.
4557 *
4558 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4559 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4560 * from your own package or other apps from your organization if the idea of sending to those
4561 * targets would be redundant with other app functionality. Filtered components will not
4562 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4563 */
4564 public static final String EXTRA_EXCLUDE_COMPONENTS
4565 = "android.intent.extra.EXCLUDE_COMPONENTS";
4566
4567 /**
4568 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4569 * describing additional high-priority deep-link targets for the chooser to present to the user.
4570 *
4571 * <p>Targets provided in this way will be presented inline with all other targets provided
4572 * by services from other apps. They will be prioritized before other service targets, but
4573 * after those targets provided by sources that the user has manually pinned to the front.</p>
4574 *
4575 * @see #ACTION_CHOOSER
4576 */
4577 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4578
4579 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004580 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4581 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4582 *
4583 * <p>An app preparing an action for another app to complete may wish to allow the user to
4584 * disambiguate between several options for completing the action based on the chosen target
4585 * or otherwise refine the action before it is invoked.
4586 * </p>
4587 *
4588 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4589 * <ul>
4590 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4591 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4592 * chosen target beyond the first</li>
4593 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4594 * should fill in and send once the disambiguation is complete</li>
4595 * </ul>
4596 */
4597 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4598 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4599
4600 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004601 * An {@code ArrayList} of {@code String} annotations describing content for
4602 * {@link #ACTION_CHOOSER}.
4603 *
4604 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4605 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4606 *
4607 * <p>Annotations should describe the major components or topics of the content. It is up to
4608 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4609 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004610 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4611 * character. Performance on customized annotations can suffer, if they are rarely used for
4612 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4613 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004614 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004615 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004616 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004617 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004618 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004619 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004620 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004621 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004622 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004623 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4624 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4625 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4626 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4627 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004628 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004629 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4630 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004631 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004632 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004633 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004634 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004635 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004636 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004637 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004638 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004639 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004640 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004641 * Christmas and Thanksgiving.</li>
4642 * </ul>
4643 */
4644 public static final String EXTRA_CONTENT_ANNOTATIONS
4645 = "android.intent.extra.CONTENT_ANNOTATIONS";
4646
4647 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004648 * A {@link ResultReceiver} used to return data back to the sender.
4649 *
4650 * <p>Used to complete an app-specific
4651 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4652 *
4653 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4654 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4655 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4656 * when the user selects a target component from the chooser. It is up to the recipient
4657 * to send a result to this ResultReceiver to signal that disambiguation is complete
4658 * and that the chooser should invoke the user's choice.</p>
4659 *
4660 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4661 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4662 * to match and fill in the final Intent or ChooserTarget before starting it.
4663 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4664 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4665 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4666 *
4667 * <p>The result code passed to the ResultReceiver should be
4668 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4669 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4670 * the chooser should finish without starting a target.</p>
4671 */
4672 public static final String EXTRA_RESULT_RECEIVER
4673 = "android.intent.extra.RESULT_RECEIVER";
4674
4675 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004676 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004677 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004678 */
4679 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4680
4681 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004682 * A Parcelable[] of {@link Intent} or
4683 * {@link android.content.pm.LabeledIntent} objects as set with
4684 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4685 * a the front of the list of choices, when shown to the user with a
4686 * {@link #ACTION_CHOOSER}.
4687 */
4688 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4689
4690 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004691 * A {@link IntentSender} to start after instant app installation success.
Todd Kennedy7440f172015-12-09 14:31:22 -08004692 * @hide
4693 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004694 @SystemApi
4695 public static final String EXTRA_INSTANT_APP_SUCCESS =
4696 "android.intent.extra.INSTANT_APP_SUCCESS";
4697
4698 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004699 * A {@link IntentSender} to start after instant app installation failure.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004700 * @hide
4701 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004702 @SystemApi
4703 public static final String EXTRA_INSTANT_APP_FAILURE =
4704 "android.intent.extra.INSTANT_APP_FAILURE";
4705
4706 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004707 * The host name that triggered an instant app resolution.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004708 * @hide
4709 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004710 @SystemApi
4711 public static final String EXTRA_INSTANT_APP_HOSTNAME =
4712 "android.intent.extra.INSTANT_APP_HOSTNAME";
4713
4714 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004715 * An opaque token to track instant app resolution.
4716 * @hide
4717 */
4718 @SystemApi
4719 public static final String EXTRA_INSTANT_APP_TOKEN =
4720 "android.intent.extra.INSTANT_APP_TOKEN";
4721
4722 /**
Patrick Baumannb4165d72017-12-04 11:29:24 -08004723 * The action that triggered an instant application resolution.
4724 * @hide
4725 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004726 @SystemApi
Patrick Baumannb4165d72017-12-04 11:29:24 -08004727 public static final String EXTRA_INSTANT_APP_ACTION = "android.intent.extra.INSTANT_APP_ACTION";
4728
4729 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004730 * An array of {@link Bundle}s containing details about resolved instant apps..
4731 * @hide
4732 */
4733 @SystemApi
4734 public static final String EXTRA_INSTANT_APP_BUNDLES =
4735 "android.intent.extra.INSTANT_APP_BUNDLES";
4736
4737 /**
4738 * A {@link Bundle} of metadata that describes the instant application that needs to be
Patrick Baumann709ee152017-12-04 16:12:52 -08004739 * installed. This data is populated from the response to
4740 * {@link android.content.pm.InstantAppResolveInfo#getExtras()} as provided by the registered
4741 * instant application resolver.
4742 * @hide
4743 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004744 @SystemApi
Patrick Baumann709ee152017-12-04 16:12:52 -08004745 public static final String EXTRA_INSTANT_APP_EXTRAS =
4746 "android.intent.extra.INSTANT_APP_EXTRAS";
4747
4748 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004749 * A boolean value indicating that the instant app resolver was unable to state with certainty
4750 * that it did or did not have an app for the sanitized {@link Intent} defined at
4751 * {@link #EXTRA_INTENT}.
4752 * @hide
4753 */
4754 @SystemApi
4755 public static final String EXTRA_UNKNOWN_INSTANT_APP =
4756 "android.intent.extra.UNKNOWN_INSTANT_APP";
4757
4758 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004759 * The version code of the app to install components from.
Dianne Hackborn3accca02013-09-20 09:32:11 -07004760 * @deprecated Use {@link #EXTRA_LONG_VERSION_CODE).
Todd Kennedy316c2f22017-01-23 15:40:07 -08004761 * @hide
4762 */
Dianne Hackborn3accca02013-09-20 09:32:11 -07004763 @Deprecated
Todd Kennedy316c2f22017-01-23 15:40:07 -08004764 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4765
4766 /**
Dianne Hackborn3accca02013-09-20 09:32:11 -07004767 * The version code of the app to install components from.
4768 * @hide
4769 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004770 @SystemApi
Dianne Hackborn3accca02013-09-20 09:32:11 -07004771 public static final String EXTRA_LONG_VERSION_CODE = "android.intent.extra.LONG_VERSION_CODE";
4772
4773 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004774 * The app that triggered the instant app installation.
Chad Brubaker06068612017-04-06 09:43:47 -07004775 * @hide
4776 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004777 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004778 public static final String EXTRA_CALLING_PACKAGE
4779 = "android.intent.extra.CALLING_PACKAGE";
4780
4781 /**
4782 * Optional calling app provided bundle containing additional launch information the
4783 * installer may use.
4784 * @hide
4785 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004786 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004787 public static final String EXTRA_VERIFICATION_BUNDLE
4788 = "android.intent.extra.VERIFICATION_BUNDLE";
4789
4790 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004791 * A Bundle forming a mapping of potential target package names to different extras Bundles
4792 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4793 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4794 * be currently installed on the device.
4795 *
4796 * <p>An application may choose to provide alternate extras for the case where a user
4797 * selects an activity from a predetermined set of target packages. If the activity
4798 * the user selects from the chooser belongs to a package with its package name as
4799 * a key in this bundle, the corresponding extras for that package will be merged with
4800 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4801 * extra has the same key as an extra already present in the intent it will overwrite
4802 * the extra from the intent.</p>
4803 *
4804 * <p><em>Examples:</em>
4805 * <ul>
4806 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4807 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4808 * parameters for that target.</li>
4809 * <li>An application may offer additional metadata for known targets of a given intent
4810 * to pass along information only relevant to that target such as account or content
4811 * identifiers already known to that application.</li>
4812 * </ul></p>
4813 */
4814 public static final String EXTRA_REPLACEMENT_EXTRAS =
4815 "android.intent.extra.REPLACEMENT_EXTRAS";
4816
4817 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004818 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4819 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4820 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4821 * {@link ComponentName} of the chosen component.
4822 *
4823 * <p>In some situations this callback may never come, for example if the user abandons
4824 * the chooser, switches to another task or any number of other reasons. Apps should not
4825 * be written assuming that this callback will always occur.</p>
4826 */
4827 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4828 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4829
4830 /**
4831 * The {@link ComponentName} chosen by the user to complete an action.
4832 *
4833 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4834 */
4835 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4836
4837 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004838 * A {@link android.view.KeyEvent} object containing the event that
4839 * triggered the creation of the Intent it is in.
4840 */
4841 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4842
4843 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004844 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4845 * before shutting down.
4846 *
4847 * {@hide}
4848 */
4849 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4850
4851 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004852 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4853 * requested by the user.
4854 *
4855 * {@hide}
4856 */
4857 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4858 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4859
4860 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004861 * 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 -07004862 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4863 * of restarting the application.
4864 */
4865 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4866
4867 /**
4868 * A String holding the phone number originally entered in
4869 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4870 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4871 */
4872 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004873
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004874 /**
4875 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4876 * intents to supply the uid the package had been assigned. Also an optional
4877 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4878 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4879 * purpose.
4880 */
4881 public static final String EXTRA_UID = "android.intent.extra.UID";
4882
4883 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004884 * @hide String array of package names.
4885 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004886 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004887 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4888
4889 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004890 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4891 * intents to indicate whether this represents a full uninstall (removing
4892 * both the code and its data) or a partial uninstall (leaving its data,
4893 * implying that this is an update).
4894 */
4895 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004896
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004897 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004898 * @hide
4899 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4900 * intents to indicate that at this point the package has been removed for
4901 * all users on the device.
4902 */
4903 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4904 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4905
4906 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004907 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4908 * intents to indicate that this is a replacement of the package, so this
4909 * broadcast will immediately be followed by an add broadcast for a
4910 * different version of the same package.
4911 */
4912 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004913
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004914 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004915 * Used as an int extra field in {@link android.app.AlarmManager} intents
4916 * to tell the application being invoked how many pending alarms are being
4917 * delievered with the intent. For one-shot alarms this will always be 1.
4918 * For recurring alarms, this might be greater than 1 if the device was
4919 * asleep or powered off at the time an earlier alarm would have been
4920 * delivered.
4921 */
4922 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004923
Jacek Surazski86b6c532009-05-13 14:38:28 +02004924 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004925 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4926 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004927 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4928 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004929 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4930 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4931 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004932 */
4933 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4934
4935 /**
4936 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4937 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004938 */
4939 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4940
4941 /**
4942 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4943 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004944 */
4945 public static final int EXTRA_DOCK_STATE_DESK = 1;
4946
4947 /**
4948 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4949 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004950 */
4951 public static final int EXTRA_DOCK_STATE_CAR = 2;
4952
4953 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004954 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4955 * to represent that the phone is in a analog (low end) dock.
4956 */
4957 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4958
4959 /**
4960 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4961 * to represent that the phone is in a digital (high end) dock.
4962 */
4963 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4964
4965 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004966 * Boolean that can be supplied as meta-data with a dock activity, to
4967 * indicate that the dock should take over the home key when it is active.
4968 */
4969 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004970
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004971 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004972 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4973 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004974 */
4975 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4976
4977 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004978 * Used in the extra field in the remote intent. It's astring token passed with the
4979 * remote intent.
4980 */
4981 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4982 "android.intent.extra.remote_intent_token";
4983
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004984 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004985 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004986 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004987 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004988 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004989 "android.intent.extra.changed_component_name";
4990
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004991 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004992 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004993 * and contains a string array of all of the components that have changed. If
4994 * the state of the overall package has changed, then it will contain an entry
4995 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004996 */
4997 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4998 "android.intent.extra.changed_component_name_list";
4999
5000 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005001 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08005002 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00005003 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
5004 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
5005 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005006 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005007 */
5008 public static final String EXTRA_CHANGED_PACKAGE_LIST =
5009 "android.intent.extra.changed_package_list";
5010
5011 /**
5012 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08005013 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
5014 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005015 * and contains an integer array of uids of all of the components
5016 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005017 */
5018 public static final String EXTRA_CHANGED_UID_LIST =
5019 "android.intent.extra.changed_uid_list";
5020
5021 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07005022 * @hide
5023 * Magic extra system code can use when binding, to give a label for
5024 * who it is that has bound to a service. This is an integer giving
5025 * a framework string resource that can be displayed to the user.
5026 */
5027 public static final String EXTRA_CLIENT_LABEL =
5028 "android.intent.extra.client_label";
5029
5030 /**
5031 * @hide
5032 * Magic extra system code can use when binding, to give a PendingIntent object
5033 * that can be launched for the user to disable the system's use of this
5034 * service.
5035 */
5036 public static final String EXTRA_CLIENT_INTENT =
5037 "android.intent.extra.client_intent";
5038
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08005039 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005040 * Extra used to indicate that an intent should only return data that is on
5041 * the local device. This is a boolean extra; the default is false. If true,
5042 * an implementation should only allow the user to select data that is
5043 * already on the device, not requiring it be downloaded from a remote
5044 * service when opened.
5045 *
5046 * @see #ACTION_GET_CONTENT
5047 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07005048 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005049 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08005050 */
5051 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005052 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005053
Amith Yamasani13593602012-03-22 16:16:17 -07005054 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005055 * Extra used to indicate that an intent can allow the user to select and
5056 * return multiple items. This is a boolean extra; the default is false. If
5057 * true, an implementation is allowed to present the user with a UI where
5058 * they can pick multiple items that are all returned to the caller. When
5059 * this happens, they should be returned as the {@link #getClipData()} part
5060 * of the result Intent.
5061 *
5062 * @see #ACTION_GET_CONTENT
5063 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08005064 */
5065 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005066 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08005067
5068 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01005069 * The integer userHandle carried with broadcast intents related to addition, removal and
5070 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
5071 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
5072 *
Amith Yamasani13593602012-03-22 16:16:17 -07005073 * @hide
5074 */
Amith Yamasani2a003292012-08-14 18:25:45 -07005075 public static final String EXTRA_USER_HANDLE =
5076 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07005077
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005078 /**
Philip P. Moltmannc54c36d2018-10-08 15:51:07 -07005079 * The UserHandle carried with intents.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01005080 */
5081 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01005082 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01005083
5084 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005085 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07005086 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
5087 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005088 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07005089 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
5090
5091 /**
5092 * Extra sent in the intent to the BroadcastReceiver that handles
5093 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
5094 * the restrictions as key/value pairs.
5095 */
5096 public static final String EXTRA_RESTRICTIONS_BUNDLE =
5097 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005098
Amith Yamasani86118ba2013-03-28 14:33:16 -07005099 /**
5100 * Extra used in the response from a BroadcastReceiver that handles
5101 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
5102 */
5103 public static final String EXTRA_RESTRICTIONS_INTENT =
5104 "android.intent.extra.restrictions_intent";
5105
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07005106 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005107 * Extra used to communicate a set of acceptable MIME types. The type of the
5108 * extra is {@code String[]}. Values may be a combination of concrete MIME
5109 * types (such as "image/png") and/or partial MIME types (such as
5110 * "audio/*").
5111 *
5112 * @see #ACTION_GET_CONTENT
5113 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07005114 */
5115 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
5116
Dianne Hackborn57a7f592013-07-22 18:21:32 -07005117 /**
5118 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
5119 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07005120 * When this is true, hardware devices can use this information to determine that
5121 * they shouldn't do a complete shutdown of their device since this is not a
5122 * complete shutdown down to the kernel, but only user space restarting.
5123 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07005124 */
5125 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
5126 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
5127
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005128 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00005129 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
5130 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
5131 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
5132 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005133 *
5134 * @hide for internal use only.
5135 */
5136 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
5137 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00005138 /** @hide */
5139 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
5140 /** @hide */
5141 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
5142 /** @hide */
5143 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005144
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07005145 /**
5146 * Intent extra: the reason that the operation associated with this intent is being performed.
5147 *
5148 * <p>Type: String
5149 * @hide
5150 */
5151 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07005152 public static final String EXTRA_REASON = "android.intent.extra.REASON";
5153
qingxi240c2bb2017-04-12 17:31:18 -07005154 /**
5155 * {@hide}
5156 * This extra will be send together with {@link #ACTION_FACTORY_RESET}
5157 */
Rubin Xue8490f12015-06-25 12:17:48 +01005158 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
5159
Santos Cordon15a13782015-03-31 18:32:31 -07005160 /**
qingxi240c2bb2017-04-12 17:31:18 -07005161 * {@hide}
5162 * This extra will be set to true when the user choose to wipe the data on eSIM during factory
5163 * reset for the device with eSIM. This extra will be sent together with
5164 * {@link #ACTION_FACTORY_RESET}
5165 */
5166 public static final String EXTRA_WIPE_ESIMS = "com.android.internal.intent.extra.WIPE_ESIMS";
5167
5168 /**
Santos Cordon15a13782015-03-31 18:32:31 -07005169 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
5170 * activation request.
5171 * TODO: Add information about the structure and response data used with the pending intent.
5172 * @hide
5173 */
5174 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
5175 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
5176
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09005177 /**
5178 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09005179 *
5180 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07005181 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09005182 */
Steve McKay6eaf38632015-08-04 10:11:01 -07005183 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
5184
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005185 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09005186 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
5187 * such as opening in other apps, sharing, opening, editing, printing, deleting,
5188 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005189 *
5190 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07005191 * @see #ACTION_QUICK_VIEW
5192 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005193 */
Garfield Tance1d0e92017-03-23 10:52:48 -07005194 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09005195 public static final String EXTRA_QUICK_VIEW_ADVANCED =
5196 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005197
5198 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07005199 * An optional extra of {@code String[]} indicating which quick view features should be made
5200 * available to the user in the quick view UI while handing a
5201 * {@link Intent#ACTION_QUICK_VIEW} intent.
5202 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
5203 * Quick viewer can implement features not listed below.
5204 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
Geoffrey Pitschbc02b772017-12-06 11:24:15 -05005205 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DELETE},
5206 * {@link QuickViewConstants#FEATURE_DOWNLOAD}, {@link QuickViewConstants#FEATURE_SEND},
5207 * {@link QuickViewConstants#FEATURE_PRINT}.
Garfield Tance1d0e92017-03-23 10:52:48 -07005208 * <p>
5209 * Requirements:
5210 * <li>Quick viewer shouldn't show a feature if the feature is absent in
5211 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
5212 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
5213 * internal policies.
5214 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
5215 * requirement that the feature be shown. Quick viewer may, according to its own policies,
5216 * disable or hide features.
5217 *
5218 * @see #ACTION_QUICK_VIEW
5219 */
5220 public static final String EXTRA_QUICK_VIEW_FEATURES =
5221 "android.intent.extra.QUICK_VIEW_FEATURES";
5222
5223 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005224 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01005225 * When a profile goes into quiet mode, all apps in the profile are killed and the
5226 * profile user is stopped. Widgets originating from the profile are masked, and app
5227 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005228 */
5229 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005230
5231 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005232 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005233 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005234 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
5235 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005236 *
5237 * @hide
5238 */
5239 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
5240 "android.intent.extra.MEDIA_RESOURCE_TYPE";
5241
5242 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07005243 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
5244 * whether to show the chooser or not when there is only one application available
5245 * to choose from.
5246 *
5247 * @hide
5248 */
5249 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
5250 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
5251
5252 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005253 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005254 * to represent that a video codec is allowed to use.
5255 *
5256 * @hide
5257 */
5258 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
5259
5260 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005261 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005262 * to represent that a audio codec is allowed to use.
5263 *
5264 * @hide
5265 */
5266 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
5267
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005268 // ---------------------------------------------------------------------
5269 // ---------------------------------------------------------------------
5270 // Intent flags (see mFlags variable).
5271
Tor Norbyed9273d62013-05-30 15:59:53 -07005272 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005273 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005274 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
5275 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07005276 @Retention(RetentionPolicy.SOURCE)
5277 public @interface GrantUriMode {}
5278
Jeff Sharkey846318a2014-04-04 12:12:41 -07005279 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005280 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005281 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
5282 @Retention(RetentionPolicy.SOURCE)
5283 public @interface AccessUriMode {}
5284
5285 /**
5286 * Test if given mode flags specify an access mode, which must be at least
5287 * read and/or write.
5288 *
5289 * @hide
5290 */
5291 public static boolean isAccessUriMode(int modeFlags) {
5292 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
5293 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
5294 }
5295
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005296 /** @hide */
5297 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5298 FLAG_GRANT_READ_URI_PERMISSION,
5299 FLAG_GRANT_WRITE_URI_PERMISSION,
5300 FLAG_FROM_BACKGROUND,
5301 FLAG_DEBUG_LOG_RESOLUTION,
5302 FLAG_EXCLUDE_STOPPED_PACKAGES,
5303 FLAG_INCLUDE_STOPPED_PACKAGES,
5304 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
5305 FLAG_GRANT_PREFIX_URI_PERMISSION,
5306 FLAG_DEBUG_TRIAGED_MISSING,
5307 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005308 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005309 FLAG_ACTIVITY_NO_HISTORY,
5310 FLAG_ACTIVITY_SINGLE_TOP,
5311 FLAG_ACTIVITY_NEW_TASK,
5312 FLAG_ACTIVITY_MULTIPLE_TASK,
5313 FLAG_ACTIVITY_CLEAR_TOP,
5314 FLAG_ACTIVITY_FORWARD_RESULT,
5315 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5316 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5317 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5318 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5319 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5320 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5321 FLAG_ACTIVITY_NEW_DOCUMENT,
5322 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5323 FLAG_ACTIVITY_NO_USER_ACTION,
5324 FLAG_ACTIVITY_REORDER_TO_FRONT,
5325 FLAG_ACTIVITY_NO_ANIMATION,
5326 FLAG_ACTIVITY_CLEAR_TASK,
5327 FLAG_ACTIVITY_TASK_ON_HOME,
5328 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5329 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5330 FLAG_RECEIVER_REGISTERED_ONLY,
5331 FLAG_RECEIVER_REPLACE_PENDING,
5332 FLAG_RECEIVER_FOREGROUND,
5333 FLAG_RECEIVER_NO_ABORT,
5334 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5335 FLAG_RECEIVER_BOOT_UPGRADE,
5336 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5337 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5338 FLAG_RECEIVER_FROM_SHELL,
5339 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
Ng Zhi An150a6ba2018-08-13 09:08:11 -07005340 FLAG_RECEIVER_OFFLOAD,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005341 })
5342 @Retention(RetentionPolicy.SOURCE)
5343 public @interface Flags {}
5344
5345 /** @hide */
5346 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5347 FLAG_FROM_BACKGROUND,
5348 FLAG_DEBUG_LOG_RESOLUTION,
5349 FLAG_EXCLUDE_STOPPED_PACKAGES,
5350 FLAG_INCLUDE_STOPPED_PACKAGES,
5351 FLAG_DEBUG_TRIAGED_MISSING,
5352 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005353 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005354 FLAG_ACTIVITY_NO_HISTORY,
5355 FLAG_ACTIVITY_SINGLE_TOP,
5356 FLAG_ACTIVITY_NEW_TASK,
5357 FLAG_ACTIVITY_MULTIPLE_TASK,
5358 FLAG_ACTIVITY_CLEAR_TOP,
5359 FLAG_ACTIVITY_FORWARD_RESULT,
5360 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5361 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5362 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5363 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5364 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5365 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5366 FLAG_ACTIVITY_NEW_DOCUMENT,
5367 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5368 FLAG_ACTIVITY_NO_USER_ACTION,
5369 FLAG_ACTIVITY_REORDER_TO_FRONT,
5370 FLAG_ACTIVITY_NO_ANIMATION,
5371 FLAG_ACTIVITY_CLEAR_TASK,
5372 FLAG_ACTIVITY_TASK_ON_HOME,
5373 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5374 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5375 FLAG_RECEIVER_REGISTERED_ONLY,
5376 FLAG_RECEIVER_REPLACE_PENDING,
5377 FLAG_RECEIVER_FOREGROUND,
5378 FLAG_RECEIVER_NO_ABORT,
5379 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5380 FLAG_RECEIVER_BOOT_UPGRADE,
5381 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5382 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5383 FLAG_RECEIVER_FROM_SHELL,
5384 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
Ng Zhi An150a6ba2018-08-13 09:08:11 -07005385 FLAG_RECEIVER_OFFLOAD,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005386 })
5387 @Retention(RetentionPolicy.SOURCE)
5388 public @interface MutableFlags {}
5389
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005390 /**
5391 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005392 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005393 * specified in its ClipData. When applying to an Intent's ClipData,
5394 * all URIs as well as recursive traversals through data or other ClipData
5395 * in Intent items will be granted; only the grant flags of the top-level
5396 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005397 */
5398 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5399 /**
5400 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005401 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005402 * specified in its ClipData. When applying to an Intent's ClipData,
5403 * all URIs as well as recursive traversals through data or other ClipData
5404 * in Intent items will be granted; only the grant flags of the top-level
5405 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005406 */
5407 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5408 /**
5409 * Can be set by the caller to indicate that this Intent is coming from
5410 * a background operation, not from direct user interaction.
5411 */
5412 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5413 /**
5414 * A flag you can enable for debugging: when set, log messages will be
5415 * printed during the resolution of this intent to show you what has
5416 * been found to create the final resolved list.
5417 */
5418 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005419 /**
5420 * If set, this intent will not match any components in packages that
5421 * are currently stopped. If this is not set, then the default behavior
5422 * is to include such applications in the result.
5423 */
5424 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5425 /**
5426 * If set, this intent will always match any components in packages that
5427 * are currently stopped. This is the default behavior when
5428 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5429 * flags are set, this one wins (it allows overriding of exclude for
5430 * places where the framework may automatically set the exclude flag).
5431 */
5432 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005433
5434 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005435 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005436 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005437 * persisted across device reboots until explicitly revoked with
5438 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5439 * grant for possible persisting; the receiving application must call
5440 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5441 * actually persist.
5442 *
5443 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5444 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5445 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005446 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005447 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005448 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005449
5450 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005451 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5452 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5453 * applies to any URI that is a prefix match against the original granted
5454 * URI. (Without this flag, the URI must match exactly for access to be
5455 * granted.) Another URI is considered a prefix match only when scheme,
5456 * authority, and all path segments defined by the prefix are an exact
5457 * match.
5458 */
5459 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5460
5461 /**
Jeff Sharkeyc59a5e72018-06-21 19:14:58 -06005462 * Flag used to automatically match intents based on their Direct Boot
5463 * awareness and the current user state.
5464 * <p>
5465 * Since the default behavior is to automatically apply the current user
5466 * state, this is effectively a sentinel value that doesn't change the
5467 * output of any queries based on its presence or absence.
5468 * <p>
5469 * Instead, this value can be useful in conjunction with
5470 * {@link android.os.StrictMode.VmPolicy.Builder#detectImplicitDirectBoot()}
5471 * to detect when a caller is relying on implicit automatic matching,
5472 * instead of confirming the explicit behavior they want.
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005473 */
Jeff Sharkeyc59a5e72018-06-21 19:14:58 -06005474 public static final int FLAG_DIRECT_BOOT_AUTO = 0x00000100;
5475
5476 /** {@hide} */
5477 @Deprecated
5478 public static final int FLAG_DEBUG_TRIAGED_MISSING = FLAG_DIRECT_BOOT_AUTO;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005479
5480 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005481 * Internal flag used to indicate ephemeral applications should not be
5482 * considered when resolving the intent.
5483 *
5484 * @hide
5485 */
5486 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5487
5488 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005489 * If set, the new activity is not kept in the history stack. As soon as
5490 * the user navigates away from it, the activity is finished. This may also
5491 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5492 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005493 *
5494 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5495 * is never invoked when the current activity starts a new activity which
5496 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005497 */
5498 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5499 /**
5500 * If set, the activity will not be launched if it is already running
5501 * at the top of the history stack.
5502 */
5503 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5504 /**
5505 * If set, this activity will become the start of a new task on this
5506 * history stack. A task (from the activity that started it to the
5507 * next task activity) defines an atomic group of activities that the
5508 * user can move to. Tasks can be moved to the foreground and background;
5509 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005510 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005511 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5512 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005513 *
5514 * <p>This flag is generally used by activities that want
5515 * to present a "launcher" style behavior: they give the user a list of
5516 * separate things that can be done, which otherwise run completely
5517 * independently of the activity launching them.
5518 *
5519 * <p>When using this flag, if a task is already running for the activity
5520 * you are now starting, then a new activity will not be started; instead,
5521 * the current task will simply be brought to the front of the screen with
5522 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5523 * to disable this behavior.
5524 *
5525 * <p>This flag can not be used when the caller is requesting a result from
5526 * the activity being launched.
5527 */
5528 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5529 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005530 * This flag is used to create a new task and launch an activity into it.
5531 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5532 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5533 * search through existing tasks for ones matching this Intent. Only if no such
5534 * task is found would a new task be created. When paired with
5535 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5536 * the search for a matching task and unconditionally start a new task.
5537 *
5538 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5539 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005540 * top-level application launcher.</strong> Used in conjunction with
5541 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5542 * behavior of bringing an existing task to the foreground. When set,
5543 * a new task is <em>always</em> started to host the Activity for the
5544 * Intent, regardless of whether there is already an existing task running
5545 * the same thing.
5546 *
5547 * <p><strong>Because the default system does not include graphical task management,
5548 * you should not use this flag unless you provide some way for a user to
5549 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005550 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005551 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5552 * creating new document tasks.
5553 *
5554 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005555 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005556 *
Scott Main7aee61f2011-02-08 11:25:01 -08005557 * <p>See
5558 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5559 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005560 *
5561 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5562 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005563 */
5564 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5565 /**
5566 * If set, and the activity being launched is already running in the
5567 * current task, then instead of launching a new instance of that activity,
5568 * all of the other activities on top of it will be closed and this Intent
5569 * will be delivered to the (now on top) old activity as a new Intent.
5570 *
5571 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5572 * If D calls startActivity() with an Intent that resolves to the component
5573 * of activity B, then C and D will be finished and B receive the given
5574 * Intent, resulting in the stack now being: A, B.
5575 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005576 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005577 * either receive the new intent you are starting here in its
5578 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005579 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005580 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5581 * the same intent, then it will be finished and re-created; for all other
5582 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5583 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005584 *
5585 * <p>This launch mode can also be used to good effect in conjunction with
5586 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5587 * of a task, it will bring any currently running instance of that task
5588 * to the foreground, and then clear it to its root state. This is
5589 * especially useful, for example, when launching an activity from the
5590 * notification manager.
5591 *
Scott Main7aee61f2011-02-08 11:25:01 -08005592 * <p>See
5593 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5594 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005595 */
5596 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5597 /**
5598 * If set and this intent is being used to launch a new activity from an
5599 * existing one, then the reply target of the existing activity will be
kopriva219f7dc2018-10-09 13:42:28 -07005600 * transferred to the new activity. This way, the new activity can call
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005601 * {@link android.app.Activity#setResult} and have that result sent back to
5602 * the reply target of the original activity.
5603 */
5604 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5605 /**
5606 * If set and this intent is being used to launch a new activity from an
5607 * existing one, the current activity will not be counted as the top
5608 * activity for deciding whether the new intent should be delivered to
5609 * the top instead of starting a new one. The previous activity will
5610 * be used as the top, with the assumption being that the current activity
5611 * will finish itself immediately.
5612 */
5613 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5614 /**
5615 * If set, the new activity is not kept in the list of recently launched
5616 * activities.
5617 */
5618 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5619 /**
5620 * This flag is not normally set by application code, but set for you by
5621 * the system as described in the
5622 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5623 * launchMode} documentation for the singleTask mode.
5624 */
5625 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5626 /**
5627 * If set, and this activity is either being started in a new task or
5628 * bringing to the top an existing task, then it will be launched as
5629 * the front door of the task. This will result in the application of
5630 * any affinities needed to have that task in the proper state (either
5631 * moving activities to or from it), or simply resetting that task to
5632 * its initial state if needed.
5633 */
5634 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5635 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005636 * This flag is not normally set by application code, but set for you by
5637 * the system if this activity is being launched from history
5638 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005639 */
5640 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005641 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005642 * @deprecated As of API 21 this performs identically to
5643 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005644 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005645 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005646 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005647 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005648 * This flag is used to open a document into a new task rooted at the activity launched
5649 * by this Intent. Through the use of this flag, or its equivalent attribute,
5650 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005651 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005652 *
Craig Mautner026596b2014-05-21 15:35:44 -07005653 * <p>The use of the activity attribute form of this,
5654 * {@link android.R.attr#documentLaunchMode}, is
5655 * preferred over the Intent flag described here. The attribute form allows the
5656 * Activity to specify multiple document behavior for all launchers of the Activity
5657 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005658 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005659 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5660 * it is kept after the activity is finished is different than the use of
5661 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5662 * this flag is being used to create a new recents entry, then by default that entry
5663 * will be removed once the activity is finished. You can modify this behavior with
5664 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5665 *
Craig Mautner026596b2014-05-21 15:35:44 -07005666 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5667 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5668 * equivalent of the Activity manifest specifying {@link
5669 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5670 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5671 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005672 *
Craig Mautner026596b2014-05-21 15:35:44 -07005673 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005674 *
Craig Mautner026596b2014-05-21 15:35:44 -07005675 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005676 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5677 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005678 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005679 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005680 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005681 * callback from occurring on the current frontmost activity before it is
5682 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005683 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005684 * <p>Typically, an activity can rely on that callback to indicate that an
5685 * explicit user action has caused their activity to be moved out of the
5686 * foreground. The callback marks an appropriate point in the activity's
5687 * lifecycle for it to dismiss any notifications that it intends to display
5688 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005689 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005690 * <p>If an activity is ever started via any non-user-driven events such as
5691 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5692 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005693 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005694 */
5695 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005696 /**
5697 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5698 * this flag will cause the launched activity to be brought to the front of its
5699 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005700 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005701 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5702 * If D calls startActivity() with an Intent that resolves to the component
5703 * of activity B, then B will be brought to the front of the history stack,
5704 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005705 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005706 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005707 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005708 */
5709 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005710 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005711 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5712 * this flag will prevent the system from applying an activity transition
5713 * animation to go to the next activity state. This doesn't mean an
5714 * animation will never run -- if another activity change happens that doesn't
5715 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005716 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005717 * when you are going to do a series of activity operations but the
5718 * animation seen by the user shouldn't be driven by the first activity
5719 * change but rather a later one.
5720 */
5721 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5722 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005723 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5724 * this flag will cause any existing task that would be associated with the
5725 * activity to be cleared before the activity is started. That is, the activity
5726 * becomes the new root of an otherwise empty task, and any old activities
5727 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5728 */
5729 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5730 /**
5731 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5732 * this flag will cause a newly launching task to be placed on top of the current
5733 * home activity task (if there is one). That is, pressing back from the task
5734 * will always return the user to home even if that was not the last activity they
5735 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5736 */
5737 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5738 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005739 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5740 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005741 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005742 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005743 * this flag. When set and the task's activity is finished, the recents
5744 * entry will remain in the interface for the user to re-launch it, like a
5745 * recents entry for a top-level application.
5746 * <p>
5747 * The receiving activity can override this request with
5748 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5749 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005750 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005751 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005752 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005753
5754 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005755 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5756 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005757 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5758 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005759 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005760 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005761
Patrick Baumann577d4022018-01-31 16:55:10 +00005762
5763 /**
Patrick Baumann92ae2c62018-05-10 10:10:26 -07005764 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5765 * this flag will attempt to launch an instant app if no full app on the device can already
5766 * handle the intent.
5767 * <p>
5768 * When attempting to resolve instant apps externally, the following {@link Intent} properties
5769 * are supported:
5770 * <ul>
5771 * <li>{@link Intent#setAction(String)}</li>
5772 * <li>{@link Intent#addCategory(String)}</li>
5773 * <li>{@link Intent#setData(Uri)}</li>
5774 * <li>{@link Intent#setType(String)}</li>
5775 * <li>{@link Intent#setPackage(String)}</li>
5776 * <li>{@link Intent#addFlags(int)}</li>
5777 * </ul>
5778 * <p>
5779 * In the case that no instant app can be found, the installer will be launched to notify the
5780 * user that the intent could not be resolved. On devices that do not support instant apps,
5781 * the flag will be ignored.
Patrick Baumann577d4022018-01-31 16:55:10 +00005782 */
5783 public static final int FLAG_ACTIVITY_MATCH_EXTERNAL = 0x00000800;
5784
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005785 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005786 * If set, when sending a broadcast only registered receivers will be
5787 * called -- no BroadcastReceiver components will be launched.
5788 */
5789 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005790 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005791 * If set, when sending a broadcast the new broadcast will replace
5792 * any existing pending broadcast that matches it. Matching is defined
5793 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5794 * true for the intents of the two broadcasts. When a match is found,
5795 * the new broadcast (and receivers associated with it) will replace the
5796 * existing one in the pending broadcast list, remaining at the same
5797 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005798 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005799 * <p>This flag is most typically used with sticky broadcasts, which
5800 * only care about delivering the most recent values of the broadcast
5801 * to their receivers.
5802 */
5803 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5804 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005805 * If set, when sending a broadcast the recipient is allowed to run at
5806 * foreground priority, with a shorter timeout interval. During normal
5807 * broadcasts the receivers are not automatically hoisted out of the
5808 * background priority class.
5809 */
5810 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5811 /**
Ng Zhi An150a6ba2018-08-13 09:08:11 -07005812 * If set, when sending a broadcast the recipient will be run on the offload queue.
5813 *
5814 * @hide
5815 */
5816 public static final int FLAG_RECEIVER_OFFLOAD = 0x80000000;
5817 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005818 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5819 * They can still propagate results through to later receivers, but they can not prevent
5820 * later receivers from seeing the broadcast.
5821 */
5822 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5823 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005824 * If set, when sending a broadcast <i>before boot has completed</i> only
5825 * registered receivers will be called -- no BroadcastReceiver components
5826 * will be launched. Sticky intent state will be recorded properly even
5827 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5828 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005829 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005830 * <p>This flag is only for use by system sevices as a convenience to
5831 * avoid having to implement a more complex mechanism around detection
5832 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005833 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005834 * @hide
5835 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01005836 @UnsupportedAppUsage
Dianne Hackborn6285a322013-09-18 12:09:47 -07005837 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005838 /**
5839 * Set when this broadcast is for a boot upgrade, a special mode that
5840 * allows the broadcast to be sent before the system is ready and launches
5841 * the app process with no providers running in it.
5842 * @hide
5843 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005844 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005845 /**
5846 * If set, the broadcast will always go to manifest receivers in background (cached
5847 * or not running) apps, regardless of whether that would be done by default. By
5848 * default they will only receive broadcasts if the broadcast has specified an
5849 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005850 *
5851 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5852 * the broadcast code there must also be changed to match.
5853 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005854 * @hide
5855 */
5856 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5857 /**
5858 * If set, the broadcast will never go to manifest receivers in background (cached
5859 * or not running) apps, regardless of whether that would be done by default. By
5860 * default they will receive broadcasts if the broadcast has specified an
5861 * explicit component or package name.
5862 * @hide
5863 */
5864 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005865 /**
5866 * If set, this broadcast is being sent from the shell.
5867 * @hide
5868 */
5869 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005870
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005871 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005872 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5873 * will not receive broadcasts.
5874 *
5875 * <em>This flag has no effect when used by an Instant App.</em>
5876 */
5877 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5878
5879 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005880 * @hide Flags that can't be changed with PendingIntent.
5881 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005882 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5883 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5884 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005885
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005886 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005887 // ---------------------------------------------------------------------
5888 // toUri() and parseUri() options.
5889
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005890 /** @hide */
5891 @IntDef(flag = true, prefix = { "URI_" }, value = {
5892 URI_ALLOW_UNSAFE,
5893 URI_ANDROID_APP_SCHEME,
5894 URI_INTENT_SCHEME,
5895 })
5896 @Retention(RetentionPolicy.SOURCE)
5897 public @interface UriFlags {}
5898
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005899 /**
5900 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5901 * always has the "intent:" scheme. This syntax can be used when you want
5902 * to later disambiguate between URIs that are intended to describe an
5903 * Intent vs. all others that should be treated as raw URIs. When used
5904 * with {@link #parseUri}, any other scheme will result in a generic
5905 * VIEW action for that raw URI.
5906 */
5907 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005908
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005909 /**
5910 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5911 * always has the "android-app:" scheme. This is a variation of
5912 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5913 * http/https URI being delivered to a specific package name. The format
5914 * is:
5915 *
5916 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005917 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005918 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005919 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5920 * you must also include a scheme; including a path also requires both a host and a scheme.
5921 * The final #Intent; fragment can be used without a scheme, host, or path.
5922 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005923 * used with intents that have a {@link #setSelector}, since the base intent
5924 * will always have an explicit package name.</p>
5925 *
5926 * <p>Some examples of how this scheme maps to Intent objects:</p>
5927 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5928 * <colgroup align="left" />
5929 * <colgroup align="left" />
5930 * <thead>
5931 * <tr><th>URI</th> <th>Intent</th></tr>
5932 * </thead>
5933 *
5934 * <tbody>
5935 * <tr><td><code>android-app://com.example.app</code></td>
5936 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5937 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5938 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5939 * </table></td>
5940 * </tr>
5941 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5942 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5943 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5944 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5945 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5946 * </table></td>
5947 * </tr>
5948 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5949 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5950 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5951 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5952 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5953 * </table></td>
5954 * </tr>
5955 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5956 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5957 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5958 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5959 * </table></td>
5960 * </tr>
5961 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5962 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5963 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5964 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5965 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5966 * </table></td>
5967 * </tr>
5968 * <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>
5969 * <td><table border="" style="margin:0" >
5970 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5971 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5972 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5973 * </table></td>
5974 * </tr>
5975 * </tbody>
5976 * </table>
5977 */
5978 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5979
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005980 /**
5981 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5982 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5983 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5984 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5985 * generated Intent can not cause unexpected data access to happen.
5986 *
5987 * <p>If you do not trust the source of the URI being parsed, you should still do further
5988 * processing to protect yourself from it. In particular, when using it to start an
5989 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5990 * that can handle it.</p>
5991 */
5992 public static final int URI_ALLOW_UNSAFE = 1<<2;
5993
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005994 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005995
5996 private String mAction;
5997 private Uri mData;
5998 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005999 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006000 private ComponentName mComponent;
6001 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006002 private ArraySet<String> mCategories;
Mathew Inwood5c0d3542018-08-14 13:54:31 +01006003 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006004 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006005 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006006 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006007 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006008 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07006009 /** Token to track instant app launches. Local only; do not copy cross-process. */
6010 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006011
6012 // ---------------------------------------------------------------------
6013
Makoto Onuki97f82f22017-05-31 16:20:21 -07006014 private static final int COPY_MODE_ALL = 0;
6015 private static final int COPY_MODE_FILTER = 1;
6016 private static final int COPY_MODE_HISTORY = 2;
6017
6018 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07006019 @IntDef(prefix = { "COPY_MODE_" }, value = {
6020 COPY_MODE_ALL,
6021 COPY_MODE_FILTER,
6022 COPY_MODE_HISTORY
6023 })
Makoto Onuki97f82f22017-05-31 16:20:21 -07006024 @Retention(RetentionPolicy.SOURCE)
6025 public @interface CopyMode {}
6026
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006027 /**
6028 * Create an empty intent.
6029 */
6030 public Intent() {
6031 }
6032
6033 /**
6034 * Copy constructor.
6035 */
6036 public Intent(Intent o) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07006037 this(o, COPY_MODE_ALL);
6038 }
6039
6040 private Intent(Intent o, @CopyMode int copyMode) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006041 this.mAction = o.mAction;
6042 this.mData = o.mData;
6043 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006044 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006045 this.mComponent = o.mComponent;
Makoto Onuki97f82f22017-05-31 16:20:21 -07006046
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006047 if (o.mCategories != null) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07006048 this.mCategories = new ArraySet<>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006049 }
Makoto Onuki97f82f22017-05-31 16:20:21 -07006050
6051 if (copyMode != COPY_MODE_FILTER) {
6052 this.mFlags = o.mFlags;
6053 this.mContentUserHint = o.mContentUserHint;
6054 this.mLaunchToken = o.mLaunchToken;
6055 if (o.mSourceBounds != null) {
6056 this.mSourceBounds = new Rect(o.mSourceBounds);
6057 }
6058 if (o.mSelector != null) {
6059 this.mSelector = new Intent(o.mSelector);
6060 }
6061
6062 if (copyMode != COPY_MODE_HISTORY) {
6063 if (o.mExtras != null) {
6064 this.mExtras = new Bundle(o.mExtras);
6065 }
6066 if (o.mClipData != null) {
6067 this.mClipData = new ClipData(o.mClipData);
6068 }
6069 } else {
6070 if (o.mExtras != null && !o.mExtras.maybeIsEmpty()) {
6071 this.mExtras = Bundle.STRIPPED;
6072 }
6073
6074 // Also set "stripped" clip data when we ever log mClipData in the (broadcast)
6075 // history.
6076 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006077 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006078 }
6079
6080 @Override
6081 public Object clone() {
6082 return new Intent(this);
6083 }
6084
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006085 /**
6086 * Make a clone of only the parts of the Intent that are relevant for
6087 * filter matching: the action, data, type, component, and categories.
6088 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006089 public @NonNull Intent cloneFilter() {
Makoto Onuki97f82f22017-05-31 16:20:21 -07006090 return new Intent(this, COPY_MODE_FILTER);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006091 }
6092
6093 /**
6094 * Create an intent with a given action. All other fields (data, type,
6095 * class) are null. Note that the action <em>must</em> be in a
6096 * namespace because Intents are used globally in the system -- for
6097 * example the system VIEW action is android.intent.action.VIEW; an
6098 * application's custom action would be something like
6099 * com.google.app.myapp.CUSTOM_ACTION.
6100 *
6101 * @param action The Intent action, such as ACTION_VIEW.
6102 */
6103 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006104 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006105 }
6106
6107 /**
6108 * Create an intent with a given action and for a given data url. Note
6109 * that the action <em>must</em> be in a namespace because Intents are
6110 * used globally in the system -- for example the system VIEW action is
6111 * android.intent.action.VIEW; an application's custom action would be
6112 * something like com.google.app.myapp.CUSTOM_ACTION.
6113 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006114 * <p><em>Note: scheme and host name matching in the Android framework is
6115 * case-sensitive, unlike the formal RFC. As a result,
6116 * you should always ensure that you write your Uri with these elements
6117 * using lower case letters, and normalize any Uris you receive from
6118 * outside of Android to ensure the scheme and host is lower case.</em></p>
6119 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006120 * @param action The Intent action, such as ACTION_VIEW.
6121 * @param uri The Intent data URI.
6122 */
6123 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006124 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006125 mData = uri;
6126 }
6127
6128 /**
6129 * Create an intent for a specific component. All other fields (action, data,
6130 * type, class) are null, though they can be modified later with explicit
6131 * calls. This provides a convenient way to create an intent that is
6132 * intended to execute a hard-coded class name, rather than relying on the
6133 * system to find an appropriate class for you; see {@link #setComponent}
6134 * for more information on the repercussions of this.
6135 *
6136 * @param packageContext A Context of the application package implementing
6137 * this class.
6138 * @param cls The component class that is to be used for the intent.
6139 *
6140 * @see #setClass
6141 * @see #setComponent
6142 * @see #Intent(String, android.net.Uri , Context, Class)
6143 */
6144 public Intent(Context packageContext, Class<?> cls) {
6145 mComponent = new ComponentName(packageContext, cls);
6146 }
6147
6148 /**
6149 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07006150 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006151 * construct the Intent and then calling {@link #setClass} to set its
6152 * class.
6153 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006154 * <p><em>Note: scheme and host name matching in the Android framework is
6155 * case-sensitive, unlike the formal RFC. As a result,
6156 * you should always ensure that you write your Uri with these elements
6157 * using lower case letters, and normalize any Uris you receive from
6158 * outside of Android to ensure the scheme and host is lower case.</em></p>
6159 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006160 * @param action The Intent action, such as ACTION_VIEW.
6161 * @param uri The Intent data URI.
6162 * @param packageContext A Context of the application package implementing
6163 * this class.
6164 * @param cls The component class that is to be used for the intent.
6165 *
6166 * @see #Intent(String, android.net.Uri)
6167 * @see #Intent(Context, Class)
6168 * @see #setClass
6169 * @see #setComponent
6170 */
6171 public Intent(String action, Uri uri,
6172 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006173 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006174 mData = uri;
6175 mComponent = new ComponentName(packageContext, cls);
6176 }
6177
6178 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08006179 * Create an intent to launch the main (root) activity of a task. This
6180 * is the Intent that is started when the application's is launched from
6181 * Home. For anything else that wants to launch an application in the
6182 * same way, it is important that they use an Intent structured the same
6183 * way, and can use this function to ensure this is the case.
6184 *
6185 * <p>The returned Intent has the given Activity component as its explicit
6186 * component, {@link #ACTION_MAIN} as its action, and includes the
6187 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
6188 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
6189 * to do that through {@link #addFlags(int)} on the returned Intent.
6190 *
6191 * @param mainActivity The main activity component that this Intent will
6192 * launch.
6193 * @return Returns a newly created Intent that can be used to launch the
6194 * activity as a main application entry.
6195 *
6196 * @see #setClass
6197 * @see #setComponent
6198 */
6199 public static Intent makeMainActivity(ComponentName mainActivity) {
6200 Intent intent = new Intent(ACTION_MAIN);
6201 intent.setComponent(mainActivity);
6202 intent.addCategory(CATEGORY_LAUNCHER);
6203 return intent;
6204 }
6205
6206 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006207 * Make an Intent for the main activity of an application, without
6208 * specifying a specific activity to run but giving a selector to find
6209 * the activity. This results in a final Intent that is structured
6210 * the same as when the application is launched from
6211 * Home. For anything else that wants to launch an application in the
6212 * same way, it is important that they use an Intent structured the same
6213 * way, and can use this function to ensure this is the case.
6214 *
6215 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
6216 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
6217 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
6218 * to do that through {@link #addFlags(int)} on the returned Intent.
6219 *
6220 * @param selectorAction The action name of the Intent's selector.
6221 * @param selectorCategory The name of a category to add to the Intent's
6222 * selector.
6223 * @return Returns a newly created Intent that can be used to launch the
6224 * activity as a main application entry.
6225 *
6226 * @see #setSelector(Intent)
6227 */
6228 public static Intent makeMainSelectorActivity(String selectorAction,
6229 String selectorCategory) {
6230 Intent intent = new Intent(ACTION_MAIN);
6231 intent.addCategory(CATEGORY_LAUNCHER);
6232 Intent selector = new Intent();
6233 selector.setAction(selectorAction);
6234 selector.addCategory(selectorCategory);
6235 intent.setSelector(selector);
6236 return intent;
6237 }
6238
6239 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08006240 * Make an Intent that can be used to re-launch an application's task
6241 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
6242 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
6243 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
6244 *
6245 * @param mainActivity The activity component that is the root of the
6246 * task; this is the activity that has been published in the application's
6247 * manifest as the main launcher icon.
6248 *
6249 * @return Returns a newly created Intent that can be used to relaunch the
6250 * activity's task in its root state.
6251 */
6252 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
6253 Intent intent = makeMainActivity(mainActivity);
6254 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
6255 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
6256 return intent;
6257 }
6258
6259 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006260 * Call {@link #parseUri} with 0 flags.
6261 * @deprecated Use {@link #parseUri} instead.
6262 */
6263 @Deprecated
6264 public static Intent getIntent(String uri) throws URISyntaxException {
6265 return parseUri(uri, 0);
6266 }
Tom Taylord4a47292009-12-21 13:59:18 -08006267
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006268 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006269 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006270 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07006271 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006272 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006273 *
6274 * <p>The URI given here must not be relative -- that is, it must include
6275 * the scheme and full path.
6276 *
6277 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006278 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006279 *
6280 * @return Intent The newly created Intent object.
6281 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006282 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
6283 * it bad (as parsed by the Uri class) or the Intent data within the
6284 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08006285 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006286 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006287 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006288 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006289 int i = 0;
6290 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006291 final boolean androidApp = uri.startsWith("android-app:");
6292
6293 // Validate intent scheme if requested.
6294 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
6295 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006296 Intent intent = new Intent(ACTION_VIEW);
6297 try {
6298 intent.setData(Uri.parse(uri));
6299 } catch (IllegalArgumentException e) {
6300 throw new URISyntaxException(uri, e.getMessage());
6301 }
6302 return intent;
6303 }
6304 }
Tom Taylord4a47292009-12-21 13:59:18 -08006305
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006306 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006307 // simple case
6308 if (i == -1) {
6309 if (!androidApp) {
6310 return new Intent(ACTION_VIEW, Uri.parse(uri));
6311 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006312
6313 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006314 } else if (!uri.startsWith("#Intent;", i)) {
6315 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006316 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006317 } else {
6318 i = -1;
6319 }
6320 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006321
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006322 // new format
6323 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006324 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006325 boolean explicitAction = false;
6326 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006327
6328 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006329 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006330 String data;
6331 if (i >= 0) {
6332 data = uri.substring(0, i);
6333 i += 8; // length of "#Intent;"
6334 } else {
6335 data = uri;
6336 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006337
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006338 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006339 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006340 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006341 if (eq < 0) eq = i-1;
6342 int semi = uri.indexOf(';', i);
6343 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006344
6345 // action
6346 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006347 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006348 if (!inSelector) {
6349 explicitAction = true;
6350 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006351 }
6352
6353 // categories
6354 else if (uri.startsWith("category=", i)) {
6355 intent.addCategory(value);
6356 }
6357
6358 // type
6359 else if (uri.startsWith("type=", i)) {
6360 intent.mType = value;
6361 }
6362
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006363 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006364 else if (uri.startsWith("launchFlags=", i)) {
6365 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006366 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6367 intent.mFlags &= ~IMMUTABLE_FLAGS;
6368 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006369 }
6370
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006371 // package
6372 else if (uri.startsWith("package=", i)) {
6373 intent.mPackage = value;
6374 }
6375
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006376 // component
6377 else if (uri.startsWith("component=", i)) {
6378 intent.mComponent = ComponentName.unflattenFromString(value);
6379 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006380
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006381 // scheme
6382 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006383 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006384 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006385 } else {
6386 scheme = value;
6387 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006388 }
6389
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006390 // source bounds
6391 else if (uri.startsWith("sourceBounds=", i)) {
6392 intent.mSourceBounds = Rect.unflattenFromString(value);
6393 }
6394
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006395 // selector
6396 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
6397 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006398 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006399 }
6400
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006401 // extra
6402 else {
6403 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006404 // create Bundle if it doesn't already exist
6405 if (intent.mExtras == null) intent.mExtras = new Bundle();
6406 Bundle b = intent.mExtras;
6407 // add EXTRA
6408 if (uri.startsWith("S.", i)) b.putString(key, value);
6409 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
6410 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
6411 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
6412 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
6413 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
6414 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
6415 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
6416 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
6417 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
6418 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006419
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006420 // move to the next item
6421 i = semi + 1;
6422 }
6423
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006424 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006425 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006426 if (baseIntent.mPackage == null) {
6427 baseIntent.setSelector(intent);
6428 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006429 intent = baseIntent;
6430 }
6431
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006432 if (data != null) {
6433 if (data.startsWith("intent:")) {
6434 data = data.substring(7);
6435 if (scheme != null) {
6436 data = scheme + ':' + data;
6437 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006438 } else if (data.startsWith("android-app:")) {
6439 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
6440 // Correctly formed android-app, first part is package name.
6441 int end = data.indexOf('/', 14);
6442 if (end < 0) {
6443 // All we have is a package name.
6444 intent.mPackage = data.substring(14);
6445 if (!explicitAction) {
6446 intent.setAction(ACTION_MAIN);
6447 }
6448 data = "";
6449 } else {
6450 // Target the Intent at the given package name always.
6451 String authority = null;
6452 intent.mPackage = data.substring(14, end);
6453 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006454 if ((end+1) < data.length()) {
6455 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6456 // Found a scheme, remember it.
6457 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006458 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006459 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6460 // Found a authority, remember it.
6461 authority = data.substring(end+1, newEnd);
6462 end = newEnd;
6463 }
6464 } else {
6465 // All we have is a scheme.
6466 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006467 }
6468 }
6469 if (scheme == null) {
6470 // If there was no scheme, then this just targets the package.
6471 if (!explicitAction) {
6472 intent.setAction(ACTION_MAIN);
6473 }
6474 data = "";
6475 } else if (authority == null) {
6476 data = scheme + ":";
6477 } else {
6478 data = scheme + "://" + authority + data.substring(end);
6479 }
6480 }
6481 } else {
6482 data = "";
6483 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006484 }
Tom Taylord4a47292009-12-21 13:59:18 -08006485
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006486 if (data.length() > 0) {
6487 try {
6488 intent.mData = Uri.parse(data);
6489 } catch (IllegalArgumentException e) {
6490 throw new URISyntaxException(uri, e.getMessage());
6491 }
6492 }
6493 }
Tom Taylord4a47292009-12-21 13:59:18 -08006494
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006495 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006496
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006497 } catch (IndexOutOfBoundsException e) {
6498 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6499 }
6500 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006501
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006502 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006503 return getIntentOld(uri, 0);
6504 }
6505
6506 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006507 Intent intent;
6508
6509 int i = uri.lastIndexOf('#');
6510 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006511 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006512 final int intentFragmentStart = i;
6513 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006514
6515 i++;
6516
6517 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006518 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006519 i += 7;
6520 int j = uri.indexOf(')', i);
6521 action = uri.substring(i, j);
6522 i = j + 1;
6523 }
6524
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006525 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006526
6527 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006528 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006529 i += 11;
6530 int j = uri.indexOf(')', i);
6531 while (i < j) {
6532 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006533 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006534 if (i < sep) {
6535 intent.addCategory(uri.substring(i, sep));
6536 }
6537 i = sep + 1;
6538 }
6539 i = j + 1;
6540 }
6541
6542 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006543 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006544 i += 5;
6545 int j = uri.indexOf(')', i);
6546 intent.mType = uri.substring(i, j);
6547 i = j + 1;
6548 }
6549
6550 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006551 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006552 i += 12;
6553 int j = uri.indexOf(')', i);
6554 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006555 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6556 intent.mFlags &= ~IMMUTABLE_FLAGS;
6557 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006558 i = j + 1;
6559 }
6560
6561 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006562 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006563 i += 10;
6564 int j = uri.indexOf(')', i);
6565 int sep = uri.indexOf('!', i);
6566 if (sep >= 0 && sep < j) {
6567 String pkg = uri.substring(i, sep);
6568 String cls = uri.substring(sep + 1, j);
6569 intent.mComponent = new ComponentName(pkg, cls);
6570 }
6571 i = j + 1;
6572 }
6573
6574 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006575 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006576 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006577
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006578 final int closeParen = uri.indexOf(')', i);
6579 if (closeParen == -1) throw new URISyntaxException(uri,
6580 "EXTRA missing trailing ')'", i);
6581
6582 while (i < closeParen) {
6583 // fetch the key value
6584 int j = uri.indexOf('=', i);
6585 if (j <= i + 1 || i >= closeParen) {
6586 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6587 }
6588 char type = uri.charAt(i);
6589 i++;
6590 String key = uri.substring(i, j);
6591 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006592
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006593 // get type-value
6594 j = uri.indexOf('!', i);
6595 if (j == -1 || j >= closeParen) j = closeParen;
6596 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6597 String value = uri.substring(i, j);
6598 i = j;
6599
6600 // create Bundle if it doesn't already exist
6601 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006602
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006603 // add item to bundle
6604 try {
6605 switch (type) {
6606 case 'S':
6607 intent.mExtras.putString(key, Uri.decode(value));
6608 break;
6609 case 'B':
6610 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6611 break;
6612 case 'b':
6613 intent.mExtras.putByte(key, Byte.parseByte(value));
6614 break;
6615 case 'c':
6616 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6617 break;
6618 case 'd':
6619 intent.mExtras.putDouble(key, Double.parseDouble(value));
6620 break;
6621 case 'f':
6622 intent.mExtras.putFloat(key, Float.parseFloat(value));
6623 break;
6624 case 'i':
6625 intent.mExtras.putInt(key, Integer.parseInt(value));
6626 break;
6627 case 'l':
6628 intent.mExtras.putLong(key, Long.parseLong(value));
6629 break;
6630 case 's':
6631 intent.mExtras.putShort(key, Short.parseShort(value));
6632 break;
6633 default:
6634 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6635 }
6636 } catch (NumberFormatException e) {
6637 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6638 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006639
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006640 char ch = uri.charAt(i);
6641 if (ch == ')') break;
6642 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6643 i++;
6644 }
6645 }
6646
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006647 if (isIntentFragment) {
6648 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6649 } else {
6650 intent.mData = Uri.parse(uri);
6651 }
Tom Taylord4a47292009-12-21 13:59:18 -08006652
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006653 if (intent.mAction == null) {
6654 // By default, if no action is specified, then use VIEW.
6655 intent.mAction = ACTION_VIEW;
6656 }
6657
6658 } else {
6659 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6660 }
6661
6662 return intent;
6663 }
6664
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006665 /** @hide */
6666 public interface CommandOptionHandler {
6667 boolean handleOption(String opt, ShellCommand cmd);
6668 }
6669
6670 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01006671 @UnsupportedAppUsage
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006672 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6673 throws URISyntaxException {
6674 Intent intent = new Intent();
6675 Intent baseIntent = intent;
6676 boolean hasIntentInfo = false;
6677
6678 Uri data = null;
6679 String type = null;
6680
6681 String opt;
6682 while ((opt=cmd.getNextOption()) != null) {
6683 switch (opt) {
6684 case "-a":
6685 intent.setAction(cmd.getNextArgRequired());
6686 if (intent == baseIntent) {
6687 hasIntentInfo = true;
6688 }
6689 break;
6690 case "-d":
6691 data = Uri.parse(cmd.getNextArgRequired());
6692 if (intent == baseIntent) {
6693 hasIntentInfo = true;
6694 }
6695 break;
6696 case "-t":
6697 type = cmd.getNextArgRequired();
6698 if (intent == baseIntent) {
6699 hasIntentInfo = true;
6700 }
6701 break;
6702 case "-c":
6703 intent.addCategory(cmd.getNextArgRequired());
6704 if (intent == baseIntent) {
6705 hasIntentInfo = true;
6706 }
6707 break;
6708 case "-e":
6709 case "--es": {
6710 String key = cmd.getNextArgRequired();
6711 String value = cmd.getNextArgRequired();
6712 intent.putExtra(key, value);
6713 }
6714 break;
6715 case "--esn": {
6716 String key = cmd.getNextArgRequired();
6717 intent.putExtra(key, (String) null);
6718 }
6719 break;
6720 case "--ei": {
6721 String key = cmd.getNextArgRequired();
6722 String value = cmd.getNextArgRequired();
6723 intent.putExtra(key, Integer.decode(value));
6724 }
6725 break;
6726 case "--eu": {
6727 String key = cmd.getNextArgRequired();
6728 String value = cmd.getNextArgRequired();
6729 intent.putExtra(key, Uri.parse(value));
6730 }
6731 break;
6732 case "--ecn": {
6733 String key = cmd.getNextArgRequired();
6734 String value = cmd.getNextArgRequired();
6735 ComponentName cn = ComponentName.unflattenFromString(value);
6736 if (cn == null)
6737 throw new IllegalArgumentException("Bad component name: " + value);
6738 intent.putExtra(key, cn);
6739 }
6740 break;
6741 case "--eia": {
6742 String key = cmd.getNextArgRequired();
6743 String value = cmd.getNextArgRequired();
6744 String[] strings = value.split(",");
6745 int[] list = new int[strings.length];
6746 for (int i = 0; i < strings.length; i++) {
6747 list[i] = Integer.decode(strings[i]);
6748 }
6749 intent.putExtra(key, list);
6750 }
6751 break;
6752 case "--eial": {
6753 String key = cmd.getNextArgRequired();
6754 String value = cmd.getNextArgRequired();
6755 String[] strings = value.split(",");
6756 ArrayList<Integer> list = new ArrayList<>(strings.length);
6757 for (int i = 0; i < strings.length; i++) {
6758 list.add(Integer.decode(strings[i]));
6759 }
6760 intent.putExtra(key, list);
6761 }
6762 break;
6763 case "--el": {
6764 String key = cmd.getNextArgRequired();
6765 String value = cmd.getNextArgRequired();
6766 intent.putExtra(key, Long.valueOf(value));
6767 }
6768 break;
6769 case "--ela": {
6770 String key = cmd.getNextArgRequired();
6771 String value = cmd.getNextArgRequired();
6772 String[] strings = value.split(",");
6773 long[] list = new long[strings.length];
6774 for (int i = 0; i < strings.length; i++) {
6775 list[i] = Long.valueOf(strings[i]);
6776 }
6777 intent.putExtra(key, list);
6778 hasIntentInfo = true;
6779 }
6780 break;
6781 case "--elal": {
6782 String key = cmd.getNextArgRequired();
6783 String value = cmd.getNextArgRequired();
6784 String[] strings = value.split(",");
6785 ArrayList<Long> list = new ArrayList<>(strings.length);
6786 for (int i = 0; i < strings.length; i++) {
6787 list.add(Long.valueOf(strings[i]));
6788 }
6789 intent.putExtra(key, list);
6790 hasIntentInfo = true;
6791 }
6792 break;
6793 case "--ef": {
6794 String key = cmd.getNextArgRequired();
6795 String value = cmd.getNextArgRequired();
6796 intent.putExtra(key, Float.valueOf(value));
6797 hasIntentInfo = true;
6798 }
6799 break;
6800 case "--efa": {
6801 String key = cmd.getNextArgRequired();
6802 String value = cmd.getNextArgRequired();
6803 String[] strings = value.split(",");
6804 float[] list = new float[strings.length];
6805 for (int i = 0; i < strings.length; i++) {
6806 list[i] = Float.valueOf(strings[i]);
6807 }
6808 intent.putExtra(key, list);
6809 hasIntentInfo = true;
6810 }
6811 break;
6812 case "--efal": {
6813 String key = cmd.getNextArgRequired();
6814 String value = cmd.getNextArgRequired();
6815 String[] strings = value.split(",");
6816 ArrayList<Float> list = new ArrayList<>(strings.length);
6817 for (int i = 0; i < strings.length; i++) {
6818 list.add(Float.valueOf(strings[i]));
6819 }
6820 intent.putExtra(key, list);
6821 hasIntentInfo = true;
6822 }
6823 break;
6824 case "--esa": {
6825 String key = cmd.getNextArgRequired();
6826 String value = cmd.getNextArgRequired();
6827 // Split on commas unless they are preceeded by an escape.
6828 // The escape character must be escaped for the string and
6829 // again for the regex, thus four escape characters become one.
6830 String[] strings = value.split("(?<!\\\\),");
6831 intent.putExtra(key, strings);
6832 hasIntentInfo = true;
6833 }
6834 break;
6835 case "--esal": {
6836 String key = cmd.getNextArgRequired();
6837 String value = cmd.getNextArgRequired();
6838 // Split on commas unless they are preceeded by an escape.
6839 // The escape character must be escaped for the string and
6840 // again for the regex, thus four escape characters become one.
6841 String[] strings = value.split("(?<!\\\\),");
6842 ArrayList<String> list = new ArrayList<>(strings.length);
6843 for (int i = 0; i < strings.length; i++) {
6844 list.add(strings[i]);
6845 }
6846 intent.putExtra(key, list);
6847 hasIntentInfo = true;
6848 }
6849 break;
6850 case "--ez": {
6851 String key = cmd.getNextArgRequired();
6852 String value = cmd.getNextArgRequired().toLowerCase();
6853 // Boolean.valueOf() results in false for anything that is not "true", which is
6854 // error-prone in shell commands
6855 boolean arg;
6856 if ("true".equals(value) || "t".equals(value)) {
6857 arg = true;
6858 } else if ("false".equals(value) || "f".equals(value)) {
6859 arg = false;
6860 } else {
6861 try {
6862 arg = Integer.decode(value) != 0;
6863 } catch (NumberFormatException ex) {
6864 throw new IllegalArgumentException("Invalid boolean value: " + value);
6865 }
6866 }
6867
6868 intent.putExtra(key, arg);
6869 }
6870 break;
6871 case "-n": {
6872 String str = cmd.getNextArgRequired();
6873 ComponentName cn = ComponentName.unflattenFromString(str);
6874 if (cn == null)
6875 throw new IllegalArgumentException("Bad component name: " + str);
6876 intent.setComponent(cn);
6877 if (intent == baseIntent) {
6878 hasIntentInfo = true;
6879 }
6880 }
6881 break;
6882 case "-p": {
6883 String str = cmd.getNextArgRequired();
6884 intent.setPackage(str);
6885 if (intent == baseIntent) {
6886 hasIntentInfo = true;
6887 }
6888 }
6889 break;
6890 case "-f":
6891 String str = cmd.getNextArgRequired();
6892 intent.setFlags(Integer.decode(str).intValue());
6893 break;
6894 case "--grant-read-uri-permission":
6895 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6896 break;
6897 case "--grant-write-uri-permission":
6898 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6899 break;
6900 case "--grant-persistable-uri-permission":
6901 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6902 break;
6903 case "--grant-prefix-uri-permission":
6904 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6905 break;
6906 case "--exclude-stopped-packages":
6907 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6908 break;
6909 case "--include-stopped-packages":
6910 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6911 break;
6912 case "--debug-log-resolution":
6913 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6914 break;
6915 case "--activity-brought-to-front":
6916 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6917 break;
6918 case "--activity-clear-top":
6919 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6920 break;
6921 case "--activity-clear-when-task-reset":
6922 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6923 break;
6924 case "--activity-exclude-from-recents":
6925 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6926 break;
6927 case "--activity-launched-from-history":
6928 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6929 break;
6930 case "--activity-multiple-task":
6931 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6932 break;
6933 case "--activity-no-animation":
6934 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6935 break;
6936 case "--activity-no-history":
6937 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6938 break;
6939 case "--activity-no-user-action":
6940 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6941 break;
6942 case "--activity-previous-is-top":
6943 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6944 break;
6945 case "--activity-reorder-to-front":
6946 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6947 break;
6948 case "--activity-reset-task-if-needed":
6949 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6950 break;
6951 case "--activity-single-top":
6952 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6953 break;
6954 case "--activity-clear-task":
6955 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6956 break;
6957 case "--activity-task-on-home":
6958 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6959 break;
Patrick Baumann229141f2018-04-06 13:53:25 -07006960 case "--activity-match-external":
6961 intent.addFlags(Intent.FLAG_ACTIVITY_MATCH_EXTERNAL);
6962 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006963 case "--receiver-registered-only":
6964 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6965 break;
6966 case "--receiver-replace-pending":
6967 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6968 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006969 case "--receiver-foreground":
6970 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6971 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006972 case "--receiver-no-abort":
6973 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6974 break;
6975 case "--receiver-include-background":
6976 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6977 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006978 case "--selector":
6979 intent.setDataAndType(data, type);
6980 intent = new Intent();
6981 break;
6982 default:
6983 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6984 // Okay, caller handled this option.
6985 } else {
6986 throw new IllegalArgumentException("Unknown option: " + opt);
6987 }
6988 break;
6989 }
6990 }
6991 intent.setDataAndType(data, type);
6992
6993 final boolean hasSelector = intent != baseIntent;
6994 if (hasSelector) {
6995 // A selector was specified; fix up.
6996 baseIntent.setSelector(intent);
6997 intent = baseIntent;
6998 }
6999
7000 String arg = cmd.getNextArg();
7001 baseIntent = null;
7002 if (arg == null) {
7003 if (hasSelector) {
7004 // If a selector has been specified, and no arguments
7005 // have been supplied for the main Intent, then we can
7006 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
7007 // need to have a component name specified yet, the
7008 // selector will take care of that.
7009 baseIntent = new Intent(Intent.ACTION_MAIN);
7010 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
7011 }
7012 } else if (arg.indexOf(':') >= 0) {
7013 // The argument is a URI. Fully parse it, and use that result
7014 // to fill in any data not specified so far.
7015 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
7016 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
7017 } else if (arg.indexOf('/') >= 0) {
7018 // The argument is a component name. Build an Intent to launch
7019 // it.
7020 baseIntent = new Intent(Intent.ACTION_MAIN);
7021 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
7022 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
7023 } else {
7024 // Assume the argument is a package name.
7025 baseIntent = new Intent(Intent.ACTION_MAIN);
7026 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
7027 baseIntent.setPackage(arg);
7028 }
7029 if (baseIntent != null) {
7030 Bundle extras = intent.getExtras();
7031 intent.replaceExtras((Bundle)null);
7032 Bundle uriExtras = baseIntent.getExtras();
7033 baseIntent.replaceExtras((Bundle)null);
7034 if (intent.getAction() != null && baseIntent.getCategories() != null) {
7035 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
7036 for (String c : cats) {
7037 baseIntent.removeCategory(c);
7038 }
7039 }
7040 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
7041 if (extras == null) {
7042 extras = uriExtras;
7043 } else if (uriExtras != null) {
7044 uriExtras.putAll(extras);
7045 extras = uriExtras;
7046 }
7047 intent.replaceExtras(extras);
7048 hasIntentInfo = true;
7049 }
7050
7051 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
7052 return intent;
7053 }
7054
7055 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007056 @UnsupportedAppUsage
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007057 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
7058 final String[] lines = new String[] {
7059 "<INTENT> specifications include these flags and arguments:",
7060 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
7061 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
Felipe Leme4e02e252018-04-20 11:25:59 -07007062 " [-n <COMPONENT_NAME>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007063 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
7064 " [--esn <EXTRA_KEY> ...]",
7065 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
7066 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
7067 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
7068 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
7069 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
7070 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
7071 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
7072 " (mutiple extras passed as Integer[])",
7073 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
7074 " (mutiple extras passed as List<Integer>)",
7075 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
7076 " (mutiple extras passed as Long[])",
7077 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
7078 " (mutiple extras passed as List<Long>)",
7079 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
7080 " (mutiple extras passed as Float[])",
7081 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
7082 " (mutiple extras passed as List<Float>)",
7083 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
7084 " (mutiple extras passed as String[]; to embed a comma into a string,",
7085 " escape it using \"\\,\")",
7086 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
7087 " (mutiple extras passed as List<String>; to embed a comma into a string,",
7088 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08007089 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007090 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
7091 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
7092 " [--debug-log-resolution] [--exclude-stopped-packages]",
7093 " [--include-stopped-packages]",
7094 " [--activity-brought-to-front] [--activity-clear-top]",
7095 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
7096 " [--activity-launched-from-history] [--activity-multiple-task]",
7097 " [--activity-no-animation] [--activity-no-history]",
7098 " [--activity-no-user-action] [--activity-previous-is-top]",
7099 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
7100 " [--activity-single-top] [--activity-clear-task]",
Patrick Baumann229141f2018-04-06 13:53:25 -07007101 " [--activity-task-on-home] [--activity-match-external]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007102 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08007103 " [--receiver-foreground] [--receiver-no-abort]",
7104 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007105 " [--selector]",
7106 " [<URI> | <PACKAGE> | <COMPONENT>]"
7107 };
7108 for (String line : lines) {
7109 pw.print(prefix);
7110 pw.println(line);
7111 }
7112 }
7113
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007114 /**
7115 * Retrieve the general action to be performed, such as
7116 * {@link #ACTION_VIEW}. The action describes the general way the rest of
7117 * the information in the intent should be interpreted -- most importantly,
7118 * what to do with the data returned by {@link #getData}.
7119 *
7120 * @return The action of this intent or null if none is specified.
7121 *
7122 * @see #setAction
7123 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007124 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007125 return mAction;
7126 }
7127
7128 /**
7129 * Retrieve data this intent is operating on. This URI specifies the name
7130 * of the data; often it uses the content: scheme, specifying data in a
7131 * content provider. Other schemes may be handled by specific activities,
7132 * such as http: by the web browser.
7133 *
7134 * @return The URI of the data this intent is targeting or null.
7135 *
7136 * @see #getScheme
7137 * @see #setData
7138 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007139 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007140 return mData;
7141 }
7142
7143 /**
7144 * The same as {@link #getData()}, but returns the URI as an encoded
7145 * String.
7146 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007147 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007148 return mData != null ? mData.toString() : null;
7149 }
7150
7151 /**
7152 * Return the scheme portion of the intent's data. If the data is null or
7153 * does not include a scheme, null is returned. Otherwise, the scheme
7154 * prefix without the final ':' is returned, i.e. "http".
7155 *
7156 * <p>This is the same as calling getData().getScheme() (and checking for
7157 * null data).
7158 *
7159 * @return The scheme of this intent.
7160 *
7161 * @see #getData
7162 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007163 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007164 return mData != null ? mData.getScheme() : null;
7165 }
7166
7167 /**
7168 * Retrieve any explicit MIME type included in the intent. This is usually
7169 * null, as the type is determined by the intent data.
7170 *
7171 * @return If a type was manually set, it is returned; else null is
7172 * returned.
7173 *
7174 * @see #resolveType(ContentResolver)
7175 * @see #setType
7176 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007177 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007178 return mType;
7179 }
7180
7181 /**
7182 * Return the MIME data type of this intent. If the type field is
7183 * explicitly set, that is simply returned. Otherwise, if the data is set,
7184 * the type of that data is returned. If neither fields are set, a null is
7185 * returned.
7186 *
7187 * @return The MIME type of this intent.
7188 *
7189 * @see #getType
7190 * @see #resolveType(ContentResolver)
7191 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007192 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007193 return resolveType(context.getContentResolver());
7194 }
7195
7196 /**
7197 * Return the MIME data type of this intent. If the type field is
7198 * explicitly set, that is simply returned. Otherwise, if the data is set,
7199 * the type of that data is returned. If neither fields are set, a null is
7200 * returned.
7201 *
7202 * @param resolver A ContentResolver that can be used to determine the MIME
7203 * type of the intent's data.
7204 *
7205 * @return The MIME type of this intent.
7206 *
7207 * @see #getType
7208 * @see #resolveType(Context)
7209 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007210 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007211 if (mType != null) {
7212 return mType;
7213 }
7214 if (mData != null) {
7215 if ("content".equals(mData.getScheme())) {
7216 return resolver.getType(mData);
7217 }
7218 }
7219 return null;
7220 }
7221
7222 /**
7223 * Return the MIME data type of this intent, only if it will be needed for
7224 * intent resolution. This is not generally useful for application code;
7225 * it is used by the frameworks for communicating with back-end system
7226 * services.
7227 *
7228 * @param resolver A ContentResolver that can be used to determine the MIME
7229 * type of the intent's data.
7230 *
7231 * @return The MIME type of this intent, or null if it is unknown or not
7232 * needed.
7233 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007234 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007235 if (mComponent != null) {
7236 return mType;
7237 }
7238 return resolveType(resolver);
7239 }
7240
7241 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007242 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007243 *
7244 * @param category The category to check.
7245 *
7246 * @return boolean True if the intent contains the category, else false.
7247 *
7248 * @see #getCategories
7249 * @see #addCategory
7250 */
7251 public boolean hasCategory(String category) {
7252 return mCategories != null && mCategories.contains(category);
7253 }
7254
7255 /**
7256 * Return the set of all categories in the intent. If there are no categories,
7257 * returns NULL.
7258 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007259 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007260 *
7261 * @see #hasCategory
7262 * @see #addCategory
7263 */
7264 public Set<String> getCategories() {
7265 return mCategories;
7266 }
7267
7268 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007269 * Return the specific selector associated with this Intent. If there is
7270 * none, returns null. See {@link #setSelector} for more information.
7271 *
7272 * @see #setSelector
7273 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007274 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007275 return mSelector;
7276 }
7277
7278 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007279 * Return the {@link ClipData} associated with this Intent. If there is
7280 * none, returns null. See {@link #setClipData} for more information.
7281 *
John Spurlock125d1332013-11-25 11:58:37 -05007282 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007283 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007284 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007285 return mClipData;
7286 }
7287
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007288 /** @hide */
7289 public int getContentUserHint() {
7290 return mContentUserHint;
7291 }
7292
Todd Kennedyb3b431302017-03-20 16:05:48 -07007293 /** @hide */
7294 public String getLaunchToken() {
7295 return mLaunchToken;
7296 }
7297
7298 /** @hide */
7299 public void setLaunchToken(String launchToken) {
7300 mLaunchToken = launchToken;
7301 }
7302
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007303 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007304 * Sets the ClassLoader that will be used when unmarshalling
7305 * any Parcelable values from the extras of this Intent.
7306 *
7307 * @param loader a ClassLoader, or null to use the default loader
7308 * at the time of unmarshalling.
7309 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007310 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007311 if (mExtras != null) {
7312 mExtras.setClassLoader(loader);
7313 }
7314 }
7315
7316 /**
7317 * Returns true if an extra value is associated with the given name.
7318 * @param name the extra's name
7319 * @return true if the given extra is present.
7320 */
7321 public boolean hasExtra(String name) {
7322 return mExtras != null && mExtras.containsKey(name);
7323 }
7324
7325 /**
7326 * Returns true if the Intent's extras contain a parcelled file descriptor.
7327 * @return true if the Intent contains a parcelled file descriptor.
7328 */
7329 public boolean hasFileDescriptors() {
7330 return mExtras != null && mExtras.hasFileDescriptors();
7331 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007332
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007333 /** {@hide} */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007334 @UnsupportedAppUsage
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04007335 public void setAllowFds(boolean allowFds) {
7336 if (mExtras != null) {
7337 mExtras.setAllowFds(allowFds);
7338 }
7339 }
7340
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007341 /** {@hide} */
7342 public void setDefusable(boolean defusable) {
7343 if (mExtras != null) {
7344 mExtras.setDefusable(defusable);
7345 }
7346 }
7347
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007348 /**
7349 * Retrieve extended data from the intent.
7350 *
7351 * @param name The name of the desired item.
7352 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007353 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007354 * or null if none was found.
7355 *
7356 * @deprecated
7357 * @hide
7358 */
7359 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007360 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007361 public Object getExtra(String name) {
7362 return getExtra(name, null);
7363 }
7364
7365 /**
7366 * Retrieve extended data from the intent.
7367 *
7368 * @param name The name of the desired item.
7369 * @param defaultValue the value to be returned if no value of the desired
7370 * type is stored with the given name.
7371 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007372 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007373 * or the default value if none was found.
7374 *
7375 * @see #putExtra(String, boolean)
7376 */
7377 public boolean getBooleanExtra(String name, boolean defaultValue) {
7378 return mExtras == null ? defaultValue :
7379 mExtras.getBoolean(name, defaultValue);
7380 }
7381
7382 /**
7383 * Retrieve extended data from the intent.
7384 *
7385 * @param name The name of the desired item.
7386 * @param defaultValue the value to be returned if no value of the desired
7387 * type is stored with the given name.
7388 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007389 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007390 * or the default value if none was found.
7391 *
7392 * @see #putExtra(String, byte)
7393 */
7394 public byte getByteExtra(String name, byte defaultValue) {
7395 return mExtras == null ? defaultValue :
7396 mExtras.getByte(name, defaultValue);
7397 }
7398
7399 /**
7400 * Retrieve extended data from the intent.
7401 *
7402 * @param name The name of the desired item.
7403 * @param defaultValue the value to be returned if no value of the desired
7404 * type is stored with the given name.
7405 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007406 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007407 * or the default value if none was found.
7408 *
7409 * @see #putExtra(String, short)
7410 */
7411 public short getShortExtra(String name, short defaultValue) {
7412 return mExtras == null ? defaultValue :
7413 mExtras.getShort(name, defaultValue);
7414 }
7415
7416 /**
7417 * Retrieve extended data from the intent.
7418 *
7419 * @param name The name of the desired item.
7420 * @param defaultValue the value to be returned if no value of the desired
7421 * type is stored with the given name.
7422 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007423 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007424 * or the default value if none was found.
7425 *
7426 * @see #putExtra(String, char)
7427 */
7428 public char getCharExtra(String name, char defaultValue) {
7429 return mExtras == null ? defaultValue :
7430 mExtras.getChar(name, defaultValue);
7431 }
7432
7433 /**
7434 * Retrieve extended data from the intent.
7435 *
7436 * @param name The name of the desired item.
7437 * @param defaultValue the value to be returned if no value of the desired
7438 * type is stored with the given name.
7439 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007440 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007441 * or the default value if none was found.
7442 *
7443 * @see #putExtra(String, int)
7444 */
7445 public int getIntExtra(String name, int defaultValue) {
7446 return mExtras == null ? defaultValue :
7447 mExtras.getInt(name, defaultValue);
7448 }
7449
7450 /**
7451 * Retrieve extended data from the intent.
7452 *
7453 * @param name The name of the desired item.
7454 * @param defaultValue the value to be returned if no value of the desired
7455 * type is stored with the given name.
7456 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007457 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007458 * or the default value if none was found.
7459 *
7460 * @see #putExtra(String, long)
7461 */
7462 public long getLongExtra(String name, long defaultValue) {
7463 return mExtras == null ? defaultValue :
7464 mExtras.getLong(name, defaultValue);
7465 }
7466
7467 /**
7468 * Retrieve extended data from the intent.
7469 *
7470 * @param name The name of the desired item.
7471 * @param defaultValue the value to be returned if no value of the desired
7472 * type is stored with the given name.
7473 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007474 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007475 * or the default value if no such item is present
7476 *
7477 * @see #putExtra(String, float)
7478 */
7479 public float getFloatExtra(String name, float defaultValue) {
7480 return mExtras == null ? defaultValue :
7481 mExtras.getFloat(name, defaultValue);
7482 }
7483
7484 /**
7485 * Retrieve extended data from the intent.
7486 *
7487 * @param name The name of the desired item.
7488 * @param defaultValue the value to be returned if no value of the desired
7489 * type is stored with the given name.
7490 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007491 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007492 * or the default value if none was found.
7493 *
7494 * @see #putExtra(String, double)
7495 */
7496 public double getDoubleExtra(String name, double defaultValue) {
7497 return mExtras == null ? defaultValue :
7498 mExtras.getDouble(name, defaultValue);
7499 }
7500
7501 /**
7502 * Retrieve extended data from the intent.
7503 *
7504 * @param name The name of the desired item.
7505 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007506 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007507 * or null if no String value was found.
7508 *
7509 * @see #putExtra(String, String)
7510 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007511 public @Nullable String getStringExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007512 return mExtras == null ? null : mExtras.getString(name);
7513 }
7514
7515 /**
7516 * Retrieve extended data from the intent.
7517 *
7518 * @param name The name of the desired item.
7519 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007520 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007521 * or null if no CharSequence value was found.
7522 *
7523 * @see #putExtra(String, CharSequence)
7524 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007525 public @Nullable CharSequence getCharSequenceExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007526 return mExtras == null ? null : mExtras.getCharSequence(name);
7527 }
7528
7529 /**
7530 * Retrieve extended data from the intent.
7531 *
7532 * @param name The name of the desired item.
7533 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007534 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007535 * or null if no Parcelable value was found.
7536 *
7537 * @see #putExtra(String, Parcelable)
7538 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007539 public @Nullable <T extends Parcelable> T getParcelableExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007540 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7541 }
7542
7543 /**
7544 * Retrieve extended data from the intent.
7545 *
7546 * @param name The name of the desired item.
7547 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007548 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007549 * or null if no Parcelable[] value was found.
7550 *
7551 * @see #putExtra(String, Parcelable[])
7552 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007553 public @Nullable Parcelable[] getParcelableArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007554 return mExtras == null ? null : mExtras.getParcelableArray(name);
7555 }
7556
7557 /**
7558 * Retrieve extended data from the intent.
7559 *
7560 * @param name The name of the desired item.
7561 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007562 * @return the value of an item previously added with
7563 * putParcelableArrayListExtra(), or null if no
7564 * ArrayList<Parcelable> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007565 *
7566 * @see #putParcelableArrayListExtra(String, ArrayList)
7567 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007568 public @Nullable <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007569 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7570 }
7571
7572 /**
7573 * Retrieve extended data from the intent.
7574 *
7575 * @param name The name of the desired item.
7576 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007577 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007578 * or null if no Serializable value was found.
7579 *
7580 * @see #putExtra(String, Serializable)
7581 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007582 public @Nullable Serializable getSerializableExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007583 return mExtras == null ? null : mExtras.getSerializable(name);
7584 }
7585
7586 /**
7587 * Retrieve extended data from the intent.
7588 *
7589 * @param name The name of the desired item.
7590 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007591 * @return the value of an item previously added with
7592 * putIntegerArrayListExtra(), or null if no
7593 * ArrayList<Integer> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007594 *
7595 * @see #putIntegerArrayListExtra(String, ArrayList)
7596 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007597 public @Nullable ArrayList<Integer> getIntegerArrayListExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007598 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7599 }
7600
7601 /**
7602 * Retrieve extended data from the intent.
7603 *
7604 * @param name The name of the desired item.
7605 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007606 * @return the value of an item previously added with
7607 * putStringArrayListExtra(), or null if no
7608 * ArrayList<String> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007609 *
7610 * @see #putStringArrayListExtra(String, ArrayList)
7611 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007612 public @Nullable ArrayList<String> getStringArrayListExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007613 return mExtras == null ? null : mExtras.getStringArrayList(name);
7614 }
7615
7616 /**
7617 * Retrieve extended data from the intent.
7618 *
7619 * @param name The name of the desired item.
7620 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007621 * @return the value of an item previously added with
7622 * putCharSequenceArrayListExtra, or null if no
7623 * ArrayList<CharSequence> value was found.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007624 *
7625 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7626 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007627 public @Nullable ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007628 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7629 }
7630
7631 /**
7632 * Retrieve extended data from the intent.
7633 *
7634 * @param name The name of the desired item.
7635 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007636 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007637 * or null if no boolean array value was found.
7638 *
7639 * @see #putExtra(String, boolean[])
7640 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007641 public @Nullable boolean[] getBooleanArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007642 return mExtras == null ? null : mExtras.getBooleanArray(name);
7643 }
7644
7645 /**
7646 * Retrieve extended data from the intent.
7647 *
7648 * @param name The name of the desired item.
7649 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007650 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007651 * or null if no byte array value was found.
7652 *
7653 * @see #putExtra(String, byte[])
7654 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007655 public @Nullable byte[] getByteArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007656 return mExtras == null ? null : mExtras.getByteArray(name);
7657 }
7658
7659 /**
7660 * Retrieve extended data from the intent.
7661 *
7662 * @param name The name of the desired item.
7663 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007664 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007665 * or null if no short array value was found.
7666 *
7667 * @see #putExtra(String, short[])
7668 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007669 public @Nullable short[] getShortArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007670 return mExtras == null ? null : mExtras.getShortArray(name);
7671 }
7672
7673 /**
7674 * Retrieve extended data from the intent.
7675 *
7676 * @param name The name of the desired item.
7677 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007678 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007679 * or null if no char array value was found.
7680 *
7681 * @see #putExtra(String, char[])
7682 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007683 public @Nullable char[] getCharArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007684 return mExtras == null ? null : mExtras.getCharArray(name);
7685 }
7686
7687 /**
7688 * Retrieve extended data from the intent.
7689 *
7690 * @param name The name of the desired item.
7691 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007692 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007693 * or null if no int array value was found.
7694 *
7695 * @see #putExtra(String, int[])
7696 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007697 public @Nullable int[] getIntArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007698 return mExtras == null ? null : mExtras.getIntArray(name);
7699 }
7700
7701 /**
7702 * Retrieve extended data from the intent.
7703 *
7704 * @param name The name of the desired item.
7705 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007706 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007707 * or null if no long array value was found.
7708 *
7709 * @see #putExtra(String, long[])
7710 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007711 public @Nullable long[] getLongArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007712 return mExtras == null ? null : mExtras.getLongArray(name);
7713 }
7714
7715 /**
7716 * Retrieve extended data from the intent.
7717 *
7718 * @param name The name of the desired item.
7719 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007720 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007721 * or null if no float array value was found.
7722 *
7723 * @see #putExtra(String, float[])
7724 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007725 public @Nullable float[] getFloatArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007726 return mExtras == null ? null : mExtras.getFloatArray(name);
7727 }
7728
7729 /**
7730 * Retrieve extended data from the intent.
7731 *
7732 * @param name The name of the desired item.
7733 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007734 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007735 * or null if no double array value was found.
7736 *
7737 * @see #putExtra(String, double[])
7738 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007739 public @Nullable double[] getDoubleArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007740 return mExtras == null ? null : mExtras.getDoubleArray(name);
7741 }
7742
7743 /**
7744 * Retrieve extended data from the intent.
7745 *
7746 * @param name The name of the desired item.
7747 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007748 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007749 * or null if no String array value was found.
7750 *
7751 * @see #putExtra(String, String[])
7752 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007753 public @Nullable String[] getStringArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007754 return mExtras == null ? null : mExtras.getStringArray(name);
7755 }
7756
7757 /**
7758 * Retrieve extended data from the intent.
7759 *
7760 * @param name The name of the desired item.
7761 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007762 * @return the value of an item previously added with putExtra(),
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007763 * or null if no CharSequence array value was found.
7764 *
7765 * @see #putExtra(String, CharSequence[])
7766 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007767 public @Nullable CharSequence[] getCharSequenceArrayExtra(String name) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007768 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7769 }
7770
7771 /**
7772 * Retrieve extended data from the intent.
7773 *
7774 * @param name The name of the desired item.
7775 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007776 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007777 * or null if no Bundle value was found.
7778 *
7779 * @see #putExtra(String, Bundle)
7780 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007781 public @Nullable Bundle getBundleExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007782 return mExtras == null ? null : mExtras.getBundle(name);
7783 }
7784
7785 /**
7786 * Retrieve extended data from the intent.
7787 *
7788 * @param name The name of the desired item.
7789 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007790 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007791 * or null if no IBinder value was found.
7792 *
7793 * @see #putExtra(String, IBinder)
7794 *
7795 * @deprecated
7796 * @hide
7797 */
7798 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007799 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007800 public IBinder getIBinderExtra(String name) {
7801 return mExtras == null ? null : mExtras.getIBinder(name);
7802 }
7803
7804 /**
7805 * Retrieve extended data from the intent.
7806 *
7807 * @param name The name of the desired item.
7808 * @param defaultValue The default value to return in case no item is
7809 * associated with the key 'name'
7810 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007811 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007812 * or defaultValue if none was found.
7813 *
7814 * @see #putExtra
7815 *
7816 * @deprecated
7817 * @hide
7818 */
7819 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007820 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007821 public Object getExtra(String name, Object defaultValue) {
7822 Object result = defaultValue;
7823 if (mExtras != null) {
7824 Object result2 = mExtras.get(name);
7825 if (result2 != null) {
7826 result = result2;
7827 }
7828 }
7829
7830 return result;
7831 }
7832
7833 /**
7834 * Retrieves a map of extended data from the intent.
7835 *
7836 * @return the map of all extras previously added with putExtra(),
7837 * or null if none have been added.
7838 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007839 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007840 return (mExtras != null)
7841 ? new Bundle(mExtras)
7842 : null;
7843 }
7844
7845 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007846 * Filter extras to only basic types.
7847 * @hide
7848 */
7849 public void removeUnsafeExtras() {
7850 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007851 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007852 }
7853 }
7854
7855 /**
Makoto Onuki97f82f22017-05-31 16:20:21 -07007856 * @return Whether {@link #maybeStripForHistory} will return an lightened intent or
7857 * return itself as-is.
7858 * @hide
7859 */
7860 public boolean canStripForHistory() {
7861 return ((mExtras != null) && mExtras.isParcelled()) || (mClipData != null);
7862 }
7863
7864 /**
7865 * Call it when the system needs to keep an intent for logging purposes to remove fields
7866 * that are not needed for logging.
7867 * @hide
7868 */
7869 public Intent maybeStripForHistory() {
7870 // TODO Scan and remove possibly heavy instances like Bitmaps from unparcelled extras?
7871
7872 if (!canStripForHistory()) {
7873 return this;
7874 }
7875 return new Intent(this, COPY_MODE_HISTORY);
7876 }
7877
7878 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007879 * Retrieve any special flags associated with this intent. You will
7880 * normally just set them with {@link #setFlags} and let the system
7881 * take the appropriate action with them.
7882 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007883 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007884 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007885 * @see #addFlags
7886 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007887 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007888 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007889 return mFlags;
7890 }
7891
Dianne Hackborne7f97212011-02-24 14:40:20 -08007892 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007893 @UnsupportedAppUsage
Dianne Hackborne7f97212011-02-24 14:40:20 -08007894 public boolean isExcludingStopped() {
7895 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7896 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7897 }
7898
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007899 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007900 * Retrieve the application package name this Intent is limited to. When
7901 * resolving an Intent, if non-null this limits the resolution to only
7902 * components in the given application package.
7903 *
7904 * @return The name of the application package for the Intent.
7905 *
7906 * @see #resolveActivity
7907 * @see #setPackage
7908 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007909 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007910 return mPackage;
7911 }
7912
7913 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007914 * Retrieve the concrete component associated with the intent. When receiving
7915 * an intent, this is the component that was found to best handle it (that is,
7916 * yourself) and will always be non-null; in all other cases it will be
7917 * null unless explicitly set.
7918 *
7919 * @return The name of the application component to handle the intent.
7920 *
7921 * @see #resolveActivity
7922 * @see #setComponent
7923 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007924 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007925 return mComponent;
7926 }
7927
7928 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007929 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7930 * used as a hint to the receiver for animations and the like. Null means that there
7931 * is no source bounds.
7932 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007933 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007934 return mSourceBounds;
7935 }
7936
7937 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007938 * Return the Activity component that should be used to handle this intent.
7939 * The appropriate component is determined based on the information in the
7940 * intent, evaluated as follows:
7941 *
7942 * <p>If {@link #getComponent} returns an explicit class, that is returned
7943 * without any further consideration.
7944 *
7945 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7946 * category to be considered.
7947 *
7948 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7949 * action.
7950 *
7951 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7952 * this type.
7953 *
7954 * <p>If {@link #addCategory} has added any categories, the activity must
7955 * handle ALL of the categories specified.
7956 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007957 * <p>If {@link #getPackage} is non-NULL, only activity components in
7958 * that application package will be considered.
7959 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007960 * <p>If there are no activities that satisfy all of these conditions, a
7961 * null string is returned.
7962 *
7963 * <p>If multiple activities are found to satisfy the intent, the one with
7964 * the highest priority will be used. If there are multiple activities
7965 * with the same priority, the system will either pick the best activity
7966 * based on user preference, or resolve to a system class that will allow
7967 * the user to pick an activity and forward from there.
7968 *
7969 * <p>This method is implemented simply by calling
7970 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7971 * true.</p>
7972 * <p> This API is called for you as part of starting an activity from an
7973 * intent. You do not normally need to call it yourself.</p>
7974 *
7975 * @param pm The package manager with which to resolve the Intent.
7976 *
7977 * @return Name of the component implementing an activity that can
7978 * display the intent.
7979 *
7980 * @see #setComponent
7981 * @see #getComponent
7982 * @see #resolveActivityInfo
7983 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007984 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007985 if (mComponent != null) {
7986 return mComponent;
7987 }
7988
7989 ResolveInfo info = pm.resolveActivity(
7990 this, PackageManager.MATCH_DEFAULT_ONLY);
7991 if (info != null) {
7992 return new ComponentName(
7993 info.activityInfo.applicationInfo.packageName,
7994 info.activityInfo.name);
7995 }
7996
7997 return null;
7998 }
7999
8000 /**
8001 * Resolve the Intent into an {@link ActivityInfo}
8002 * describing the activity that should execute the intent. Resolution
8003 * follows the same rules as described for {@link #resolveActivity}, but
8004 * you get back the completely information about the resolved activity
8005 * instead of just its class name.
8006 *
8007 * @param pm The package manager with which to resolve the Intent.
8008 * @param flags Addition information to retrieve as per
8009 * {@link PackageManager#getActivityInfo(ComponentName, int)
8010 * PackageManager.getActivityInfo()}.
8011 *
8012 * @return PackageManager.ActivityInfo
8013 *
8014 * @see #resolveActivity
8015 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008016 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
8017 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008018 ActivityInfo ai = null;
8019 if (mComponent != null) {
8020 try {
8021 ai = pm.getActivityInfo(mComponent, flags);
8022 } catch (PackageManager.NameNotFoundException e) {
8023 // ignore
8024 }
8025 } else {
8026 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07008027 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008028 if (info != null) {
8029 ai = info.activityInfo;
8030 }
8031 }
8032
8033 return ai;
8034 }
8035
8036 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07008037 * Special function for use by the system to resolve service
8038 * intents to system apps. Throws an exception if there are
8039 * multiple potential matches to the Intent. Returns null if
8040 * there are no matches.
8041 * @hide
8042 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01008043 @UnsupportedAppUsage
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008044 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
8045 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07008046 if (mComponent != null) {
8047 return mComponent;
8048 }
8049
8050 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
8051 if (results == null) {
8052 return null;
8053 }
8054 ComponentName comp = null;
8055 for (int i=0; i<results.size(); i++) {
8056 ResolveInfo ri = results.get(i);
8057 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
8058 continue;
8059 }
8060 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
8061 ri.serviceInfo.name);
8062 if (comp != null) {
8063 throw new IllegalStateException("Multiple system services handle " + this
8064 + ": " + comp + ", " + foundComp);
8065 }
8066 comp = foundComp;
8067 }
8068 return comp;
8069 }
8070
8071 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008072 * Set the general action to be performed.
8073 *
8074 * @param action An action name, such as ACTION_VIEW. Application-specific
8075 * actions should be prefixed with the vendor's package name.
8076 *
8077 * @return Returns the same Intent object, for chaining multiple calls
8078 * into a single statement.
8079 *
8080 * @see #getAction
8081 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008082 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008083 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008084 return this;
8085 }
8086
8087 /**
8088 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08008089 * clears any type that was previously set by {@link #setType} or
8090 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008091 *
Nick Pellyccae4122012-01-09 14:12:58 -08008092 * <p><em>Note: scheme matching in the Android framework is
8093 * case-sensitive, unlike the formal RFC. As a result,
8094 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008095 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08008096 * {@link #setDataAndNormalize}
8097 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008098 *
Nick Pellyccae4122012-01-09 14:12:58 -08008099 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008100 *
8101 * @return Returns the same Intent object, for chaining multiple calls
8102 * into a single statement.
8103 *
8104 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08008105 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07008106 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008107 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008108 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008109 mData = data;
8110 mType = null;
8111 return this;
8112 }
8113
8114 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008115 * Normalize and set the data this intent is operating on.
8116 *
8117 * <p>This method automatically clears any type that was
8118 * previously set (for example, by {@link #setType}).
8119 *
8120 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008121 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08008122 * so really this is just a convenience method for
8123 * <pre>
8124 * setData(data.normalize())
8125 * </pre>
8126 *
8127 * @param data The Uri of the data this intent is now targeting.
8128 *
8129 * @return Returns the same Intent object, for chaining multiple calls
8130 * into a single statement.
8131 *
8132 * @see #getData
8133 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008134 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008135 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008136 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008137 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08008138 }
8139
8140 /**
8141 * Set an explicit MIME data type.
8142 *
8143 * <p>This is used to create intents that only specify a type and not data,
8144 * for example to indicate the type of data to return.
8145 *
8146 * <p>This method automatically clears any data that was
8147 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07008148 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008149 * <p><em>Note: MIME type matching in the Android framework is
8150 * case-sensitive, unlike formal RFC MIME types. As a result,
8151 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08008152 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
8153 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008154 *
8155 * @param type The MIME type of the data being handled by this intent.
8156 *
8157 * @return Returns the same Intent object, for chaining multiple calls
8158 * into a single statement.
8159 *
8160 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08008161 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008162 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08008163 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008164 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008165 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008166 mData = null;
8167 mType = type;
8168 return this;
8169 }
8170
8171 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008172 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008173 *
Nick Pellyccae4122012-01-09 14:12:58 -08008174 * <p>This is used to create intents that only specify a type and not data,
8175 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008176 *
Nick Pellyccae4122012-01-09 14:12:58 -08008177 * <p>This method automatically clears any data that was
8178 * previously set (for example by {@link #setData}).
8179 *
8180 * <p>The MIME type is normalized using
8181 * {@link #normalizeMimeType} before it is set,
8182 * so really this is just a convenience method for
8183 * <pre>
8184 * setType(Intent.normalizeMimeType(type))
8185 * </pre>
8186 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008187 * @param type The MIME type of the data being handled by this intent.
8188 *
8189 * @return Returns the same Intent object, for chaining multiple calls
8190 * into a single statement.
8191 *
Nick Pellyccae4122012-01-09 14:12:58 -08008192 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008193 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08008194 * @see #normalizeMimeType
8195 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008196 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08008197 return setType(normalizeMimeType(type));
8198 }
8199
8200 /**
8201 * (Usually optional) Set the data for the intent along with an explicit
8202 * MIME data type. This method should very rarely be used -- it allows you
8203 * to override the MIME type that would ordinarily be inferred from the
8204 * data with your own type given here.
8205 *
8206 * <p><em>Note: MIME type and Uri scheme matching in the
8207 * Android framework is case-sensitive, unlike the formal RFC definitions.
8208 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008209 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08008210 * {@link #setDataAndTypeAndNormalize}
8211 * to ensure that they are converted to lower case.</em>
8212 *
8213 * @param data The Uri of the data this intent is now targeting.
8214 * @param type The MIME type of the data being handled by this intent.
8215 *
8216 * @return Returns the same Intent object, for chaining multiple calls
8217 * into a single statement.
8218 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008219 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08008220 * @see #setData
8221 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008222 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008223 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008224 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008225 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008226 mData = data;
8227 mType = type;
8228 return this;
8229 }
8230
8231 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008232 * (Usually optional) Normalize and set both the data Uri and an explicit
8233 * MIME data type. This method should very rarely be used -- it allows you
8234 * to override the MIME type that would ordinarily be inferred from the
8235 * data with your own type given here.
8236 *
8237 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008238 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08008239 * before they are set, so really this is just a convenience method for
8240 * <pre>
8241 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
8242 * </pre>
8243 *
8244 * @param data The Uri of the data this intent is now targeting.
8245 * @param type The MIME type of the data being handled by this intent.
8246 *
8247 * @return Returns the same Intent object, for chaining multiple calls
8248 * into a single statement.
8249 *
8250 * @see #setType
8251 * @see #setData
8252 * @see #setDataAndType
8253 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008254 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008255 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008256 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008257 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08008258 }
8259
8260 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008261 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008262 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008263 * activities that provide <em>all</em> of the requested categories will be
8264 * used.
8265 *
8266 * @param category The desired category. This can be either one of the
8267 * predefined Intent categories, or a custom category in your own
8268 * namespace.
8269 *
8270 * @return Returns the same Intent object, for chaining multiple calls
8271 * into a single statement.
8272 *
8273 * @see #hasCategory
8274 * @see #removeCategory
8275 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008276 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008277 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008278 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008279 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08008280 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008281 return this;
8282 }
8283
8284 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008285 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008286 *
8287 * @param category The category to remove.
8288 *
8289 * @see #addCategory
8290 */
8291 public void removeCategory(String category) {
8292 if (mCategories != null) {
8293 mCategories.remove(category);
8294 if (mCategories.size() == 0) {
8295 mCategories = null;
8296 }
8297 }
8298 }
8299
8300 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008301 * Set a selector for this Intent. This is a modification to the kinds of
8302 * things the Intent will match. If the selector is set, it will be used
8303 * when trying to find entities that can handle the Intent, instead of the
8304 * main contents of the Intent. This allows you build an Intent containing
8305 * a generic protocol while targeting it more specifically.
8306 *
8307 * <p>An example of where this may be used is with things like
8308 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
8309 * Intent that will launch the Browser application. However, the correct
8310 * main entry point of an application is actually {@link #ACTION_MAIN}
8311 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
8312 * used to specify the actual Activity to launch. If you launch the browser
8313 * with something different, undesired behavior may happen if the user has
8314 * previously or later launches it the normal way, since they do not match.
8315 * Instead, you can build an Intent with the MAIN action (but no ComponentName
8316 * yet specified) and set a selector with {@link #ACTION_MAIN} and
8317 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
8318 *
8319 * <p>Setting a selector does not impact the behavior of
8320 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
8321 * desired behavior of a selector -- it does not impact the base meaning
8322 * of the Intent, just what kinds of things will be matched against it
8323 * when determining who can handle it.</p>
8324 *
8325 * <p>You can not use both a selector and {@link #setPackage(String)} on
8326 * the same base Intent.</p>
8327 *
8328 * @param selector The desired selector Intent; set to null to not use
8329 * a special selector.
8330 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008331 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008332 if (selector == this) {
8333 throw new IllegalArgumentException(
8334 "Intent being set as a selector of itself");
8335 }
8336 if (selector != null && mPackage != null) {
8337 throw new IllegalArgumentException(
8338 "Can't set selector when package name is already set");
8339 }
8340 mSelector = selector;
8341 }
8342
8343 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008344 * Set a {@link ClipData} associated with this Intent. This replaces any
8345 * previously set ClipData.
8346 *
8347 * <p>The ClipData in an intent is not used for Intent matching or other
8348 * such operations. Semantically it is like extras, used to transmit
8349 * additional data with the Intent. The main feature of using this over
8350 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
8351 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
8352 * items included in the clip data. This is useful, in particular, if
8353 * you want to transmit an Intent containing multiple <code>content:</code>
8354 * URIs for which the recipient may not have global permission to access the
8355 * content provider.
8356 *
8357 * <p>If the ClipData contains items that are themselves Intents, any
8358 * grant flags in those Intents will be ignored. Only the top-level flags
8359 * of the main Intent are respected, and will be applied to all Uri or
8360 * Intent items in the clip (or sub-items of the clip).
8361 *
8362 * <p>The MIME type, label, and icon in the ClipData object are not
8363 * directly used by Intent. Applications should generally rely on the
8364 * MIME type of the Intent itself, not what it may find in the ClipData.
8365 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05008366 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008367 *
8368 * @param clip The new clip to set. May be null to clear the current clip.
8369 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008370 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008371 mClipData = clip;
8372 }
8373
8374 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008375 * This is NOT a secure mechanism to identify the user who sent the intent.
8376 * When the intent is sent to a different user, it is used to fix uris by adding the userId
8377 * who sent the intent.
8378 * @hide
8379 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01008380 public void prepareToLeaveUser(int userId) {
8381 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
8382 // We want mContentUserHint to refer to the original user, so don't do anything.
8383 if (mContentUserHint == UserHandle.USER_CURRENT) {
8384 mContentUserHint = userId;
8385 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008386 }
8387
8388 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008389 * Add extended data to the intent. The name must include a package
8390 * prefix, for example the app com.android.contacts would use names
8391 * like "com.android.contacts.ShowAll".
8392 *
8393 * @param name The name of the extra data, with package prefix.
8394 * @param value The boolean data value.
8395 *
8396 * @return Returns the same Intent object, for chaining multiple calls
8397 * into a single statement.
8398 *
8399 * @see #putExtras
8400 * @see #removeExtra
8401 * @see #getBooleanExtra(String, boolean)
8402 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008403 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008404 if (mExtras == null) {
8405 mExtras = new Bundle();
8406 }
8407 mExtras.putBoolean(name, value);
8408 return this;
8409 }
8410
8411 /**
8412 * Add extended data to the intent. The name must include a package
8413 * prefix, for example the app com.android.contacts would use names
8414 * like "com.android.contacts.ShowAll".
8415 *
8416 * @param name The name of the extra data, with package prefix.
8417 * @param value The byte data value.
8418 *
8419 * @return Returns the same Intent object, for chaining multiple calls
8420 * into a single statement.
8421 *
8422 * @see #putExtras
8423 * @see #removeExtra
8424 * @see #getByteExtra(String, byte)
8425 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008426 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008427 if (mExtras == null) {
8428 mExtras = new Bundle();
8429 }
8430 mExtras.putByte(name, value);
8431 return this;
8432 }
8433
8434 /**
8435 * Add extended data to the intent. The name must include a package
8436 * prefix, for example the app com.android.contacts would use names
8437 * like "com.android.contacts.ShowAll".
8438 *
8439 * @param name The name of the extra data, with package prefix.
8440 * @param value The char data value.
8441 *
8442 * @return Returns the same Intent object, for chaining multiple calls
8443 * into a single statement.
8444 *
8445 * @see #putExtras
8446 * @see #removeExtra
8447 * @see #getCharExtra(String, char)
8448 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008449 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008450 if (mExtras == null) {
8451 mExtras = new Bundle();
8452 }
8453 mExtras.putChar(name, value);
8454 return this;
8455 }
8456
8457 /**
8458 * Add extended data to the intent. The name must include a package
8459 * prefix, for example the app com.android.contacts would use names
8460 * like "com.android.contacts.ShowAll".
8461 *
8462 * @param name The name of the extra data, with package prefix.
8463 * @param value The short data value.
8464 *
8465 * @return Returns the same Intent object, for chaining multiple calls
8466 * into a single statement.
8467 *
8468 * @see #putExtras
8469 * @see #removeExtra
8470 * @see #getShortExtra(String, short)
8471 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008472 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008473 if (mExtras == null) {
8474 mExtras = new Bundle();
8475 }
8476 mExtras.putShort(name, value);
8477 return this;
8478 }
8479
8480 /**
8481 * Add extended data to the intent. The name must include a package
8482 * prefix, for example the app com.android.contacts would use names
8483 * like "com.android.contacts.ShowAll".
8484 *
8485 * @param name The name of the extra data, with package prefix.
8486 * @param value The integer data value.
8487 *
8488 * @return Returns the same Intent object, for chaining multiple calls
8489 * into a single statement.
8490 *
8491 * @see #putExtras
8492 * @see #removeExtra
8493 * @see #getIntExtra(String, int)
8494 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008495 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008496 if (mExtras == null) {
8497 mExtras = new Bundle();
8498 }
8499 mExtras.putInt(name, value);
8500 return this;
8501 }
8502
8503 /**
8504 * Add extended data to the intent. The name must include a package
8505 * prefix, for example the app com.android.contacts would use names
8506 * like "com.android.contacts.ShowAll".
8507 *
8508 * @param name The name of the extra data, with package prefix.
8509 * @param value The long data value.
8510 *
8511 * @return Returns the same Intent object, for chaining multiple calls
8512 * into a single statement.
8513 *
8514 * @see #putExtras
8515 * @see #removeExtra
8516 * @see #getLongExtra(String, long)
8517 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008518 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008519 if (mExtras == null) {
8520 mExtras = new Bundle();
8521 }
8522 mExtras.putLong(name, value);
8523 return this;
8524 }
8525
8526 /**
8527 * Add extended data to the intent. The name must include a package
8528 * prefix, for example the app com.android.contacts would use names
8529 * like "com.android.contacts.ShowAll".
8530 *
8531 * @param name The name of the extra data, with package prefix.
8532 * @param value The float data value.
8533 *
8534 * @return Returns the same Intent object, for chaining multiple calls
8535 * into a single statement.
8536 *
8537 * @see #putExtras
8538 * @see #removeExtra
8539 * @see #getFloatExtra(String, float)
8540 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008541 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008542 if (mExtras == null) {
8543 mExtras = new Bundle();
8544 }
8545 mExtras.putFloat(name, value);
8546 return this;
8547 }
8548
8549 /**
8550 * Add extended data to the intent. The name must include a package
8551 * prefix, for example the app com.android.contacts would use names
8552 * like "com.android.contacts.ShowAll".
8553 *
8554 * @param name The name of the extra data, with package prefix.
8555 * @param value The double data value.
8556 *
8557 * @return Returns the same Intent object, for chaining multiple calls
8558 * into a single statement.
8559 *
8560 * @see #putExtras
8561 * @see #removeExtra
8562 * @see #getDoubleExtra(String, double)
8563 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008564 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008565 if (mExtras == null) {
8566 mExtras = new Bundle();
8567 }
8568 mExtras.putDouble(name, value);
8569 return this;
8570 }
8571
8572 /**
8573 * Add extended data to the intent. The name must include a package
8574 * prefix, for example the app com.android.contacts would use names
8575 * like "com.android.contacts.ShowAll".
8576 *
8577 * @param name The name of the extra data, with package prefix.
8578 * @param value The String data value.
8579 *
8580 * @return Returns the same Intent object, for chaining multiple calls
8581 * into a single statement.
8582 *
8583 * @see #putExtras
8584 * @see #removeExtra
8585 * @see #getStringExtra(String)
8586 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008587 public @NonNull Intent putExtra(String name, @Nullable String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008588 if (mExtras == null) {
8589 mExtras = new Bundle();
8590 }
8591 mExtras.putString(name, value);
8592 return this;
8593 }
8594
8595 /**
8596 * Add extended data to the intent. The name must include a package
8597 * prefix, for example the app com.android.contacts would use names
8598 * like "com.android.contacts.ShowAll".
8599 *
8600 * @param name The name of the extra data, with package prefix.
8601 * @param value The CharSequence data value.
8602 *
8603 * @return Returns the same Intent object, for chaining multiple calls
8604 * into a single statement.
8605 *
8606 * @see #putExtras
8607 * @see #removeExtra
8608 * @see #getCharSequenceExtra(String)
8609 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008610 public @NonNull Intent putExtra(String name, @Nullable CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008611 if (mExtras == null) {
8612 mExtras = new Bundle();
8613 }
8614 mExtras.putCharSequence(name, value);
8615 return this;
8616 }
8617
8618 /**
8619 * Add extended data to the intent. The name must include a package
8620 * prefix, for example the app com.android.contacts would use names
8621 * like "com.android.contacts.ShowAll".
8622 *
8623 * @param name The name of the extra data, with package prefix.
8624 * @param value The Parcelable data value.
8625 *
8626 * @return Returns the same Intent object, for chaining multiple calls
8627 * into a single statement.
8628 *
8629 * @see #putExtras
8630 * @see #removeExtra
8631 * @see #getParcelableExtra(String)
8632 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008633 public @NonNull Intent putExtra(String name, @Nullable Parcelable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008634 if (mExtras == null) {
8635 mExtras = new Bundle();
8636 }
8637 mExtras.putParcelable(name, value);
8638 return this;
8639 }
8640
8641 /**
8642 * Add extended data to the intent. The name must include a package
8643 * prefix, for example the app com.android.contacts would use names
8644 * like "com.android.contacts.ShowAll".
8645 *
8646 * @param name The name of the extra data, with package prefix.
8647 * @param value The Parcelable[] data value.
8648 *
8649 * @return Returns the same Intent object, for chaining multiple calls
8650 * into a single statement.
8651 *
8652 * @see #putExtras
8653 * @see #removeExtra
8654 * @see #getParcelableArrayExtra(String)
8655 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008656 public @NonNull Intent putExtra(String name, @Nullable Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008657 if (mExtras == null) {
8658 mExtras = new Bundle();
8659 }
8660 mExtras.putParcelableArray(name, value);
8661 return this;
8662 }
8663
8664 /**
8665 * Add extended data to the intent. The name must include a package
8666 * prefix, for example the app com.android.contacts would use names
8667 * like "com.android.contacts.ShowAll".
8668 *
8669 * @param name The name of the extra data, with package prefix.
8670 * @param value The ArrayList<Parcelable> data value.
8671 *
8672 * @return Returns the same Intent object, for chaining multiple calls
8673 * into a single statement.
8674 *
8675 * @see #putExtras
8676 * @see #removeExtra
8677 * @see #getParcelableArrayListExtra(String)
8678 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008679 public @NonNull Intent putParcelableArrayListExtra(String name,
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008680 @Nullable ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008681 if (mExtras == null) {
8682 mExtras = new Bundle();
8683 }
8684 mExtras.putParcelableArrayList(name, value);
8685 return this;
8686 }
8687
8688 /**
8689 * Add extended data to the intent. The name must include a package
8690 * prefix, for example the app com.android.contacts would use names
8691 * like "com.android.contacts.ShowAll".
8692 *
8693 * @param name The name of the extra data, with package prefix.
8694 * @param value The ArrayList<Integer> data value.
8695 *
8696 * @return Returns the same Intent object, for chaining multiple calls
8697 * into a single statement.
8698 *
8699 * @see #putExtras
8700 * @see #removeExtra
8701 * @see #getIntegerArrayListExtra(String)
8702 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008703 public @NonNull Intent putIntegerArrayListExtra(String name,
8704 @Nullable ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008705 if (mExtras == null) {
8706 mExtras = new Bundle();
8707 }
8708 mExtras.putIntegerArrayList(name, value);
8709 return this;
8710 }
8711
8712 /**
8713 * Add extended data to the intent. The name must include a package
8714 * prefix, for example the app com.android.contacts would use names
8715 * like "com.android.contacts.ShowAll".
8716 *
8717 * @param name The name of the extra data, with package prefix.
8718 * @param value The ArrayList<String> data value.
8719 *
8720 * @return Returns the same Intent object, for chaining multiple calls
8721 * into a single statement.
8722 *
8723 * @see #putExtras
8724 * @see #removeExtra
8725 * @see #getStringArrayListExtra(String)
8726 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008727 public @NonNull Intent putStringArrayListExtra(String name, @Nullable ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008728 if (mExtras == null) {
8729 mExtras = new Bundle();
8730 }
8731 mExtras.putStringArrayList(name, value);
8732 return this;
8733 }
8734
8735 /**
8736 * Add extended data to the intent. The name must include a package
8737 * prefix, for example the app com.android.contacts would use names
8738 * like "com.android.contacts.ShowAll".
8739 *
8740 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008741 * @param value The ArrayList<CharSequence> data value.
8742 *
8743 * @return Returns the same Intent object, for chaining multiple calls
8744 * into a single statement.
8745 *
8746 * @see #putExtras
8747 * @see #removeExtra
8748 * @see #getCharSequenceArrayListExtra(String)
8749 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008750 public @NonNull Intent putCharSequenceArrayListExtra(String name,
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008751 @Nullable ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008752 if (mExtras == null) {
8753 mExtras = new Bundle();
8754 }
8755 mExtras.putCharSequenceArrayList(name, value);
8756 return this;
8757 }
8758
8759 /**
8760 * Add extended data to the intent. The name must include a package
8761 * prefix, for example the app com.android.contacts would use names
8762 * like "com.android.contacts.ShowAll".
8763 *
8764 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008765 * @param value The Serializable data value.
8766 *
8767 * @return Returns the same Intent object, for chaining multiple calls
8768 * into a single statement.
8769 *
8770 * @see #putExtras
8771 * @see #removeExtra
8772 * @see #getSerializableExtra(String)
8773 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008774 public @NonNull Intent putExtra(String name, @Nullable Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008775 if (mExtras == null) {
8776 mExtras = new Bundle();
8777 }
8778 mExtras.putSerializable(name, value);
8779 return this;
8780 }
8781
8782 /**
8783 * Add extended data to the intent. The name must include a package
8784 * prefix, for example the app com.android.contacts would use names
8785 * like "com.android.contacts.ShowAll".
8786 *
8787 * @param name The name of the extra data, with package prefix.
8788 * @param value The boolean array data value.
8789 *
8790 * @return Returns the same Intent object, for chaining multiple calls
8791 * into a single statement.
8792 *
8793 * @see #putExtras
8794 * @see #removeExtra
8795 * @see #getBooleanArrayExtra(String)
8796 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008797 public @NonNull Intent putExtra(String name, @Nullable boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008798 if (mExtras == null) {
8799 mExtras = new Bundle();
8800 }
8801 mExtras.putBooleanArray(name, value);
8802 return this;
8803 }
8804
8805 /**
8806 * Add extended data to the intent. The name must include a package
8807 * prefix, for example the app com.android.contacts would use names
8808 * like "com.android.contacts.ShowAll".
8809 *
8810 * @param name The name of the extra data, with package prefix.
8811 * @param value The byte array data value.
8812 *
8813 * @return Returns the same Intent object, for chaining multiple calls
8814 * into a single statement.
8815 *
8816 * @see #putExtras
8817 * @see #removeExtra
8818 * @see #getByteArrayExtra(String)
8819 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008820 public @NonNull Intent putExtra(String name, @Nullable byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008821 if (mExtras == null) {
8822 mExtras = new Bundle();
8823 }
8824 mExtras.putByteArray(name, value);
8825 return this;
8826 }
8827
8828 /**
8829 * Add extended data to the intent. The name must include a package
8830 * prefix, for example the app com.android.contacts would use names
8831 * like "com.android.contacts.ShowAll".
8832 *
8833 * @param name The name of the extra data, with package prefix.
8834 * @param value The short array data value.
8835 *
8836 * @return Returns the same Intent object, for chaining multiple calls
8837 * into a single statement.
8838 *
8839 * @see #putExtras
8840 * @see #removeExtra
8841 * @see #getShortArrayExtra(String)
8842 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008843 public @NonNull Intent putExtra(String name, @Nullable short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008844 if (mExtras == null) {
8845 mExtras = new Bundle();
8846 }
8847 mExtras.putShortArray(name, value);
8848 return this;
8849 }
8850
8851 /**
8852 * Add extended data to the intent. The name must include a package
8853 * prefix, for example the app com.android.contacts would use names
8854 * like "com.android.contacts.ShowAll".
8855 *
8856 * @param name The name of the extra data, with package prefix.
8857 * @param value The char array data value.
8858 *
8859 * @return Returns the same Intent object, for chaining multiple calls
8860 * into a single statement.
8861 *
8862 * @see #putExtras
8863 * @see #removeExtra
8864 * @see #getCharArrayExtra(String)
8865 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008866 public @NonNull Intent putExtra(String name, @Nullable char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008867 if (mExtras == null) {
8868 mExtras = new Bundle();
8869 }
8870 mExtras.putCharArray(name, value);
8871 return this;
8872 }
8873
8874 /**
8875 * Add extended data to the intent. The name must include a package
8876 * prefix, for example the app com.android.contacts would use names
8877 * like "com.android.contacts.ShowAll".
8878 *
8879 * @param name The name of the extra data, with package prefix.
8880 * @param value The int array data value.
8881 *
8882 * @return Returns the same Intent object, for chaining multiple calls
8883 * into a single statement.
8884 *
8885 * @see #putExtras
8886 * @see #removeExtra
8887 * @see #getIntArrayExtra(String)
8888 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008889 public @NonNull Intent putExtra(String name, @Nullable int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008890 if (mExtras == null) {
8891 mExtras = new Bundle();
8892 }
8893 mExtras.putIntArray(name, value);
8894 return this;
8895 }
8896
8897 /**
8898 * Add extended data to the intent. The name must include a package
8899 * prefix, for example the app com.android.contacts would use names
8900 * like "com.android.contacts.ShowAll".
8901 *
8902 * @param name The name of the extra data, with package prefix.
8903 * @param value The byte array data value.
8904 *
8905 * @return Returns the same Intent object, for chaining multiple calls
8906 * into a single statement.
8907 *
8908 * @see #putExtras
8909 * @see #removeExtra
8910 * @see #getLongArrayExtra(String)
8911 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008912 public @NonNull Intent putExtra(String name, @Nullable long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008913 if (mExtras == null) {
8914 mExtras = new Bundle();
8915 }
8916 mExtras.putLongArray(name, value);
8917 return this;
8918 }
8919
8920 /**
8921 * Add extended data to the intent. The name must include a package
8922 * prefix, for example the app com.android.contacts would use names
8923 * like "com.android.contacts.ShowAll".
8924 *
8925 * @param name The name of the extra data, with package prefix.
8926 * @param value The float array data value.
8927 *
8928 * @return Returns the same Intent object, for chaining multiple calls
8929 * into a single statement.
8930 *
8931 * @see #putExtras
8932 * @see #removeExtra
8933 * @see #getFloatArrayExtra(String)
8934 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008935 public @NonNull Intent putExtra(String name, @Nullable float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008936 if (mExtras == null) {
8937 mExtras = new Bundle();
8938 }
8939 mExtras.putFloatArray(name, value);
8940 return this;
8941 }
8942
8943 /**
8944 * Add extended data to the intent. The name must include a package
8945 * prefix, for example the app com.android.contacts would use names
8946 * like "com.android.contacts.ShowAll".
8947 *
8948 * @param name The name of the extra data, with package prefix.
8949 * @param value The double array data value.
8950 *
8951 * @return Returns the same Intent object, for chaining multiple calls
8952 * into a single statement.
8953 *
8954 * @see #putExtras
8955 * @see #removeExtra
8956 * @see #getDoubleArrayExtra(String)
8957 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008958 public @NonNull Intent putExtra(String name, @Nullable double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008959 if (mExtras == null) {
8960 mExtras = new Bundle();
8961 }
8962 mExtras.putDoubleArray(name, value);
8963 return this;
8964 }
8965
8966 /**
8967 * Add extended data to the intent. The name must include a package
8968 * prefix, for example the app com.android.contacts would use names
8969 * like "com.android.contacts.ShowAll".
8970 *
8971 * @param name The name of the extra data, with package prefix.
8972 * @param value The String array data value.
8973 *
8974 * @return Returns the same Intent object, for chaining multiple calls
8975 * into a single statement.
8976 *
8977 * @see #putExtras
8978 * @see #removeExtra
8979 * @see #getStringArrayExtra(String)
8980 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008981 public @NonNull Intent putExtra(String name, @Nullable String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008982 if (mExtras == null) {
8983 mExtras = new Bundle();
8984 }
8985 mExtras.putStringArray(name, value);
8986 return this;
8987 }
8988
8989 /**
8990 * Add extended data to the intent. The name must include a package
8991 * prefix, for example the app com.android.contacts would use names
8992 * like "com.android.contacts.ShowAll".
8993 *
8994 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008995 * @param value The CharSequence array data value.
8996 *
8997 * @return Returns the same Intent object, for chaining multiple calls
8998 * into a single statement.
8999 *
9000 * @see #putExtras
9001 * @see #removeExtra
9002 * @see #getCharSequenceArrayExtra(String)
9003 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00009004 public @NonNull Intent putExtra(String name, @Nullable CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00009005 if (mExtras == null) {
9006 mExtras = new Bundle();
9007 }
9008 mExtras.putCharSequenceArray(name, value);
9009 return this;
9010 }
9011
9012 /**
9013 * Add extended data to the intent. The name must include a package
9014 * prefix, for example the app com.android.contacts would use names
9015 * like "com.android.contacts.ShowAll".
9016 *
9017 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009018 * @param value The Bundle data value.
9019 *
9020 * @return Returns the same Intent object, for chaining multiple calls
9021 * into a single statement.
9022 *
9023 * @see #putExtras
9024 * @see #removeExtra
9025 * @see #getBundleExtra(String)
9026 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00009027 public @NonNull Intent putExtra(String name, @Nullable Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009028 if (mExtras == null) {
9029 mExtras = new Bundle();
9030 }
9031 mExtras.putBundle(name, value);
9032 return this;
9033 }
9034
9035 /**
9036 * Add extended data to the intent. The name must include a package
9037 * prefix, for example the app com.android.contacts would use names
9038 * like "com.android.contacts.ShowAll".
9039 *
9040 * @param name The name of the extra data, with package prefix.
9041 * @param value The IBinder data value.
9042 *
9043 * @return Returns the same Intent object, for chaining multiple calls
9044 * into a single statement.
9045 *
9046 * @see #putExtras
9047 * @see #removeExtra
9048 * @see #getIBinderExtra(String)
9049 *
9050 * @deprecated
9051 * @hide
9052 */
9053 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01009054 @UnsupportedAppUsage
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009055 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009056 if (mExtras == null) {
9057 mExtras = new Bundle();
9058 }
9059 mExtras.putIBinder(name, value);
9060 return this;
9061 }
9062
9063 /**
9064 * Copy all extras in 'src' in to this intent.
9065 *
9066 * @param src Contains the extras to copy.
9067 *
9068 * @see #putExtra
9069 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009070 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009071 if (src.mExtras != null) {
9072 if (mExtras == null) {
9073 mExtras = new Bundle(src.mExtras);
9074 } else {
9075 mExtras.putAll(src.mExtras);
9076 }
9077 }
9078 return this;
9079 }
9080
9081 /**
9082 * Add a set of extended data to the intent. The keys must include a package
9083 * prefix, for example the app com.android.contacts would use names
9084 * like "com.android.contacts.ShowAll".
9085 *
9086 * @param extras The Bundle of extras to add to this intent.
9087 *
9088 * @see #putExtra
9089 * @see #removeExtra
9090 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009091 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009092 if (mExtras == null) {
9093 mExtras = new Bundle();
9094 }
9095 mExtras.putAll(extras);
9096 return this;
9097 }
9098
9099 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009100 * Completely replace the extras in the Intent with the extras in the
9101 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07009102 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009103 * @param src The exact extras contained in this Intent are copied
9104 * into the target intent, replacing any that were previously there.
9105 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009106 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009107 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
9108 return this;
9109 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009110
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009111 /**
9112 * Completely replace the extras in the Intent with the given Bundle of
9113 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07009114 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009115 * @param extras The new set of extras in the Intent, or null to erase
9116 * all extras.
9117 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009118 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009119 mExtras = extras != null ? new Bundle(extras) : null;
9120 return this;
9121 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009122
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009123 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009124 * Remove extended data from the intent.
9125 *
9126 * @see #putExtra
9127 */
9128 public void removeExtra(String name) {
9129 if (mExtras != null) {
9130 mExtras.remove(name);
9131 if (mExtras.size() == 0) {
9132 mExtras = null;
9133 }
9134 }
9135 }
9136
9137 /**
9138 * Set special flags controlling how this intent is handled. Most values
9139 * here depend on the type of component being executed by the Intent,
9140 * specifically the FLAG_ACTIVITY_* flags are all for use with
9141 * {@link Context#startActivity Context.startActivity()} and the
9142 * FLAG_RECEIVER_* flags are all for use with
9143 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
9144 *
Scott Main7aee61f2011-02-08 11:25:01 -08009145 * <p>See the
9146 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
9147 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009148 * the behavior of your application.
9149 *
9150 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009151 * @return Returns the same Intent object, for chaining multiple calls
9152 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009153 * @see #getFlags
9154 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009155 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009156 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009157 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009158 mFlags = flags;
9159 return this;
9160 }
9161
9162 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009163 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009164 *
9165 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009166 * @return Returns the same Intent object, for chaining multiple calls into
9167 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009168 * @see #setFlags
9169 * @see #getFlags
9170 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009171 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009172 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009173 mFlags |= flags;
9174 return this;
9175 }
9176
9177 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009178 * Remove these flags from the intent.
9179 *
9180 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009181 * @see #setFlags
9182 * @see #getFlags
9183 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009184 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009185 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009186 mFlags &= ~flags;
9187 }
9188
9189 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009190 * (Usually optional) Set an explicit application package name that limits
9191 * the components this Intent will resolve to. If left to the default
9192 * value of null, all components in all applications will considered.
9193 * If non-null, the Intent can only match the components in the given
9194 * application package.
9195 *
9196 * @param packageName The name of the application package to handle the
9197 * intent, or null to allow any application package.
9198 *
9199 * @return Returns the same Intent object, for chaining multiple calls
9200 * into a single statement.
9201 *
9202 * @see #getPackage
9203 * @see #resolveActivity
9204 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009205 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009206 if (packageName != null && mSelector != null) {
9207 throw new IllegalArgumentException(
9208 "Can't set package name when selector is already set");
9209 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009210 mPackage = packageName;
9211 return this;
9212 }
9213
9214 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009215 * (Usually optional) Explicitly set the component to handle the intent.
9216 * If left with the default value of null, the system will determine the
9217 * appropriate class to use based on the other fields (action, data,
9218 * type, categories) in the Intent. If this class is defined, the
9219 * specified class will always be used regardless of the other fields. You
9220 * should only set this value when you know you absolutely want a specific
9221 * class to be used; otherwise it is better to let the system find the
9222 * appropriate class so that you will respect the installed applications
9223 * and user preferences.
9224 *
9225 * @param component The name of the application component to handle the
9226 * intent, or null to let the system find one for you.
9227 *
9228 * @return Returns the same Intent object, for chaining multiple calls
9229 * into a single statement.
9230 *
9231 * @see #setClass
9232 * @see #setClassName(Context, String)
9233 * @see #setClassName(String, String)
9234 * @see #getComponent
9235 * @see #resolveActivity
9236 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009237 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009238 mComponent = component;
9239 return this;
9240 }
9241
9242 /**
9243 * Convenience for calling {@link #setComponent} with an
9244 * explicit class name.
9245 *
9246 * @param packageContext A Context of the application package implementing
9247 * this class.
9248 * @param className The name of a class inside of the application package
9249 * that will be used as the component for this Intent.
9250 *
9251 * @return Returns the same Intent object, for chaining multiple calls
9252 * into a single statement.
9253 *
9254 * @see #setComponent
9255 * @see #setClass
9256 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009257 public @NonNull Intent setClassName(@NonNull Context packageContext,
9258 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009259 mComponent = new ComponentName(packageContext, className);
9260 return this;
9261 }
9262
9263 /**
9264 * Convenience for calling {@link #setComponent} with an
9265 * explicit application package name and class name.
9266 *
9267 * @param packageName The name of the package implementing the desired
9268 * component.
9269 * @param className The name of a class inside of the application package
9270 * that will be used as the component for this Intent.
9271 *
9272 * @return Returns the same Intent object, for chaining multiple calls
9273 * into a single statement.
9274 *
9275 * @see #setComponent
9276 * @see #setClass
9277 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009278 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009279 mComponent = new ComponentName(packageName, className);
9280 return this;
9281 }
9282
9283 /**
9284 * Convenience for calling {@link #setComponent(ComponentName)} with the
9285 * name returned by a {@link Class} object.
9286 *
9287 * @param packageContext A Context of the application package implementing
9288 * this class.
9289 * @param cls The class name to set, equivalent to
9290 * <code>setClassName(context, cls.getName())</code>.
9291 *
9292 * @return Returns the same Intent object, for chaining multiple calls
9293 * into a single statement.
9294 *
9295 * @see #setComponent
9296 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009297 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009298 mComponent = new ComponentName(packageContext, cls);
9299 return this;
9300 }
9301
9302 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009303 * Set the bounds of the sender of this intent, in screen coordinates. This can be
9304 * used as a hint to the receiver for animations and the like. Null means that there
9305 * is no source bounds.
9306 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009307 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009308 if (r != null) {
9309 mSourceBounds = new Rect(r);
9310 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07009311 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009312 }
9313 }
9314
Tor Norbyed9273d62013-05-30 15:59:53 -07009315 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07009316 @IntDef(flag = true, prefix = { "FILL_IN_" }, value = {
9317 FILL_IN_ACTION,
9318 FILL_IN_DATA,
9319 FILL_IN_CATEGORIES,
9320 FILL_IN_COMPONENT,
9321 FILL_IN_PACKAGE,
9322 FILL_IN_SOURCE_BOUNDS,
9323 FILL_IN_SELECTOR,
9324 FILL_IN_CLIP_DATA
9325 })
Tor Norbyed9273d62013-05-30 15:59:53 -07009326 @Retention(RetentionPolicy.SOURCE)
9327 public @interface FillInFlags {}
9328
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009329 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009330 * Use with {@link #fillIn} to allow the current action value to be
9331 * overwritten, even if it is already set.
9332 */
9333 public static final int FILL_IN_ACTION = 1<<0;
9334
9335 /**
9336 * Use with {@link #fillIn} to allow the current data or type value
9337 * overwritten, even if it is already set.
9338 */
9339 public static final int FILL_IN_DATA = 1<<1;
9340
9341 /**
9342 * Use with {@link #fillIn} to allow the current categories to be
9343 * overwritten, even if they are already set.
9344 */
9345 public static final int FILL_IN_CATEGORIES = 1<<2;
9346
9347 /**
9348 * Use with {@link #fillIn} to allow the current component value to be
9349 * overwritten, even if it is already set.
9350 */
9351 public static final int FILL_IN_COMPONENT = 1<<3;
9352
9353 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009354 * Use with {@link #fillIn} to allow the current package value to be
9355 * overwritten, even if it is already set.
9356 */
9357 public static final int FILL_IN_PACKAGE = 1<<4;
9358
9359 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009360 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009361 * overwritten, even if it is already set.
9362 */
9363 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
9364
9365 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009366 * Use with {@link #fillIn} to allow the current selector to be
9367 * overwritten, even if it is already set.
9368 */
9369 public static final int FILL_IN_SELECTOR = 1<<6;
9370
9371 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009372 * Use with {@link #fillIn} to allow the current ClipData to be
9373 * overwritten, even if it is already set.
9374 */
9375 public static final int FILL_IN_CLIP_DATA = 1<<7;
9376
9377 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009378 * Copy the contents of <var>other</var> in to this object, but only
9379 * where fields are not defined by this object. For purposes of a field
9380 * being defined, the following pieces of data in the Intent are
9381 * considered to be separate fields:
9382 *
9383 * <ul>
9384 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08009385 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009386 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
9387 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009388 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009389 * <li> component, as set by {@link #setComponent(ComponentName)} or
9390 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009391 * <li> source bounds, as set by {@link #setSourceBounds}.
9392 * <li> selector, as set by {@link #setSelector(Intent)}.
9393 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009394 * <li> each top-level name in the associated extras.
9395 * </ul>
9396 *
9397 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009398 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009399 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
9400 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
9401 * the restriction where the corresponding field will not be replaced if
9402 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009403 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009404 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
9405 * is explicitly specified. The selector will only be copied if
9406 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07009407 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009408 * <p>For example, consider Intent A with {data="foo", categories="bar"}
9409 * and Intent B with {action="gotit", data-type="some/thing",
9410 * categories="one","two"}.
9411 *
9412 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
9413 * containing: {action="gotit", data-type="some/thing",
9414 * categories="bar"}.
9415 *
9416 * @param other Another Intent whose values are to be used to fill in
9417 * the current one.
9418 * @param flags Options to control which fields can be filled in.
9419 *
9420 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009421 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07009422 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08009423 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07009424 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009425 */
Tor Norbyed9273d62013-05-30 15:59:53 -07009426 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009427 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009428 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009429 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009430 if (other.mAction != null
9431 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009432 mAction = other.mAction;
9433 changes |= FILL_IN_ACTION;
9434 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009435 if ((other.mData != null || other.mType != null)
9436 && ((mData == null && mType == null)
9437 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009438 mData = other.mData;
9439 mType = other.mType;
9440 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009441 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009442 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009443 if (other.mCategories != null
9444 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009445 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009446 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009447 }
9448 changes |= FILL_IN_CATEGORIES;
9449 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009450 if (other.mPackage != null
9451 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009452 // Only do this if mSelector is not set.
9453 if (mSelector == null) {
9454 mPackage = other.mPackage;
9455 changes |= FILL_IN_PACKAGE;
9456 }
9457 }
9458 // Selector is special: it can only be set if explicitly allowed,
9459 // for the same reason as the component name.
9460 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
9461 if (mPackage == null) {
9462 mSelector = new Intent(other.mSelector);
9463 mPackage = null;
9464 changes |= FILL_IN_SELECTOR;
9465 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009466 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009467 if (other.mClipData != null
9468 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
9469 mClipData = other.mClipData;
9470 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009471 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009472 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009473 // Component is special: it can -only- be set if explicitly allowed,
9474 // since otherwise the sender could force the intent somewhere the
9475 // originator didn't intend.
9476 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009477 mComponent = other.mComponent;
9478 changes |= FILL_IN_COMPONENT;
9479 }
9480 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009481 if (other.mSourceBounds != null
9482 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
9483 mSourceBounds = new Rect(other.mSourceBounds);
9484 changes |= FILL_IN_SOURCE_BOUNDS;
9485 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009486 if (mExtras == null) {
9487 if (other.mExtras != null) {
9488 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009489 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009490 }
9491 } else if (other.mExtras != null) {
9492 try {
9493 Bundle newb = new Bundle(other.mExtras);
9494 newb.putAll(mExtras);
9495 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009496 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009497 } catch (RuntimeException e) {
9498 // Modifying the extras can cause us to unparcel the contents
9499 // of the bundle, and if we do this in the system process that
9500 // may fail. We really should handle this (i.e., the Bundle
9501 // impl shouldn't be on top of a plain map), but for now just
9502 // ignore it and keep the original contents. :(
9503 Log.w("Intent", "Failure filling in extras", e);
9504 }
9505 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009506 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9507 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9508 mContentUserHint = other.mContentUserHint;
9509 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009510 return changes;
9511 }
9512
9513 /**
9514 * Wrapper class holding an Intent and implementing comparisons on it for
9515 * the purpose of filtering. The class implements its
9516 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9517 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9518 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9519 * on the wrapped Intent.
9520 */
9521 public static final class FilterComparison {
9522 private final Intent mIntent;
9523 private final int mHashCode;
9524
9525 public FilterComparison(Intent intent) {
9526 mIntent = intent;
9527 mHashCode = intent.filterHashCode();
9528 }
9529
9530 /**
9531 * Return the Intent that this FilterComparison represents.
9532 * @return Returns the Intent held by the FilterComparison. Do
9533 * not modify!
9534 */
9535 public Intent getIntent() {
9536 return mIntent;
9537 }
9538
9539 @Override
9540 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009541 if (obj instanceof FilterComparison) {
9542 Intent other = ((FilterComparison)obj).mIntent;
9543 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009544 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009545 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009546 }
9547
9548 @Override
9549 public int hashCode() {
9550 return mHashCode;
9551 }
9552 }
9553
9554 /**
9555 * Determine if two intents are the same for the purposes of intent
9556 * resolution (filtering). That is, if their action, data, type,
9557 * class, and categories are the same. This does <em>not</em> compare
9558 * any extra data included in the intents.
9559 *
9560 * @param other The other Intent to compare against.
9561 *
9562 * @return Returns true if action, data, type, class, and categories
9563 * are the same.
9564 */
9565 public boolean filterEquals(Intent other) {
9566 if (other == null) {
9567 return false;
9568 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009569 if (!Objects.equals(this.mAction, other.mAction)) return false;
9570 if (!Objects.equals(this.mData, other.mData)) return false;
9571 if (!Objects.equals(this.mType, other.mType)) return false;
9572 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9573 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9574 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009575
9576 return true;
9577 }
9578
9579 /**
9580 * Generate hash code that matches semantics of filterEquals().
9581 *
9582 * @return Returns the hash value of the action, data, type, class, and
9583 * categories.
9584 *
9585 * @see #filterEquals
9586 */
9587 public int filterHashCode() {
9588 int code = 0;
9589 if (mAction != null) {
9590 code += mAction.hashCode();
9591 }
9592 if (mData != null) {
9593 code += mData.hashCode();
9594 }
9595 if (mType != null) {
9596 code += mType.hashCode();
9597 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009598 if (mPackage != null) {
9599 code += mPackage.hashCode();
9600 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009601 if (mComponent != null) {
9602 code += mComponent.hashCode();
9603 }
9604 if (mCategories != null) {
9605 code += mCategories.hashCode();
9606 }
9607 return code;
9608 }
9609
9610 @Override
9611 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009612 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009613
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009614 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009615 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009616 b.append(" }");
9617
9618 return b.toString();
9619 }
9620
9621 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01009622 @UnsupportedAppUsage
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009623 public String toInsecureString() {
9624 StringBuilder b = new StringBuilder(128);
9625
9626 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009627 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009628 b.append(" }");
9629
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009630 return b.toString();
9631 }
Romain Guy4969af72009-06-17 10:53:19 -07009632
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009633 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009634 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009635 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009636
9637 b.append("Intent { ");
9638 toShortString(b, false, true, true, true);
9639 b.append(" }");
9640
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009641 return b.toString();
9642 }
9643
9644 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009645 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9646 StringBuilder b = new StringBuilder(128);
9647 toShortString(b, secure, comp, extras, clip);
9648 return b.toString();
9649 }
9650
9651 /** @hide */
9652 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9653 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009654 boolean first = true;
9655 if (mAction != null) {
9656 b.append("act=").append(mAction);
9657 first = false;
9658 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009659 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009660 if (!first) {
9661 b.append(' ');
9662 }
9663 first = false;
9664 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009665 for (int i=0; i<mCategories.size(); i++) {
9666 if (i > 0) b.append(',');
9667 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009668 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009669 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009670 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009671 if (mData != null) {
9672 if (!first) {
9673 b.append(' ');
9674 }
9675 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009676 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009677 if (secure) {
9678 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009679 } else {
9680 b.append(mData);
9681 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009682 }
9683 if (mType != null) {
9684 if (!first) {
9685 b.append(' ');
9686 }
9687 first = false;
9688 b.append("typ=").append(mType);
9689 }
9690 if (mFlags != 0) {
9691 if (!first) {
9692 b.append(' ');
9693 }
9694 first = false;
9695 b.append("flg=0x").append(Integer.toHexString(mFlags));
9696 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009697 if (mPackage != null) {
9698 if (!first) {
9699 b.append(' ');
9700 }
9701 first = false;
9702 b.append("pkg=").append(mPackage);
9703 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009704 if (comp && mComponent != null) {
9705 if (!first) {
9706 b.append(' ');
9707 }
9708 first = false;
9709 b.append("cmp=").append(mComponent.flattenToShortString());
9710 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009711 if (mSourceBounds != null) {
9712 if (!first) {
9713 b.append(' ');
9714 }
9715 first = false;
9716 b.append("bnds=").append(mSourceBounds.toShortString());
9717 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009718 if (mClipData != null) {
9719 if (!first) {
9720 b.append(' ');
9721 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009722 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009723 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009724 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009725 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009726 if (mClipData.getDescription() != null) {
9727 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9728 } else {
9729 first = true;
9730 }
9731 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009732 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009733 first = false;
9734 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009735 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009736 if (extras && mExtras != null) {
9737 if (!first) {
9738 b.append(' ');
9739 }
9740 first = false;
9741 b.append("(has extras)");
9742 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009743 if (mContentUserHint != UserHandle.USER_CURRENT) {
9744 if (!first) {
9745 b.append(' ');
9746 }
9747 first = false;
9748 b.append("u=").append(mContentUserHint);
9749 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009750 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009751 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009752 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009753 b.append("}");
9754 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009755 }
9756
Yi Jin129fc6c2017-09-28 15:48:38 -07009757 /** @hide */
Kweku Adams85f2fbc2017-12-18 12:04:12 -08009758 public void writeToProto(ProtoOutputStream proto, long fieldId) {
9759 // Same input parameters that toString() gives to toShortString().
9760 writeToProto(proto, fieldId, true, true, true, false);
9761 }
9762
9763 /** @hide */
Yi Jin129fc6c2017-09-28 15:48:38 -07009764 public void writeToProto(ProtoOutputStream proto, long fieldId, boolean secure, boolean comp,
9765 boolean extras, boolean clip) {
9766 long token = proto.start(fieldId);
9767 if (mAction != null) {
9768 proto.write(IntentProto.ACTION, mAction);
9769 }
9770 if (mCategories != null) {
9771 for (String category : mCategories) {
9772 proto.write(IntentProto.CATEGORIES, category);
9773 }
9774 }
9775 if (mData != null) {
9776 proto.write(IntentProto.DATA, secure ? mData.toSafeString() : mData.toString());
9777 }
9778 if (mType != null) {
9779 proto.write(IntentProto.TYPE, mType);
9780 }
9781 if (mFlags != 0) {
9782 proto.write(IntentProto.FLAG, "0x" + Integer.toHexString(mFlags));
9783 }
9784 if (mPackage != null) {
9785 proto.write(IntentProto.PACKAGE, mPackage);
9786 }
9787 if (comp && mComponent != null) {
Yi Jin676d1ac2018-01-25 15:40:28 -08009788 mComponent.writeToProto(proto, IntentProto.COMPONENT);
Yi Jin129fc6c2017-09-28 15:48:38 -07009789 }
9790 if (mSourceBounds != null) {
9791 proto.write(IntentProto.SOURCE_BOUNDS, mSourceBounds.toShortString());
9792 }
9793 if (mClipData != null) {
9794 StringBuilder b = new StringBuilder();
9795 if (clip) {
9796 mClipData.toShortString(b);
9797 } else {
9798 mClipData.toShortStringShortItems(b, false);
9799 }
9800 proto.write(IntentProto.CLIP_DATA, b.toString());
9801 }
9802 if (extras && mExtras != null) {
9803 proto.write(IntentProto.EXTRAS, mExtras.toShortString());
9804 }
9805 if (mContentUserHint != 0) {
9806 proto.write(IntentProto.CONTENT_USER_HINT, mContentUserHint);
9807 }
9808 if (mSelector != null) {
9809 proto.write(IntentProto.SELECTOR, mSelector.toShortString(secure, comp, extras, clip));
9810 }
9811 proto.end(token);
9812 }
9813
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009814 /**
9815 * Call {@link #toUri} with 0 flags.
9816 * @deprecated Use {@link #toUri} instead.
9817 */
9818 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009819 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009820 return toUri(0);
9821 }
9822
9823 /**
9824 * Convert this Intent into a String holding a URI representation of it.
9825 * The returned URI string has been properly URI encoded, so it can be
9826 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9827 * Intent's data as the base URI, with an additional fragment describing
9828 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009829 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009830 * <p>You can convert the returned string back to an Intent with
9831 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009832 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009833 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009834 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009835 * @return Returns a URI encoding URI string describing the entire contents
9836 * of the Intent.
9837 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009838 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009839 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009840 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9841 if (mPackage == null) {
9842 throw new IllegalArgumentException(
9843 "Intent must include an explicit package name to build an android-app: "
9844 + this);
9845 }
9846 uri.append("android-app://");
9847 uri.append(mPackage);
9848 String scheme = null;
9849 if (mData != null) {
9850 scheme = mData.getScheme();
9851 if (scheme != null) {
9852 uri.append('/');
9853 uri.append(scheme);
9854 String authority = mData.getEncodedAuthority();
9855 if (authority != null) {
9856 uri.append('/');
9857 uri.append(authority);
9858 String path = mData.getEncodedPath();
9859 if (path != null) {
9860 uri.append(path);
9861 }
9862 String queryParams = mData.getEncodedQuery();
9863 if (queryParams != null) {
9864 uri.append('?');
9865 uri.append(queryParams);
9866 }
9867 String fragment = mData.getEncodedFragment();
9868 if (fragment != null) {
9869 uri.append('#');
9870 uri.append(fragment);
9871 }
9872 }
9873 }
9874 }
9875 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9876 mPackage, flags);
9877 return uri.toString();
9878 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009879 String scheme = null;
9880 if (mData != null) {
9881 String data = mData.toString();
9882 if ((flags&URI_INTENT_SCHEME) != 0) {
9883 final int N = data.length();
9884 for (int i=0; i<N; i++) {
9885 char c = data.charAt(i);
9886 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
Christopher Schuster42c3a6e2017-07-21 14:53:52 -07009887 || (c >= '0' && c <= '9') || c == '.' || c == '-' || c == '+') {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009888 continue;
9889 }
9890 if (c == ':' && i > 0) {
9891 // Valid scheme.
9892 scheme = data.substring(0, i);
9893 uri.append("intent:");
9894 data = data.substring(i+1);
9895 break;
9896 }
Tom Taylord4a47292009-12-21 13:59:18 -08009897
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009898 // No scheme.
9899 break;
9900 }
9901 }
9902 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009903
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009904 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9905 uri.append("intent:");
9906 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009907
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009908 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009909
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009910 return uri.toString();
9911 }
9912
9913 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9914 String defPackage, int flags) {
9915 StringBuilder frag = new StringBuilder(128);
9916
9917 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009918 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009919 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009920 // Note that for now we are not going to try to handle the
9921 // data part; not clear how to represent this as a URI, and
9922 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009923 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9924 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009925 }
9926
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009927 if (frag.length() > 0) {
9928 uri.append("#Intent;");
9929 uri.append(frag);
9930 uri.append("end");
9931 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009932 }
9933
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009934 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9935 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009936 if (scheme != null) {
9937 uri.append("scheme=").append(scheme).append(';');
9938 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009939 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009940 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009941 }
9942 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009943 for (int i=0; i<mCategories.size(); i++) {
9944 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009945 }
9946 }
9947 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009948 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009949 }
9950 if (mFlags != 0) {
9951 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9952 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009953 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009954 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9955 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009956 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009957 uri.append("component=").append(Uri.encode(
9958 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009959 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009960 if (mSourceBounds != null) {
9961 uri.append("sourceBounds=")
9962 .append(Uri.encode(mSourceBounds.flattenToString()))
9963 .append(';');
9964 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009965 if (mExtras != null) {
9966 for (String key : mExtras.keySet()) {
9967 final Object value = mExtras.get(key);
9968 char entryType =
9969 value instanceof String ? 'S' :
9970 value instanceof Boolean ? 'B' :
9971 value instanceof Byte ? 'b' :
9972 value instanceof Character ? 'c' :
9973 value instanceof Double ? 'd' :
9974 value instanceof Float ? 'f' :
9975 value instanceof Integer ? 'i' :
9976 value instanceof Long ? 'l' :
9977 value instanceof Short ? 's' :
9978 '\0';
9979
9980 if (entryType != '\0') {
9981 uri.append(entryType);
9982 uri.append('.');
9983 uri.append(Uri.encode(key));
9984 uri.append('=');
9985 uri.append(Uri.encode(value.toString()));
9986 uri.append(';');
9987 }
9988 }
9989 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009990 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009991
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009992 public int describeContents() {
9993 return (mExtras != null) ? mExtras.describeContents() : 0;
9994 }
9995
9996 public void writeToParcel(Parcel out, int flags) {
9997 out.writeString(mAction);
9998 Uri.writeToParcel(out, mData);
9999 out.writeString(mType);
10000 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -070010001 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010002 ComponentName.writeToParcel(mComponent, out);
10003
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080010004 if (mSourceBounds != null) {
10005 out.writeInt(1);
10006 mSourceBounds.writeToParcel(out, flags);
10007 } else {
10008 out.writeInt(0);
10009 }
10010
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010011 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -070010012 final int N = mCategories.size();
10013 out.writeInt(N);
10014 for (int i=0; i<N; i++) {
10015 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010016 }
10017 } else {
10018 out.writeInt(0);
10019 }
10020
Dianne Hackbornf5b86712011-12-05 17:42:41 -080010021 if (mSelector != null) {
10022 out.writeInt(1);
10023 mSelector.writeToParcel(out, flags);
10024 } else {
10025 out.writeInt(0);
10026 }
10027
Dianne Hackborn21c241e2012-03-08 13:57:23 -080010028 if (mClipData != null) {
10029 out.writeInt(1);
10030 mClipData.writeToParcel(out, flags);
10031 } else {
10032 out.writeInt(0);
10033 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010034 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010035 out.writeBundle(mExtras);
10036 }
10037
10038 public static final Parcelable.Creator<Intent> CREATOR
10039 = new Parcelable.Creator<Intent>() {
10040 public Intent createFromParcel(Parcel in) {
10041 return new Intent(in);
10042 }
10043 public Intent[] newArray(int size) {
10044 return new Intent[size];
10045 }
10046 };
10047
Dianne Hackborneb034652009-09-07 00:49:58 -070010048 /** @hide */
10049 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010050 readFromParcel(in);
10051 }
10052
10053 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -080010054 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010055 mData = Uri.CREATOR.createFromParcel(in);
10056 mType = in.readString();
10057 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -070010058 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010059 mComponent = ComponentName.readFromParcel(in);
10060
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080010061 if (in.readInt() != 0) {
10062 mSourceBounds = Rect.CREATOR.createFromParcel(in);
10063 }
10064
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010065 int N = in.readInt();
10066 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -070010067 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010068 int i;
10069 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -080010070 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010071 }
10072 } else {
10073 mCategories = null;
10074 }
10075
Dianne Hackbornf5b86712011-12-05 17:42:41 -080010076 if (in.readInt() != 0) {
10077 mSelector = new Intent(in);
10078 }
10079
Dianne Hackborn21c241e2012-03-08 13:57:23 -080010080 if (in.readInt() != 0) {
10081 mClipData = new ClipData(in);
10082 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010083 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010084 mExtras = in.readBundle();
10085 }
10086
10087 /**
10088 * Parses the "intent" element (and its children) from XML and instantiates
10089 * an Intent object. The given XML parser should be located at the tag
10090 * where parsing should start (often named "intent"), from which the
10091 * basic action, data, type, and package and class name will be
10092 * retrieved. The function will then parse in to any child elements,
10093 * looking for <category android:name="xxx"> tags to add categories and
10094 * <extra android:name="xxx" android:value="yyy"> to attach extra data
10095 * to the intent.
10096 *
10097 * @param resources The Resources to use when inflating resources.
10098 * @param parser The XML parser pointing at an "intent" tag.
10099 * @param attrs The AttributeSet interface for retrieving extended
10100 * attribute data at the current <var>parser</var> location.
10101 * @return An Intent object matching the XML data.
10102 * @throws XmlPullParserException If there was an XML parsing error.
10103 * @throws IOException If there was an I/O error.
10104 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060010105 public static @NonNull Intent parseIntent(@NonNull Resources resources,
10106 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010107 throws XmlPullParserException, IOException {
10108 Intent intent = new Intent();
10109
10110 TypedArray sa = resources.obtainAttributes(attrs,
10111 com.android.internal.R.styleable.Intent);
10112
10113 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
10114
10115 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
10116 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
10117 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
10118
10119 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
10120 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
10121 if (packageName != null && className != null) {
10122 intent.setComponent(new ComponentName(packageName, className));
10123 }
10124
10125 sa.recycle();
10126
10127 int outerDepth = parser.getDepth();
10128 int type;
10129 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
10130 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
10131 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
10132 continue;
10133 }
10134
10135 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -070010136 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010137 sa = resources.obtainAttributes(attrs,
10138 com.android.internal.R.styleable.IntentCategory);
10139 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
10140 sa.recycle();
10141
10142 if (cat != null) {
10143 intent.addCategory(cat);
10144 }
10145 XmlUtils.skipCurrentTag(parser);
10146
Craig Mautner21d24a22014-04-23 11:45:37 -070010147 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -080010148 if (intent.mExtras == null) {
10149 intent.mExtras = new Bundle();
10150 }
Craig Mautner21d24a22014-04-23 11:45:37 -070010151 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -080010152 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010153
10154 } else {
10155 XmlUtils.skipCurrentTag(parser);
10156 }
10157 }
10158
10159 return intent;
10160 }
Nick Pellyccae4122012-01-09 14:12:58 -080010161
Craig Mautner21d24a22014-04-23 11:45:37 -070010162 /** @hide */
10163 public void saveToXml(XmlSerializer out) throws IOException {
10164 if (mAction != null) {
10165 out.attribute(null, ATTR_ACTION, mAction);
10166 }
10167 if (mData != null) {
10168 out.attribute(null, ATTR_DATA, mData.toString());
10169 }
10170 if (mType != null) {
10171 out.attribute(null, ATTR_TYPE, mType);
10172 }
10173 if (mComponent != null) {
10174 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
10175 }
10176 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
10177
10178 if (mCategories != null) {
10179 out.startTag(null, TAG_CATEGORIES);
10180 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
10181 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
10182 }
Craig Mautner43e52ed2014-06-16 17:18:52 -070010183 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -070010184 }
10185 }
10186
10187 /** @hide */
10188 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
10189 XmlPullParserException {
10190 Intent intent = new Intent();
10191 final int outerDepth = in.getDepth();
10192
10193 int attrCount = in.getAttributeCount();
10194 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
10195 final String attrName = in.getAttributeName(attrNdx);
10196 final String attrValue = in.getAttributeValue(attrNdx);
10197 if (ATTR_ACTION.equals(attrName)) {
10198 intent.setAction(attrValue);
10199 } else if (ATTR_DATA.equals(attrName)) {
10200 intent.setData(Uri.parse(attrValue));
10201 } else if (ATTR_TYPE.equals(attrName)) {
10202 intent.setType(attrValue);
10203 } else if (ATTR_COMPONENT.equals(attrName)) {
10204 intent.setComponent(ComponentName.unflattenFromString(attrValue));
10205 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +010010206 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -070010207 } else {
10208 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
10209 }
10210 }
10211
10212 int event;
10213 String name;
10214 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
10215 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
10216 if (event == XmlPullParser.START_TAG) {
10217 name = in.getName();
10218 if (TAG_CATEGORIES.equals(name)) {
10219 attrCount = in.getAttributeCount();
10220 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
10221 intent.addCategory(in.getAttributeValue(attrNdx));
10222 }
10223 } else {
10224 Log.w("Intent", "restoreFromXml: unknown name=" + name);
10225 XmlUtils.skipCurrentTag(in);
10226 }
10227 }
10228 }
10229
10230 return intent;
10231 }
10232
Nick Pellyccae4122012-01-09 14:12:58 -080010233 /**
10234 * Normalize a MIME data type.
10235 *
10236 * <p>A normalized MIME type has white-space trimmed,
10237 * content-type parameters removed, and is lower-case.
10238 * This aligns the type with Android best practices for
10239 * intent filtering.
10240 *
10241 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
10242 * "text/x-vCard" becomes "text/x-vcard".
10243 *
10244 * <p>All MIME types received from outside Android (such as user input,
10245 * or external sources like Bluetooth, NFC, or the Internet) should
10246 * be normalized before they are used to create an Intent.
10247 *
10248 * @param type MIME data type to normalize
10249 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -050010250 * @see #setType
10251 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -080010252 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060010253 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -080010254 if (type == null) {
10255 return null;
10256 }
10257
Elliott Hughescb64d432013-08-02 10:00:44 -070010258 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -080010259
10260 final int semicolonIndex = type.indexOf(';');
10261 if (semicolonIndex != -1) {
10262 type = type.substring(0, semicolonIndex);
10263 }
10264 return type;
10265 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010266
10267 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010268 * Prepare this {@link Intent} to leave an app process.
10269 *
10270 * @hide
10271 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +010010272 @UnsupportedAppUsage
Jeff Sharkey344744b2016-01-28 19:03:30 -070010273 public void prepareToLeaveProcess(Context context) {
10274 final boolean leavingPackage = (mComponent == null)
10275 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
10276 prepareToLeaveProcess(leavingPackage);
10277 }
10278
10279 /**
10280 * Prepare this {@link Intent} to leave an app process.
10281 *
10282 * @hide
10283 */
10284 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010285 setAllowFds(false);
10286
10287 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010288 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010289 }
10290 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010291 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010292 }
10293
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -070010294 if (mExtras != null && !mExtras.isParcelled()) {
10295 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
10296 if (intent instanceof Intent) {
10297 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
10298 }
10299 }
10300
Jeff Sharkeya8b42782016-01-30 17:58:09 -070010301 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
10302 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010303 switch (mAction) {
10304 case ACTION_MEDIA_REMOVED:
10305 case ACTION_MEDIA_UNMOUNTED:
10306 case ACTION_MEDIA_CHECKING:
10307 case ACTION_MEDIA_NOFS:
10308 case ACTION_MEDIA_MOUNTED:
10309 case ACTION_MEDIA_SHARED:
10310 case ACTION_MEDIA_UNSHARED:
10311 case ACTION_MEDIA_BAD_REMOVAL:
10312 case ACTION_MEDIA_UNMOUNTABLE:
10313 case ACTION_MEDIA_EJECT:
10314 case ACTION_MEDIA_SCANNER_STARTED:
10315 case ACTION_MEDIA_SCANNER_FINISHED:
10316 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -070010317 case ACTION_PACKAGE_NEEDS_VERIFICATION:
10318 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -070010319 // Ignore legacy actions
10320 break;
10321 default:
10322 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010323 }
10324 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010325
10326 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
10327 && leavingPackage) {
10328 switch (mAction) {
10329 case ACTION_PROVIDER_CHANGED:
Makoto Onuki7d1911f2017-06-09 12:30:09 -070010330 case QuickContact.ACTION_QUICK_CONTACT:
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010331 // Ignore actions that don't need to grant
10332 break;
10333 default:
10334 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
10335 }
10336 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010337 }
10338
10339 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010340 * @hide
10341 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010342 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -070010343 // We just entered destination process, so we should be able to read all
10344 // parcelables inside.
10345 setDefusable(true);
10346
10347 if (mSelector != null) {
10348 mSelector.prepareToEnterProcess();
10349 }
10350 if (mClipData != null) {
10351 mClipData.prepareToEnterProcess();
10352 }
10353
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010354 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000010355 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
10356 fixUris(mContentUserHint);
10357 mContentUserHint = UserHandle.USER_CURRENT;
10358 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010359 }
10360 }
10361
Patrick Baumann577d4022018-01-31 16:55:10 +000010362 /** @hide */
10363 public boolean hasWebURI() {
10364 if (getData() == null) {
10365 return false;
10366 }
10367 final String scheme = getScheme();
10368 if (TextUtils.isEmpty(scheme)) {
10369 return false;
10370 }
10371 return scheme.equals(IntentFilter.SCHEME_HTTP) || scheme.equals(IntentFilter.SCHEME_HTTPS);
10372 }
10373
10374 /** @hide */
Patrick Baumann0da85372018-02-02 16:07:35 -080010375 public boolean isWebIntent() {
Patrick Baumann577d4022018-01-31 16:55:10 +000010376 return ACTION_VIEW.equals(mAction)
Patrick Baumann577d4022018-01-31 16:55:10 +000010377 && hasWebURI();
10378 }
10379
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010380 /**
10381 * @hide
10382 */
10383 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010384 Uri data = getData();
10385 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010386 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010387 }
10388 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010389 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010390 }
10391 String action = getAction();
10392 if (ACTION_SEND.equals(action)) {
10393 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10394 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010395 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010396 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010397 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010398 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10399 if (streams != null) {
10400 ArrayList<Uri> newStreams = new ArrayList<Uri>();
10401 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010402 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010403 }
10404 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
10405 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010406 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10407 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10408 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10409 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10410 if (output != null) {
10411 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
10412 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010413 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010414 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010415
10416 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010417 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010418 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
10419 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010420 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010421 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010422 * @hide
10423 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010424 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010425 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010426 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010427
10428 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010429 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010430
10431 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010432 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010433 // Inspect contained intents to see if we need to migrate extras. We
10434 // don't promote ClipData to the parent, since ChooserActivity will
10435 // already start the picked item as the caller, and we can't combine
10436 // the flags in a safe way.
10437
10438 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -070010439 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010440 final Intent intent = getParcelableExtra(EXTRA_INTENT);
10441 if (intent != null) {
10442 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -070010443 }
10444 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010445 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010446 try {
10447 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
10448 if (intents != null) {
10449 for (int i = 0; i < intents.length; i++) {
10450 final Intent intent = (Intent) intents[i];
10451 if (intent != null) {
10452 migrated |= intent.migrateExtraStreamToClipData();
10453 }
10454 }
10455 }
10456 } catch (ClassCastException e) {
10457 }
10458 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010459
10460 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010461 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010462 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10463 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
10464 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
10465 if (stream != null || text != null || htmlText != null) {
10466 final ClipData clipData = new ClipData(
10467 null, new String[] { getType() },
10468 new ClipData.Item(text, htmlText, null, stream));
10469 setClipData(clipData);
10470 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010471 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010472 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010473 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010474 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010475
10476 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010477 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010478 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10479 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
10480 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
10481 int num = -1;
10482 if (streams != null) {
10483 num = streams.size();
10484 }
10485 if (texts != null) {
10486 if (num >= 0 && num != texts.size()) {
10487 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010488 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010489 }
10490 num = texts.size();
10491 }
10492 if (htmlTexts != null) {
10493 if (num >= 0 && num != htmlTexts.size()) {
10494 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010495 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010496 }
10497 num = htmlTexts.size();
10498 }
10499 if (num > 0) {
10500 final ClipData clipData = new ClipData(
10501 null, new String[] { getType() },
10502 makeClipItem(streams, texts, htmlTexts, 0));
10503
10504 for (int i = 1; i < num; i++) {
10505 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
10506 }
10507
10508 setClipData(clipData);
10509 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010510 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010511 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010512 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010513 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010514 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10515 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10516 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10517 final Uri output;
10518 try {
10519 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10520 } catch (ClassCastException e) {
10521 return false;
10522 }
10523 if (output != null) {
10524 setClipData(ClipData.newRawUri("", output));
10525 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
10526 return true;
10527 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010528 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010529
10530 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010531 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010532
Michael Wright19859762017-09-18 20:57:58 +010010533 /**
10534 * Convert the dock state to a human readable format.
10535 * @hide
10536 */
10537 public static String dockStateToString(int dock) {
10538 switch (dock) {
10539 case EXTRA_DOCK_STATE_HE_DESK:
10540 return "EXTRA_DOCK_STATE_HE_DESK";
10541 case EXTRA_DOCK_STATE_LE_DESK:
10542 return "EXTRA_DOCK_STATE_LE_DESK";
10543 case EXTRA_DOCK_STATE_CAR:
10544 return "EXTRA_DOCK_STATE_CAR";
10545 case EXTRA_DOCK_STATE_DESK:
10546 return "EXTRA_DOCK_STATE_DESK";
10547 case EXTRA_DOCK_STATE_UNDOCKED:
10548 return "EXTRA_DOCK_STATE_UNDOCKED";
10549 default:
10550 return Integer.toString(dock);
10551 }
10552 }
10553
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010554 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
10555 ArrayList<String> htmlTexts, int which) {
10556 Uri uri = streams != null ? streams.get(which) : null;
10557 CharSequence text = texts != null ? texts.get(which) : null;
10558 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
10559 return new ClipData.Item(text, htmlText, null, uri);
10560 }
Craig Mautnerd00f4742014-03-12 14:17:26 -070010561
10562 /** @hide */
10563 public boolean isDocument() {
10564 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
10565 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010566}