blob: ab271c9282de07a3347ca07612257e484b95c8a2 [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>
Joel Galensonad219782018-11-21 10:43:18 -08001770 * <li> {@link #EXTRA_USER} specifies the UserHandle of the user that owns the app.
1771 * </p>
1772 * <p>
Philip P. Moltmanned988282018-11-07 16:19:42 -08001773 * Output: Nothing.
1774 * </p>
1775 *
1776 * @see #EXTRA_PACKAGE_NAME
1777 * @see #EXTRA_PERMISSION_NAME
1778 *
1779 * @hide
1780 */
1781 @SystemApi
1782 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1783 public static final String ACTION_MANAGE_APP_PERMISSION =
1784 "android.intent.action.MANAGE_APP_PERMISSION";
1785
1786 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001787 * Activity action: Launch UI to manage permissions.
1788 * <p>
1789 * Input: Nothing.
1790 * </p>
1791 * <p>
1792 * Output: Nothing.
1793 * </p>
1794 *
1795 * @hide
1796 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001797 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001798 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1799 public static final String ACTION_MANAGE_PERMISSIONS =
1800 "android.intent.action.MANAGE_PERMISSIONS";
1801
1802 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001803 * Activity action: Launch UI to review permissions for an app.
1804 * The system uses this intent if permission review for apps not
1805 * supporting the new runtime permissions model is enabled. In
1806 * this mode a permission review is required before any of the
1807 * app components can run.
1808 * <p>
1809 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1810 * permissions will be reviewed (mandatory).
1811 * </p>
1812 * <p>
1813 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1814 * be fired after the permission review (optional).
1815 * </p>
1816 * <p>
1817 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1818 * be invoked after the permission review (optional).
1819 * </p>
1820 * <p>
1821 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1822 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1823 * </p>
1824 * <p>
1825 * Output: Nothing.
1826 * </p>
1827 *
1828 * @see #EXTRA_PACKAGE_NAME
1829 * @see #EXTRA_INTENT
1830 * @see #EXTRA_REMOTE_CALLBACK
1831 * @see #EXTRA_RESULT_NEEDED
1832 *
1833 * @hide
1834 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001835 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001836 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1837 public static final String ACTION_REVIEW_PERMISSIONS =
1838 "android.intent.action.REVIEW_PERMISSIONS";
1839
1840 /**
1841 * Intent extra: A callback for reporting remote result as a bundle.
1842 * <p>
1843 * Type: IRemoteCallback
1844 * </p>
1845 *
1846 * @hide
1847 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001848 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001849 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1850
1851 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001852 * Intent extra: An app package name.
1853 * <p>
1854 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001855 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001856 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001857 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001858 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1859
1860 /**
Suprabh Shukla96212bc2018-04-10 15:04:51 -07001861 * Intent extra: A {@link Bundle} of extras for a package being suspended. Will be sent as an
1862 * extra with {@link #ACTION_MY_PACKAGE_SUSPENDED}.
1863 *
1864 * <p>The contents of this {@link Bundle} are a contract between the suspended app and the
1865 * suspending app, i.e. any app with the permission {@code android.permission.SUSPEND_APPS}.
1866 * This is meant to enable the suspended app to better handle the state of being suspended.
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07001867 *
1868 * @see #ACTION_MY_PACKAGE_SUSPENDED
1869 * @see #ACTION_MY_PACKAGE_UNSUSPENDED
1870 * @see PackageManager#isPackageSuspended()
1871 * @see PackageManager#getSuspendedPackageAppExtras()
1872 */
1873 public static final String EXTRA_SUSPENDED_PACKAGE_EXTRAS = "android.intent.extra.SUSPENDED_PACKAGE_EXTRAS";
1874
1875 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001876 * Intent extra: An app split name.
1877 * <p>
1878 * Type: String
1879 * </p>
Todd Kennedye5195dd2016-10-19 15:29:19 -07001880 */
Todd Kennedye5195dd2016-10-19 15:29:19 -07001881 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1882
1883 /**
Jeff Sharkey1a749422017-04-28 14:19:50 -06001884 * Intent extra: A {@link ComponentName} value.
1885 * <p>
1886 * Type: String
1887 * </p>
1888 */
1889 public static final String EXTRA_COMPONENT_NAME = "android.intent.extra.COMPONENT_NAME";
1890
1891 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001892 * Intent extra: An extra for specifying whether a result is needed.
1893 * <p>
1894 * Type: boolean
1895 * </p>
1896 *
1897 * @hide
1898 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001899 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001900 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1901
1902 /**
Suprabh Shukla19b41f32018-03-26 22:35:13 -07001903 * Intent extra: A {@link Bundle} of extras supplied for the launcher when any packages on
1904 * device are suspended. Will be sent with {@link #ACTION_PACKAGES_SUSPENDED}.
1905 *
1906 * @see PackageManager#isPackageSuspended()
1907 * @see #ACTION_PACKAGES_SUSPENDED
1908 *
1909 * @hide
1910 */
1911 public static final String EXTRA_LAUNCHER_EXTRAS = "android.intent.extra.LAUNCHER_EXTRAS";
1912
1913 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001914 * Activity action: Launch UI to manage which apps have a given permission.
1915 * <p>
Philip P. Moltmanned988282018-11-07 16:19:42 -08001916 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission group
1917 * which will be managed by the launched UI.
Svet Ganov3695b8a2015-03-24 16:30:25 -07001918 * </p>
1919 * <p>
1920 * Output: Nothing.
1921 * </p>
1922 *
1923 * @see #EXTRA_PERMISSION_NAME
1924 *
1925 * @hide
1926 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001927 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001928 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1929 public static final String ACTION_MANAGE_PERMISSION_APPS =
1930 "android.intent.action.MANAGE_PERMISSION_APPS";
1931
1932 /**
1933 * Intent extra: The name of a permission.
1934 * <p>
1935 * Type: String
1936 * </p>
1937 *
1938 * @hide
1939 */
1940 @SystemApi
1941 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1942
Joel Galenson13096ea2018-09-27 11:18:44 -07001943 /**
1944 * Activity action: Launch UI to review app uses of permissions.
1945 * <p>
1946 * Input: Nothing
1947 * </p>
1948 * <p>
1949 * Output: Nothing.
1950 * </p>
1951 *
1952 * @hide
1953 */
1954 @SystemApi
1955 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1956 public static final String ACTION_REVIEW_PERMISSION_USAGE =
1957 "android.intent.action.REVIEW_PERMISSION_USAGE";
1958
Joel Galenson78ec58d2018-10-24 10:06:25 -07001959 /**
1960 * Activity action: Launch UI to review uses of permissions for a single app.
1961 * <p>
1962 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1963 * permissions will be reviewed (mandatory).
1964 * </p>
1965 * <p>
1966 * Output: Nothing.
1967 * </p>
1968 * <p class="note">
1969 * This requires {@link android.Manifest.permission#GRANT_RUNTIME_PERMISSIONS} permission.
1970 * </p>
1971 *
1972 * @see #EXTRA_PACKAGE_NAME
1973 *
1974 * @hide
1975 */
1976 @SystemApi
1977 @RequiresPermission(android.Manifest.permission.GRANT_RUNTIME_PERMISSIONS)
1978 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1979 public static final String ACTION_REVIEW_APP_PERMISSION_USAGE =
1980 "android.intent.action.REVIEW_APP_PERMISSION_USAGE";
1981
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001982 // ---------------------------------------------------------------------
1983 // ---------------------------------------------------------------------
1984 // Standard intent broadcast actions (see action variable).
1985
1986 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001987 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1988 * <p>
1989 * For historical reasons, the name of this broadcast action refers to the power
1990 * state of the screen but it is actually sent in response to changes in the
1991 * overall interactive state of the device.
1992 * </p><p>
1993 * This broadcast is sent when the device becomes non-interactive which may have
1994 * nothing to do with the screen turning off. To determine the
1995 * actual state of the screen, use {@link android.view.Display#getState}.
1996 * </p><p>
1997 * See {@link android.os.PowerManager#isInteractive} for details.
1998 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001999 * You <em>cannot</em> receive this through components declared in
2000 * manifests, only by explicitly registering for it with
2001 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2002 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002003 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002004 * <p class="note">This is a protected intent that can only be sent
2005 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002006 */
2007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2008 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07002009
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002010 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07002011 * Broadcast Action: Sent when the device wakes up and becomes interactive.
2012 * <p>
2013 * For historical reasons, the name of this broadcast action refers to the power
2014 * state of the screen but it is actually sent in response to changes in the
2015 * overall interactive state of the device.
2016 * </p><p>
2017 * This broadcast is sent when the device becomes interactive which may have
2018 * nothing to do with the screen turning on. To determine the
2019 * actual state of the screen, use {@link android.view.Display#getState}.
2020 * </p><p>
2021 * See {@link android.os.PowerManager#isInteractive} for details.
2022 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07002023 * You <em>cannot</em> receive this through components declared in
2024 * manifests, only by explicitly registering for it with
2025 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2026 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002027 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002028 * <p class="note">This is a protected intent that can only be sent
2029 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002030 */
2031 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2032 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07002033
2034 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07002035 * Broadcast Action: Sent after the system stops dreaming.
2036 *
2037 * <p class="note">This is a protected intent that can only be sent by the system.
2038 * It is only sent to registered receivers.</p>
2039 */
2040 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2041 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
2042
2043 /**
2044 * Broadcast Action: Sent after the system starts dreaming.
2045 *
2046 * <p class="note">This is a protected intent that can only be sent by the system.
2047 * It is only sent to registered receivers.</p>
2048 */
2049 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2050 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
2051
2052 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07002053 * 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 -07002054 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08002055 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002056 * <p class="note">This is a protected intent that can only be sent
2057 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07002058 */
2059 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002060 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07002061
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002062 /**
2063 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07002064 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04002065 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002066 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2067 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002068 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002069 * <p class="note">This is a protected intent that can only be sent
2070 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002071 */
2072 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2073 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
2074 /**
2075 * Broadcast Action: The time was set.
2076 */
2077 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2078 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
2079 /**
2080 * Broadcast Action: The date has changed.
2081 */
2082 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2083 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
2084 /**
2085 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
2086 * <ul>
2087 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
2088 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002089 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002090 * <p class="note">This is a protected intent that can only be sent
2091 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002092 */
2093 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2094 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
2095 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07002096 * Clear DNS Cache Action: This is broadcast when networks have changed and old
2097 * DNS entries should be tossed.
2098 * @hide
2099 */
2100 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2101 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
2102 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002103 * Alarm Changed Action: This is broadcast when the AlarmClock
2104 * application's alarm is set or unset. It is used by the
2105 * AlarmClock application and the StatusBar service.
2106 * @hide
2107 */
2108 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002109 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002110 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002111
2112 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002113 * Broadcast Action: This is broadcast once, after the user has finished
2114 * booting, but while still in the "locked" state. It can be used to perform
2115 * application-specific initialization, such as installing alarms. You must
2116 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
2117 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002118 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002119 * This broadcast is sent immediately at boot by all devices (regardless of
2120 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
2121 * higher. Upon receipt of this broadcast, the user is still locked and only
2122 * device-protected storage can be accessed safely. If you want to access
2123 * credential-protected storage, you need to wait for the user to be
2124 * unlocked (typically by entering their lock pattern or PIN for the first
2125 * time), after which the {@link #ACTION_USER_UNLOCKED} and
2126 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
2127 * <p>
2128 * To receive this broadcast, your receiver component must be marked as
2129 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002130 * <p class="note">
2131 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002132 *
2133 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002134 */
2135 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2136 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2137
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002138 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002139 * Broadcast Action: This is broadcast once, after the user has finished
2140 * booting. It can be used to perform application-specific initialization,
2141 * such as installing alarms. You must hold the
2142 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2143 * order to receive this broadcast.
2144 * <p>
2145 * This broadcast is sent at boot by all devices (both with and without
2146 * direct boot support). Upon receipt of this broadcast, the user is
2147 * unlocked and both device-protected and credential-protected storage can
2148 * accessed safely.
2149 * <p>
2150 * If you need to run while the user is still locked (before they've entered
2151 * their lock pattern or PIN for the first time), you can listen for the
2152 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2153 * <p class="note">
2154 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002155 */
2156 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002157 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002158 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002159
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002160 /**
2161 * Broadcast Action: This is broadcast when a user action should request a
2162 * temporary system dialog to dismiss. Some examples of temporary system
2163 * dialogs are the notification window-shade and the recent tasks dialog.
2164 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002165 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002166 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2167 /**
2168 * Broadcast Action: Trigger the download and eventual installation
2169 * of a package.
2170 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002171 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002172 * <p class="note">This is a protected intent that can only be sent
2173 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002174 *
2175 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002176 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002177 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002178 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2179 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2180 /**
Christopher Tate94b91db2017-04-19 15:49:17 -07002181 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002182 * device. The data contains the name of the package. Note that the
2183 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002184 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002185 * <ul>
Christopher Tate94b91db2017-04-19 15:49:17 -07002186 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2187 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002188 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2189 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002190 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002191 * <p class="note">This is a protected intent that can only be sent
2192 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002193 */
2194 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2195 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2196 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002197 * Broadcast Action: A new version of an application package has been
2198 * installed, replacing an existing version that was previously installed.
2199 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002200 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002201 * <ul>
2202 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2203 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002204 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002205 * <p class="note">This is a protected intent that can only be sent
2206 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002207 */
2208 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2209 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2210 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002211 * Broadcast Action: A new version of your application has been installed
2212 * over an existing one. This is only sent to the application that was
2213 * replaced. It does not contain any additional data; to receive it, just
2214 * use an intent filter for this action.
2215 *
2216 * <p class="note">This is a protected intent that can only be sent
2217 * by the system.
2218 */
2219 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2220 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2221 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002222 * Broadcast Action: An existing application package has been removed from
2223 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002224 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002225 * <ul>
2226 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2227 * to the package.
2228 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2229 * application -- data and code -- is being removed.
2230 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2231 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2232 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002233 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002234 * <p class="note">This is a protected intent that can only be sent
2235 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002236 */
2237 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2238 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2239 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002240 * Broadcast Action: An existing application package has been completely
2241 * removed from the device. The data contains the name of the package.
2242 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2243 * {@link #EXTRA_DATA_REMOVED} is true and
2244 * {@link #EXTRA_REPLACING} is false of that broadcast.
2245 *
2246 * <ul>
2247 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2248 * to the package.
2249 * </ul>
2250 *
2251 * <p class="note">This is a protected intent that can only be sent
2252 * by the system.
2253 */
2254 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2255 public static final String ACTION_PACKAGE_FULLY_REMOVED
2256 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2257 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002258 * Broadcast Action: An existing application package has been changed (for
2259 * example, a component has been enabled or disabled). The data contains
2260 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002261 * <ul>
2262 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002263 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002264 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002265 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2266 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002267 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002268 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002269 * <p class="note">This is a protected intent that can only be sent
2270 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002271 */
2272 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2273 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2274 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002275 * @hide
2276 * Broadcast Action: Ask system services if there is any reason to
2277 * restart the given package. The data contains the name of the
2278 * package.
2279 * <ul>
2280 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2281 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2282 * </ul>
2283 *
2284 * <p class="note">This is a protected intent that can only be sent
2285 * by the system.
2286 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002287 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002288 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2289 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2290 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002291 * Broadcast Action: The user has restarted a package, and all of its
2292 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002293 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002294 * be removed. Note that the restarted package does <em>not</em>
2295 * receive this broadcast.
2296 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002297 * <ul>
2298 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2299 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002300 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002301 * <p class="note">This is a protected intent that can only be sent
2302 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002303 */
2304 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2305 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2306 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002307 * Broadcast Action: The user has cleared the data of a package. This should
2308 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002309 * its persistent data is erased and this broadcast sent.
2310 * Note that the cleared package does <em>not</em>
2311 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002312 * <ul>
Svet Ganovf935a702017-08-22 12:15:58 -07002313 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package. If the
2314 * package whose data was cleared is an uninstalled instant app, then the UID
2315 * will be -1. The platform keeps some meta-data associated with instant apps
2316 * after they are uninstalled.
2317 * <li> {@link #EXTRA_PACKAGE_NAME} containing the package name only if the cleared
2318 * data was for an instant app.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002319 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002320 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002321 * <p class="note">This is a protected intent that can only be sent
2322 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002323 */
2324 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2325 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2326 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002327 * Broadcast Action: Packages have been suspended.
2328 * <p>Includes the following extras:
2329 * <ul>
2330 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
Julia Reynolds4bc42b92018-08-14 11:27:35 -04002331 * <li> {@link #EXTRA_CHANGED_UID_LIST} is the set of uids which have been suspended
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002332 * </ul>
2333 *
2334 * <p class="note">This is a protected intent that can only be sent
2335 * by the system. It is only sent to registered receivers.
2336 */
2337 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2338 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2339 /**
2340 * Broadcast Action: Packages have been unsuspended.
2341 * <p>Includes the following extras:
2342 * <ul>
2343 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
Julia Reynolds4bc42b92018-08-14 11:27:35 -04002344 * <li> {@link #EXTRA_CHANGED_UID_LIST} is the set of uids which have been unsuspended
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002345 * </ul>
2346 *
2347 * <p class="note">This is a protected intent that can only be sent
2348 * by the system. It is only sent to registered receivers.
2349 */
2350 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2351 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002352
2353 /**
2354 * Broadcast Action: Sent to a package that has been suspended by the system. This is sent
Suprabh Shukla19b41f32018-03-26 22:35:13 -07002355 * whenever a package is put into a suspended state or any of its app extras change while in the
2356 * suspended state.
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002357 * <p> Optionally includes the following extras:
2358 * <ul>
2359 * <li> {@link #EXTRA_SUSPENDED_PACKAGE_EXTRAS} which is a {@link Bundle} which will contain
2360 * useful information for the app being suspended.
2361 * </ul>
2362 * <p class="note">This is a protected intent that can only be sent
2363 * by the system. <em>This will be delivered to {@link BroadcastReceiver} components declared in
2364 * the manifest.</em>
2365 *
2366 * @see #ACTION_MY_PACKAGE_UNSUSPENDED
2367 * @see #EXTRA_SUSPENDED_PACKAGE_EXTRAS
2368 * @see PackageManager#isPackageSuspended()
2369 * @see PackageManager#getSuspendedPackageAppExtras()
2370 */
2371 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2372 public static final String ACTION_MY_PACKAGE_SUSPENDED = "android.intent.action.MY_PACKAGE_SUSPENDED";
2373
2374 /**
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002375 * Activity Action: Started to show more details about why an application was suspended.
2376 *
Suprabh Shukla3e03ab92018-04-11 16:03:49 -07002377 * <p>Whenever the system detects an activity launch for a suspended app, this action can
2378 * be used to show more details about the reason for suspension.
Suprabh Shukla96212bc2018-04-10 15:04:51 -07002379 *
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002380 * <p>Apps holding {@link android.Manifest.permission#SUSPEND_APPS} must declare an activity
2381 * handling this intent and protect it with
2382 * {@link android.Manifest.permission#SEND_SHOW_SUSPENDED_APP_DETAILS}.
2383 *
2384 * <p>Includes an extra {@link #EXTRA_PACKAGE_NAME} which is the name of the suspended package.
2385 *
2386 * <p class="note">This is a protected intent that can only be sent
2387 * by the system.
2388 *
Suprabh Shukla96212bc2018-04-10 15:04:51 -07002389 * @see PackageManager#setPackagesSuspended(String[], boolean, PersistableBundle,
2390 * PersistableBundle, String)
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002391 * @see PackageManager#isPackageSuspended()
2392 * @see #ACTION_PACKAGES_SUSPENDED
2393 *
2394 * @hide
2395 */
2396 @SystemApi
2397 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2398 public static final String ACTION_SHOW_SUSPENDED_APP_DETAILS =
2399 "android.intent.action.SHOW_SUSPENDED_APP_DETAILS";
2400
2401 /**
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002402 * Broadcast Action: Sent to a package that has been unsuspended.
2403 *
2404 * <p class="note">This is a protected intent that can only be sent
2405 * by the system. <em>This will be delivered to {@link BroadcastReceiver} components declared in
2406 * the manifest.</em>
2407 *
2408 * @see #ACTION_MY_PACKAGE_SUSPENDED
2409 * @see #EXTRA_SUSPENDED_PACKAGE_EXTRAS
2410 * @see PackageManager#isPackageSuspended()
2411 * @see PackageManager#getSuspendedPackageAppExtras()
2412 */
2413 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2414 public static final String ACTION_MY_PACKAGE_UNSUSPENDED = "android.intent.action.MY_PACKAGE_UNSUSPENDED";
2415
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002416 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002417 * Broadcast Action: A user ID has been removed from the system. The user
2418 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002419 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002420 * <p class="note">This is a protected intent that can only be sent
2421 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002422 */
2423 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2424 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002425
2426 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002427 * Broadcast Action: Sent to the installer package of an application when
2428 * that application is first launched (that is the first time it is moved
2429 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002430 *
2431 * <p class="note">This is a protected intent that can only be sent
2432 * by the system.
2433 */
2434 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2435 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2436
2437 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002438 * Broadcast Action: Sent to the system package verifier when a package
2439 * needs to be verified. The data contains the package URI.
2440 * <p class="note">
2441 * This is a protected intent that can only be sent by the system.
2442 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002443 */
2444 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2445 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2446
2447 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002448 * Broadcast Action: Sent to the system package verifier when a package is
2449 * verified. The data contains the package URI.
2450 * <p class="note">
2451 * This is a protected intent that can only be sent by the system.
2452 */
2453 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2454 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2455
2456 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002457 * Broadcast Action: Sent to the system intent filter verifier when an
2458 * intent filter needs to be verified. The data contains the filter data
2459 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002460 * <p class="note">
2461 * This is a protected intent that can only be sent by the system.
2462 * </p>
2463 *
2464 * @hide
2465 */
2466 @SystemApi
2467 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2468 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2469
2470 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002471 * Broadcast Action: Resources for a set of packages (which were
2472 * previously unavailable) are currently
2473 * available since the media on which they exist is available.
2474 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2475 * list of packages whose availability changed.
2476 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2477 * list of uids of packages whose availability changed.
2478 * Note that the
2479 * packages in this list do <em>not</em> receive this broadcast.
2480 * The specified set of packages are now available on the system.
2481 * <p>Includes the following extras:
2482 * <ul>
2483 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2484 * whose resources(were previously unavailable) are currently available.
2485 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2486 * packages whose resources(were previously unavailable)
2487 * are currently available.
2488 * </ul>
2489 *
2490 * <p class="note">This is a protected intent that can only be sent
2491 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002492 */
2493 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002494 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2495 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002496
2497 /**
2498 * Broadcast Action: Resources for a set of packages are currently
2499 * unavailable since the media on which they exist is unavailable.
2500 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2501 * list of packages whose availability changed.
2502 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2503 * list of uids of packages whose availability changed.
2504 * The specified set of packages can no longer be
2505 * launched and are practically unavailable on the system.
2506 * <p>Inclues the following extras:
2507 * <ul>
2508 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2509 * whose resources are no longer available.
2510 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2511 * whose resources are no longer available.
2512 * </ul>
2513 *
2514 * <p class="note">This is a protected intent that can only be sent
2515 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002516 */
2517 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002518 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002519 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002520
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002521 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002522 * Broadcast Action: preferred activities have changed *explicitly*.
2523 *
2524 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2525 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2526 * be sent.
2527 *
2528 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2529 *
2530 * @hide
2531 */
2532 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2533 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2534 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2535
2536
2537 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002538 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002539 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002540 * This should <em>only</em> be used to determine when the wallpaper
2541 * has changed to show the new wallpaper to the user. You should certainly
2542 * never, in response to this, change the wallpaper or other attributes of
2543 * it such as the suggested size. That would be crazy, right? You'd cause
2544 * all kinds of loops, especially if other apps are doing similar things,
2545 * right? Of course. So please don't do this.
2546 *
2547 * @deprecated Modern applications should use
2548 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2549 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2550 * shown behind their UI, rather than watching for this broadcast and
2551 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002552 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002553 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002554 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2555 /**
2556 * Broadcast Action: The current device {@link android.content.res.Configuration}
2557 * (orientation, locale, etc) has changed. When such a change happens, the
2558 * UIs (view hierarchy) will need to be rebuilt based on this new
2559 * information; for the most part, applications don't need to worry about
2560 * this, because the system will take care of stopping and restarting the
2561 * application to make sure it sees the new changes. Some system code that
2562 * can not be restarted will need to watch for this action and handle it
2563 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002564 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002565 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002566 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002567 * in manifests, only by explicitly registering for it with
2568 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2569 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002570 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002571 * <p class="note">This is a protected intent that can only be sent
2572 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002573 *
2574 * @see android.content.res.Configuration
2575 */
2576 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2577 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
Adam Lesinski57fccd62018-01-25 13:03:57 -08002578
2579 /**
2580 * Broadcast Action: The current device {@link android.content.res.Configuration} has changed
2581 * such that the device may be eligible for the installation of additional configuration splits.
2582 * Configuration properties that can trigger this broadcast include locale and display density.
2583 *
2584 * <p class="note">
2585 * Unlike {@link #ACTION_CONFIGURATION_CHANGED}, you <em>can</em> receive this through
2586 * components declared in manifests. However, the receiver <em>must</em> hold the
2587 * {@link android.Manifest.permission#INSTALL_PACKAGES} permission.
2588 *
2589 * <p class="note">
2590 * This is a protected intent that can only be sent by the system.
2591 *
2592 * @hide
2593 */
2594 @SystemApi
2595 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2596 public static final String ACTION_SPLIT_CONFIGURATION_CHANGED =
2597 "android.intent.action.SPLIT_CONFIGURATION_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002598 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002599 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002600 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002601 * <p class="note">This is a protected intent that can only be sent
2602 * by the system.
2603 */
2604 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2605 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2606 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002607 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2608 * charging state, level, and other information about the battery.
2609 * See {@link android.os.BatteryManager} for documentation on the
2610 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002611 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002612 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002613 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002614 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002615 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002616 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2617 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2618 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2619 * broadcasts that are sent and can be received through manifest
2620 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002621 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002622 * <p class="note">This is a protected intent that can only be sent
2623 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002624 */
2625 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2626 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
Fyodor Kupolov70e75432018-03-01 18:29:06 -08002627
2628
2629 /**
2630 * Broadcast Action: Sent when the current battery level changes.
2631 *
2632 * It has {@link android.os.BatteryManager#EXTRA_EVENTS} that carries a list of {@link Bundle}
2633 * instances representing individual battery level changes with associated
2634 * extras from {@link #ACTION_BATTERY_CHANGED}.
2635 *
2636 * <p class="note">
2637 * This broadcast requires {@link android.Manifest.permission#BATTERY_STATS} permission.
2638 *
2639 * @hide
2640 */
2641 @SystemApi
2642 public static final String ACTION_BATTERY_LEVEL_CHANGED =
2643 "android.intent.action.BATTERY_LEVEL_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002644 /**
2645 * Broadcast Action: Indicates low battery condition on the device.
2646 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002647 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002648 * <p class="note">This is a protected intent that can only be sent
2649 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002650 */
2651 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2652 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2653 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002654 * Broadcast Action: Indicates the battery is now okay after being low.
2655 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2656 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002657 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002658 * <p class="note">This is a protected intent that can only be sent
2659 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002660 */
2661 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2662 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2663 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002664 * Broadcast Action: External power has been connected to the device.
2665 * This is intended for applications that wish to register specifically to this notification.
2666 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2667 * stay active to receive this notification. This action can be used to implement actions
2668 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002669 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002670 * <p class="note">This is a protected intent that can only be sent
2671 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002672 */
2673 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002674 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002675 /**
2676 * Broadcast Action: External power has been removed from the device.
2677 * This is intended for applications that wish to register specifically to this notification.
2678 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2679 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002680 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002681 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002682 * <p class="note">This is a protected intent that can only be sent
2683 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002684 */
2685 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002686 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002687 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002688 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002689 * Broadcast Action: Device is shutting down.
2690 * This is broadcast when the device is being shut down (completely turned
2691 * off, not sleeping). Once the broadcast is complete, the final shutdown
2692 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002693 * to handle this, since the foreground activity will be paused as well.
Fyodor Kupolov1fc62602018-02-01 15:48:53 -08002694 * <p>As of {@link Build.VERSION_CODES#P} this broadcast is only sent to receivers registered
2695 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2696 * Context.registerReceiver}.
Tom Taylord4a47292009-12-21 13:59:18 -08002697 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002698 * <p class="note">This is a protected intent that can only be sent
2699 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002700 * <p>May include the following extras:
2701 * <ul>
2702 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2703 * shutdown is only for userspace processes. If not set, assumed to be false.
2704 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002705 */
2706 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002707 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002708 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002709 * Activity Action: Start this activity to request system shutdown.
2710 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002711 * to request confirmation from the user before shutting down. The optional boolean
2712 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2713 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002714 *
2715 * <p class="note">This is a protected intent that can only be sent
2716 * by the system.
2717 *
2718 * {@hide}
2719 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002720 public static final String ACTION_REQUEST_SHUTDOWN
2721 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002722 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002723 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002724 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002725 * <p class="note">
2726 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002727 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002728 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2729 * or above, this broadcast will no longer be delivered to any
2730 * {@link BroadcastReceiver} defined in your manifest. Instead,
2731 * apps are strongly encouraged to use the improved
2732 * {@link Context#getCacheDir()} behavior so the system can
2733 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002734 */
2735 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002736 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002737 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2738 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002739 * Broadcast Action: Indicates low storage space condition on the device no
2740 * longer exists
2741 * <p class="note">
2742 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002743 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002744 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2745 * or above, this broadcast will no longer be delivered to any
2746 * {@link BroadcastReceiver} defined in your manifest. Instead,
2747 * apps are strongly encouraged to use the improved
2748 * {@link Context#getCacheDir()} behavior so the system can
2749 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002750 */
2751 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002752 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002753 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2754 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002755 * Broadcast Action: A sticky broadcast that indicates a storage space full
2756 * condition on the device. This is intended for activities that want to be
2757 * able to fill the data partition completely, leaving only enough free
2758 * space to prevent system-wide SQLite failures.
2759 * <p class="note">
2760 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002761 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002762 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2763 * or above, this broadcast will no longer be delivered to any
2764 * {@link BroadcastReceiver} defined in your manifest. Instead,
2765 * apps are strongly encouraged to use the improved
2766 * {@link Context#getCacheDir()} behavior so the system can
2767 * automatically free up storage when needed.
2768 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002769 */
2770 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002771 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002772 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2773 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002774 * Broadcast Action: Indicates storage space full condition on the device no
2775 * longer exists.
2776 * <p class="note">
2777 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002778 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002779 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2780 * or above, this broadcast will no longer be delivered to any
2781 * {@link BroadcastReceiver} defined in your manifest. Instead,
2782 * apps are strongly encouraged to use the improved
2783 * {@link Context#getCacheDir()} behavior so the system can
2784 * automatically free up storage when needed.
2785 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002786 */
2787 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002788 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002789 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2790 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002791 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2792 * and package management should be started.
2793 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2794 * notification.
2795 */
2796 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2797 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2798 /**
2799 * Broadcast Action: The device has entered USB Mass Storage mode.
2800 * This is used mainly for the USB Settings panel.
2801 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2802 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002803 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002804 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002805 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002806 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002807 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2808
2809 /**
2810 * Broadcast Action: The device has exited USB Mass Storage mode.
2811 * This is used mainly for the USB Settings panel.
2812 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2813 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002814 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002815 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002816 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002817 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002818 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2819
2820 /**
2821 * Broadcast Action: External media has been removed.
2822 * The path to the mount point for the removed media is contained in the Intent.mData field.
2823 */
2824 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2825 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2826
2827 /**
2828 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002829 * 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 -07002830 */
2831 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2832 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2833
2834 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002835 * Broadcast Action: External media is present, and being disk-checked
2836 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002837 */
2838 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2839 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2840
2841 /**
2842 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2843 * 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 -08002844 */
2845 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2846 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2847
2848 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002849 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002850 * 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 -07002851 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2852 * media was mounted read only.
2853 */
2854 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2855 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2856
2857 /**
2858 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002859 * 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 -07002860 */
2861 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2862 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2863
2864 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002865 * Broadcast Action: External media is no longer being shared via USB mass storage.
2866 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2867 *
2868 * @hide
2869 */
2870 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2871
2872 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002873 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2874 * The path to the mount point for the removed media is contained in the Intent.mData field.
2875 */
2876 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2877 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2878
2879 /**
2880 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002881 * 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 -07002882 */
2883 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2884 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2885
2886 /**
2887 * Broadcast Action: User has expressed the desire to remove the external storage media.
2888 * Applications should close all files they have open within the mount point when they receive this intent.
2889 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2890 */
2891 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2892 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2893
2894 /**
2895 * Broadcast Action: The media scanner has started scanning a directory.
2896 * The path to the directory being scanned is contained in the Intent.mData field.
2897 */
2898 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2899 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2900
2901 /**
2902 * Broadcast Action: The media scanner has finished scanning a directory.
2903 * The path to the scanned directory is contained in the Intent.mData field.
2904 */
2905 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2906 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2907
2908 /**
2909 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2910 * The path to the file is contained in the Intent.mData field.
2911 */
2912 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2913 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2914
2915 /**
2916 * Broadcast Action: The "Media Button" was pressed. Includes a single
2917 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2918 * caused the broadcast.
2919 */
2920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2921 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2922
2923 /**
2924 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2925 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2926 * caused the broadcast.
2927 */
2928 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2929 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2930
2931 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2932 // location; they are not general-purpose actions.
2933
2934 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002935 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002936 */
2937 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2938 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2939 "android.intent.action.GTALK_CONNECTED";
2940
2941 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002942 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002943 */
2944 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2945 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2946 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002947
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002948 /**
2949 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002950 */
2951 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2952 public static final String ACTION_INPUT_METHOD_CHANGED =
2953 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002954
2955 /**
2956 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2957 * more radios have been turned off or on. The intent will have the following extra value:</p>
2958 * <ul>
2959 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2960 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2961 * turned off</li>
2962 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002963 *
Peng Xua35b5532016-01-20 00:05:45 -08002964 * <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 -07002965 */
2966 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2967 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2968
2969 /**
2970 * Broadcast Action: Some content providers have parts of their namespace
2971 * where they publish new events or items that the user may be especially
2972 * interested in. For these things, they may broadcast this action when the
2973 * set of interesting items change.
2974 *
2975 * For example, GmailProvider sends this notification when the set of unread
2976 * mail in the inbox changes.
2977 *
2978 * <p>The data of the intent identifies which part of which provider
2979 * changed. When queried through the content resolver, the data URI will
2980 * return the data set in question.
2981 *
2982 * <p>The intent will have the following extra values:
2983 * <ul>
2984 * <li><em>count</em> - The number of items in the data set. This is the
2985 * same as the number of items in the cursor returned by querying the
2986 * data URI. </li>
2987 * </ul>
2988 *
2989 * This intent will be sent at boot (if the count is non-zero) and when the
2990 * data set changes. It is possible for the data set to change without the
2991 * count changing (for example, if a new unread message arrives in the same
2992 * sync operation in which a message is archived). The phone should still
2993 * ring/vibrate/etc as normal in this case.
2994 */
2995 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2996 public static final String ACTION_PROVIDER_CHANGED =
2997 "android.intent.action.PROVIDER_CHANGED";
2998
2999 /**
3000 * Broadcast Action: Wired Headset plugged in or unplugged.
3001 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07003002 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
3003 * and documentation.
3004 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07003005 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07003006 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003007 */
3008 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07003009 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07003010
3011 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07003012 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
3013 * <ul>
3014 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
3015 * </ul>
3016 *
3017 * <p class="note">This is a protected intent that can only be sent
3018 * by the system.
3019 *
3020 * @hide
3021 */
3022 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3023 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
3024 = "android.intent.action.ADVANCED_SETTINGS";
3025
3026 /**
Robin Lee66e5d962014-04-09 16:44:21 +01003027 * Broadcast Action: Sent after application restrictions are changed.
3028 *
3029 * <p class="note">This is a protected intent that can only be sent
3030 * by the system.</p>
3031 */
3032 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3033 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
3034 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
3035
3036 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003037 * Broadcast Action: An outgoing call is about to be placed.
3038 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07003039 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003040 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07003041 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003042 * the phone number originally intended to be dialed.</li>
3043 * </ul>
3044 * <p>Once the broadcast is finished, the resultData is used as the actual
3045 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07003046 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003047 * outgoing call in turn: for example, a parental control application
3048 * might verify that the user is authorized to place the call at that
3049 * time, then a number-rewriting application might add an area code if
3050 * one was not specified.</p>
3051 * <p>For consistency, any receiver whose purpose is to prohibit phone
3052 * calls should have a priority of 0, to ensure it will see the final
3053 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07003054 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003055 * should have a positive priority.
3056 * Negative priorities are reserved for the system for this broadcast;
3057 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07003058 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
3059 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003060 * <p>Emergency calls cannot be intercepted using this mechanism, and
3061 * other calls cannot be modified to call emergency numbers using this
3062 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07003063 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
3064 * call to use their own service instead. Those apps should first prevent
3065 * the call from being placed by setting resultData to <code>null</code>
3066 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07003067 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003068 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
3069 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08003070 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07003071 * <p class="note">This is a protected intent that can only be sent
3072 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003073 */
3074 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3075 public static final String ACTION_NEW_OUTGOING_CALL =
3076 "android.intent.action.NEW_OUTGOING_CALL";
3077
3078 /**
3079 * Broadcast Action: Have the device reboot. This is only for use by
3080 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08003081 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07003082 * <p class="note">This is a protected intent that can only be sent
3083 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003084 */
3085 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3086 public static final String ACTION_REBOOT =
3087 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003088
Wei Huang97ecc9c2009-05-11 17:44:20 -07003089 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08003090 * Broadcast Action: A sticky broadcast for changes in the physical
3091 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08003092 *
3093 * <p>The intent will have the following extra values:
3094 * <ul>
3095 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08003096 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08003097 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08003098 * <p>This is intended for monitoring the current physical dock state.
3099 * See {@link android.app.UiModeManager} for the normal API dealing with
3100 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07003101 */
3102 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3103 public static final String ACTION_DOCK_EVENT =
3104 "android.intent.action.DOCK_EVENT";
3105
3106 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08003107 * Broadcast Action: A broadcast when idle maintenance can be started.
3108 * This means that the user is not interacting with the device and is
3109 * not expected to do so soon. Typical use of the idle maintenance is
3110 * to perform somehow expensive tasks that can be postponed at a moment
3111 * when they will not degrade user experience.
3112 * <p>
3113 * <p class="note">In order to keep the device responsive in case of an
3114 * unexpected user interaction, implementations of a maintenance task
3115 * should be interruptible. In such a scenario a broadcast with action
3116 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
3117 * should not do the maintenance work in
3118 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
3119 * maintenance service by {@link Context#startService(Intent)}. Also
3120 * you should hold a wake lock while your maintenance service is running
3121 * to prevent the device going to sleep.
3122 * </p>
3123 * <p>
3124 * <p class="note">This is a protected intent that can only be sent by
3125 * the system.
3126 * </p>
3127 *
3128 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07003129 *
3130 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08003131 */
3132 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3133 public static final String ACTION_IDLE_MAINTENANCE_START =
3134 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
3135
3136 /**
3137 * Broadcast Action: A broadcast when idle maintenance should be stopped.
3138 * This means that the user was not interacting with the device as a result
3139 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
3140 * was sent and now the user started interacting with the device. Typical
3141 * use of the idle maintenance is to perform somehow expensive tasks that
3142 * can be postponed at a moment when they will not degrade user experience.
3143 * <p>
3144 * <p class="note">In order to keep the device responsive in case of an
3145 * unexpected user interaction, implementations of a maintenance task
3146 * should be interruptible. Hence, on receiving a broadcast with this
3147 * action, the maintenance task should be interrupted as soon as possible.
3148 * In other words, you should not do the maintenance work in
3149 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
3150 * maintenance service that was started on receiving of
3151 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
3152 * lock you acquired when your maintenance service started.
3153 * </p>
3154 * <p class="note">This is a protected intent that can only be sent
3155 * by the system.
3156 *
3157 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07003158 *
3159 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08003160 */
3161 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3162 public static final String ACTION_IDLE_MAINTENANCE_END =
3163 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
3164
3165 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003166 * Broadcast Action: a remote intent is to be broadcasted.
3167 *
3168 * A remote intent is used for remote RPC between devices. The remote intent
3169 * is serialized and sent from one device to another device. The receiving
3170 * device parses the remote intent and broadcasts it. Note that anyone can
3171 * broadcast a remote intent. However, if the intent receiver of the remote intent
3172 * does not trust intent broadcasts from arbitrary intent senders, it should require
3173 * the sender to hold certain permissions so only trusted sender's broadcast will be
3174 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07003175 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07003176 */
3177 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07003178 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07003179
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003180 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06003181 * Broadcast Action: This is broadcast once when the user is booting after a
3182 * system update. It can be used to perform cleanup or upgrades after a
3183 * system update.
3184 * <p>
3185 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
3186 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
3187 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
3188 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003189 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003190 * @hide
3191 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003192 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003193 public static final String ACTION_PRE_BOOT_COMPLETED =
3194 "android.intent.action.PRE_BOOT_COMPLETED";
3195
Amith Yamasani13593602012-03-22 16:16:17 -07003196 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003197 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003198 * on restricted users. The broadcast intent contains an extra
3199 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
3200 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
3201 * String[] depending on the restriction type.<p/>
3202 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07003203 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
3204 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
3205 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003206 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
3207 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003208 * @see RestrictionEntry
3209 */
3210 public static final String ACTION_GET_RESTRICTION_ENTRIES =
3211 "android.intent.action.GET_RESTRICTION_ENTRIES";
3212
3213 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003214 * Sent the first time a user is starting, to allow system apps to
3215 * perform one time initialization. (This will not be seen by third
3216 * party applications because a newly initialized user does not have any
3217 * third party applications installed for it.) This is sent early in
3218 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003219 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3220 * broadcast, since it is part of a visible user interaction; be as quick
3221 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003222 */
3223 public static final String ACTION_USER_INITIALIZE =
3224 "android.intent.action.USER_INITIALIZE";
3225
3226 /**
3227 * Sent when a user switch is happening, causing the process's user to be
3228 * brought to the foreground. This is only sent to receivers registered
3229 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3230 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003231 * foreground. This is sent as a foreground
3232 * broadcast, since it is part of a visible user interaction; be as quick
3233 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003234 */
3235 public static final String ACTION_USER_FOREGROUND =
3236 "android.intent.action.USER_FOREGROUND";
3237
3238 /**
3239 * Sent when a user switch is happening, causing the process's user to be
3240 * sent to the background. This is only sent to receivers registered
3241 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3242 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003243 * background. This is sent as a foreground
3244 * broadcast, since it is part of a visible user interaction; be as quick
3245 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003246 */
3247 public static final String ACTION_USER_BACKGROUND =
3248 "android.intent.action.USER_BACKGROUND";
3249
3250 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003251 * Broadcast sent to the system when a user is added. Carries an extra
3252 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3253 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003254 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003255 * @hide
3256 */
3257 public static final String ACTION_USER_ADDED =
3258 "android.intent.action.USER_ADDED";
3259
3260 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003261 * Broadcast sent by the system when a user is started. Carries an extra
3262 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003263 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003264 * that has been started. This is sent as a foreground
3265 * broadcast, since it is part of a visible user interaction; be as quick
3266 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003267 * @hide
3268 */
3269 public static final String ACTION_USER_STARTED =
3270 "android.intent.action.USER_STARTED";
3271
3272 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003273 * Broadcast sent when a user is in the process of starting. Carries an extra
3274 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3275 * sent to registered receivers, not manifest receivers. It is sent to all
3276 * users (including the one that is being started). You must hold
3277 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3278 * this broadcast. This is sent as a background broadcast, since
3279 * its result is not part of the primary UX flow; to safely keep track of
3280 * started/stopped state of a user you can use this in conjunction with
3281 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3282 * other user state broadcasts since those are foreground broadcasts so can
3283 * execute in a different order.
3284 * @hide
3285 */
3286 public static final String ACTION_USER_STARTING =
3287 "android.intent.action.USER_STARTING";
3288
3289 /**
3290 * Broadcast sent when a user is going to be stopped. Carries an extra
3291 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3292 * sent to registered receivers, not manifest receivers. It is sent to all
3293 * users (including the one that is being stopped). You must hold
3294 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3295 * this broadcast. The user will not stop until all receivers have
3296 * handled the broadcast. This is sent as a background broadcast, since
3297 * its result is not part of the primary UX flow; to safely keep track of
3298 * started/stopped state of a user you can use this in conjunction with
3299 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3300 * other user state broadcasts since those are foreground broadcasts so can
3301 * execute in a different order.
3302 * @hide
3303 */
3304 public static final String ACTION_USER_STOPPING =
3305 "android.intent.action.USER_STOPPING";
3306
3307 /**
3308 * Broadcast sent to the system when a user is stopped. Carries an extra
3309 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3310 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3311 * specific package. This is only sent to registered receivers, not manifest
3312 * receivers. It is sent to all running users <em>except</em> the one that
3313 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003314 * @hide
3315 */
3316 public static final String ACTION_USER_STOPPED =
3317 "android.intent.action.USER_STOPPED";
3318
3319 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003320 * 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 -07003321 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003322 * one that has been removed. The user will not be completely removed until all receivers have
3323 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003324 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003325 * @hide
3326 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003327 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003328 public static final String ACTION_USER_REMOVED =
3329 "android.intent.action.USER_REMOVED";
3330
3331 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003332 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003333 * the userHandle of the user to become the current one. This is only sent to
3334 * registered receivers, not manifest receivers. It is sent to all running users.
3335 * You must hold
3336 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003337 * @hide
3338 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01003339 @UnsupportedAppUsage
Amith Yamasani13593602012-03-22 16:16:17 -07003340 public static final String ACTION_USER_SWITCHED =
3341 "android.intent.action.USER_SWITCHED";
3342
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003343 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003344 * Broadcast Action: Sent when the credential-encrypted private storage has
3345 * become unlocked for the target user. This is only sent to registered
3346 * receivers, not manifest receivers.
3347 */
3348 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3349 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3350
3351 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003352 * Broadcast sent to the system when a user's information changes. Carries an extra
3353 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003354 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003355 * @hide
3356 */
3357 public static final String ACTION_USER_INFO_CHANGED =
3358 "android.intent.action.USER_INFO_CHANGED";
3359
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003360 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003361 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3362 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003363 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3364 * that need to display merged content across both primary and managed profiles need to
3365 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003366 * not manifest receivers.
3367 */
3368 public static final String ACTION_MANAGED_PROFILE_ADDED =
3369 "android.intent.action.MANAGED_PROFILE_ADDED";
3370
3371 /**
3372 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003373 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3374 * Only applications (for example Launchers) that need to display merged content across both
3375 * primary and managed profiles need to worry about this broadcast. This is only sent to
3376 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003377 */
3378 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3379 "android.intent.action.MANAGED_PROFILE_REMOVED";
3380
3381 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003382 * Broadcast sent to the primary user when the credential-encrypted private storage for
3383 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3384 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3385 * Launchers) that need to display merged content across both primary and managed profiles
3386 * need to worry about this broadcast. This is only sent to registered receivers,
3387 * not manifest receivers.
3388 */
3389 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3390 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3391
3392 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003393 * Broadcast sent to the primary user when an associated managed profile has become available.
3394 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003395 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3396 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3397 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003398 */
Rubin Xue95057a2016-04-01 16:49:25 +01003399 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3400 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3401
3402 /**
3403 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3404 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3405 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3406 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3407 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3408 */
3409 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3410 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003411
3412 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003413 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3414 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3415 * the device was locked or unlocked.
3416 *
3417 * This is only sent to registered receivers.
3418 *
3419 * @hide
3420 */
3421 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3422 "android.intent.action.DEVICE_LOCKED_CHANGED";
3423
3424 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003425 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3426 */
3427 public static final String ACTION_QUICK_CLOCK =
3428 "android.intent.action.QUICK_CLOCK";
3429
Michael Wright0087a142013-02-05 16:29:39 -08003430 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003431 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003432 * @hide
3433 */
3434 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003435 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003436
Justin Kohd378ad72013-04-01 12:18:26 -07003437 /**
3438 * Broadcast Action: A global button was pressed. Includes a single
3439 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3440 * caused the broadcast.
3441 * @hide
3442 */
Sujith Ramakrishnan48e19c82017-04-24 15:57:58 -07003443 @SystemApi
Justin Kohd378ad72013-04-01 12:18:26 -07003444 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3445
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003446 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003447 * Broadcast Action: Sent when media resource is granted.
3448 * <p>
3449 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3450 * granted.
3451 * </p>
3452 * <p class="note">
3453 * This is a protected intent that can only be sent by the system.
3454 * </p>
3455 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003456 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003457 * </p>
3458 *
3459 * @hide
3460 */
3461 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3462 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3463
3464 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003465 * Broadcast Action: An overlay package has changed. The data contains the
3466 * name of the overlay package which has changed. This is broadcast on all
3467 * changes to the OverlayInfo returned by {@link
3468 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3469 * most common change is a state change that will change whether the
3470 * overlay is enabled or not.
3471 * @hide
3472 */
3473 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3474
3475 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003476 * Activity Action: Allow the user to select and return one or more existing
3477 * documents. When invoked, the system will display the various
3478 * {@link DocumentsProvider} instances installed on the device, letting the
3479 * user interactively navigate through them. These documents include local
3480 * media, such as photos and video, and documents provided by installed
3481 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003482 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003483 * Each document is represented as a {@code content://} URI backed by a
3484 * {@link DocumentsProvider}, which can be opened as a stream with
3485 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3486 * {@link android.provider.DocumentsContract.Document} metadata.
3487 * <p>
3488 * All selected documents are returned to the calling application with
3489 * persistable read and write permission grants. If you want to maintain
3490 * access to the documents across device reboots, you need to explicitly
3491 * take the persistable permissions using
3492 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3493 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003494 * Callers must indicate the acceptable document MIME types through
3495 * {@link #setType(String)}. For example, to select photos, use
3496 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3497 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3498 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003499 * <p>
3500 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003501 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3502 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003503 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003504 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3505 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003506 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003507 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003508 * Callers can set a document URI through
3509 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3510 * location of documents navigator. System will do its best to launch the
3511 * navigator in the specified document if it's a folder, or the folder that
3512 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003513 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003514 * Output: The URI of the item that was picked, returned in
3515 * {@link #getData()}. This must be a {@code content://} URI so that any
3516 * receiver can access it. If multiple documents were selected, they are
3517 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003518 *
3519 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003520 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003521 * @see #ACTION_CREATE_DOCUMENT
3522 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003523 */
3524 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3525 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3526
3527 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003528 * Activity Action: Allow the user to create a new document. When invoked,
3529 * the system will display the various {@link DocumentsProvider} instances
3530 * installed on the device, letting the user navigate through them. The
3531 * returned document may be a newly created document with no content, or it
3532 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003533 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003534 * Each document is represented as a {@code content://} URI backed by a
3535 * {@link DocumentsProvider}, which can be opened as a stream with
3536 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3537 * {@link android.provider.DocumentsContract.Document} metadata.
3538 * <p>
3539 * Callers must indicate the concrete MIME type of the document being
3540 * created by setting {@link #setType(String)}. This MIME type cannot be
3541 * changed after the document is created.
3542 * <p>
3543 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3544 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003545 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003546 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3547 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003548 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003549 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003550 * Callers can set a document URI through
3551 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3552 * location of documents navigator. System will do its best to launch the
3553 * navigator in the specified document if it's a folder, or the folder that
3554 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003555 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003556 * Output: The URI of the item that was created. This must be a
3557 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003558 *
3559 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003560 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003561 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003562 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003563 */
3564 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3565 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3566
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003567 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003568 * Activity Action: Allow the user to pick a directory subtree. When
3569 * invoked, the system will display the various {@link DocumentsProvider}
3570 * instances installed on the device, letting the user navigate through
3571 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003572 * <p>
3573 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003574 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3575 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3576 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003577 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003578 * Callers can set a document URI through
3579 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3580 * location of documents navigator. System will do its best to launch the
3581 * navigator in the specified document if it's a folder, or the folder that
3582 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003583 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003584 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003585 *
3586 * @see DocumentsContract
3587 */
3588 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003589 public static final String
3590 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003591
Felipe Lemec7b1f892016-01-15 15:02:31 -08003592 /**
Peng Xua35b5532016-01-20 00:05:45 -08003593 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3594 * exisiting sensor being disconnected.
3595 *
3596 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3597 *
3598 * {@hide}
3599 */
3600 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3601 public static final String
3602 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3603
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003604 /**
Sam Line707f832017-04-13 17:00:55 -07003605 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003606 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003607 * @removed
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003608 */
3609 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003610 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003611 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3612
Christopher Tate6597e342015-02-17 12:15:25 -08003613 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003614 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3615 * is about to be performed.
3616 * @hide
3617 */
3618 @SystemApi
3619 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3620 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3621 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3622
3623 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003624 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3625 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3626 *
3627 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3628 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003629 * @hide
3630 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003631 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003632 public static final String EXTRA_FORCE_MASTER_CLEAR =
3633 "android.intent.extra.FORCE_MASTER_CLEAR";
3634
3635 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003636 * A broadcast action to trigger a factory reset.
3637 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003638 * <p>The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission. The
3639 * reason for the factory reset should be specified as {@link #EXTRA_REASON}.
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003640 *
3641 * <p>Not for use by third-party applications.
3642 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003643 * @see #EXTRA_FORCE_FACTORY_RESET
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003644 *
3645 * {@hide}
3646 */
3647 @SystemApi
3648 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3649 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3650
3651 /**
3652 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3653 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3654 *
3655 * <p>Not for use by third-party applications.
3656 *
3657 * @hide
3658 */
3659 @SystemApi
3660 public static final String EXTRA_FORCE_FACTORY_RESET =
3661 "android.intent.extra.FORCE_FACTORY_RESET";
3662
3663 /**
Michal Karpinski6135a262017-08-11 10:45:58 +01003664 * Broadcast action: report that a settings element is being restored from backup. The intent
3665 * contains four extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3666 * EXTRA_SETTING_NEW_VALUE is the value being restored, EXTRA_SETTING_PREVIOUS_VALUE
3667 * is the value of that settings entry prior to the restore operation, and
3668 * EXTRA_SETTING_RESTORED_FROM_SDK_INT is the version of the SDK that the setting has been
3669 * restored from (corresponds to {@link android.os.Build.VERSION#SDK_INT}). The first three
3670 * values are represented as strings, the fourth one as int.
Christopher Tate6597e342015-02-17 12:15:25 -08003671 *
3672 * <p>This broadcast is sent only for settings provider entries known to require special handling
3673 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3674 * the provider's backup agent implementation.
3675 *
3676 * @see #EXTRA_SETTING_NAME
3677 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3678 * @see #EXTRA_SETTING_NEW_VALUE
Michal Karpinski6135a262017-08-11 10:45:58 +01003679 * @see #EXTRA_SETTING_RESTORED_FROM_SDK_INT
Christopher Tate6597e342015-02-17 12:15:25 -08003680 * {@hide}
3681 */
3682 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3683
3684 /** {@hide} */
3685 public static final String EXTRA_SETTING_NAME = "setting_name";
3686 /** {@hide} */
3687 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3688 /** {@hide} */
3689 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
Michal Karpinski6135a262017-08-11 10:45:58 +01003690 /** {@hide} */
3691 public static final String EXTRA_SETTING_RESTORED_FROM_SDK_INT = "restored_from_sdk_int";
Christopher Tate6597e342015-02-17 12:15:25 -08003692
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003693 /**
3694 * Activity Action: Process a piece of text.
3695 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3696 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3697 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3698 */
3699 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3700 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003701
3702 /**
3703 * Broadcast Action: The sim card state has changed.
3704 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3705 * because TelephonyIntents is an internal class.
3706 * @hide
Amit Mahajan052e1e22018-01-12 17:40:29 -08003707 * @deprecated Use {@link #ACTION_SIM_CARD_STATE_CHANGED} or
3708 * {@link #ACTION_SIM_APPLICATION_STATE_CHANGED}
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003709 */
Amit Mahajan052e1e22018-01-12 17:40:29 -08003710 @Deprecated
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003711 @SystemApi
3712 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3713 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3714
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003715 /**
fionaxu90fee272017-03-31 12:45:12 -07003716 * Broadcast Action: indicate that the phone service state has changed.
3717 * The intent will have the following extra values:</p>
3718 * <p>
3719 * @see #EXTRA_VOICE_REG_STATE
3720 * @see #EXTRA_DATA_REG_STATE
3721 * @see #EXTRA_VOICE_ROAMING_TYPE
3722 * @see #EXTRA_DATA_ROAMING_TYPE
3723 * @see #EXTRA_OPERATOR_ALPHA_LONG
3724 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3725 * @see #EXTRA_OPERATOR_NUMERIC
3726 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3727 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3728 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3729 * @see #EXTRA_MANUAL
3730 * @see #EXTRA_VOICE_RADIO_TECH
3731 * @see #EXTRA_DATA_RADIO_TECH
3732 * @see #EXTRA_CSS_INDICATOR
3733 * @see #EXTRA_NETWORK_ID
3734 * @see #EXTRA_SYSTEM_ID
3735 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3736 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3737 * @see #EXTRA_EMERGENCY_ONLY
3738 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3739 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3740 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3741 *
3742 * <p class="note">
3743 * Requires the READ_PHONE_STATE permission.
3744 *
3745 * <p class="note">This is a protected intent that can only be sent by the system.
3746 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003747 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003748 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable} and the helper
3749 * functions {@code ServiceStateTable.getUriForSubscriptionIdAndField} and
3750 * {@code ServiceStateTable.getUriForSubscriptionId} to subscribe to changes to the ServiceState
3751 * for a given subscription id and field with a ContentObserver or using JobScheduler.
fionaxu90fee272017-03-31 12:45:12 -07003752 */
3753 @Deprecated
3754 @SystemApi
3755 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3756 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3757
3758 /**
3759 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3760 * state.
3761 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3762 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3763 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3764 * @see android.telephony.ServiceState#STATE_POWER_OFF
3765 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003766 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003767 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_REG_STATE}.
fionaxu90fee272017-03-31 12:45:12 -07003768 */
3769 @Deprecated
3770 @SystemApi
3771 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3772
3773 /**
3774 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3775 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3776 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3777 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3778 * @see android.telephony.ServiceState#STATE_POWER_OFF
3779 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003780 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003781 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_REG_STATE}.
fionaxu90fee272017-03-31 12:45:12 -07003782 */
3783 @Deprecated
3784 @SystemApi
3785 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3786
3787 /**
3788 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3789 * type.
3790 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003791 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003792 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_ROAMING_TYPE}.
fionaxu90fee272017-03-31 12:45:12 -07003793 */
3794 @Deprecated
3795 @SystemApi
3796 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3797
3798 /**
3799 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3800 * type.
3801 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003802 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003803 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_ROAMING_TYPE}.
fionaxu90fee272017-03-31 12:45:12 -07003804 */
3805 @Deprecated
3806 @SystemApi
3807 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3808
3809 /**
3810 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3811 * registered voice operator name in long alphanumeric format.
3812 * {@code null} if the operator name is not known or unregistered.
3813 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003814 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003815 * @deprecated Use
3816 * {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_ALPHA_LONG}.
fionaxu90fee272017-03-31 12:45:12 -07003817 */
3818 @Deprecated
3819 @SystemApi
3820 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3821
3822 /**
3823 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3824 * registered voice operator name in short alphanumeric format.
3825 * {@code null} if the operator name is not known or unregistered.
3826 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003827 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003828 * @deprecated Use
3829 * {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_ALPHA_SHORT}.
fionaxu90fee272017-03-31 12:45:12 -07003830 */
3831 @Deprecated
3832 @SystemApi
3833 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3834
3835 /**
3836 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3837 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3838 * network.
3839 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003840 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003841 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_NUMERIC}.
fionaxu90fee272017-03-31 12:45:12 -07003842 */
3843 @Deprecated
3844 @SystemApi
3845 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3846
3847 /**
3848 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3849 * registered data operator name in long alphanumeric format.
3850 * {@code null} if the operator name is not known or unregistered.
3851 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003852 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003853 * @deprecated Use
3854 * {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_ALPHA_LONG}.
fionaxu90fee272017-03-31 12:45:12 -07003855 */
3856 @Deprecated
3857 @SystemApi
3858 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3859
3860 /**
3861 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3862 * registered data operator name in short alphanumeric format.
3863 * {@code null} if the operator name is not known or unregistered.
3864 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003865 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003866 * @deprecated Use
3867 * {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_ALPHA_SHORT}.
fionaxu90fee272017-03-31 12:45:12 -07003868 */
3869 @Deprecated
3870 @SystemApi
3871 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3872
3873 /**
3874 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3875 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3876 * data operator.
3877 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003878 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003879 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_NUMERIC}.
fionaxu90fee272017-03-31 12:45:12 -07003880 */
3881 @Deprecated
3882 @SystemApi
3883 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3884
3885 /**
3886 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3887 * network selection mode is manual.
3888 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3889 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003890 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003891 * @deprecated Use
3892 * {@link android.provider.Telephony.ServiceStateTable#IS_MANUAL_NETWORK_SELECTION}.
fionaxu90fee272017-03-31 12:45:12 -07003893 */
3894 @Deprecated
3895 @SystemApi
3896 public static final String EXTRA_MANUAL = "manual";
3897
3898 /**
3899 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3900 * radio technology.
3901 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003902 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003903 * @deprecated Use
3904 * {@link android.provider.Telephony.ServiceStateTable#RIL_VOICE_RADIO_TECHNOLOGY}.
fionaxu90fee272017-03-31 12:45:12 -07003905 */
3906 @Deprecated
3907 @SystemApi
3908 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3909
3910 /**
3911 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3912 * radio technology.
3913 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003914 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003915 * @deprecated Use
3916 * {@link android.provider.Telephony.ServiceStateTable#RIL_DATA_RADIO_TECHNOLOGY}.
fionaxu90fee272017-03-31 12:45:12 -07003917 */
3918 @Deprecated
3919 @SystemApi
3920 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3921
3922 /**
3923 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3924 * support on CDMA network.
3925 * Will be {@code true} if support, {@code false} otherwise.
3926 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003927 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003928 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#CSS_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003929 */
3930 @Deprecated
3931 @SystemApi
3932 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3933
3934 /**
3935 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3936 * id. {@code Integer.MAX_VALUE} if unknown.
3937 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003938 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003939 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#NETWORK_ID}.
fionaxu90fee272017-03-31 12:45:12 -07003940 */
3941 @Deprecated
3942 @SystemApi
3943 public static final String EXTRA_NETWORK_ID = "networkId";
3944
3945 /**
3946 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3947 * {@code Integer.MAX_VALUE} if unknown.
3948 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003949 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003950 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#SYSTEM_ID}.
fionaxu90fee272017-03-31 12:45:12 -07003951 */
3952 @Deprecated
3953 @SystemApi
3954 public static final String EXTRA_SYSTEM_ID = "systemId";
3955
3956 /**
3957 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3958 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3959 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003960 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003961 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#CDMA_ROAMING_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003962 */
3963 @Deprecated
3964 @SystemApi
3965 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3966
3967 /**
3968 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3969 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3970 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003971 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003972 * @deprecated Use
3973 * {@link android.provider.Telephony.ServiceStateTable#CDMA_DEFAULT_ROAMING_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003974 */
3975 @Deprecated
3976 @SystemApi
3977 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3978
3979 /**
3980 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3981 * only mode.
3982 * {@code true} if in emergency only mode, {@code false} otherwise.
3983 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003984 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003985 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#IS_EMERGENCY_ONLY}.
fionaxu90fee272017-03-31 12:45:12 -07003986 */
3987 @Deprecated
3988 @SystemApi
3989 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3990
3991 /**
3992 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3993 * registration state is roaming.
3994 * {@code true} if registration indicates roaming, {@code false} otherwise
3995 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003996 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003997 * @deprecated Use
3998 * {@link android.provider.Telephony.ServiceStateTable#IS_DATA_ROAMING_FROM_REGISTRATION}.
fionaxu90fee272017-03-31 12:45:12 -07003999 */
4000 @Deprecated
4001 @SystemApi
4002 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
4003 "isDataRoamingFromRegistration";
4004
4005 /**
4006 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
4007 * aggregation is in use.
4008 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
4009 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06004010 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07004011 * @deprecated Use
4012 * {@link android.provider.Telephony.ServiceStateTable#IS_USING_CARRIER_AGGREGATION}.
fionaxu90fee272017-03-31 12:45:12 -07004013 */
4014 @Deprecated
4015 @SystemApi
4016 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
4017
4018 /**
4019 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
4020 * is reduced from the rsrp threshold while calculating signal strength level.
4021 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06004022 * @removed
fionaxu90fee272017-03-31 12:45:12 -07004023 */
4024 @Deprecated
4025 @SystemApi
4026 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
4027
4028 /**
chen xu02811692018-10-03 19:07:09 -07004029 * An parcelable extra used with {@link #ACTION_SERVICE_STATE} representing the service state.
4030 * @hide
4031 */
4032 public static final String EXTRA_SERVICE_STATE = "android.intent.extra.SERVICE_STATE";
4033
4034 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01004035 * The name of the extra used to define the text to be processed, as a
4036 * CharSequence. Note that this may be a styled CharSequence, so you must use
4037 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00004038 */
4039 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
4040 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01004041 * 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 +00004042 */
4043 public static final String EXTRA_PROCESS_TEXT_READONLY =
4044 "android.intent.extra.PROCESS_TEXT_READONLY";
4045
Bryce Leebc58f592015-09-25 16:43:01 -07004046 /**
4047 * Broadcast action: reports when a new thermal event has been reached. When the device
4048 * is reaching its maximum temperatue, the thermal level reported
4049 * {@hide}
4050 */
4051 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
4052 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
4053
4054 /** {@hide} */
4055 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
4056
4057 /**
4058 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08004059 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07004060 * {@hide}
4061 */
4062 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
4063
4064 /**
4065 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08004066 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07004067 * {@hide}
4068 */
4069 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
4070
4071 /**
4072 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08004073 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07004074 * {@hide}
4075 */
4076 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
4077
lpeter318abc92018-05-04 16:13:14 +08004078 /**
4079 * Broadcast Action: Indicates the dock in idle state while device is docked.
4080 *
4081 * <p class="note">This is a protected intent that can only be sent
4082 * by the system.
4083 *
4084 * @hide
4085 */
4086 public static final String ACTION_DOCK_IDLE = "android.intent.action.DOCK_IDLE";
4087
4088 /**
4089 * Broadcast Action: Indicates the dock in active state while device is docked.
4090 *
4091 * <p class="note">This is a protected intent that can only be sent
4092 * by the system.
4093 *
4094 * @hide
4095 */
4096 public static final String ACTION_DOCK_ACTIVE = "android.intent.action.DOCK_ACTIVE";
4097
Bryce Leebc58f592015-09-25 16:43:01 -07004098
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004099 // ---------------------------------------------------------------------
4100 // ---------------------------------------------------------------------
4101 // Standard intent categories (see addCategory()).
4102
4103 /**
4104 * Set if the activity should be an option for the default action
4105 * (center press) to perform on a piece of data. Setting this will
4106 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04004107 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004108 * Intent when initiating an action -- it is for use in intent filters
4109 * specified in packages.
4110 */
4111 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4112 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
4113 /**
4114 * Activities that can be safely invoked from a browser must support this
4115 * category. For example, if the user is viewing a web page or an e-mail
4116 * and clicks on a link in the text, the Intent generated execute that
4117 * link will require the BROWSABLE category, so that only activities
4118 * supporting this category will be considered as possible actions. By
4119 * supporting this category, you are promising that there is nothing
4120 * damaging (without user intervention) that can happen by invoking any
4121 * matching Intent.
4122 */
4123 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4124 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
4125 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07004126 * Categories for activities that can participate in voice interaction.
4127 * An activity that supports this category must be prepared to run with
4128 * no UI shown at all (though in some case it may have a UI shown), and
4129 * rely on {@link android.app.VoiceInteractor} to interact with the user.
4130 */
4131 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4132 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
4133 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004134 * Set if the activity should be considered as an alternative action to
4135 * the data the user is currently viewing. See also
4136 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
4137 * applies to the selection in a list of items.
4138 *
4139 * <p>Supporting this category means that you would like your activity to be
4140 * displayed in the set of alternative things the user can do, usually as
4141 * part of the current activity's options menu. You will usually want to
4142 * include a specific label in the &lt;intent-filter&gt; of this action
4143 * describing to the user what it does.
4144 *
4145 * <p>The action of IntentFilter with this category is important in that it
4146 * describes the specific action the target will perform. This generally
4147 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
4148 * a specific name such as "com.android.camera.action.CROP. Only one
4149 * alternative of any particular action will be shown to the user, so using
4150 * a specific action like this makes sure that your alternative will be
4151 * displayed while also allowing other applications to provide their own
4152 * overrides of that particular action.
4153 */
4154 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4155 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
4156 /**
4157 * Set if the activity should be considered as an alternative selection
4158 * action to the data the user has currently selected. This is like
4159 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
4160 * of items from which the user can select, giving them alternatives to the
4161 * default action that will be performed on it.
4162 */
4163 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4164 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
4165 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004166 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004167 */
4168 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4169 public static final String CATEGORY_TAB = "android.intent.category.TAB";
4170 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004171 * Should be displayed in the top-level launcher.
4172 */
4173 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4174 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
4175 /**
Jose Lima38b75b62014-03-11 10:41:39 -07004176 * Indicates an activity optimized for Leanback mode, and that should
4177 * be displayed in the Leanback launcher.
4178 */
4179 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4180 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
4181 /**
Roberto Perez7ee1a7a2017-12-04 17:14:33 -08004182 * Indicates the preferred entry-point activity when an application is launched from a Car
4183 * launcher. If not present, Car launcher can optionally use {@link #CATEGORY_LAUNCHER} as a
4184 * fallback, or exclude the application entirely.
4185 * @hide
4186 */
4187 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4188 public static final String CATEGORY_CAR_LAUNCHER = "android.intent.category.CAR_LAUNCHER";
4189 /**
Jose Lima73915cf2014-07-29 17:16:31 -07004190 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
4191 * @hide
4192 */
4193 @SystemApi
4194 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
4195 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004196 * Provides information about the package it is in; typically used if
4197 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
4198 * a front-door to the user without having to be shown in the all apps list.
4199 */
4200 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4201 public static final String CATEGORY_INFO = "android.intent.category.INFO";
4202 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004203 * This is the home activity, that is the first activity that is displayed
4204 * when the device boots.
4205 */
4206 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4207 public static final String CATEGORY_HOME = "android.intent.category.HOME";
4208 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07004209 * This is the home activity that is displayed when the device is finished setting up and ready
4210 * for use.
4211 * @hide
4212 */
4213 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4214 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
4215 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07004216 * This is the setup wizard activity, that is the first activity that is displayed
4217 * when the user sets up the device for the first time.
4218 * @hide
4219 */
4220 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4221 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
4222 /**
Svet Ganov5bb6bc62017-08-28 12:39:35 -07004223 * This is the home activity, that is the activity that serves as the launcher app
4224 * from there the user can start other apps. Often components with lower/higher
4225 * priority intent filters handle the home intent, for example SetupWizard, to
4226 * setup the device and we need to be able to distinguish the home app from these
4227 * setup helpers.
4228 * @hide
4229 */
4230 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4231 public static final String CATEGORY_LAUNCHER_APP = "android.intent.category.LAUNCHER_APP";
4232 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004233 * This activity is a preference panel.
4234 */
4235 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4236 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
4237 /**
4238 * This activity is a development preference panel.
4239 */
4240 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4241 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
4242 /**
4243 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004244 */
4245 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4246 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
4247 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07004248 * This activity allows the user to browse and download new applications.
4249 */
4250 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4251 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
4252 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004253 * This activity may be exercised by the monkey or other automated test tools.
4254 */
4255 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4256 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
4257 /**
4258 * To be used as a test (not part of the normal user experience).
4259 */
4260 public static final String CATEGORY_TEST = "android.intent.category.TEST";
4261 /**
4262 * To be used as a unit test (run through the Test Harness).
4263 */
4264 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
4265 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004266 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004267 * experience).
4268 */
4269 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004270
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004271 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004272 * Used to indicate that an intent only wants URIs that can be opened with
4273 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
4274 * must support at least the columns defined in {@link OpenableColumns} when
4275 * queried.
4276 *
4277 * @see #ACTION_GET_CONTENT
4278 * @see #ACTION_OPEN_DOCUMENT
4279 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004280 */
4281 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4282 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
4283
4284 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09004285 * Used to indicate that an intent filter can accept files which are not necessarily
4286 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
4287 * at least streamable via
4288 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
4289 * using one of the stream types exposed via
4290 * {@link ContentResolver#getStreamTypes(Uri, String)}.
4291 *
4292 * @see #ACTION_SEND
4293 * @see #ACTION_SEND_MULTIPLE
4294 */
4295 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4296 public static final String CATEGORY_TYPED_OPENABLE =
4297 "android.intent.category.TYPED_OPENABLE";
4298
4299 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004300 * To be used as code under test for framework instrumentation tests.
4301 */
4302 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
4303 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04004304 /**
4305 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004306 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4307 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004308 */
4309 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4310 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
4311 /**
4312 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004313 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4314 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004315 */
4316 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4317 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004318 /**
4319 * An activity to run when device is inserted into a analog (low end) dock.
4320 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4321 * information, see {@link android.app.UiModeManager}.
4322 */
4323 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4324 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
4325
4326 /**
4327 * An activity to run when device is inserted into a digital (high end) dock.
4328 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4329 * information, see {@link android.app.UiModeManager}.
4330 */
4331 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4332 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004333
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004334 /**
4335 * Used to indicate that the activity can be used in a car environment.
4336 */
4337 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4338 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4339
Zak Cohendb6ca492017-01-26 14:09:00 -08004340 /**
4341 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4342 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4343 * information, see {@link android.app.UiModeManager}.
4344 */
4345 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4346 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004347 // ---------------------------------------------------------------------
4348 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004349 // Application launch intent categories (see addCategory()).
4350
4351 /**
4352 * Used with {@link #ACTION_MAIN} to launch the browser application.
4353 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004354 * <p>NOTE: This should not be used as the primary key of an Intent,
4355 * since it will not result in the app launching with the correct
4356 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004357 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004358 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004359 */
4360 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4361 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4362
4363 /**
4364 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4365 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004366 * <p>NOTE: This should not be used as the primary key of an Intent,
4367 * since it will not result in the app launching with the correct
4368 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004369 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004370 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004371 */
4372 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4373 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4374
4375 /**
4376 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4377 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004378 * <p>NOTE: This should not be used as the primary key of an Intent,
4379 * since it will not result in the app launching with the correct
4380 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004381 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004382 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004383 */
4384 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4385 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4386
4387 /**
4388 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4389 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004390 * <p>NOTE: This should not be used as the primary key of an Intent,
4391 * since it will not result in the app launching with the correct
4392 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004393 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004394 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004395 */
4396 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4397 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4398
4399 /**
4400 * Used with {@link #ACTION_MAIN} to launch the email application.
4401 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004402 * <p>NOTE: This should not be used as the primary key of an Intent,
4403 * since it will not result in the app launching with the correct
4404 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004405 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004406 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004407 */
4408 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4409 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4410
4411 /**
4412 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4413 * The activity should be able to view and manipulate image and video files
4414 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004415 * <p>NOTE: This should not be used as the primary key of an Intent,
4416 * since it will not result in the app launching with the correct
4417 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004418 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004419 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004420 */
4421 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4422 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4423
4424 /**
4425 * Used with {@link #ACTION_MAIN} to launch the maps application.
4426 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004427 * <p>NOTE: This should not be used as the primary key of an Intent,
4428 * since it will not result in the app launching with the correct
4429 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004430 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004431 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004432 */
4433 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4434 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4435
4436 /**
4437 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4438 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004439 * <p>NOTE: This should not be used as the primary key of an Intent,
4440 * since it will not result in the app launching with the correct
4441 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004442 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004443 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004444 */
4445 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4446 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4447
4448 /**
4449 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004450 * The activity should be able to play, browse, or manipulate music files
4451 * stored on the device.
4452 * <p>NOTE: This should not be used as the primary key of an Intent,
4453 * since it will not result in the app launching with the correct
4454 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004455 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004456 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004457 */
4458 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4459 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4460
4461 // ---------------------------------------------------------------------
4462 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004463 // Standard extra data keys.
4464
4465 /**
4466 * The initial data to place in a newly created record. Use with
4467 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4468 * fields as would be given to the underlying ContentProvider.insert()
4469 * call.
4470 */
4471 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4472
4473 /**
4474 * A constant CharSequence that is associated with the Intent, used with
4475 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4476 * this may be a styled CharSequence, so you must use
4477 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4478 * retrieve it.
4479 */
4480 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4481
4482 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004483 * A constant String that is associated with the Intent, used with
4484 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4485 * as HTML formatted text. Note that you <em>must</em> also supply
4486 * {@link #EXTRA_TEXT}.
4487 */
4488 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4489
4490 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004491 * A content: URI holding a stream of data associated with the Intent,
4492 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004493 */
4494 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4495
4496 /**
4497 * A String[] holding e-mail addresses that should be delivered to.
4498 */
4499 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4500
4501 /**
4502 * A String[] holding e-mail addresses that should be carbon copied.
4503 */
4504 public static final String EXTRA_CC = "android.intent.extra.CC";
4505
4506 /**
4507 * A String[] holding e-mail addresses that should be blind carbon copied.
4508 */
4509 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4510
4511 /**
4512 * A constant string holding the desired subject line of a message.
4513 */
4514 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4515
4516 /**
4517 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004518 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004519 */
4520 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4521
4522 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004523 * An int representing the user id to be used.
4524 *
4525 * @hide
4526 */
4527 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4528
4529 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004530 * An int representing the task id to be retrieved. This is used when a launch from recents is
4531 * intercepted by another action such as credentials confirmation to remember which task should
4532 * be resumed when complete.
4533 *
4534 * @hide
4535 */
4536 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4537
4538 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004539 * An Intent[] describing additional, alternate choices you would like shown with
4540 * {@link #ACTION_CHOOSER}.
4541 *
4542 * <p>An app may be capable of providing several different payload types to complete a
4543 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4544 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4545 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4546 * photo data or a hosted link where the photos can be viewed.</p>
4547 *
4548 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4549 * first/primary/preferred intent in the set. Additional intents specified in
4550 * this extra are ordered; by default intents that appear earlier in the array will be
4551 * preferred over intents that appear later in the array as matches for the same
4552 * target component. To alter this preference, a calling app may also supply
4553 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4554 */
4555 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4556
4557 /**
Adam Powell52c39212016-04-07 15:14:18 -07004558 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4559 * and omitted from a list of components presented to the user.
4560 *
4561 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4562 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4563 * from your own package or other apps from your organization if the idea of sending to those
4564 * targets would be redundant with other app functionality. Filtered components will not
4565 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4566 */
4567 public static final String EXTRA_EXCLUDE_COMPONENTS
4568 = "android.intent.extra.EXCLUDE_COMPONENTS";
4569
4570 /**
4571 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4572 * describing additional high-priority deep-link targets for the chooser to present to the user.
4573 *
4574 * <p>Targets provided in this way will be presented inline with all other targets provided
4575 * by services from other apps. They will be prioritized before other service targets, but
4576 * after those targets provided by sources that the user has manually pinned to the front.</p>
4577 *
4578 * @see #ACTION_CHOOSER
4579 */
4580 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4581
4582 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004583 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4584 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4585 *
4586 * <p>An app preparing an action for another app to complete may wish to allow the user to
4587 * disambiguate between several options for completing the action based on the chosen target
4588 * or otherwise refine the action before it is invoked.
4589 * </p>
4590 *
4591 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4592 * <ul>
4593 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4594 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4595 * chosen target beyond the first</li>
4596 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4597 * should fill in and send once the disambiguation is complete</li>
4598 * </ul>
4599 */
4600 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4601 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4602
4603 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004604 * An {@code ArrayList} of {@code String} annotations describing content for
4605 * {@link #ACTION_CHOOSER}.
4606 *
4607 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4608 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4609 *
4610 * <p>Annotations should describe the major components or topics of the content. It is up to
4611 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4612 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004613 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4614 * character. Performance on customized annotations can suffer, if they are rarely used for
4615 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4616 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004617 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004618 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004619 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004620 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004621 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004622 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004623 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004624 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004625 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004626 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4627 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4628 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4629 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4630 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004631 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004632 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4633 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004634 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004635 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004636 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004637 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004638 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004639 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004640 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004641 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004642 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004643 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004644 * Christmas and Thanksgiving.</li>
4645 * </ul>
4646 */
4647 public static final String EXTRA_CONTENT_ANNOTATIONS
4648 = "android.intent.extra.CONTENT_ANNOTATIONS";
4649
4650 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004651 * A {@link ResultReceiver} used to return data back to the sender.
4652 *
4653 * <p>Used to complete an app-specific
4654 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4655 *
4656 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4657 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4658 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4659 * when the user selects a target component from the chooser. It is up to the recipient
4660 * to send a result to this ResultReceiver to signal that disambiguation is complete
4661 * and that the chooser should invoke the user's choice.</p>
4662 *
4663 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4664 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4665 * to match and fill in the final Intent or ChooserTarget before starting it.
4666 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4667 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4668 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4669 *
4670 * <p>The result code passed to the ResultReceiver should be
4671 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4672 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4673 * the chooser should finish without starting a target.</p>
4674 */
4675 public static final String EXTRA_RESULT_RECEIVER
4676 = "android.intent.extra.RESULT_RECEIVER";
4677
4678 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004679 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004680 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004681 */
4682 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4683
4684 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004685 * A Parcelable[] of {@link Intent} or
4686 * {@link android.content.pm.LabeledIntent} objects as set with
4687 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4688 * a the front of the list of choices, when shown to the user with a
4689 * {@link #ACTION_CHOOSER}.
4690 */
4691 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4692
4693 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004694 * A {@link IntentSender} to start after instant app installation success.
Todd Kennedy7440f172015-12-09 14:31:22 -08004695 * @hide
4696 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004697 @SystemApi
4698 public static final String EXTRA_INSTANT_APP_SUCCESS =
4699 "android.intent.extra.INSTANT_APP_SUCCESS";
4700
4701 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004702 * A {@link IntentSender} to start after instant app installation failure.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004703 * @hide
4704 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004705 @SystemApi
4706 public static final String EXTRA_INSTANT_APP_FAILURE =
4707 "android.intent.extra.INSTANT_APP_FAILURE";
4708
4709 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004710 * The host name that triggered an instant app resolution.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004711 * @hide
4712 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004713 @SystemApi
4714 public static final String EXTRA_INSTANT_APP_HOSTNAME =
4715 "android.intent.extra.INSTANT_APP_HOSTNAME";
4716
4717 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004718 * An opaque token to track instant app resolution.
4719 * @hide
4720 */
4721 @SystemApi
4722 public static final String EXTRA_INSTANT_APP_TOKEN =
4723 "android.intent.extra.INSTANT_APP_TOKEN";
4724
4725 /**
Patrick Baumannb4165d72017-12-04 11:29:24 -08004726 * The action that triggered an instant application resolution.
4727 * @hide
4728 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004729 @SystemApi
Patrick Baumannb4165d72017-12-04 11:29:24 -08004730 public static final String EXTRA_INSTANT_APP_ACTION = "android.intent.extra.INSTANT_APP_ACTION";
4731
4732 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004733 * An array of {@link Bundle}s containing details about resolved instant apps..
4734 * @hide
4735 */
4736 @SystemApi
4737 public static final String EXTRA_INSTANT_APP_BUNDLES =
4738 "android.intent.extra.INSTANT_APP_BUNDLES";
4739
4740 /**
4741 * A {@link Bundle} of metadata that describes the instant application that needs to be
Patrick Baumann709ee152017-12-04 16:12:52 -08004742 * installed. This data is populated from the response to
4743 * {@link android.content.pm.InstantAppResolveInfo#getExtras()} as provided by the registered
4744 * instant application resolver.
4745 * @hide
4746 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004747 @SystemApi
Patrick Baumann709ee152017-12-04 16:12:52 -08004748 public static final String EXTRA_INSTANT_APP_EXTRAS =
4749 "android.intent.extra.INSTANT_APP_EXTRAS";
4750
4751 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004752 * A boolean value indicating that the instant app resolver was unable to state with certainty
4753 * that it did or did not have an app for the sanitized {@link Intent} defined at
4754 * {@link #EXTRA_INTENT}.
4755 * @hide
4756 */
4757 @SystemApi
4758 public static final String EXTRA_UNKNOWN_INSTANT_APP =
4759 "android.intent.extra.UNKNOWN_INSTANT_APP";
4760
4761 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004762 * The version code of the app to install components from.
Dianne Hackborn3accca02013-09-20 09:32:11 -07004763 * @deprecated Use {@link #EXTRA_LONG_VERSION_CODE).
Todd Kennedy316c2f22017-01-23 15:40:07 -08004764 * @hide
4765 */
Dianne Hackborn3accca02013-09-20 09:32:11 -07004766 @Deprecated
Todd Kennedy316c2f22017-01-23 15:40:07 -08004767 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4768
4769 /**
Dianne Hackborn3accca02013-09-20 09:32:11 -07004770 * The version code of the app to install components from.
4771 * @hide
4772 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004773 @SystemApi
Dianne Hackborn3accca02013-09-20 09:32:11 -07004774 public static final String EXTRA_LONG_VERSION_CODE = "android.intent.extra.LONG_VERSION_CODE";
4775
4776 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004777 * The app that triggered the instant app installation.
Chad Brubaker06068612017-04-06 09:43:47 -07004778 * @hide
4779 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004780 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004781 public static final String EXTRA_CALLING_PACKAGE
4782 = "android.intent.extra.CALLING_PACKAGE";
4783
4784 /**
4785 * Optional calling app provided bundle containing additional launch information the
4786 * installer may use.
4787 * @hide
4788 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004789 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004790 public static final String EXTRA_VERIFICATION_BUNDLE
4791 = "android.intent.extra.VERIFICATION_BUNDLE";
4792
4793 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004794 * A Bundle forming a mapping of potential target package names to different extras Bundles
4795 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4796 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4797 * be currently installed on the device.
4798 *
4799 * <p>An application may choose to provide alternate extras for the case where a user
4800 * selects an activity from a predetermined set of target packages. If the activity
4801 * the user selects from the chooser belongs to a package with its package name as
4802 * a key in this bundle, the corresponding extras for that package will be merged with
4803 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4804 * extra has the same key as an extra already present in the intent it will overwrite
4805 * the extra from the intent.</p>
4806 *
4807 * <p><em>Examples:</em>
4808 * <ul>
4809 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4810 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4811 * parameters for that target.</li>
4812 * <li>An application may offer additional metadata for known targets of a given intent
4813 * to pass along information only relevant to that target such as account or content
4814 * identifiers already known to that application.</li>
4815 * </ul></p>
4816 */
4817 public static final String EXTRA_REPLACEMENT_EXTRAS =
4818 "android.intent.extra.REPLACEMENT_EXTRAS";
4819
4820 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004821 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4822 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4823 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4824 * {@link ComponentName} of the chosen component.
4825 *
4826 * <p>In some situations this callback may never come, for example if the user abandons
4827 * the chooser, switches to another task or any number of other reasons. Apps should not
4828 * be written assuming that this callback will always occur.</p>
4829 */
4830 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4831 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4832
4833 /**
4834 * The {@link ComponentName} chosen by the user to complete an action.
4835 *
4836 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4837 */
4838 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4839
4840 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004841 * A {@link android.view.KeyEvent} object containing the event that
4842 * triggered the creation of the Intent it is in.
4843 */
4844 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4845
4846 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004847 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4848 * before shutting down.
4849 *
4850 * {@hide}
4851 */
4852 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4853
4854 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004855 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4856 * requested by the user.
4857 *
4858 * {@hide}
4859 */
4860 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4861 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4862
4863 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004864 * 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 -07004865 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4866 * of restarting the application.
4867 */
4868 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4869
4870 /**
4871 * A String holding the phone number originally entered in
4872 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4873 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4874 */
4875 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004876
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004877 /**
4878 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4879 * intents to supply the uid the package had been assigned. Also an optional
4880 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4881 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4882 * purpose.
4883 */
4884 public static final String EXTRA_UID = "android.intent.extra.UID";
4885
4886 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004887 * @hide String array of package names.
4888 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004889 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004890 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4891
4892 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004893 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4894 * intents to indicate whether this represents a full uninstall (removing
4895 * both the code and its data) or a partial uninstall (leaving its data,
4896 * implying that this is an update).
4897 */
4898 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004899
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004900 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004901 * @hide
4902 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4903 * intents to indicate that at this point the package has been removed for
4904 * all users on the device.
4905 */
4906 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4907 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4908
4909 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004910 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4911 * intents to indicate that this is a replacement of the package, so this
4912 * broadcast will immediately be followed by an add broadcast for a
4913 * different version of the same package.
4914 */
4915 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004916
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004917 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004918 * Used as an int extra field in {@link android.app.AlarmManager} intents
4919 * to tell the application being invoked how many pending alarms are being
4920 * delievered with the intent. For one-shot alarms this will always be 1.
4921 * For recurring alarms, this might be greater than 1 if the device was
4922 * asleep or powered off at the time an earlier alarm would have been
4923 * delivered.
4924 */
4925 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004926
Jacek Surazski86b6c532009-05-13 14:38:28 +02004927 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004928 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4929 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004930 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4931 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004932 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4933 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4934 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004935 */
4936 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4937
4938 /**
4939 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4940 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004941 */
4942 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4943
4944 /**
4945 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4946 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004947 */
4948 public static final int EXTRA_DOCK_STATE_DESK = 1;
4949
4950 /**
4951 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4952 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004953 */
4954 public static final int EXTRA_DOCK_STATE_CAR = 2;
4955
4956 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004957 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4958 * to represent that the phone is in a analog (low end) dock.
4959 */
4960 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4961
4962 /**
4963 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4964 * to represent that the phone is in a digital (high end) dock.
4965 */
4966 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4967
4968 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004969 * Boolean that can be supplied as meta-data with a dock activity, to
4970 * indicate that the dock should take over the home key when it is active.
4971 */
4972 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004973
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004974 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004975 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4976 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004977 */
4978 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4979
4980 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004981 * Used in the extra field in the remote intent. It's astring token passed with the
4982 * remote intent.
4983 */
4984 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4985 "android.intent.extra.remote_intent_token";
4986
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004987 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004988 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004989 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004990 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004991 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004992 "android.intent.extra.changed_component_name";
4993
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004994 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004995 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004996 * and contains a string array of all of the components that have changed. If
4997 * the state of the overall package has changed, then it will contain an entry
4998 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004999 */
5000 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
5001 "android.intent.extra.changed_component_name_list";
5002
5003 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005004 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08005005 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00005006 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
5007 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
5008 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005009 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005010 */
5011 public static final String EXTRA_CHANGED_PACKAGE_LIST =
5012 "android.intent.extra.changed_package_list";
5013
5014 /**
5015 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08005016 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
5017 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005018 * and contains an integer array of uids of all of the components
5019 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005020 */
5021 public static final String EXTRA_CHANGED_UID_LIST =
5022 "android.intent.extra.changed_uid_list";
5023
5024 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07005025 * @hide
5026 * Magic extra system code can use when binding, to give a label for
5027 * who it is that has bound to a service. This is an integer giving
5028 * a framework string resource that can be displayed to the user.
5029 */
5030 public static final String EXTRA_CLIENT_LABEL =
5031 "android.intent.extra.client_label";
5032
5033 /**
5034 * @hide
5035 * Magic extra system code can use when binding, to give a PendingIntent object
5036 * that can be launched for the user to disable the system's use of this
5037 * service.
5038 */
5039 public static final String EXTRA_CLIENT_INTENT =
5040 "android.intent.extra.client_intent";
5041
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08005042 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005043 * Extra used to indicate that an intent should only return data that is on
5044 * the local device. This is a boolean extra; the default is false. If true,
5045 * an implementation should only allow the user to select data that is
5046 * already on the device, not requiring it be downloaded from a remote
5047 * service when opened.
5048 *
5049 * @see #ACTION_GET_CONTENT
5050 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07005051 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005052 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08005053 */
5054 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005055 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005056
Amith Yamasani13593602012-03-22 16:16:17 -07005057 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005058 * Extra used to indicate that an intent can allow the user to select and
5059 * return multiple items. This is a boolean extra; the default is false. If
5060 * true, an implementation is allowed to present the user with a UI where
5061 * they can pick multiple items that are all returned to the caller. When
5062 * this happens, they should be returned as the {@link #getClipData()} part
5063 * of the result Intent.
5064 *
5065 * @see #ACTION_GET_CONTENT
5066 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08005067 */
5068 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005069 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08005070
5071 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01005072 * The integer userHandle carried with broadcast intents related to addition, removal and
5073 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
5074 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
5075 *
Amith Yamasani13593602012-03-22 16:16:17 -07005076 * @hide
5077 */
Amith Yamasani2a003292012-08-14 18:25:45 -07005078 public static final String EXTRA_USER_HANDLE =
5079 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07005080
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005081 /**
Philip P. Moltmannc54c36d2018-10-08 15:51:07 -07005082 * The UserHandle carried with intents.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01005083 */
5084 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01005085 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01005086
5087 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005088 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07005089 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
5090 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005091 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07005092 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
5093
5094 /**
5095 * Extra sent in the intent to the BroadcastReceiver that handles
5096 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
5097 * the restrictions as key/value pairs.
5098 */
5099 public static final String EXTRA_RESTRICTIONS_BUNDLE =
5100 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005101
Amith Yamasani86118ba2013-03-28 14:33:16 -07005102 /**
5103 * Extra used in the response from a BroadcastReceiver that handles
5104 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
5105 */
5106 public static final String EXTRA_RESTRICTIONS_INTENT =
5107 "android.intent.extra.restrictions_intent";
5108
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07005109 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005110 * Extra used to communicate a set of acceptable MIME types. The type of the
5111 * extra is {@code String[]}. Values may be a combination of concrete MIME
5112 * types (such as "image/png") and/or partial MIME types (such as
5113 * "audio/*").
5114 *
5115 * @see #ACTION_GET_CONTENT
5116 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07005117 */
5118 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
5119
Dianne Hackborn57a7f592013-07-22 18:21:32 -07005120 /**
5121 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
5122 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07005123 * When this is true, hardware devices can use this information to determine that
5124 * they shouldn't do a complete shutdown of their device since this is not a
5125 * complete shutdown down to the kernel, but only user space restarting.
5126 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07005127 */
5128 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
5129 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
5130
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005131 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00005132 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
5133 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
5134 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
5135 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005136 *
5137 * @hide for internal use only.
5138 */
5139 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
5140 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00005141 /** @hide */
5142 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
5143 /** @hide */
5144 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
5145 /** @hide */
5146 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005147
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07005148 /**
5149 * Intent extra: the reason that the operation associated with this intent is being performed.
5150 *
5151 * <p>Type: String
5152 * @hide
5153 */
5154 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07005155 public static final String EXTRA_REASON = "android.intent.extra.REASON";
5156
qingxi240c2bb2017-04-12 17:31:18 -07005157 /**
5158 * {@hide}
5159 * This extra will be send together with {@link #ACTION_FACTORY_RESET}
5160 */
Rubin Xue8490f12015-06-25 12:17:48 +01005161 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
5162
Santos Cordon15a13782015-03-31 18:32:31 -07005163 /**
qingxi240c2bb2017-04-12 17:31:18 -07005164 * {@hide}
5165 * This extra will be set to true when the user choose to wipe the data on eSIM during factory
5166 * reset for the device with eSIM. This extra will be sent together with
5167 * {@link #ACTION_FACTORY_RESET}
5168 */
5169 public static final String EXTRA_WIPE_ESIMS = "com.android.internal.intent.extra.WIPE_ESIMS";
5170
5171 /**
Santos Cordon15a13782015-03-31 18:32:31 -07005172 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
5173 * activation request.
5174 * TODO: Add information about the structure and response data used with the pending intent.
5175 * @hide
5176 */
5177 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
5178 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
5179
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09005180 /**
5181 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09005182 *
5183 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07005184 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09005185 */
Steve McKay6eaf38632015-08-04 10:11:01 -07005186 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
5187
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005188 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09005189 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
5190 * such as opening in other apps, sharing, opening, editing, printing, deleting,
5191 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005192 *
5193 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07005194 * @see #ACTION_QUICK_VIEW
5195 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005196 */
Garfield Tance1d0e92017-03-23 10:52:48 -07005197 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09005198 public static final String EXTRA_QUICK_VIEW_ADVANCED =
5199 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005200
5201 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07005202 * An optional extra of {@code String[]} indicating which quick view features should be made
5203 * available to the user in the quick view UI while handing a
5204 * {@link Intent#ACTION_QUICK_VIEW} intent.
5205 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
5206 * Quick viewer can implement features not listed below.
5207 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
Geoffrey Pitschbc02b772017-12-06 11:24:15 -05005208 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DELETE},
5209 * {@link QuickViewConstants#FEATURE_DOWNLOAD}, {@link QuickViewConstants#FEATURE_SEND},
5210 * {@link QuickViewConstants#FEATURE_PRINT}.
Garfield Tance1d0e92017-03-23 10:52:48 -07005211 * <p>
5212 * Requirements:
5213 * <li>Quick viewer shouldn't show a feature if the feature is absent in
5214 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
5215 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
5216 * internal policies.
5217 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
5218 * requirement that the feature be shown. Quick viewer may, according to its own policies,
5219 * disable or hide features.
5220 *
5221 * @see #ACTION_QUICK_VIEW
5222 */
5223 public static final String EXTRA_QUICK_VIEW_FEATURES =
5224 "android.intent.extra.QUICK_VIEW_FEATURES";
5225
5226 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005227 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01005228 * When a profile goes into quiet mode, all apps in the profile are killed and the
5229 * profile user is stopped. Widgets originating from the profile are masked, and app
5230 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005231 */
5232 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005233
5234 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005235 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005236 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005237 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
5238 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005239 *
5240 * @hide
5241 */
5242 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
5243 "android.intent.extra.MEDIA_RESOURCE_TYPE";
5244
5245 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07005246 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
5247 * whether to show the chooser or not when there is only one application available
5248 * to choose from.
5249 *
5250 * @hide
5251 */
5252 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
5253 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
5254
5255 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005256 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005257 * to represent that a video codec is allowed to use.
5258 *
5259 * @hide
5260 */
5261 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
5262
5263 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005264 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005265 * to represent that a audio codec is allowed to use.
5266 *
5267 * @hide
5268 */
5269 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
5270
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005271 // ---------------------------------------------------------------------
5272 // ---------------------------------------------------------------------
5273 // Intent flags (see mFlags variable).
5274
Tor Norbyed9273d62013-05-30 15:59:53 -07005275 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005276 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005277 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
5278 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07005279 @Retention(RetentionPolicy.SOURCE)
5280 public @interface GrantUriMode {}
5281
Jeff Sharkey846318a2014-04-04 12:12:41 -07005282 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005283 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005284 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
5285 @Retention(RetentionPolicy.SOURCE)
5286 public @interface AccessUriMode {}
5287
5288 /**
5289 * Test if given mode flags specify an access mode, which must be at least
5290 * read and/or write.
5291 *
5292 * @hide
5293 */
5294 public static boolean isAccessUriMode(int modeFlags) {
5295 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
5296 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
5297 }
5298
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005299 /** @hide */
5300 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5301 FLAG_GRANT_READ_URI_PERMISSION,
5302 FLAG_GRANT_WRITE_URI_PERMISSION,
5303 FLAG_FROM_BACKGROUND,
5304 FLAG_DEBUG_LOG_RESOLUTION,
5305 FLAG_EXCLUDE_STOPPED_PACKAGES,
5306 FLAG_INCLUDE_STOPPED_PACKAGES,
5307 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
5308 FLAG_GRANT_PREFIX_URI_PERMISSION,
5309 FLAG_DEBUG_TRIAGED_MISSING,
5310 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005311 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005312 FLAG_ACTIVITY_NO_HISTORY,
5313 FLAG_ACTIVITY_SINGLE_TOP,
5314 FLAG_ACTIVITY_NEW_TASK,
5315 FLAG_ACTIVITY_MULTIPLE_TASK,
5316 FLAG_ACTIVITY_CLEAR_TOP,
5317 FLAG_ACTIVITY_FORWARD_RESULT,
5318 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5319 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5320 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5321 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5322 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5323 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5324 FLAG_ACTIVITY_NEW_DOCUMENT,
5325 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5326 FLAG_ACTIVITY_NO_USER_ACTION,
5327 FLAG_ACTIVITY_REORDER_TO_FRONT,
5328 FLAG_ACTIVITY_NO_ANIMATION,
5329 FLAG_ACTIVITY_CLEAR_TASK,
5330 FLAG_ACTIVITY_TASK_ON_HOME,
5331 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5332 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5333 FLAG_RECEIVER_REGISTERED_ONLY,
5334 FLAG_RECEIVER_REPLACE_PENDING,
5335 FLAG_RECEIVER_FOREGROUND,
5336 FLAG_RECEIVER_NO_ABORT,
5337 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5338 FLAG_RECEIVER_BOOT_UPGRADE,
5339 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5340 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5341 FLAG_RECEIVER_FROM_SHELL,
5342 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
Ng Zhi An150a6ba2018-08-13 09:08:11 -07005343 FLAG_RECEIVER_OFFLOAD,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005344 })
5345 @Retention(RetentionPolicy.SOURCE)
5346 public @interface Flags {}
5347
5348 /** @hide */
5349 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5350 FLAG_FROM_BACKGROUND,
5351 FLAG_DEBUG_LOG_RESOLUTION,
5352 FLAG_EXCLUDE_STOPPED_PACKAGES,
5353 FLAG_INCLUDE_STOPPED_PACKAGES,
5354 FLAG_DEBUG_TRIAGED_MISSING,
5355 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005356 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005357 FLAG_ACTIVITY_NO_HISTORY,
5358 FLAG_ACTIVITY_SINGLE_TOP,
5359 FLAG_ACTIVITY_NEW_TASK,
5360 FLAG_ACTIVITY_MULTIPLE_TASK,
5361 FLAG_ACTIVITY_CLEAR_TOP,
5362 FLAG_ACTIVITY_FORWARD_RESULT,
5363 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5364 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5365 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5366 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5367 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5368 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5369 FLAG_ACTIVITY_NEW_DOCUMENT,
5370 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5371 FLAG_ACTIVITY_NO_USER_ACTION,
5372 FLAG_ACTIVITY_REORDER_TO_FRONT,
5373 FLAG_ACTIVITY_NO_ANIMATION,
5374 FLAG_ACTIVITY_CLEAR_TASK,
5375 FLAG_ACTIVITY_TASK_ON_HOME,
5376 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5377 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5378 FLAG_RECEIVER_REGISTERED_ONLY,
5379 FLAG_RECEIVER_REPLACE_PENDING,
5380 FLAG_RECEIVER_FOREGROUND,
5381 FLAG_RECEIVER_NO_ABORT,
5382 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5383 FLAG_RECEIVER_BOOT_UPGRADE,
5384 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5385 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5386 FLAG_RECEIVER_FROM_SHELL,
5387 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
Ng Zhi An150a6ba2018-08-13 09:08:11 -07005388 FLAG_RECEIVER_OFFLOAD,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005389 })
5390 @Retention(RetentionPolicy.SOURCE)
5391 public @interface MutableFlags {}
5392
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005393 /**
5394 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005395 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005396 * specified in its ClipData. When applying to an Intent's ClipData,
5397 * all URIs as well as recursive traversals through data or other ClipData
5398 * in Intent items will be granted; only the grant flags of the top-level
5399 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005400 */
5401 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5402 /**
5403 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005404 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005405 * specified in its ClipData. When applying to an Intent's ClipData,
5406 * all URIs as well as recursive traversals through data or other ClipData
5407 * in Intent items will be granted; only the grant flags of the top-level
5408 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005409 */
5410 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5411 /**
5412 * Can be set by the caller to indicate that this Intent is coming from
5413 * a background operation, not from direct user interaction.
5414 */
5415 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5416 /**
5417 * A flag you can enable for debugging: when set, log messages will be
5418 * printed during the resolution of this intent to show you what has
5419 * been found to create the final resolved list.
5420 */
5421 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005422 /**
5423 * If set, this intent will not match any components in packages that
5424 * are currently stopped. If this is not set, then the default behavior
5425 * is to include such applications in the result.
5426 */
5427 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5428 /**
5429 * If set, this intent will always match any components in packages that
5430 * are currently stopped. This is the default behavior when
5431 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5432 * flags are set, this one wins (it allows overriding of exclude for
5433 * places where the framework may automatically set the exclude flag).
5434 */
5435 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005436
5437 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005438 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005439 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005440 * persisted across device reboots until explicitly revoked with
5441 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5442 * grant for possible persisting; the receiving application must call
5443 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5444 * actually persist.
5445 *
5446 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5447 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5448 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005449 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005450 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005451 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005452
5453 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005454 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5455 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5456 * applies to any URI that is a prefix match against the original granted
5457 * URI. (Without this flag, the URI must match exactly for access to be
5458 * granted.) Another URI is considered a prefix match only when scheme,
5459 * authority, and all path segments defined by the prefix are an exact
5460 * match.
5461 */
5462 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5463
5464 /**
Jeff Sharkeyc59a5e72018-06-21 19:14:58 -06005465 * Flag used to automatically match intents based on their Direct Boot
5466 * awareness and the current user state.
5467 * <p>
5468 * Since the default behavior is to automatically apply the current user
5469 * state, this is effectively a sentinel value that doesn't change the
5470 * output of any queries based on its presence or absence.
5471 * <p>
5472 * Instead, this value can be useful in conjunction with
5473 * {@link android.os.StrictMode.VmPolicy.Builder#detectImplicitDirectBoot()}
5474 * to detect when a caller is relying on implicit automatic matching,
5475 * instead of confirming the explicit behavior they want.
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005476 */
Jeff Sharkeyc59a5e72018-06-21 19:14:58 -06005477 public static final int FLAG_DIRECT_BOOT_AUTO = 0x00000100;
5478
5479 /** {@hide} */
5480 @Deprecated
5481 public static final int FLAG_DEBUG_TRIAGED_MISSING = FLAG_DIRECT_BOOT_AUTO;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005482
5483 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005484 * Internal flag used to indicate ephemeral applications should not be
5485 * considered when resolving the intent.
5486 *
5487 * @hide
5488 */
5489 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5490
5491 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005492 * If set, the new activity is not kept in the history stack. As soon as
5493 * the user navigates away from it, the activity is finished. This may also
5494 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5495 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005496 *
5497 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5498 * is never invoked when the current activity starts a new activity which
5499 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005500 */
5501 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5502 /**
5503 * If set, the activity will not be launched if it is already running
5504 * at the top of the history stack.
5505 */
5506 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5507 /**
5508 * If set, this activity will become the start of a new task on this
5509 * history stack. A task (from the activity that started it to the
5510 * next task activity) defines an atomic group of activities that the
5511 * user can move to. Tasks can be moved to the foreground and background;
5512 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005513 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005514 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5515 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005516 *
5517 * <p>This flag is generally used by activities that want
5518 * to present a "launcher" style behavior: they give the user a list of
5519 * separate things that can be done, which otherwise run completely
5520 * independently of the activity launching them.
5521 *
5522 * <p>When using this flag, if a task is already running for the activity
5523 * you are now starting, then a new activity will not be started; instead,
5524 * the current task will simply be brought to the front of the screen with
5525 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5526 * to disable this behavior.
5527 *
5528 * <p>This flag can not be used when the caller is requesting a result from
5529 * the activity being launched.
5530 */
5531 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5532 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005533 * This flag is used to create a new task and launch an activity into it.
5534 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5535 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5536 * search through existing tasks for ones matching this Intent. Only if no such
5537 * task is found would a new task be created. When paired with
5538 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5539 * the search for a matching task and unconditionally start a new task.
5540 *
5541 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5542 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005543 * top-level application launcher.</strong> Used in conjunction with
5544 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5545 * behavior of bringing an existing task to the foreground. When set,
5546 * a new task is <em>always</em> started to host the Activity for the
5547 * Intent, regardless of whether there is already an existing task running
5548 * the same thing.
5549 *
5550 * <p><strong>Because the default system does not include graphical task management,
5551 * you should not use this flag unless you provide some way for a user to
5552 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005553 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005554 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5555 * creating new document tasks.
5556 *
5557 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005558 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005559 *
Scott Main7aee61f2011-02-08 11:25:01 -08005560 * <p>See
5561 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5562 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005563 *
5564 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5565 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005566 */
5567 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5568 /**
5569 * If set, and the activity being launched is already running in the
5570 * current task, then instead of launching a new instance of that activity,
5571 * all of the other activities on top of it will be closed and this Intent
5572 * will be delivered to the (now on top) old activity as a new Intent.
5573 *
5574 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5575 * If D calls startActivity() with an Intent that resolves to the component
5576 * of activity B, then C and D will be finished and B receive the given
5577 * Intent, resulting in the stack now being: A, B.
5578 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005579 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005580 * either receive the new intent you are starting here in its
5581 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005582 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005583 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5584 * the same intent, then it will be finished and re-created; for all other
5585 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5586 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005587 *
5588 * <p>This launch mode can also be used to good effect in conjunction with
5589 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5590 * of a task, it will bring any currently running instance of that task
5591 * to the foreground, and then clear it to its root state. This is
5592 * especially useful, for example, when launching an activity from the
5593 * notification manager.
5594 *
Scott Main7aee61f2011-02-08 11:25:01 -08005595 * <p>See
5596 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5597 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005598 */
5599 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5600 /**
5601 * If set and this intent is being used to launch a new activity from an
5602 * existing one, then the reply target of the existing activity will be
kopriva219f7dc2018-10-09 13:42:28 -07005603 * transferred to the new activity. This way, the new activity can call
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005604 * {@link android.app.Activity#setResult} and have that result sent back to
5605 * the reply target of the original activity.
5606 */
5607 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5608 /**
5609 * If set and this intent is being used to launch a new activity from an
5610 * existing one, the current activity will not be counted as the top
5611 * activity for deciding whether the new intent should be delivered to
5612 * the top instead of starting a new one. The previous activity will
5613 * be used as the top, with the assumption being that the current activity
5614 * will finish itself immediately.
5615 */
5616 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5617 /**
5618 * If set, the new activity is not kept in the list of recently launched
5619 * activities.
5620 */
5621 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5622 /**
5623 * This flag is not normally set by application code, but set for you by
5624 * the system as described in the
5625 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5626 * launchMode} documentation for the singleTask mode.
5627 */
5628 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5629 /**
5630 * If set, and this activity is either being started in a new task or
5631 * bringing to the top an existing task, then it will be launched as
5632 * the front door of the task. This will result in the application of
5633 * any affinities needed to have that task in the proper state (either
5634 * moving activities to or from it), or simply resetting that task to
5635 * its initial state if needed.
5636 */
5637 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5638 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005639 * This flag is not normally set by application code, but set for you by
5640 * the system if this activity is being launched from history
5641 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005642 */
5643 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005644 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005645 * @deprecated As of API 21 this performs identically to
5646 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005647 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005648 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005649 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005650 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005651 * This flag is used to open a document into a new task rooted at the activity launched
5652 * by this Intent. Through the use of this flag, or its equivalent attribute,
5653 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005654 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005655 *
Craig Mautner026596b2014-05-21 15:35:44 -07005656 * <p>The use of the activity attribute form of this,
5657 * {@link android.R.attr#documentLaunchMode}, is
5658 * preferred over the Intent flag described here. The attribute form allows the
5659 * Activity to specify multiple document behavior for all launchers of the Activity
5660 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005661 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005662 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5663 * it is kept after the activity is finished is different than the use of
5664 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5665 * this flag is being used to create a new recents entry, then by default that entry
5666 * will be removed once the activity is finished. You can modify this behavior with
5667 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5668 *
Craig Mautner026596b2014-05-21 15:35:44 -07005669 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5670 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5671 * equivalent of the Activity manifest specifying {@link
5672 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5673 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5674 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005675 *
Craig Mautner026596b2014-05-21 15:35:44 -07005676 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005677 *
Craig Mautner026596b2014-05-21 15:35:44 -07005678 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005679 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5680 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005681 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005682 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005683 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005684 * callback from occurring on the current frontmost activity before it is
5685 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005686 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005687 * <p>Typically, an activity can rely on that callback to indicate that an
5688 * explicit user action has caused their activity to be moved out of the
5689 * foreground. The callback marks an appropriate point in the activity's
5690 * lifecycle for it to dismiss any notifications that it intends to display
5691 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005692 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005693 * <p>If an activity is ever started via any non-user-driven events such as
5694 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5695 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005696 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005697 */
5698 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005699 /**
5700 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5701 * this flag will cause the launched activity to be brought to the front of its
5702 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005703 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005704 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5705 * If D calls startActivity() with an Intent that resolves to the component
5706 * of activity B, then B will be brought to the front of the history stack,
5707 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005708 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005709 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005710 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005711 */
5712 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005713 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005714 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5715 * this flag will prevent the system from applying an activity transition
5716 * animation to go to the next activity state. This doesn't mean an
5717 * animation will never run -- if another activity change happens that doesn't
5718 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005719 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005720 * when you are going to do a series of activity operations but the
5721 * animation seen by the user shouldn't be driven by the first activity
5722 * change but rather a later one.
5723 */
5724 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5725 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005726 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5727 * this flag will cause any existing task that would be associated with the
5728 * activity to be cleared before the activity is started. That is, the activity
5729 * becomes the new root of an otherwise empty task, and any old activities
5730 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5731 */
5732 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5733 /**
5734 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5735 * this flag will cause a newly launching task to be placed on top of the current
5736 * home activity task (if there is one). That is, pressing back from the task
5737 * will always return the user to home even if that was not the last activity they
5738 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5739 */
5740 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5741 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005742 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5743 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005744 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005745 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005746 * this flag. When set and the task's activity is finished, the recents
5747 * entry will remain in the interface for the user to re-launch it, like a
5748 * recents entry for a top-level application.
5749 * <p>
5750 * The receiving activity can override this request with
5751 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5752 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005753 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005754 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005755 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005756
5757 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005758 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5759 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005760 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5761 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005762 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005763 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005764
Patrick Baumann577d4022018-01-31 16:55:10 +00005765
5766 /**
Patrick Baumann92ae2c62018-05-10 10:10:26 -07005767 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5768 * this flag will attempt to launch an instant app if no full app on the device can already
5769 * handle the intent.
5770 * <p>
5771 * When attempting to resolve instant apps externally, the following {@link Intent} properties
5772 * are supported:
5773 * <ul>
5774 * <li>{@link Intent#setAction(String)}</li>
5775 * <li>{@link Intent#addCategory(String)}</li>
5776 * <li>{@link Intent#setData(Uri)}</li>
5777 * <li>{@link Intent#setType(String)}</li>
5778 * <li>{@link Intent#setPackage(String)}</li>
5779 * <li>{@link Intent#addFlags(int)}</li>
5780 * </ul>
5781 * <p>
5782 * In the case that no instant app can be found, the installer will be launched to notify the
5783 * user that the intent could not be resolved. On devices that do not support instant apps,
5784 * the flag will be ignored.
Patrick Baumann577d4022018-01-31 16:55:10 +00005785 */
5786 public static final int FLAG_ACTIVITY_MATCH_EXTERNAL = 0x00000800;
5787
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005788 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005789 * If set, when sending a broadcast only registered receivers will be
5790 * called -- no BroadcastReceiver components will be launched.
5791 */
5792 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005793 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005794 * If set, when sending a broadcast the new broadcast will replace
5795 * any existing pending broadcast that matches it. Matching is defined
5796 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5797 * true for the intents of the two broadcasts. When a match is found,
5798 * the new broadcast (and receivers associated with it) will replace the
5799 * existing one in the pending broadcast list, remaining at the same
5800 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005801 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005802 * <p>This flag is most typically used with sticky broadcasts, which
5803 * only care about delivering the most recent values of the broadcast
5804 * to their receivers.
5805 */
5806 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5807 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005808 * If set, when sending a broadcast the recipient is allowed to run at
5809 * foreground priority, with a shorter timeout interval. During normal
5810 * broadcasts the receivers are not automatically hoisted out of the
5811 * background priority class.
5812 */
5813 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5814 /**
Ng Zhi An150a6ba2018-08-13 09:08:11 -07005815 * If set, when sending a broadcast the recipient will be run on the offload queue.
5816 *
5817 * @hide
5818 */
5819 public static final int FLAG_RECEIVER_OFFLOAD = 0x80000000;
5820 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005821 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5822 * They can still propagate results through to later receivers, but they can not prevent
5823 * later receivers from seeing the broadcast.
5824 */
5825 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5826 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005827 * If set, when sending a broadcast <i>before boot has completed</i> only
5828 * registered receivers will be called -- no BroadcastReceiver components
5829 * will be launched. Sticky intent state will be recorded properly even
5830 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5831 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005832 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005833 * <p>This flag is only for use by system sevices as a convenience to
5834 * avoid having to implement a more complex mechanism around detection
5835 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005836 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005837 * @hide
5838 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01005839 @UnsupportedAppUsage
Dianne Hackborn6285a322013-09-18 12:09:47 -07005840 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005841 /**
5842 * Set when this broadcast is for a boot upgrade, a special mode that
5843 * allows the broadcast to be sent before the system is ready and launches
5844 * the app process with no providers running in it.
5845 * @hide
5846 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005847 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005848 /**
5849 * If set, the broadcast will always go to manifest receivers in background (cached
5850 * or not running) apps, regardless of whether that would be done by default. By
5851 * default they will only receive broadcasts if the broadcast has specified an
5852 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005853 *
5854 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5855 * the broadcast code there must also be changed to match.
5856 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005857 * @hide
5858 */
5859 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5860 /**
5861 * If set, the broadcast will never go to manifest receivers in background (cached
5862 * or not running) apps, regardless of whether that would be done by default. By
5863 * default they will receive broadcasts if the broadcast has specified an
5864 * explicit component or package name.
5865 * @hide
5866 */
5867 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005868 /**
5869 * If set, this broadcast is being sent from the shell.
5870 * @hide
5871 */
5872 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005873
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005874 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005875 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5876 * will not receive broadcasts.
5877 *
5878 * <em>This flag has no effect when used by an Instant App.</em>
5879 */
5880 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5881
5882 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005883 * @hide Flags that can't be changed with PendingIntent.
5884 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005885 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5886 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5887 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005888
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005889 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005890 // ---------------------------------------------------------------------
5891 // toUri() and parseUri() options.
5892
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005893 /** @hide */
5894 @IntDef(flag = true, prefix = { "URI_" }, value = {
5895 URI_ALLOW_UNSAFE,
5896 URI_ANDROID_APP_SCHEME,
5897 URI_INTENT_SCHEME,
5898 })
5899 @Retention(RetentionPolicy.SOURCE)
5900 public @interface UriFlags {}
5901
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005902 /**
5903 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5904 * always has the "intent:" scheme. This syntax can be used when you want
5905 * to later disambiguate between URIs that are intended to describe an
5906 * Intent vs. all others that should be treated as raw URIs. When used
5907 * with {@link #parseUri}, any other scheme will result in a generic
5908 * VIEW action for that raw URI.
5909 */
5910 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005911
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005912 /**
5913 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5914 * always has the "android-app:" scheme. This is a variation of
5915 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5916 * http/https URI being delivered to a specific package name. The format
5917 * is:
5918 *
5919 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005920 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005921 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005922 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5923 * you must also include a scheme; including a path also requires both a host and a scheme.
5924 * The final #Intent; fragment can be used without a scheme, host, or path.
5925 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005926 * used with intents that have a {@link #setSelector}, since the base intent
5927 * will always have an explicit package name.</p>
5928 *
5929 * <p>Some examples of how this scheme maps to Intent objects:</p>
5930 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5931 * <colgroup align="left" />
5932 * <colgroup align="left" />
5933 * <thead>
5934 * <tr><th>URI</th> <th>Intent</th></tr>
5935 * </thead>
5936 *
5937 * <tbody>
5938 * <tr><td><code>android-app://com.example.app</code></td>
5939 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5940 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5941 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5942 * </table></td>
5943 * </tr>
5944 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5945 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5946 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5947 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5948 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5949 * </table></td>
5950 * </tr>
5951 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5952 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5953 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5954 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5955 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5956 * </table></td>
5957 * </tr>
5958 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5959 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5960 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5961 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5962 * </table></td>
5963 * </tr>
5964 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5965 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5966 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5967 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5968 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5969 * </table></td>
5970 * </tr>
5971 * <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>
5972 * <td><table border="" style="margin:0" >
5973 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5974 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5975 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5976 * </table></td>
5977 * </tr>
5978 * </tbody>
5979 * </table>
5980 */
5981 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5982
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005983 /**
5984 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5985 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5986 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5987 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5988 * generated Intent can not cause unexpected data access to happen.
5989 *
5990 * <p>If you do not trust the source of the URI being parsed, you should still do further
5991 * processing to protect yourself from it. In particular, when using it to start an
5992 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5993 * that can handle it.</p>
5994 */
5995 public static final int URI_ALLOW_UNSAFE = 1<<2;
5996
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005997 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005998
5999 private String mAction;
6000 private Uri mData;
6001 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006002 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006003 private ComponentName mComponent;
6004 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006005 private ArraySet<String> mCategories;
Mathew Inwood5c0d3542018-08-14 13:54:31 +01006006 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006007 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006008 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006009 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006010 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006011 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07006012 /** Token to track instant app launches. Local only; do not copy cross-process. */
6013 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006014
6015 // ---------------------------------------------------------------------
6016
Makoto Onuki97f82f22017-05-31 16:20:21 -07006017 private static final int COPY_MODE_ALL = 0;
6018 private static final int COPY_MODE_FILTER = 1;
6019 private static final int COPY_MODE_HISTORY = 2;
6020
6021 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07006022 @IntDef(prefix = { "COPY_MODE_" }, value = {
6023 COPY_MODE_ALL,
6024 COPY_MODE_FILTER,
6025 COPY_MODE_HISTORY
6026 })
Makoto Onuki97f82f22017-05-31 16:20:21 -07006027 @Retention(RetentionPolicy.SOURCE)
6028 public @interface CopyMode {}
6029
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006030 /**
6031 * Create an empty intent.
6032 */
6033 public Intent() {
6034 }
6035
6036 /**
6037 * Copy constructor.
6038 */
6039 public Intent(Intent o) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07006040 this(o, COPY_MODE_ALL);
6041 }
6042
6043 private Intent(Intent o, @CopyMode int copyMode) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006044 this.mAction = o.mAction;
6045 this.mData = o.mData;
6046 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006047 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006048 this.mComponent = o.mComponent;
Makoto Onuki97f82f22017-05-31 16:20:21 -07006049
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006050 if (o.mCategories != null) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07006051 this.mCategories = new ArraySet<>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006052 }
Makoto Onuki97f82f22017-05-31 16:20:21 -07006053
6054 if (copyMode != COPY_MODE_FILTER) {
6055 this.mFlags = o.mFlags;
6056 this.mContentUserHint = o.mContentUserHint;
6057 this.mLaunchToken = o.mLaunchToken;
6058 if (o.mSourceBounds != null) {
6059 this.mSourceBounds = new Rect(o.mSourceBounds);
6060 }
6061 if (o.mSelector != null) {
6062 this.mSelector = new Intent(o.mSelector);
6063 }
6064
6065 if (copyMode != COPY_MODE_HISTORY) {
6066 if (o.mExtras != null) {
6067 this.mExtras = new Bundle(o.mExtras);
6068 }
6069 if (o.mClipData != null) {
6070 this.mClipData = new ClipData(o.mClipData);
6071 }
6072 } else {
6073 if (o.mExtras != null && !o.mExtras.maybeIsEmpty()) {
6074 this.mExtras = Bundle.STRIPPED;
6075 }
6076
6077 // Also set "stripped" clip data when we ever log mClipData in the (broadcast)
6078 // history.
6079 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006080 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006081 }
6082
6083 @Override
6084 public Object clone() {
6085 return new Intent(this);
6086 }
6087
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006088 /**
6089 * Make a clone of only the parts of the Intent that are relevant for
6090 * filter matching: the action, data, type, component, and categories.
6091 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006092 public @NonNull Intent cloneFilter() {
Makoto Onuki97f82f22017-05-31 16:20:21 -07006093 return new Intent(this, COPY_MODE_FILTER);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006094 }
6095
6096 /**
6097 * Create an intent with a given action. All other fields (data, type,
6098 * class) are null. Note that the action <em>must</em> be in a
6099 * namespace because Intents are used globally in the system -- for
6100 * example the system VIEW action is android.intent.action.VIEW; an
6101 * application's custom action would be something like
6102 * com.google.app.myapp.CUSTOM_ACTION.
6103 *
6104 * @param action The Intent action, such as ACTION_VIEW.
6105 */
6106 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006107 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006108 }
6109
6110 /**
6111 * Create an intent with a given action and for a given data url. Note
6112 * that the action <em>must</em> be in a namespace because Intents are
6113 * used globally in the system -- for example the system VIEW action is
6114 * android.intent.action.VIEW; an application's custom action would be
6115 * something like com.google.app.myapp.CUSTOM_ACTION.
6116 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006117 * <p><em>Note: scheme and host name matching in the Android framework is
6118 * case-sensitive, unlike the formal RFC. As a result,
6119 * you should always ensure that you write your Uri with these elements
6120 * using lower case letters, and normalize any Uris you receive from
6121 * outside of Android to ensure the scheme and host is lower case.</em></p>
6122 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006123 * @param action The Intent action, such as ACTION_VIEW.
6124 * @param uri The Intent data URI.
6125 */
6126 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006127 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006128 mData = uri;
6129 }
6130
6131 /**
6132 * Create an intent for a specific component. All other fields (action, data,
6133 * type, class) are null, though they can be modified later with explicit
6134 * calls. This provides a convenient way to create an intent that is
6135 * intended to execute a hard-coded class name, rather than relying on the
6136 * system to find an appropriate class for you; see {@link #setComponent}
6137 * for more information on the repercussions of this.
6138 *
6139 * @param packageContext A Context of the application package implementing
6140 * this class.
6141 * @param cls The component class that is to be used for the intent.
6142 *
6143 * @see #setClass
6144 * @see #setComponent
6145 * @see #Intent(String, android.net.Uri , Context, Class)
6146 */
6147 public Intent(Context packageContext, Class<?> cls) {
6148 mComponent = new ComponentName(packageContext, cls);
6149 }
6150
6151 /**
6152 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07006153 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006154 * construct the Intent and then calling {@link #setClass} to set its
6155 * class.
6156 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006157 * <p><em>Note: scheme and host name matching in the Android framework is
6158 * case-sensitive, unlike the formal RFC. As a result,
6159 * you should always ensure that you write your Uri with these elements
6160 * using lower case letters, and normalize any Uris you receive from
6161 * outside of Android to ensure the scheme and host is lower case.</em></p>
6162 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006163 * @param action The Intent action, such as ACTION_VIEW.
6164 * @param uri The Intent data URI.
6165 * @param packageContext A Context of the application package implementing
6166 * this class.
6167 * @param cls The component class that is to be used for the intent.
6168 *
6169 * @see #Intent(String, android.net.Uri)
6170 * @see #Intent(Context, Class)
6171 * @see #setClass
6172 * @see #setComponent
6173 */
6174 public Intent(String action, Uri uri,
6175 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006176 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006177 mData = uri;
6178 mComponent = new ComponentName(packageContext, cls);
6179 }
6180
6181 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08006182 * Create an intent to launch the main (root) activity of a task. This
6183 * is the Intent that is started when the application's is launched from
6184 * Home. For anything else that wants to launch an application in the
6185 * same way, it is important that they use an Intent structured the same
6186 * way, and can use this function to ensure this is the case.
6187 *
6188 * <p>The returned Intent has the given Activity component as its explicit
6189 * component, {@link #ACTION_MAIN} as its action, and includes the
6190 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
6191 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
6192 * to do that through {@link #addFlags(int)} on the returned Intent.
6193 *
6194 * @param mainActivity The main activity component that this Intent will
6195 * launch.
6196 * @return Returns a newly created Intent that can be used to launch the
6197 * activity as a main application entry.
6198 *
6199 * @see #setClass
6200 * @see #setComponent
6201 */
6202 public static Intent makeMainActivity(ComponentName mainActivity) {
6203 Intent intent = new Intent(ACTION_MAIN);
6204 intent.setComponent(mainActivity);
6205 intent.addCategory(CATEGORY_LAUNCHER);
6206 return intent;
6207 }
6208
6209 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006210 * Make an Intent for the main activity of an application, without
6211 * specifying a specific activity to run but giving a selector to find
6212 * the activity. This results in a final Intent that is structured
6213 * the same as when the application is launched from
6214 * Home. For anything else that wants to launch an application in the
6215 * same way, it is important that they use an Intent structured the same
6216 * way, and can use this function to ensure this is the case.
6217 *
6218 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
6219 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
6220 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
6221 * to do that through {@link #addFlags(int)} on the returned Intent.
6222 *
6223 * @param selectorAction The action name of the Intent's selector.
6224 * @param selectorCategory The name of a category to add to the Intent's
6225 * selector.
6226 * @return Returns a newly created Intent that can be used to launch the
6227 * activity as a main application entry.
6228 *
6229 * @see #setSelector(Intent)
6230 */
6231 public static Intent makeMainSelectorActivity(String selectorAction,
6232 String selectorCategory) {
6233 Intent intent = new Intent(ACTION_MAIN);
6234 intent.addCategory(CATEGORY_LAUNCHER);
6235 Intent selector = new Intent();
6236 selector.setAction(selectorAction);
6237 selector.addCategory(selectorCategory);
6238 intent.setSelector(selector);
6239 return intent;
6240 }
6241
6242 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08006243 * Make an Intent that can be used to re-launch an application's task
6244 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
6245 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
6246 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
6247 *
6248 * @param mainActivity The activity component that is the root of the
6249 * task; this is the activity that has been published in the application's
6250 * manifest as the main launcher icon.
6251 *
6252 * @return Returns a newly created Intent that can be used to relaunch the
6253 * activity's task in its root state.
6254 */
6255 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
6256 Intent intent = makeMainActivity(mainActivity);
6257 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
6258 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
6259 return intent;
6260 }
6261
6262 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006263 * Call {@link #parseUri} with 0 flags.
6264 * @deprecated Use {@link #parseUri} instead.
6265 */
6266 @Deprecated
6267 public static Intent getIntent(String uri) throws URISyntaxException {
6268 return parseUri(uri, 0);
6269 }
Tom Taylord4a47292009-12-21 13:59:18 -08006270
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006271 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006272 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006273 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07006274 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006275 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006276 *
6277 * <p>The URI given here must not be relative -- that is, it must include
6278 * the scheme and full path.
6279 *
6280 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006281 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006282 *
6283 * @return Intent The newly created Intent object.
6284 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006285 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
6286 * it bad (as parsed by the Uri class) or the Intent data within the
6287 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08006288 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006289 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006290 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006291 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006292 int i = 0;
6293 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006294 final boolean androidApp = uri.startsWith("android-app:");
6295
6296 // Validate intent scheme if requested.
6297 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
6298 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006299 Intent intent = new Intent(ACTION_VIEW);
6300 try {
6301 intent.setData(Uri.parse(uri));
6302 } catch (IllegalArgumentException e) {
6303 throw new URISyntaxException(uri, e.getMessage());
6304 }
6305 return intent;
6306 }
6307 }
Tom Taylord4a47292009-12-21 13:59:18 -08006308
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006309 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006310 // simple case
6311 if (i == -1) {
6312 if (!androidApp) {
6313 return new Intent(ACTION_VIEW, Uri.parse(uri));
6314 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006315
6316 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006317 } else if (!uri.startsWith("#Intent;", i)) {
6318 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006319 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006320 } else {
6321 i = -1;
6322 }
6323 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006324
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006325 // new format
6326 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006327 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006328 boolean explicitAction = false;
6329 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006330
6331 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006332 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006333 String data;
6334 if (i >= 0) {
6335 data = uri.substring(0, i);
6336 i += 8; // length of "#Intent;"
6337 } else {
6338 data = uri;
6339 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006340
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006341 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006342 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006343 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006344 if (eq < 0) eq = i-1;
6345 int semi = uri.indexOf(';', i);
6346 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006347
6348 // action
6349 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006350 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006351 if (!inSelector) {
6352 explicitAction = true;
6353 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006354 }
6355
6356 // categories
6357 else if (uri.startsWith("category=", i)) {
6358 intent.addCategory(value);
6359 }
6360
6361 // type
6362 else if (uri.startsWith("type=", i)) {
6363 intent.mType = value;
6364 }
6365
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006366 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006367 else if (uri.startsWith("launchFlags=", i)) {
6368 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006369 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6370 intent.mFlags &= ~IMMUTABLE_FLAGS;
6371 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006372 }
6373
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006374 // package
6375 else if (uri.startsWith("package=", i)) {
6376 intent.mPackage = value;
6377 }
6378
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006379 // component
6380 else if (uri.startsWith("component=", i)) {
6381 intent.mComponent = ComponentName.unflattenFromString(value);
6382 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006383
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006384 // scheme
6385 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006386 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006387 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006388 } else {
6389 scheme = value;
6390 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006391 }
6392
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006393 // source bounds
6394 else if (uri.startsWith("sourceBounds=", i)) {
6395 intent.mSourceBounds = Rect.unflattenFromString(value);
6396 }
6397
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006398 // selector
6399 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
6400 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006401 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006402 }
6403
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006404 // extra
6405 else {
6406 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006407 // create Bundle if it doesn't already exist
6408 if (intent.mExtras == null) intent.mExtras = new Bundle();
6409 Bundle b = intent.mExtras;
6410 // add EXTRA
6411 if (uri.startsWith("S.", i)) b.putString(key, value);
6412 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
6413 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
6414 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
6415 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
6416 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
6417 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
6418 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
6419 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
6420 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
6421 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006422
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006423 // move to the next item
6424 i = semi + 1;
6425 }
6426
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006427 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006428 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006429 if (baseIntent.mPackage == null) {
6430 baseIntent.setSelector(intent);
6431 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006432 intent = baseIntent;
6433 }
6434
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006435 if (data != null) {
6436 if (data.startsWith("intent:")) {
6437 data = data.substring(7);
6438 if (scheme != null) {
6439 data = scheme + ':' + data;
6440 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006441 } else if (data.startsWith("android-app:")) {
6442 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
6443 // Correctly formed android-app, first part is package name.
6444 int end = data.indexOf('/', 14);
6445 if (end < 0) {
6446 // All we have is a package name.
6447 intent.mPackage = data.substring(14);
6448 if (!explicitAction) {
6449 intent.setAction(ACTION_MAIN);
6450 }
6451 data = "";
6452 } else {
6453 // Target the Intent at the given package name always.
6454 String authority = null;
6455 intent.mPackage = data.substring(14, end);
6456 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006457 if ((end+1) < data.length()) {
6458 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6459 // Found a scheme, remember it.
6460 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006461 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006462 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6463 // Found a authority, remember it.
6464 authority = data.substring(end+1, newEnd);
6465 end = newEnd;
6466 }
6467 } else {
6468 // All we have is a scheme.
6469 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006470 }
6471 }
6472 if (scheme == null) {
6473 // If there was no scheme, then this just targets the package.
6474 if (!explicitAction) {
6475 intent.setAction(ACTION_MAIN);
6476 }
6477 data = "";
6478 } else if (authority == null) {
6479 data = scheme + ":";
6480 } else {
6481 data = scheme + "://" + authority + data.substring(end);
6482 }
6483 }
6484 } else {
6485 data = "";
6486 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006487 }
Tom Taylord4a47292009-12-21 13:59:18 -08006488
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006489 if (data.length() > 0) {
6490 try {
6491 intent.mData = Uri.parse(data);
6492 } catch (IllegalArgumentException e) {
6493 throw new URISyntaxException(uri, e.getMessage());
6494 }
6495 }
6496 }
Tom Taylord4a47292009-12-21 13:59:18 -08006497
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006498 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006499
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006500 } catch (IndexOutOfBoundsException e) {
6501 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6502 }
6503 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006504
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006505 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006506 return getIntentOld(uri, 0);
6507 }
6508
6509 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006510 Intent intent;
6511
6512 int i = uri.lastIndexOf('#');
6513 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006514 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006515 final int intentFragmentStart = i;
6516 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006517
6518 i++;
6519
6520 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006521 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006522 i += 7;
6523 int j = uri.indexOf(')', i);
6524 action = uri.substring(i, j);
6525 i = j + 1;
6526 }
6527
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006528 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006529
6530 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006531 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006532 i += 11;
6533 int j = uri.indexOf(')', i);
6534 while (i < j) {
6535 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006536 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006537 if (i < sep) {
6538 intent.addCategory(uri.substring(i, sep));
6539 }
6540 i = sep + 1;
6541 }
6542 i = j + 1;
6543 }
6544
6545 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006546 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006547 i += 5;
6548 int j = uri.indexOf(')', i);
6549 intent.mType = uri.substring(i, j);
6550 i = j + 1;
6551 }
6552
6553 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006554 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006555 i += 12;
6556 int j = uri.indexOf(')', i);
6557 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006558 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6559 intent.mFlags &= ~IMMUTABLE_FLAGS;
6560 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006561 i = j + 1;
6562 }
6563
6564 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006565 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006566 i += 10;
6567 int j = uri.indexOf(')', i);
6568 int sep = uri.indexOf('!', i);
6569 if (sep >= 0 && sep < j) {
6570 String pkg = uri.substring(i, sep);
6571 String cls = uri.substring(sep + 1, j);
6572 intent.mComponent = new ComponentName(pkg, cls);
6573 }
6574 i = j + 1;
6575 }
6576
6577 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006578 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006579 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006580
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006581 final int closeParen = uri.indexOf(')', i);
6582 if (closeParen == -1) throw new URISyntaxException(uri,
6583 "EXTRA missing trailing ')'", i);
6584
6585 while (i < closeParen) {
6586 // fetch the key value
6587 int j = uri.indexOf('=', i);
6588 if (j <= i + 1 || i >= closeParen) {
6589 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6590 }
6591 char type = uri.charAt(i);
6592 i++;
6593 String key = uri.substring(i, j);
6594 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006595
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006596 // get type-value
6597 j = uri.indexOf('!', i);
6598 if (j == -1 || j >= closeParen) j = closeParen;
6599 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6600 String value = uri.substring(i, j);
6601 i = j;
6602
6603 // create Bundle if it doesn't already exist
6604 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006605
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006606 // add item to bundle
6607 try {
6608 switch (type) {
6609 case 'S':
6610 intent.mExtras.putString(key, Uri.decode(value));
6611 break;
6612 case 'B':
6613 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6614 break;
6615 case 'b':
6616 intent.mExtras.putByte(key, Byte.parseByte(value));
6617 break;
6618 case 'c':
6619 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6620 break;
6621 case 'd':
6622 intent.mExtras.putDouble(key, Double.parseDouble(value));
6623 break;
6624 case 'f':
6625 intent.mExtras.putFloat(key, Float.parseFloat(value));
6626 break;
6627 case 'i':
6628 intent.mExtras.putInt(key, Integer.parseInt(value));
6629 break;
6630 case 'l':
6631 intent.mExtras.putLong(key, Long.parseLong(value));
6632 break;
6633 case 's':
6634 intent.mExtras.putShort(key, Short.parseShort(value));
6635 break;
6636 default:
6637 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6638 }
6639 } catch (NumberFormatException e) {
6640 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6641 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006642
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006643 char ch = uri.charAt(i);
6644 if (ch == ')') break;
6645 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6646 i++;
6647 }
6648 }
6649
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006650 if (isIntentFragment) {
6651 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6652 } else {
6653 intent.mData = Uri.parse(uri);
6654 }
Tom Taylord4a47292009-12-21 13:59:18 -08006655
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006656 if (intent.mAction == null) {
6657 // By default, if no action is specified, then use VIEW.
6658 intent.mAction = ACTION_VIEW;
6659 }
6660
6661 } else {
6662 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6663 }
6664
6665 return intent;
6666 }
6667
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006668 /** @hide */
6669 public interface CommandOptionHandler {
6670 boolean handleOption(String opt, ShellCommand cmd);
6671 }
6672
6673 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01006674 @UnsupportedAppUsage
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006675 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6676 throws URISyntaxException {
6677 Intent intent = new Intent();
6678 Intent baseIntent = intent;
6679 boolean hasIntentInfo = false;
6680
6681 Uri data = null;
6682 String type = null;
6683
6684 String opt;
6685 while ((opt=cmd.getNextOption()) != null) {
6686 switch (opt) {
6687 case "-a":
6688 intent.setAction(cmd.getNextArgRequired());
6689 if (intent == baseIntent) {
6690 hasIntentInfo = true;
6691 }
6692 break;
6693 case "-d":
6694 data = Uri.parse(cmd.getNextArgRequired());
6695 if (intent == baseIntent) {
6696 hasIntentInfo = true;
6697 }
6698 break;
6699 case "-t":
6700 type = cmd.getNextArgRequired();
6701 if (intent == baseIntent) {
6702 hasIntentInfo = true;
6703 }
6704 break;
6705 case "-c":
6706 intent.addCategory(cmd.getNextArgRequired());
6707 if (intent == baseIntent) {
6708 hasIntentInfo = true;
6709 }
6710 break;
6711 case "-e":
6712 case "--es": {
6713 String key = cmd.getNextArgRequired();
6714 String value = cmd.getNextArgRequired();
6715 intent.putExtra(key, value);
6716 }
6717 break;
6718 case "--esn": {
6719 String key = cmd.getNextArgRequired();
6720 intent.putExtra(key, (String) null);
6721 }
6722 break;
6723 case "--ei": {
6724 String key = cmd.getNextArgRequired();
6725 String value = cmd.getNextArgRequired();
6726 intent.putExtra(key, Integer.decode(value));
6727 }
6728 break;
6729 case "--eu": {
6730 String key = cmd.getNextArgRequired();
6731 String value = cmd.getNextArgRequired();
6732 intent.putExtra(key, Uri.parse(value));
6733 }
6734 break;
6735 case "--ecn": {
6736 String key = cmd.getNextArgRequired();
6737 String value = cmd.getNextArgRequired();
6738 ComponentName cn = ComponentName.unflattenFromString(value);
6739 if (cn == null)
6740 throw new IllegalArgumentException("Bad component name: " + value);
6741 intent.putExtra(key, cn);
6742 }
6743 break;
6744 case "--eia": {
6745 String key = cmd.getNextArgRequired();
6746 String value = cmd.getNextArgRequired();
6747 String[] strings = value.split(",");
6748 int[] list = new int[strings.length];
6749 for (int i = 0; i < strings.length; i++) {
6750 list[i] = Integer.decode(strings[i]);
6751 }
6752 intent.putExtra(key, list);
6753 }
6754 break;
6755 case "--eial": {
6756 String key = cmd.getNextArgRequired();
6757 String value = cmd.getNextArgRequired();
6758 String[] strings = value.split(",");
6759 ArrayList<Integer> list = new ArrayList<>(strings.length);
6760 for (int i = 0; i < strings.length; i++) {
6761 list.add(Integer.decode(strings[i]));
6762 }
6763 intent.putExtra(key, list);
6764 }
6765 break;
6766 case "--el": {
6767 String key = cmd.getNextArgRequired();
6768 String value = cmd.getNextArgRequired();
6769 intent.putExtra(key, Long.valueOf(value));
6770 }
6771 break;
6772 case "--ela": {
6773 String key = cmd.getNextArgRequired();
6774 String value = cmd.getNextArgRequired();
6775 String[] strings = value.split(",");
6776 long[] list = new long[strings.length];
6777 for (int i = 0; i < strings.length; i++) {
6778 list[i] = Long.valueOf(strings[i]);
6779 }
6780 intent.putExtra(key, list);
6781 hasIntentInfo = true;
6782 }
6783 break;
6784 case "--elal": {
6785 String key = cmd.getNextArgRequired();
6786 String value = cmd.getNextArgRequired();
6787 String[] strings = value.split(",");
6788 ArrayList<Long> list = new ArrayList<>(strings.length);
6789 for (int i = 0; i < strings.length; i++) {
6790 list.add(Long.valueOf(strings[i]));
6791 }
6792 intent.putExtra(key, list);
6793 hasIntentInfo = true;
6794 }
6795 break;
6796 case "--ef": {
6797 String key = cmd.getNextArgRequired();
6798 String value = cmd.getNextArgRequired();
6799 intent.putExtra(key, Float.valueOf(value));
6800 hasIntentInfo = true;
6801 }
6802 break;
6803 case "--efa": {
6804 String key = cmd.getNextArgRequired();
6805 String value = cmd.getNextArgRequired();
6806 String[] strings = value.split(",");
6807 float[] list = new float[strings.length];
6808 for (int i = 0; i < strings.length; i++) {
6809 list[i] = Float.valueOf(strings[i]);
6810 }
6811 intent.putExtra(key, list);
6812 hasIntentInfo = true;
6813 }
6814 break;
6815 case "--efal": {
6816 String key = cmd.getNextArgRequired();
6817 String value = cmd.getNextArgRequired();
6818 String[] strings = value.split(",");
6819 ArrayList<Float> list = new ArrayList<>(strings.length);
6820 for (int i = 0; i < strings.length; i++) {
6821 list.add(Float.valueOf(strings[i]));
6822 }
6823 intent.putExtra(key, list);
6824 hasIntentInfo = true;
6825 }
6826 break;
6827 case "--esa": {
6828 String key = cmd.getNextArgRequired();
6829 String value = cmd.getNextArgRequired();
6830 // Split on commas unless they are preceeded by an escape.
6831 // The escape character must be escaped for the string and
6832 // again for the regex, thus four escape characters become one.
6833 String[] strings = value.split("(?<!\\\\),");
6834 intent.putExtra(key, strings);
6835 hasIntentInfo = true;
6836 }
6837 break;
6838 case "--esal": {
6839 String key = cmd.getNextArgRequired();
6840 String value = cmd.getNextArgRequired();
6841 // Split on commas unless they are preceeded by an escape.
6842 // The escape character must be escaped for the string and
6843 // again for the regex, thus four escape characters become one.
6844 String[] strings = value.split("(?<!\\\\),");
6845 ArrayList<String> list = new ArrayList<>(strings.length);
6846 for (int i = 0; i < strings.length; i++) {
6847 list.add(strings[i]);
6848 }
6849 intent.putExtra(key, list);
6850 hasIntentInfo = true;
6851 }
6852 break;
6853 case "--ez": {
6854 String key = cmd.getNextArgRequired();
6855 String value = cmd.getNextArgRequired().toLowerCase();
6856 // Boolean.valueOf() results in false for anything that is not "true", which is
6857 // error-prone in shell commands
6858 boolean arg;
6859 if ("true".equals(value) || "t".equals(value)) {
6860 arg = true;
6861 } else if ("false".equals(value) || "f".equals(value)) {
6862 arg = false;
6863 } else {
6864 try {
6865 arg = Integer.decode(value) != 0;
6866 } catch (NumberFormatException ex) {
6867 throw new IllegalArgumentException("Invalid boolean value: " + value);
6868 }
6869 }
6870
6871 intent.putExtra(key, arg);
6872 }
6873 break;
6874 case "-n": {
6875 String str = cmd.getNextArgRequired();
6876 ComponentName cn = ComponentName.unflattenFromString(str);
6877 if (cn == null)
6878 throw new IllegalArgumentException("Bad component name: " + str);
6879 intent.setComponent(cn);
6880 if (intent == baseIntent) {
6881 hasIntentInfo = true;
6882 }
6883 }
6884 break;
6885 case "-p": {
6886 String str = cmd.getNextArgRequired();
6887 intent.setPackage(str);
6888 if (intent == baseIntent) {
6889 hasIntentInfo = true;
6890 }
6891 }
6892 break;
6893 case "-f":
6894 String str = cmd.getNextArgRequired();
6895 intent.setFlags(Integer.decode(str).intValue());
6896 break;
6897 case "--grant-read-uri-permission":
6898 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6899 break;
6900 case "--grant-write-uri-permission":
6901 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6902 break;
6903 case "--grant-persistable-uri-permission":
6904 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6905 break;
6906 case "--grant-prefix-uri-permission":
6907 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6908 break;
6909 case "--exclude-stopped-packages":
6910 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6911 break;
6912 case "--include-stopped-packages":
6913 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6914 break;
6915 case "--debug-log-resolution":
6916 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6917 break;
6918 case "--activity-brought-to-front":
6919 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6920 break;
6921 case "--activity-clear-top":
6922 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6923 break;
6924 case "--activity-clear-when-task-reset":
6925 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6926 break;
6927 case "--activity-exclude-from-recents":
6928 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6929 break;
6930 case "--activity-launched-from-history":
6931 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6932 break;
6933 case "--activity-multiple-task":
6934 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6935 break;
6936 case "--activity-no-animation":
6937 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6938 break;
6939 case "--activity-no-history":
6940 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6941 break;
6942 case "--activity-no-user-action":
6943 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6944 break;
6945 case "--activity-previous-is-top":
6946 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6947 break;
6948 case "--activity-reorder-to-front":
6949 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6950 break;
6951 case "--activity-reset-task-if-needed":
6952 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6953 break;
6954 case "--activity-single-top":
6955 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6956 break;
6957 case "--activity-clear-task":
6958 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6959 break;
6960 case "--activity-task-on-home":
6961 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6962 break;
Patrick Baumann229141f2018-04-06 13:53:25 -07006963 case "--activity-match-external":
6964 intent.addFlags(Intent.FLAG_ACTIVITY_MATCH_EXTERNAL);
6965 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006966 case "--receiver-registered-only":
6967 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6968 break;
6969 case "--receiver-replace-pending":
6970 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6971 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006972 case "--receiver-foreground":
6973 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6974 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006975 case "--receiver-no-abort":
6976 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6977 break;
6978 case "--receiver-include-background":
6979 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6980 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006981 case "--selector":
6982 intent.setDataAndType(data, type);
6983 intent = new Intent();
6984 break;
6985 default:
6986 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6987 // Okay, caller handled this option.
6988 } else {
6989 throw new IllegalArgumentException("Unknown option: " + opt);
6990 }
6991 break;
6992 }
6993 }
6994 intent.setDataAndType(data, type);
6995
6996 final boolean hasSelector = intent != baseIntent;
6997 if (hasSelector) {
6998 // A selector was specified; fix up.
6999 baseIntent.setSelector(intent);
7000 intent = baseIntent;
7001 }
7002
7003 String arg = cmd.getNextArg();
7004 baseIntent = null;
7005 if (arg == null) {
7006 if (hasSelector) {
7007 // If a selector has been specified, and no arguments
7008 // have been supplied for the main Intent, then we can
7009 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
7010 // need to have a component name specified yet, the
7011 // selector will take care of that.
7012 baseIntent = new Intent(Intent.ACTION_MAIN);
7013 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
7014 }
7015 } else if (arg.indexOf(':') >= 0) {
7016 // The argument is a URI. Fully parse it, and use that result
7017 // to fill in any data not specified so far.
7018 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
7019 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
7020 } else if (arg.indexOf('/') >= 0) {
7021 // The argument is a component name. Build an Intent to launch
7022 // it.
7023 baseIntent = new Intent(Intent.ACTION_MAIN);
7024 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
7025 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
7026 } else {
7027 // Assume the argument is a package name.
7028 baseIntent = new Intent(Intent.ACTION_MAIN);
7029 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
7030 baseIntent.setPackage(arg);
7031 }
7032 if (baseIntent != null) {
7033 Bundle extras = intent.getExtras();
7034 intent.replaceExtras((Bundle)null);
7035 Bundle uriExtras = baseIntent.getExtras();
7036 baseIntent.replaceExtras((Bundle)null);
7037 if (intent.getAction() != null && baseIntent.getCategories() != null) {
7038 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
7039 for (String c : cats) {
7040 baseIntent.removeCategory(c);
7041 }
7042 }
7043 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
7044 if (extras == null) {
7045 extras = uriExtras;
7046 } else if (uriExtras != null) {
7047 uriExtras.putAll(extras);
7048 extras = uriExtras;
7049 }
7050 intent.replaceExtras(extras);
7051 hasIntentInfo = true;
7052 }
7053
7054 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
7055 return intent;
7056 }
7057
7058 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007059 @UnsupportedAppUsage
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007060 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
7061 final String[] lines = new String[] {
7062 "<INTENT> specifications include these flags and arguments:",
7063 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
7064 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
Felipe Leme4e02e252018-04-20 11:25:59 -07007065 " [-n <COMPONENT_NAME>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007066 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
7067 " [--esn <EXTRA_KEY> ...]",
7068 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
7069 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
7070 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
7071 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
7072 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
7073 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
7074 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
7075 " (mutiple extras passed as Integer[])",
7076 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
7077 " (mutiple extras passed as List<Integer>)",
7078 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
7079 " (mutiple extras passed as Long[])",
7080 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
7081 " (mutiple extras passed as List<Long>)",
7082 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
7083 " (mutiple extras passed as Float[])",
7084 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
7085 " (mutiple extras passed as List<Float>)",
7086 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
7087 " (mutiple extras passed as String[]; to embed a comma into a string,",
7088 " escape it using \"\\,\")",
7089 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
7090 " (mutiple extras passed as List<String>; to embed a comma into a string,",
7091 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08007092 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007093 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
7094 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
7095 " [--debug-log-resolution] [--exclude-stopped-packages]",
7096 " [--include-stopped-packages]",
7097 " [--activity-brought-to-front] [--activity-clear-top]",
7098 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
7099 " [--activity-launched-from-history] [--activity-multiple-task]",
7100 " [--activity-no-animation] [--activity-no-history]",
7101 " [--activity-no-user-action] [--activity-previous-is-top]",
7102 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
7103 " [--activity-single-top] [--activity-clear-task]",
Patrick Baumann229141f2018-04-06 13:53:25 -07007104 " [--activity-task-on-home] [--activity-match-external]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007105 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08007106 " [--receiver-foreground] [--receiver-no-abort]",
7107 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007108 " [--selector]",
7109 " [<URI> | <PACKAGE> | <COMPONENT>]"
7110 };
7111 for (String line : lines) {
7112 pw.print(prefix);
7113 pw.println(line);
7114 }
7115 }
7116
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007117 /**
7118 * Retrieve the general action to be performed, such as
7119 * {@link #ACTION_VIEW}. The action describes the general way the rest of
7120 * the information in the intent should be interpreted -- most importantly,
7121 * what to do with the data returned by {@link #getData}.
7122 *
7123 * @return The action of this intent or null if none is specified.
7124 *
7125 * @see #setAction
7126 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007127 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007128 return mAction;
7129 }
7130
7131 /**
7132 * Retrieve data this intent is operating on. This URI specifies the name
7133 * of the data; often it uses the content: scheme, specifying data in a
7134 * content provider. Other schemes may be handled by specific activities,
7135 * such as http: by the web browser.
7136 *
7137 * @return The URI of the data this intent is targeting or null.
7138 *
7139 * @see #getScheme
7140 * @see #setData
7141 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007142 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007143 return mData;
7144 }
7145
7146 /**
7147 * The same as {@link #getData()}, but returns the URI as an encoded
7148 * String.
7149 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007150 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007151 return mData != null ? mData.toString() : null;
7152 }
7153
7154 /**
7155 * Return the scheme portion of the intent's data. If the data is null or
7156 * does not include a scheme, null is returned. Otherwise, the scheme
7157 * prefix without the final ':' is returned, i.e. "http".
7158 *
7159 * <p>This is the same as calling getData().getScheme() (and checking for
7160 * null data).
7161 *
7162 * @return The scheme of this intent.
7163 *
7164 * @see #getData
7165 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007166 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007167 return mData != null ? mData.getScheme() : null;
7168 }
7169
7170 /**
7171 * Retrieve any explicit MIME type included in the intent. This is usually
7172 * null, as the type is determined by the intent data.
7173 *
7174 * @return If a type was manually set, it is returned; else null is
7175 * returned.
7176 *
7177 * @see #resolveType(ContentResolver)
7178 * @see #setType
7179 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007180 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007181 return mType;
7182 }
7183
7184 /**
7185 * Return the MIME data type of this intent. If the type field is
7186 * explicitly set, that is simply returned. Otherwise, if the data is set,
7187 * the type of that data is returned. If neither fields are set, a null is
7188 * returned.
7189 *
7190 * @return The MIME type of this intent.
7191 *
7192 * @see #getType
7193 * @see #resolveType(ContentResolver)
7194 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007195 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007196 return resolveType(context.getContentResolver());
7197 }
7198
7199 /**
7200 * Return the MIME data type of this intent. If the type field is
7201 * explicitly set, that is simply returned. Otherwise, if the data is set,
7202 * the type of that data is returned. If neither fields are set, a null is
7203 * returned.
7204 *
7205 * @param resolver A ContentResolver that can be used to determine the MIME
7206 * type of the intent's data.
7207 *
7208 * @return The MIME type of this intent.
7209 *
7210 * @see #getType
7211 * @see #resolveType(Context)
7212 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007213 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007214 if (mType != null) {
7215 return mType;
7216 }
7217 if (mData != null) {
7218 if ("content".equals(mData.getScheme())) {
7219 return resolver.getType(mData);
7220 }
7221 }
7222 return null;
7223 }
7224
7225 /**
7226 * Return the MIME data type of this intent, only if it will be needed for
7227 * intent resolution. This is not generally useful for application code;
7228 * it is used by the frameworks for communicating with back-end system
7229 * services.
7230 *
7231 * @param resolver A ContentResolver that can be used to determine the MIME
7232 * type of the intent's data.
7233 *
7234 * @return The MIME type of this intent, or null if it is unknown or not
7235 * needed.
7236 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007237 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007238 if (mComponent != null) {
7239 return mType;
7240 }
7241 return resolveType(resolver);
7242 }
7243
7244 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007245 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007246 *
7247 * @param category The category to check.
7248 *
7249 * @return boolean True if the intent contains the category, else false.
7250 *
7251 * @see #getCategories
7252 * @see #addCategory
7253 */
7254 public boolean hasCategory(String category) {
7255 return mCategories != null && mCategories.contains(category);
7256 }
7257
7258 /**
7259 * Return the set of all categories in the intent. If there are no categories,
7260 * returns NULL.
7261 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007262 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007263 *
7264 * @see #hasCategory
7265 * @see #addCategory
7266 */
7267 public Set<String> getCategories() {
7268 return mCategories;
7269 }
7270
7271 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007272 * Return the specific selector associated with this Intent. If there is
7273 * none, returns null. See {@link #setSelector} for more information.
7274 *
7275 * @see #setSelector
7276 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007277 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007278 return mSelector;
7279 }
7280
7281 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007282 * Return the {@link ClipData} associated with this Intent. If there is
7283 * none, returns null. See {@link #setClipData} for more information.
7284 *
John Spurlock125d1332013-11-25 11:58:37 -05007285 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007286 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007287 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007288 return mClipData;
7289 }
7290
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007291 /** @hide */
7292 public int getContentUserHint() {
7293 return mContentUserHint;
7294 }
7295
Todd Kennedyb3b431302017-03-20 16:05:48 -07007296 /** @hide */
7297 public String getLaunchToken() {
7298 return mLaunchToken;
7299 }
7300
7301 /** @hide */
7302 public void setLaunchToken(String launchToken) {
7303 mLaunchToken = launchToken;
7304 }
7305
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007306 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007307 * Sets the ClassLoader that will be used when unmarshalling
7308 * any Parcelable values from the extras of this Intent.
7309 *
7310 * @param loader a ClassLoader, or null to use the default loader
7311 * at the time of unmarshalling.
7312 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007313 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007314 if (mExtras != null) {
7315 mExtras.setClassLoader(loader);
7316 }
7317 }
7318
7319 /**
7320 * Returns true if an extra value is associated with the given name.
7321 * @param name the extra's name
7322 * @return true if the given extra is present.
7323 */
7324 public boolean hasExtra(String name) {
7325 return mExtras != null && mExtras.containsKey(name);
7326 }
7327
7328 /**
7329 * Returns true if the Intent's extras contain a parcelled file descriptor.
7330 * @return true if the Intent contains a parcelled file descriptor.
7331 */
7332 public boolean hasFileDescriptors() {
7333 return mExtras != null && mExtras.hasFileDescriptors();
7334 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007335
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007336 /** {@hide} */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007337 @UnsupportedAppUsage
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04007338 public void setAllowFds(boolean allowFds) {
7339 if (mExtras != null) {
7340 mExtras.setAllowFds(allowFds);
7341 }
7342 }
7343
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007344 /** {@hide} */
7345 public void setDefusable(boolean defusable) {
7346 if (mExtras != null) {
7347 mExtras.setDefusable(defusable);
7348 }
7349 }
7350
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007351 /**
7352 * Retrieve extended data from the intent.
7353 *
7354 * @param name The name of the desired item.
7355 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007356 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007357 * or null if none was found.
7358 *
7359 * @deprecated
7360 * @hide
7361 */
7362 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007363 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007364 public Object getExtra(String name) {
7365 return getExtra(name, null);
7366 }
7367
7368 /**
7369 * Retrieve extended data from the intent.
7370 *
7371 * @param name The name of the desired item.
7372 * @param defaultValue the value to be returned if no value of the desired
7373 * type is stored with the given name.
7374 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007375 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007376 * or the default value if none was found.
7377 *
7378 * @see #putExtra(String, boolean)
7379 */
7380 public boolean getBooleanExtra(String name, boolean defaultValue) {
7381 return mExtras == null ? defaultValue :
7382 mExtras.getBoolean(name, defaultValue);
7383 }
7384
7385 /**
7386 * Retrieve extended data from the intent.
7387 *
7388 * @param name The name of the desired item.
7389 * @param defaultValue the value to be returned if no value of the desired
7390 * type is stored with the given name.
7391 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007392 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007393 * or the default value if none was found.
7394 *
7395 * @see #putExtra(String, byte)
7396 */
7397 public byte getByteExtra(String name, byte defaultValue) {
7398 return mExtras == null ? defaultValue :
7399 mExtras.getByte(name, defaultValue);
7400 }
7401
7402 /**
7403 * Retrieve extended data from the intent.
7404 *
7405 * @param name The name of the desired item.
7406 * @param defaultValue the value to be returned if no value of the desired
7407 * type is stored with the given name.
7408 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007409 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007410 * or the default value if none was found.
7411 *
7412 * @see #putExtra(String, short)
7413 */
7414 public short getShortExtra(String name, short defaultValue) {
7415 return mExtras == null ? defaultValue :
7416 mExtras.getShort(name, defaultValue);
7417 }
7418
7419 /**
7420 * Retrieve extended data from the intent.
7421 *
7422 * @param name The name of the desired item.
7423 * @param defaultValue the value to be returned if no value of the desired
7424 * type is stored with the given name.
7425 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007426 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007427 * or the default value if none was found.
7428 *
7429 * @see #putExtra(String, char)
7430 */
7431 public char getCharExtra(String name, char defaultValue) {
7432 return mExtras == null ? defaultValue :
7433 mExtras.getChar(name, defaultValue);
7434 }
7435
7436 /**
7437 * Retrieve extended data from the intent.
7438 *
7439 * @param name The name of the desired item.
7440 * @param defaultValue the value to be returned if no value of the desired
7441 * type is stored with the given name.
7442 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007443 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007444 * or the default value if none was found.
7445 *
7446 * @see #putExtra(String, int)
7447 */
7448 public int getIntExtra(String name, int defaultValue) {
7449 return mExtras == null ? defaultValue :
7450 mExtras.getInt(name, defaultValue);
7451 }
7452
7453 /**
7454 * Retrieve extended data from the intent.
7455 *
7456 * @param name The name of the desired item.
7457 * @param defaultValue the value to be returned if no value of the desired
7458 * type is stored with the given name.
7459 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007460 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007461 * or the default value if none was found.
7462 *
7463 * @see #putExtra(String, long)
7464 */
7465 public long getLongExtra(String name, long defaultValue) {
7466 return mExtras == null ? defaultValue :
7467 mExtras.getLong(name, defaultValue);
7468 }
7469
7470 /**
7471 * Retrieve extended data from the intent.
7472 *
7473 * @param name The name of the desired item.
7474 * @param defaultValue the value to be returned if no value of the desired
7475 * type is stored with the given name.
7476 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007477 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007478 * or the default value if no such item is present
7479 *
7480 * @see #putExtra(String, float)
7481 */
7482 public float getFloatExtra(String name, float defaultValue) {
7483 return mExtras == null ? defaultValue :
7484 mExtras.getFloat(name, defaultValue);
7485 }
7486
7487 /**
7488 * Retrieve extended data from the intent.
7489 *
7490 * @param name The name of the desired item.
7491 * @param defaultValue the value to be returned if no value of the desired
7492 * type is stored with the given name.
7493 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007494 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007495 * or the default value if none was found.
7496 *
7497 * @see #putExtra(String, double)
7498 */
7499 public double getDoubleExtra(String name, double defaultValue) {
7500 return mExtras == null ? defaultValue :
7501 mExtras.getDouble(name, defaultValue);
7502 }
7503
7504 /**
7505 * Retrieve extended data from the intent.
7506 *
7507 * @param name The name of the desired item.
7508 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007509 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007510 * or null if no String value was found.
7511 *
7512 * @see #putExtra(String, String)
7513 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007514 public @Nullable String getStringExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007515 return mExtras == null ? null : mExtras.getString(name);
7516 }
7517
7518 /**
7519 * Retrieve extended data from the intent.
7520 *
7521 * @param name The name of the desired item.
7522 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007523 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007524 * or null if no CharSequence value was found.
7525 *
7526 * @see #putExtra(String, CharSequence)
7527 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007528 public @Nullable CharSequence getCharSequenceExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007529 return mExtras == null ? null : mExtras.getCharSequence(name);
7530 }
7531
7532 /**
7533 * Retrieve extended data from the intent.
7534 *
7535 * @param name The name of the desired item.
7536 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007537 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007538 * or null if no Parcelable value was found.
7539 *
7540 * @see #putExtra(String, Parcelable)
7541 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007542 public @Nullable <T extends Parcelable> T getParcelableExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007543 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7544 }
7545
7546 /**
7547 * Retrieve extended data from the intent.
7548 *
7549 * @param name The name of the desired item.
7550 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007551 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007552 * or null if no Parcelable[] value was found.
7553 *
7554 * @see #putExtra(String, Parcelable[])
7555 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007556 public @Nullable Parcelable[] getParcelableArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007557 return mExtras == null ? null : mExtras.getParcelableArray(name);
7558 }
7559
7560 /**
7561 * Retrieve extended data from the intent.
7562 *
7563 * @param name The name of the desired item.
7564 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007565 * @return the value of an item previously added with
7566 * putParcelableArrayListExtra(), or null if no
7567 * ArrayList<Parcelable> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007568 *
7569 * @see #putParcelableArrayListExtra(String, ArrayList)
7570 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007571 public @Nullable <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007572 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7573 }
7574
7575 /**
7576 * Retrieve extended data from the intent.
7577 *
7578 * @param name The name of the desired item.
7579 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007580 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007581 * or null if no Serializable value was found.
7582 *
7583 * @see #putExtra(String, Serializable)
7584 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007585 public @Nullable Serializable getSerializableExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007586 return mExtras == null ? null : mExtras.getSerializable(name);
7587 }
7588
7589 /**
7590 * Retrieve extended data from the intent.
7591 *
7592 * @param name The name of the desired item.
7593 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007594 * @return the value of an item previously added with
7595 * putIntegerArrayListExtra(), or null if no
7596 * ArrayList<Integer> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007597 *
7598 * @see #putIntegerArrayListExtra(String, ArrayList)
7599 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007600 public @Nullable ArrayList<Integer> getIntegerArrayListExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007601 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7602 }
7603
7604 /**
7605 * Retrieve extended data from the intent.
7606 *
7607 * @param name The name of the desired item.
7608 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007609 * @return the value of an item previously added with
7610 * putStringArrayListExtra(), or null if no
7611 * ArrayList<String> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007612 *
7613 * @see #putStringArrayListExtra(String, ArrayList)
7614 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007615 public @Nullable ArrayList<String> getStringArrayListExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007616 return mExtras == null ? null : mExtras.getStringArrayList(name);
7617 }
7618
7619 /**
7620 * Retrieve extended data from the intent.
7621 *
7622 * @param name The name of the desired item.
7623 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007624 * @return the value of an item previously added with
7625 * putCharSequenceArrayListExtra, or null if no
7626 * ArrayList<CharSequence> value was found.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007627 *
7628 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7629 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007630 public @Nullable ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007631 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7632 }
7633
7634 /**
7635 * Retrieve extended data from the intent.
7636 *
7637 * @param name The name of the desired item.
7638 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007639 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007640 * or null if no boolean array value was found.
7641 *
7642 * @see #putExtra(String, boolean[])
7643 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007644 public @Nullable boolean[] getBooleanArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007645 return mExtras == null ? null : mExtras.getBooleanArray(name);
7646 }
7647
7648 /**
7649 * Retrieve extended data from the intent.
7650 *
7651 * @param name The name of the desired item.
7652 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007653 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007654 * or null if no byte array value was found.
7655 *
7656 * @see #putExtra(String, byte[])
7657 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007658 public @Nullable byte[] getByteArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007659 return mExtras == null ? null : mExtras.getByteArray(name);
7660 }
7661
7662 /**
7663 * Retrieve extended data from the intent.
7664 *
7665 * @param name The name of the desired item.
7666 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007667 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007668 * or null if no short array value was found.
7669 *
7670 * @see #putExtra(String, short[])
7671 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007672 public @Nullable short[] getShortArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007673 return mExtras == null ? null : mExtras.getShortArray(name);
7674 }
7675
7676 /**
7677 * Retrieve extended data from the intent.
7678 *
7679 * @param name The name of the desired item.
7680 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007681 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007682 * or null if no char array value was found.
7683 *
7684 * @see #putExtra(String, char[])
7685 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007686 public @Nullable char[] getCharArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007687 return mExtras == null ? null : mExtras.getCharArray(name);
7688 }
7689
7690 /**
7691 * Retrieve extended data from the intent.
7692 *
7693 * @param name The name of the desired item.
7694 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007695 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007696 * or null if no int array value was found.
7697 *
7698 * @see #putExtra(String, int[])
7699 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007700 public @Nullable int[] getIntArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007701 return mExtras == null ? null : mExtras.getIntArray(name);
7702 }
7703
7704 /**
7705 * Retrieve extended data from the intent.
7706 *
7707 * @param name The name of the desired item.
7708 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007709 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007710 * or null if no long array value was found.
7711 *
7712 * @see #putExtra(String, long[])
7713 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007714 public @Nullable long[] getLongArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007715 return mExtras == null ? null : mExtras.getLongArray(name);
7716 }
7717
7718 /**
7719 * Retrieve extended data from the intent.
7720 *
7721 * @param name The name of the desired item.
7722 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007723 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007724 * or null if no float array value was found.
7725 *
7726 * @see #putExtra(String, float[])
7727 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007728 public @Nullable float[] getFloatArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007729 return mExtras == null ? null : mExtras.getFloatArray(name);
7730 }
7731
7732 /**
7733 * Retrieve extended data from the intent.
7734 *
7735 * @param name The name of the desired item.
7736 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007737 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007738 * or null if no double array value was found.
7739 *
7740 * @see #putExtra(String, double[])
7741 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007742 public @Nullable double[] getDoubleArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007743 return mExtras == null ? null : mExtras.getDoubleArray(name);
7744 }
7745
7746 /**
7747 * Retrieve extended data from the intent.
7748 *
7749 * @param name The name of the desired item.
7750 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007751 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007752 * or null if no String array value was found.
7753 *
7754 * @see #putExtra(String, String[])
7755 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007756 public @Nullable String[] getStringArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007757 return mExtras == null ? null : mExtras.getStringArray(name);
7758 }
7759
7760 /**
7761 * Retrieve extended data from the intent.
7762 *
7763 * @param name The name of the desired item.
7764 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007765 * @return the value of an item previously added with putExtra(),
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007766 * or null if no CharSequence array value was found.
7767 *
7768 * @see #putExtra(String, CharSequence[])
7769 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007770 public @Nullable CharSequence[] getCharSequenceArrayExtra(String name) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007771 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7772 }
7773
7774 /**
7775 * Retrieve extended data from the intent.
7776 *
7777 * @param name The name of the desired item.
7778 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007779 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007780 * or null if no Bundle value was found.
7781 *
7782 * @see #putExtra(String, Bundle)
7783 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007784 public @Nullable Bundle getBundleExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007785 return mExtras == null ? null : mExtras.getBundle(name);
7786 }
7787
7788 /**
7789 * Retrieve extended data from the intent.
7790 *
7791 * @param name The name of the desired item.
7792 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007793 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007794 * or null if no IBinder value was found.
7795 *
7796 * @see #putExtra(String, IBinder)
7797 *
7798 * @deprecated
7799 * @hide
7800 */
7801 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007802 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007803 public IBinder getIBinderExtra(String name) {
7804 return mExtras == null ? null : mExtras.getIBinder(name);
7805 }
7806
7807 /**
7808 * Retrieve extended data from the intent.
7809 *
7810 * @param name The name of the desired item.
7811 * @param defaultValue The default value to return in case no item is
7812 * associated with the key 'name'
7813 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007814 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007815 * or defaultValue if none was found.
7816 *
7817 * @see #putExtra
7818 *
7819 * @deprecated
7820 * @hide
7821 */
7822 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007823 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007824 public Object getExtra(String name, Object defaultValue) {
7825 Object result = defaultValue;
7826 if (mExtras != null) {
7827 Object result2 = mExtras.get(name);
7828 if (result2 != null) {
7829 result = result2;
7830 }
7831 }
7832
7833 return result;
7834 }
7835
7836 /**
7837 * Retrieves a map of extended data from the intent.
7838 *
7839 * @return the map of all extras previously added with putExtra(),
7840 * or null if none have been added.
7841 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007842 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007843 return (mExtras != null)
7844 ? new Bundle(mExtras)
7845 : null;
7846 }
7847
7848 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007849 * Filter extras to only basic types.
7850 * @hide
7851 */
7852 public void removeUnsafeExtras() {
7853 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007854 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007855 }
7856 }
7857
7858 /**
Makoto Onuki97f82f22017-05-31 16:20:21 -07007859 * @return Whether {@link #maybeStripForHistory} will return an lightened intent or
7860 * return itself as-is.
7861 * @hide
7862 */
7863 public boolean canStripForHistory() {
7864 return ((mExtras != null) && mExtras.isParcelled()) || (mClipData != null);
7865 }
7866
7867 /**
7868 * Call it when the system needs to keep an intent for logging purposes to remove fields
7869 * that are not needed for logging.
7870 * @hide
7871 */
7872 public Intent maybeStripForHistory() {
7873 // TODO Scan and remove possibly heavy instances like Bitmaps from unparcelled extras?
7874
7875 if (!canStripForHistory()) {
7876 return this;
7877 }
7878 return new Intent(this, COPY_MODE_HISTORY);
7879 }
7880
7881 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007882 * Retrieve any special flags associated with this intent. You will
7883 * normally just set them with {@link #setFlags} and let the system
7884 * take the appropriate action with them.
7885 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007886 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007887 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007888 * @see #addFlags
7889 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007890 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007891 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007892 return mFlags;
7893 }
7894
Dianne Hackborne7f97212011-02-24 14:40:20 -08007895 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007896 @UnsupportedAppUsage
Dianne Hackborne7f97212011-02-24 14:40:20 -08007897 public boolean isExcludingStopped() {
7898 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7899 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7900 }
7901
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007902 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007903 * Retrieve the application package name this Intent is limited to. When
7904 * resolving an Intent, if non-null this limits the resolution to only
7905 * components in the given application package.
7906 *
7907 * @return The name of the application package for the Intent.
7908 *
7909 * @see #resolveActivity
7910 * @see #setPackage
7911 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007912 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007913 return mPackage;
7914 }
7915
7916 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007917 * Retrieve the concrete component associated with the intent. When receiving
7918 * an intent, this is the component that was found to best handle it (that is,
7919 * yourself) and will always be non-null; in all other cases it will be
7920 * null unless explicitly set.
7921 *
7922 * @return The name of the application component to handle the intent.
7923 *
7924 * @see #resolveActivity
7925 * @see #setComponent
7926 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007927 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007928 return mComponent;
7929 }
7930
7931 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007932 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7933 * used as a hint to the receiver for animations and the like. Null means that there
7934 * is no source bounds.
7935 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007936 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007937 return mSourceBounds;
7938 }
7939
7940 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007941 * Return the Activity component that should be used to handle this intent.
7942 * The appropriate component is determined based on the information in the
7943 * intent, evaluated as follows:
7944 *
7945 * <p>If {@link #getComponent} returns an explicit class, that is returned
7946 * without any further consideration.
7947 *
7948 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7949 * category to be considered.
7950 *
7951 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7952 * action.
7953 *
7954 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7955 * this type.
7956 *
7957 * <p>If {@link #addCategory} has added any categories, the activity must
7958 * handle ALL of the categories specified.
7959 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007960 * <p>If {@link #getPackage} is non-NULL, only activity components in
7961 * that application package will be considered.
7962 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007963 * <p>If there are no activities that satisfy all of these conditions, a
7964 * null string is returned.
7965 *
7966 * <p>If multiple activities are found to satisfy the intent, the one with
7967 * the highest priority will be used. If there are multiple activities
7968 * with the same priority, the system will either pick the best activity
7969 * based on user preference, or resolve to a system class that will allow
7970 * the user to pick an activity and forward from there.
7971 *
7972 * <p>This method is implemented simply by calling
7973 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7974 * true.</p>
7975 * <p> This API is called for you as part of starting an activity from an
7976 * intent. You do not normally need to call it yourself.</p>
7977 *
7978 * @param pm The package manager with which to resolve the Intent.
7979 *
7980 * @return Name of the component implementing an activity that can
7981 * display the intent.
7982 *
7983 * @see #setComponent
7984 * @see #getComponent
7985 * @see #resolveActivityInfo
7986 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007987 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007988 if (mComponent != null) {
7989 return mComponent;
7990 }
7991
7992 ResolveInfo info = pm.resolveActivity(
7993 this, PackageManager.MATCH_DEFAULT_ONLY);
7994 if (info != null) {
7995 return new ComponentName(
7996 info.activityInfo.applicationInfo.packageName,
7997 info.activityInfo.name);
7998 }
7999
8000 return null;
8001 }
8002
8003 /**
8004 * Resolve the Intent into an {@link ActivityInfo}
8005 * describing the activity that should execute the intent. Resolution
8006 * follows the same rules as described for {@link #resolveActivity}, but
8007 * you get back the completely information about the resolved activity
8008 * instead of just its class name.
8009 *
8010 * @param pm The package manager with which to resolve the Intent.
8011 * @param flags Addition information to retrieve as per
8012 * {@link PackageManager#getActivityInfo(ComponentName, int)
8013 * PackageManager.getActivityInfo()}.
8014 *
8015 * @return PackageManager.ActivityInfo
8016 *
8017 * @see #resolveActivity
8018 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008019 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
8020 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008021 ActivityInfo ai = null;
8022 if (mComponent != null) {
8023 try {
8024 ai = pm.getActivityInfo(mComponent, flags);
8025 } catch (PackageManager.NameNotFoundException e) {
8026 // ignore
8027 }
8028 } else {
8029 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07008030 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008031 if (info != null) {
8032 ai = info.activityInfo;
8033 }
8034 }
8035
8036 return ai;
8037 }
8038
8039 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07008040 * Special function for use by the system to resolve service
8041 * intents to system apps. Throws an exception if there are
8042 * multiple potential matches to the Intent. Returns null if
8043 * there are no matches.
8044 * @hide
8045 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01008046 @UnsupportedAppUsage
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008047 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
8048 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07008049 if (mComponent != null) {
8050 return mComponent;
8051 }
8052
8053 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
8054 if (results == null) {
8055 return null;
8056 }
8057 ComponentName comp = null;
8058 for (int i=0; i<results.size(); i++) {
8059 ResolveInfo ri = results.get(i);
8060 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
8061 continue;
8062 }
8063 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
8064 ri.serviceInfo.name);
8065 if (comp != null) {
8066 throw new IllegalStateException("Multiple system services handle " + this
8067 + ": " + comp + ", " + foundComp);
8068 }
8069 comp = foundComp;
8070 }
8071 return comp;
8072 }
8073
8074 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008075 * Set the general action to be performed.
8076 *
8077 * @param action An action name, such as ACTION_VIEW. Application-specific
8078 * actions should be prefixed with the vendor's package name.
8079 *
8080 * @return Returns the same Intent object, for chaining multiple calls
8081 * into a single statement.
8082 *
8083 * @see #getAction
8084 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008085 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008086 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008087 return this;
8088 }
8089
8090 /**
8091 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08008092 * clears any type that was previously set by {@link #setType} or
8093 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008094 *
Nick Pellyccae4122012-01-09 14:12:58 -08008095 * <p><em>Note: scheme matching in the Android framework is
8096 * case-sensitive, unlike the formal RFC. As a result,
8097 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008098 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08008099 * {@link #setDataAndNormalize}
8100 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008101 *
Nick Pellyccae4122012-01-09 14:12:58 -08008102 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008103 *
8104 * @return Returns the same Intent object, for chaining multiple calls
8105 * into a single statement.
8106 *
8107 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08008108 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07008109 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008110 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008111 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008112 mData = data;
8113 mType = null;
8114 return this;
8115 }
8116
8117 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008118 * Normalize and set the data this intent is operating on.
8119 *
8120 * <p>This method automatically clears any type that was
8121 * previously set (for example, by {@link #setType}).
8122 *
8123 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008124 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08008125 * so really this is just a convenience method for
8126 * <pre>
8127 * setData(data.normalize())
8128 * </pre>
8129 *
8130 * @param data The Uri of the data this intent is now targeting.
8131 *
8132 * @return Returns the same Intent object, for chaining multiple calls
8133 * into a single statement.
8134 *
8135 * @see #getData
8136 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008137 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008138 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008139 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008140 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08008141 }
8142
8143 /**
8144 * Set an explicit MIME data type.
8145 *
8146 * <p>This is used to create intents that only specify a type and not data,
8147 * for example to indicate the type of data to return.
8148 *
8149 * <p>This method automatically clears any data that was
8150 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07008151 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008152 * <p><em>Note: MIME type matching in the Android framework is
8153 * case-sensitive, unlike formal RFC MIME types. As a result,
8154 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08008155 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
8156 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008157 *
8158 * @param type The MIME type of the data being handled by this intent.
8159 *
8160 * @return Returns the same Intent object, for chaining multiple calls
8161 * into a single statement.
8162 *
8163 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08008164 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008165 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08008166 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008167 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008168 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008169 mData = null;
8170 mType = type;
8171 return this;
8172 }
8173
8174 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008175 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008176 *
Nick Pellyccae4122012-01-09 14:12:58 -08008177 * <p>This is used to create intents that only specify a type and not data,
8178 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008179 *
Nick Pellyccae4122012-01-09 14:12:58 -08008180 * <p>This method automatically clears any data that was
8181 * previously set (for example by {@link #setData}).
8182 *
8183 * <p>The MIME type is normalized using
8184 * {@link #normalizeMimeType} before it is set,
8185 * so really this is just a convenience method for
8186 * <pre>
8187 * setType(Intent.normalizeMimeType(type))
8188 * </pre>
8189 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008190 * @param type The MIME type of the data being handled by this intent.
8191 *
8192 * @return Returns the same Intent object, for chaining multiple calls
8193 * into a single statement.
8194 *
Nick Pellyccae4122012-01-09 14:12:58 -08008195 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008196 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08008197 * @see #normalizeMimeType
8198 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008199 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08008200 return setType(normalizeMimeType(type));
8201 }
8202
8203 /**
8204 * (Usually optional) Set the data for the intent along with an explicit
8205 * MIME data type. This method should very rarely be used -- it allows you
8206 * to override the MIME type that would ordinarily be inferred from the
8207 * data with your own type given here.
8208 *
8209 * <p><em>Note: MIME type and Uri scheme matching in the
8210 * Android framework is case-sensitive, unlike the formal RFC definitions.
8211 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008212 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08008213 * {@link #setDataAndTypeAndNormalize}
8214 * to ensure that they are converted to lower case.</em>
8215 *
8216 * @param data The Uri of the data this intent is now targeting.
8217 * @param type The MIME type of the data being handled by this intent.
8218 *
8219 * @return Returns the same Intent object, for chaining multiple calls
8220 * into a single statement.
8221 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008222 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08008223 * @see #setData
8224 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008225 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008226 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008227 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008228 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008229 mData = data;
8230 mType = type;
8231 return this;
8232 }
8233
8234 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008235 * (Usually optional) Normalize and set both the data Uri and an explicit
8236 * MIME data type. This method should very rarely be used -- it allows you
8237 * to override the MIME type that would ordinarily be inferred from the
8238 * data with your own type given here.
8239 *
8240 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008241 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08008242 * before they are set, so really this is just a convenience method for
8243 * <pre>
8244 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
8245 * </pre>
8246 *
8247 * @param data The Uri of the data this intent is now targeting.
8248 * @param type The MIME type of the data being handled by this intent.
8249 *
8250 * @return Returns the same Intent object, for chaining multiple calls
8251 * into a single statement.
8252 *
8253 * @see #setType
8254 * @see #setData
8255 * @see #setDataAndType
8256 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008257 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008258 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008259 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008260 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08008261 }
8262
8263 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008264 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008265 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008266 * activities that provide <em>all</em> of the requested categories will be
8267 * used.
8268 *
8269 * @param category The desired category. This can be either one of the
8270 * predefined Intent categories, or a custom category in your own
8271 * namespace.
8272 *
8273 * @return Returns the same Intent object, for chaining multiple calls
8274 * into a single statement.
8275 *
8276 * @see #hasCategory
8277 * @see #removeCategory
8278 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008279 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008280 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008281 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008282 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08008283 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008284 return this;
8285 }
8286
8287 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008288 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008289 *
8290 * @param category The category to remove.
8291 *
8292 * @see #addCategory
8293 */
8294 public void removeCategory(String category) {
8295 if (mCategories != null) {
8296 mCategories.remove(category);
8297 if (mCategories.size() == 0) {
8298 mCategories = null;
8299 }
8300 }
8301 }
8302
8303 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008304 * Set a selector for this Intent. This is a modification to the kinds of
8305 * things the Intent will match. If the selector is set, it will be used
8306 * when trying to find entities that can handle the Intent, instead of the
8307 * main contents of the Intent. This allows you build an Intent containing
8308 * a generic protocol while targeting it more specifically.
8309 *
8310 * <p>An example of where this may be used is with things like
8311 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
8312 * Intent that will launch the Browser application. However, the correct
8313 * main entry point of an application is actually {@link #ACTION_MAIN}
8314 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
8315 * used to specify the actual Activity to launch. If you launch the browser
8316 * with something different, undesired behavior may happen if the user has
8317 * previously or later launches it the normal way, since they do not match.
8318 * Instead, you can build an Intent with the MAIN action (but no ComponentName
8319 * yet specified) and set a selector with {@link #ACTION_MAIN} and
8320 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
8321 *
8322 * <p>Setting a selector does not impact the behavior of
8323 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
8324 * desired behavior of a selector -- it does not impact the base meaning
8325 * of the Intent, just what kinds of things will be matched against it
8326 * when determining who can handle it.</p>
8327 *
8328 * <p>You can not use both a selector and {@link #setPackage(String)} on
8329 * the same base Intent.</p>
8330 *
8331 * @param selector The desired selector Intent; set to null to not use
8332 * a special selector.
8333 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008334 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008335 if (selector == this) {
8336 throw new IllegalArgumentException(
8337 "Intent being set as a selector of itself");
8338 }
8339 if (selector != null && mPackage != null) {
8340 throw new IllegalArgumentException(
8341 "Can't set selector when package name is already set");
8342 }
8343 mSelector = selector;
8344 }
8345
8346 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008347 * Set a {@link ClipData} associated with this Intent. This replaces any
8348 * previously set ClipData.
8349 *
8350 * <p>The ClipData in an intent is not used for Intent matching or other
8351 * such operations. Semantically it is like extras, used to transmit
8352 * additional data with the Intent. The main feature of using this over
8353 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
8354 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
8355 * items included in the clip data. This is useful, in particular, if
8356 * you want to transmit an Intent containing multiple <code>content:</code>
8357 * URIs for which the recipient may not have global permission to access the
8358 * content provider.
8359 *
8360 * <p>If the ClipData contains items that are themselves Intents, any
8361 * grant flags in those Intents will be ignored. Only the top-level flags
8362 * of the main Intent are respected, and will be applied to all Uri or
8363 * Intent items in the clip (or sub-items of the clip).
8364 *
8365 * <p>The MIME type, label, and icon in the ClipData object are not
8366 * directly used by Intent. Applications should generally rely on the
8367 * MIME type of the Intent itself, not what it may find in the ClipData.
8368 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05008369 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008370 *
8371 * @param clip The new clip to set. May be null to clear the current clip.
8372 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008373 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008374 mClipData = clip;
8375 }
8376
8377 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008378 * This is NOT a secure mechanism to identify the user who sent the intent.
8379 * When the intent is sent to a different user, it is used to fix uris by adding the userId
8380 * who sent the intent.
8381 * @hide
8382 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01008383 public void prepareToLeaveUser(int userId) {
8384 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
8385 // We want mContentUserHint to refer to the original user, so don't do anything.
8386 if (mContentUserHint == UserHandle.USER_CURRENT) {
8387 mContentUserHint = userId;
8388 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008389 }
8390
8391 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008392 * Add extended data to the intent. The name must include a package
8393 * prefix, for example the app com.android.contacts would use names
8394 * like "com.android.contacts.ShowAll".
8395 *
8396 * @param name The name of the extra data, with package prefix.
8397 * @param value The boolean data value.
8398 *
8399 * @return Returns the same Intent object, for chaining multiple calls
8400 * into a single statement.
8401 *
8402 * @see #putExtras
8403 * @see #removeExtra
8404 * @see #getBooleanExtra(String, boolean)
8405 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008406 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008407 if (mExtras == null) {
8408 mExtras = new Bundle();
8409 }
8410 mExtras.putBoolean(name, value);
8411 return this;
8412 }
8413
8414 /**
8415 * Add extended data to the intent. The name must include a package
8416 * prefix, for example the app com.android.contacts would use names
8417 * like "com.android.contacts.ShowAll".
8418 *
8419 * @param name The name of the extra data, with package prefix.
8420 * @param value The byte data value.
8421 *
8422 * @return Returns the same Intent object, for chaining multiple calls
8423 * into a single statement.
8424 *
8425 * @see #putExtras
8426 * @see #removeExtra
8427 * @see #getByteExtra(String, byte)
8428 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008429 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008430 if (mExtras == null) {
8431 mExtras = new Bundle();
8432 }
8433 mExtras.putByte(name, value);
8434 return this;
8435 }
8436
8437 /**
8438 * Add extended data to the intent. The name must include a package
8439 * prefix, for example the app com.android.contacts would use names
8440 * like "com.android.contacts.ShowAll".
8441 *
8442 * @param name The name of the extra data, with package prefix.
8443 * @param value The char data value.
8444 *
8445 * @return Returns the same Intent object, for chaining multiple calls
8446 * into a single statement.
8447 *
8448 * @see #putExtras
8449 * @see #removeExtra
8450 * @see #getCharExtra(String, char)
8451 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008452 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008453 if (mExtras == null) {
8454 mExtras = new Bundle();
8455 }
8456 mExtras.putChar(name, value);
8457 return this;
8458 }
8459
8460 /**
8461 * Add extended data to the intent. The name must include a package
8462 * prefix, for example the app com.android.contacts would use names
8463 * like "com.android.contacts.ShowAll".
8464 *
8465 * @param name The name of the extra data, with package prefix.
8466 * @param value The short data value.
8467 *
8468 * @return Returns the same Intent object, for chaining multiple calls
8469 * into a single statement.
8470 *
8471 * @see #putExtras
8472 * @see #removeExtra
8473 * @see #getShortExtra(String, short)
8474 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008475 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008476 if (mExtras == null) {
8477 mExtras = new Bundle();
8478 }
8479 mExtras.putShort(name, value);
8480 return this;
8481 }
8482
8483 /**
8484 * Add extended data to the intent. The name must include a package
8485 * prefix, for example the app com.android.contacts would use names
8486 * like "com.android.contacts.ShowAll".
8487 *
8488 * @param name The name of the extra data, with package prefix.
8489 * @param value The integer data value.
8490 *
8491 * @return Returns the same Intent object, for chaining multiple calls
8492 * into a single statement.
8493 *
8494 * @see #putExtras
8495 * @see #removeExtra
8496 * @see #getIntExtra(String, int)
8497 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008498 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008499 if (mExtras == null) {
8500 mExtras = new Bundle();
8501 }
8502 mExtras.putInt(name, value);
8503 return this;
8504 }
8505
8506 /**
8507 * Add extended data to the intent. The name must include a package
8508 * prefix, for example the app com.android.contacts would use names
8509 * like "com.android.contacts.ShowAll".
8510 *
8511 * @param name The name of the extra data, with package prefix.
8512 * @param value The long data value.
8513 *
8514 * @return Returns the same Intent object, for chaining multiple calls
8515 * into a single statement.
8516 *
8517 * @see #putExtras
8518 * @see #removeExtra
8519 * @see #getLongExtra(String, long)
8520 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008521 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008522 if (mExtras == null) {
8523 mExtras = new Bundle();
8524 }
8525 mExtras.putLong(name, value);
8526 return this;
8527 }
8528
8529 /**
8530 * Add extended data to the intent. The name must include a package
8531 * prefix, for example the app com.android.contacts would use names
8532 * like "com.android.contacts.ShowAll".
8533 *
8534 * @param name The name of the extra data, with package prefix.
8535 * @param value The float data value.
8536 *
8537 * @return Returns the same Intent object, for chaining multiple calls
8538 * into a single statement.
8539 *
8540 * @see #putExtras
8541 * @see #removeExtra
8542 * @see #getFloatExtra(String, float)
8543 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008544 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008545 if (mExtras == null) {
8546 mExtras = new Bundle();
8547 }
8548 mExtras.putFloat(name, value);
8549 return this;
8550 }
8551
8552 /**
8553 * Add extended data to the intent. The name must include a package
8554 * prefix, for example the app com.android.contacts would use names
8555 * like "com.android.contacts.ShowAll".
8556 *
8557 * @param name The name of the extra data, with package prefix.
8558 * @param value The double data value.
8559 *
8560 * @return Returns the same Intent object, for chaining multiple calls
8561 * into a single statement.
8562 *
8563 * @see #putExtras
8564 * @see #removeExtra
8565 * @see #getDoubleExtra(String, double)
8566 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008567 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008568 if (mExtras == null) {
8569 mExtras = new Bundle();
8570 }
8571 mExtras.putDouble(name, value);
8572 return this;
8573 }
8574
8575 /**
8576 * Add extended data to the intent. The name must include a package
8577 * prefix, for example the app com.android.contacts would use names
8578 * like "com.android.contacts.ShowAll".
8579 *
8580 * @param name The name of the extra data, with package prefix.
8581 * @param value The String data value.
8582 *
8583 * @return Returns the same Intent object, for chaining multiple calls
8584 * into a single statement.
8585 *
8586 * @see #putExtras
8587 * @see #removeExtra
8588 * @see #getStringExtra(String)
8589 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008590 public @NonNull Intent putExtra(String name, @Nullable String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008591 if (mExtras == null) {
8592 mExtras = new Bundle();
8593 }
8594 mExtras.putString(name, value);
8595 return this;
8596 }
8597
8598 /**
8599 * Add extended data to the intent. The name must include a package
8600 * prefix, for example the app com.android.contacts would use names
8601 * like "com.android.contacts.ShowAll".
8602 *
8603 * @param name The name of the extra data, with package prefix.
8604 * @param value The CharSequence data value.
8605 *
8606 * @return Returns the same Intent object, for chaining multiple calls
8607 * into a single statement.
8608 *
8609 * @see #putExtras
8610 * @see #removeExtra
8611 * @see #getCharSequenceExtra(String)
8612 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008613 public @NonNull Intent putExtra(String name, @Nullable CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008614 if (mExtras == null) {
8615 mExtras = new Bundle();
8616 }
8617 mExtras.putCharSequence(name, value);
8618 return this;
8619 }
8620
8621 /**
8622 * Add extended data to the intent. The name must include a package
8623 * prefix, for example the app com.android.contacts would use names
8624 * like "com.android.contacts.ShowAll".
8625 *
8626 * @param name The name of the extra data, with package prefix.
8627 * @param value The Parcelable data value.
8628 *
8629 * @return Returns the same Intent object, for chaining multiple calls
8630 * into a single statement.
8631 *
8632 * @see #putExtras
8633 * @see #removeExtra
8634 * @see #getParcelableExtra(String)
8635 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008636 public @NonNull Intent putExtra(String name, @Nullable Parcelable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008637 if (mExtras == null) {
8638 mExtras = new Bundle();
8639 }
8640 mExtras.putParcelable(name, value);
8641 return this;
8642 }
8643
8644 /**
8645 * Add extended data to the intent. The name must include a package
8646 * prefix, for example the app com.android.contacts would use names
8647 * like "com.android.contacts.ShowAll".
8648 *
8649 * @param name The name of the extra data, with package prefix.
8650 * @param value The Parcelable[] data value.
8651 *
8652 * @return Returns the same Intent object, for chaining multiple calls
8653 * into a single statement.
8654 *
8655 * @see #putExtras
8656 * @see #removeExtra
8657 * @see #getParcelableArrayExtra(String)
8658 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008659 public @NonNull Intent putExtra(String name, @Nullable Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008660 if (mExtras == null) {
8661 mExtras = new Bundle();
8662 }
8663 mExtras.putParcelableArray(name, value);
8664 return this;
8665 }
8666
8667 /**
8668 * Add extended data to the intent. The name must include a package
8669 * prefix, for example the app com.android.contacts would use names
8670 * like "com.android.contacts.ShowAll".
8671 *
8672 * @param name The name of the extra data, with package prefix.
8673 * @param value The ArrayList<Parcelable> data value.
8674 *
8675 * @return Returns the same Intent object, for chaining multiple calls
8676 * into a single statement.
8677 *
8678 * @see #putExtras
8679 * @see #removeExtra
8680 * @see #getParcelableArrayListExtra(String)
8681 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008682 public @NonNull Intent putParcelableArrayListExtra(String name,
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008683 @Nullable ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008684 if (mExtras == null) {
8685 mExtras = new Bundle();
8686 }
8687 mExtras.putParcelableArrayList(name, value);
8688 return this;
8689 }
8690
8691 /**
8692 * Add extended data to the intent. The name must include a package
8693 * prefix, for example the app com.android.contacts would use names
8694 * like "com.android.contacts.ShowAll".
8695 *
8696 * @param name The name of the extra data, with package prefix.
8697 * @param value The ArrayList<Integer> data value.
8698 *
8699 * @return Returns the same Intent object, for chaining multiple calls
8700 * into a single statement.
8701 *
8702 * @see #putExtras
8703 * @see #removeExtra
8704 * @see #getIntegerArrayListExtra(String)
8705 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008706 public @NonNull Intent putIntegerArrayListExtra(String name,
8707 @Nullable ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008708 if (mExtras == null) {
8709 mExtras = new Bundle();
8710 }
8711 mExtras.putIntegerArrayList(name, value);
8712 return this;
8713 }
8714
8715 /**
8716 * Add extended data to the intent. The name must include a package
8717 * prefix, for example the app com.android.contacts would use names
8718 * like "com.android.contacts.ShowAll".
8719 *
8720 * @param name The name of the extra data, with package prefix.
8721 * @param value The ArrayList<String> data value.
8722 *
8723 * @return Returns the same Intent object, for chaining multiple calls
8724 * into a single statement.
8725 *
8726 * @see #putExtras
8727 * @see #removeExtra
8728 * @see #getStringArrayListExtra(String)
8729 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008730 public @NonNull Intent putStringArrayListExtra(String name, @Nullable ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008731 if (mExtras == null) {
8732 mExtras = new Bundle();
8733 }
8734 mExtras.putStringArrayList(name, value);
8735 return this;
8736 }
8737
8738 /**
8739 * Add extended data to the intent. The name must include a package
8740 * prefix, for example the app com.android.contacts would use names
8741 * like "com.android.contacts.ShowAll".
8742 *
8743 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008744 * @param value The ArrayList<CharSequence> data value.
8745 *
8746 * @return Returns the same Intent object, for chaining multiple calls
8747 * into a single statement.
8748 *
8749 * @see #putExtras
8750 * @see #removeExtra
8751 * @see #getCharSequenceArrayListExtra(String)
8752 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008753 public @NonNull Intent putCharSequenceArrayListExtra(String name,
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008754 @Nullable ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008755 if (mExtras == null) {
8756 mExtras = new Bundle();
8757 }
8758 mExtras.putCharSequenceArrayList(name, value);
8759 return this;
8760 }
8761
8762 /**
8763 * Add extended data to the intent. The name must include a package
8764 * prefix, for example the app com.android.contacts would use names
8765 * like "com.android.contacts.ShowAll".
8766 *
8767 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008768 * @param value The Serializable data value.
8769 *
8770 * @return Returns the same Intent object, for chaining multiple calls
8771 * into a single statement.
8772 *
8773 * @see #putExtras
8774 * @see #removeExtra
8775 * @see #getSerializableExtra(String)
8776 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008777 public @NonNull Intent putExtra(String name, @Nullable Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008778 if (mExtras == null) {
8779 mExtras = new Bundle();
8780 }
8781 mExtras.putSerializable(name, value);
8782 return this;
8783 }
8784
8785 /**
8786 * Add extended data to the intent. The name must include a package
8787 * prefix, for example the app com.android.contacts would use names
8788 * like "com.android.contacts.ShowAll".
8789 *
8790 * @param name The name of the extra data, with package prefix.
8791 * @param value The boolean array data value.
8792 *
8793 * @return Returns the same Intent object, for chaining multiple calls
8794 * into a single statement.
8795 *
8796 * @see #putExtras
8797 * @see #removeExtra
8798 * @see #getBooleanArrayExtra(String)
8799 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008800 public @NonNull Intent putExtra(String name, @Nullable boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008801 if (mExtras == null) {
8802 mExtras = new Bundle();
8803 }
8804 mExtras.putBooleanArray(name, value);
8805 return this;
8806 }
8807
8808 /**
8809 * Add extended data to the intent. The name must include a package
8810 * prefix, for example the app com.android.contacts would use names
8811 * like "com.android.contacts.ShowAll".
8812 *
8813 * @param name The name of the extra data, with package prefix.
8814 * @param value The byte array data value.
8815 *
8816 * @return Returns the same Intent object, for chaining multiple calls
8817 * into a single statement.
8818 *
8819 * @see #putExtras
8820 * @see #removeExtra
8821 * @see #getByteArrayExtra(String)
8822 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008823 public @NonNull Intent putExtra(String name, @Nullable byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008824 if (mExtras == null) {
8825 mExtras = new Bundle();
8826 }
8827 mExtras.putByteArray(name, value);
8828 return this;
8829 }
8830
8831 /**
8832 * Add extended data to the intent. The name must include a package
8833 * prefix, for example the app com.android.contacts would use names
8834 * like "com.android.contacts.ShowAll".
8835 *
8836 * @param name The name of the extra data, with package prefix.
8837 * @param value The short array data value.
8838 *
8839 * @return Returns the same Intent object, for chaining multiple calls
8840 * into a single statement.
8841 *
8842 * @see #putExtras
8843 * @see #removeExtra
8844 * @see #getShortArrayExtra(String)
8845 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008846 public @NonNull Intent putExtra(String name, @Nullable short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008847 if (mExtras == null) {
8848 mExtras = new Bundle();
8849 }
8850 mExtras.putShortArray(name, value);
8851 return this;
8852 }
8853
8854 /**
8855 * Add extended data to the intent. The name must include a package
8856 * prefix, for example the app com.android.contacts would use names
8857 * like "com.android.contacts.ShowAll".
8858 *
8859 * @param name The name of the extra data, with package prefix.
8860 * @param value The char array data value.
8861 *
8862 * @return Returns the same Intent object, for chaining multiple calls
8863 * into a single statement.
8864 *
8865 * @see #putExtras
8866 * @see #removeExtra
8867 * @see #getCharArrayExtra(String)
8868 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008869 public @NonNull Intent putExtra(String name, @Nullable char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008870 if (mExtras == null) {
8871 mExtras = new Bundle();
8872 }
8873 mExtras.putCharArray(name, value);
8874 return this;
8875 }
8876
8877 /**
8878 * Add extended data to the intent. The name must include a package
8879 * prefix, for example the app com.android.contacts would use names
8880 * like "com.android.contacts.ShowAll".
8881 *
8882 * @param name The name of the extra data, with package prefix.
8883 * @param value The int array data value.
8884 *
8885 * @return Returns the same Intent object, for chaining multiple calls
8886 * into a single statement.
8887 *
8888 * @see #putExtras
8889 * @see #removeExtra
8890 * @see #getIntArrayExtra(String)
8891 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008892 public @NonNull Intent putExtra(String name, @Nullable int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008893 if (mExtras == null) {
8894 mExtras = new Bundle();
8895 }
8896 mExtras.putIntArray(name, value);
8897 return this;
8898 }
8899
8900 /**
8901 * Add extended data to the intent. The name must include a package
8902 * prefix, for example the app com.android.contacts would use names
8903 * like "com.android.contacts.ShowAll".
8904 *
8905 * @param name The name of the extra data, with package prefix.
8906 * @param value The byte array data value.
8907 *
8908 * @return Returns the same Intent object, for chaining multiple calls
8909 * into a single statement.
8910 *
8911 * @see #putExtras
8912 * @see #removeExtra
8913 * @see #getLongArrayExtra(String)
8914 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008915 public @NonNull Intent putExtra(String name, @Nullable long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008916 if (mExtras == null) {
8917 mExtras = new Bundle();
8918 }
8919 mExtras.putLongArray(name, value);
8920 return this;
8921 }
8922
8923 /**
8924 * Add extended data to the intent. The name must include a package
8925 * prefix, for example the app com.android.contacts would use names
8926 * like "com.android.contacts.ShowAll".
8927 *
8928 * @param name The name of the extra data, with package prefix.
8929 * @param value The float array data value.
8930 *
8931 * @return Returns the same Intent object, for chaining multiple calls
8932 * into a single statement.
8933 *
8934 * @see #putExtras
8935 * @see #removeExtra
8936 * @see #getFloatArrayExtra(String)
8937 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008938 public @NonNull Intent putExtra(String name, @Nullable float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008939 if (mExtras == null) {
8940 mExtras = new Bundle();
8941 }
8942 mExtras.putFloatArray(name, value);
8943 return this;
8944 }
8945
8946 /**
8947 * Add extended data to the intent. The name must include a package
8948 * prefix, for example the app com.android.contacts would use names
8949 * like "com.android.contacts.ShowAll".
8950 *
8951 * @param name The name of the extra data, with package prefix.
8952 * @param value The double array data value.
8953 *
8954 * @return Returns the same Intent object, for chaining multiple calls
8955 * into a single statement.
8956 *
8957 * @see #putExtras
8958 * @see #removeExtra
8959 * @see #getDoubleArrayExtra(String)
8960 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008961 public @NonNull Intent putExtra(String name, @Nullable double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008962 if (mExtras == null) {
8963 mExtras = new Bundle();
8964 }
8965 mExtras.putDoubleArray(name, value);
8966 return this;
8967 }
8968
8969 /**
8970 * Add extended data to the intent. The name must include a package
8971 * prefix, for example the app com.android.contacts would use names
8972 * like "com.android.contacts.ShowAll".
8973 *
8974 * @param name The name of the extra data, with package prefix.
8975 * @param value The String array data value.
8976 *
8977 * @return Returns the same Intent object, for chaining multiple calls
8978 * into a single statement.
8979 *
8980 * @see #putExtras
8981 * @see #removeExtra
8982 * @see #getStringArrayExtra(String)
8983 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008984 public @NonNull Intent putExtra(String name, @Nullable String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008985 if (mExtras == null) {
8986 mExtras = new Bundle();
8987 }
8988 mExtras.putStringArray(name, value);
8989 return this;
8990 }
8991
8992 /**
8993 * Add extended data to the intent. The name must include a package
8994 * prefix, for example the app com.android.contacts would use names
8995 * like "com.android.contacts.ShowAll".
8996 *
8997 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008998 * @param value The CharSequence array data value.
8999 *
9000 * @return Returns the same Intent object, for chaining multiple calls
9001 * into a single statement.
9002 *
9003 * @see #putExtras
9004 * @see #removeExtra
9005 * @see #getCharSequenceArrayExtra(String)
9006 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00009007 public @NonNull Intent putExtra(String name, @Nullable CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00009008 if (mExtras == null) {
9009 mExtras = new Bundle();
9010 }
9011 mExtras.putCharSequenceArray(name, value);
9012 return this;
9013 }
9014
9015 /**
9016 * Add extended data to the intent. The name must include a package
9017 * prefix, for example the app com.android.contacts would use names
9018 * like "com.android.contacts.ShowAll".
9019 *
9020 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009021 * @param value The Bundle data value.
9022 *
9023 * @return Returns the same Intent object, for chaining multiple calls
9024 * into a single statement.
9025 *
9026 * @see #putExtras
9027 * @see #removeExtra
9028 * @see #getBundleExtra(String)
9029 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00009030 public @NonNull Intent putExtra(String name, @Nullable Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009031 if (mExtras == null) {
9032 mExtras = new Bundle();
9033 }
9034 mExtras.putBundle(name, value);
9035 return this;
9036 }
9037
9038 /**
9039 * Add extended data to the intent. The name must include a package
9040 * prefix, for example the app com.android.contacts would use names
9041 * like "com.android.contacts.ShowAll".
9042 *
9043 * @param name The name of the extra data, with package prefix.
9044 * @param value The IBinder data value.
9045 *
9046 * @return Returns the same Intent object, for chaining multiple calls
9047 * into a single statement.
9048 *
9049 * @see #putExtras
9050 * @see #removeExtra
9051 * @see #getIBinderExtra(String)
9052 *
9053 * @deprecated
9054 * @hide
9055 */
9056 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01009057 @UnsupportedAppUsage
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009058 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009059 if (mExtras == null) {
9060 mExtras = new Bundle();
9061 }
9062 mExtras.putIBinder(name, value);
9063 return this;
9064 }
9065
9066 /**
9067 * Copy all extras in 'src' in to this intent.
9068 *
9069 * @param src Contains the extras to copy.
9070 *
9071 * @see #putExtra
9072 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009073 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009074 if (src.mExtras != null) {
9075 if (mExtras == null) {
9076 mExtras = new Bundle(src.mExtras);
9077 } else {
9078 mExtras.putAll(src.mExtras);
9079 }
9080 }
9081 return this;
9082 }
9083
9084 /**
9085 * Add a set of extended data to the intent. The keys must include a package
9086 * prefix, for example the app com.android.contacts would use names
9087 * like "com.android.contacts.ShowAll".
9088 *
9089 * @param extras The Bundle of extras to add to this intent.
9090 *
9091 * @see #putExtra
9092 * @see #removeExtra
9093 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009094 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009095 if (mExtras == null) {
9096 mExtras = new Bundle();
9097 }
9098 mExtras.putAll(extras);
9099 return this;
9100 }
9101
9102 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009103 * Completely replace the extras in the Intent with the extras in the
9104 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07009105 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009106 * @param src The exact extras contained in this Intent are copied
9107 * into the target intent, replacing any that were previously there.
9108 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009109 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009110 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
9111 return this;
9112 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009113
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009114 /**
9115 * Completely replace the extras in the Intent with the given Bundle of
9116 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07009117 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009118 * @param extras The new set of extras in the Intent, or null to erase
9119 * all extras.
9120 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009121 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009122 mExtras = extras != null ? new Bundle(extras) : null;
9123 return this;
9124 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009125
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009126 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009127 * Remove extended data from the intent.
9128 *
9129 * @see #putExtra
9130 */
9131 public void removeExtra(String name) {
9132 if (mExtras != null) {
9133 mExtras.remove(name);
9134 if (mExtras.size() == 0) {
9135 mExtras = null;
9136 }
9137 }
9138 }
9139
9140 /**
9141 * Set special flags controlling how this intent is handled. Most values
9142 * here depend on the type of component being executed by the Intent,
9143 * specifically the FLAG_ACTIVITY_* flags are all for use with
9144 * {@link Context#startActivity Context.startActivity()} and the
9145 * FLAG_RECEIVER_* flags are all for use with
9146 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
9147 *
Scott Main7aee61f2011-02-08 11:25:01 -08009148 * <p>See the
9149 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
9150 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009151 * the behavior of your application.
9152 *
9153 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009154 * @return Returns the same Intent object, for chaining multiple calls
9155 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009156 * @see #getFlags
9157 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009158 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009159 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009160 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009161 mFlags = flags;
9162 return this;
9163 }
9164
9165 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009166 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009167 *
9168 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009169 * @return Returns the same Intent object, for chaining multiple calls into
9170 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009171 * @see #setFlags
9172 * @see #getFlags
9173 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009174 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009175 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009176 mFlags |= flags;
9177 return this;
9178 }
9179
9180 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009181 * Remove these flags from the intent.
9182 *
9183 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009184 * @see #setFlags
9185 * @see #getFlags
9186 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009187 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009188 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009189 mFlags &= ~flags;
9190 }
9191
9192 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009193 * (Usually optional) Set an explicit application package name that limits
9194 * the components this Intent will resolve to. If left to the default
9195 * value of null, all components in all applications will considered.
9196 * If non-null, the Intent can only match the components in the given
9197 * application package.
9198 *
9199 * @param packageName The name of the application package to handle the
9200 * intent, or null to allow any application package.
9201 *
9202 * @return Returns the same Intent object, for chaining multiple calls
9203 * into a single statement.
9204 *
9205 * @see #getPackage
9206 * @see #resolveActivity
9207 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009208 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009209 if (packageName != null && mSelector != null) {
9210 throw new IllegalArgumentException(
9211 "Can't set package name when selector is already set");
9212 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009213 mPackage = packageName;
9214 return this;
9215 }
9216
9217 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009218 * (Usually optional) Explicitly set the component to handle the intent.
9219 * If left with the default value of null, the system will determine the
9220 * appropriate class to use based on the other fields (action, data,
9221 * type, categories) in the Intent. If this class is defined, the
9222 * specified class will always be used regardless of the other fields. You
9223 * should only set this value when you know you absolutely want a specific
9224 * class to be used; otherwise it is better to let the system find the
9225 * appropriate class so that you will respect the installed applications
9226 * and user preferences.
9227 *
9228 * @param component The name of the application component to handle the
9229 * intent, or null to let the system find one for you.
9230 *
9231 * @return Returns the same Intent object, for chaining multiple calls
9232 * into a single statement.
9233 *
9234 * @see #setClass
9235 * @see #setClassName(Context, String)
9236 * @see #setClassName(String, String)
9237 * @see #getComponent
9238 * @see #resolveActivity
9239 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009240 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009241 mComponent = component;
9242 return this;
9243 }
9244
9245 /**
9246 * Convenience for calling {@link #setComponent} with an
9247 * explicit class name.
9248 *
9249 * @param packageContext A Context of the application package implementing
9250 * this class.
9251 * @param className The name of a class inside of the application package
9252 * that will be used as the component for this Intent.
9253 *
9254 * @return Returns the same Intent object, for chaining multiple calls
9255 * into a single statement.
9256 *
9257 * @see #setComponent
9258 * @see #setClass
9259 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009260 public @NonNull Intent setClassName(@NonNull Context packageContext,
9261 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009262 mComponent = new ComponentName(packageContext, className);
9263 return this;
9264 }
9265
9266 /**
9267 * Convenience for calling {@link #setComponent} with an
9268 * explicit application package name and class name.
9269 *
9270 * @param packageName The name of the package implementing the desired
9271 * component.
9272 * @param className The name of a class inside of the application package
9273 * that will be used as the component for this Intent.
9274 *
9275 * @return Returns the same Intent object, for chaining multiple calls
9276 * into a single statement.
9277 *
9278 * @see #setComponent
9279 * @see #setClass
9280 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009281 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009282 mComponent = new ComponentName(packageName, className);
9283 return this;
9284 }
9285
9286 /**
9287 * Convenience for calling {@link #setComponent(ComponentName)} with the
9288 * name returned by a {@link Class} object.
9289 *
9290 * @param packageContext A Context of the application package implementing
9291 * this class.
9292 * @param cls The class name to set, equivalent to
9293 * <code>setClassName(context, cls.getName())</code>.
9294 *
9295 * @return Returns the same Intent object, for chaining multiple calls
9296 * into a single statement.
9297 *
9298 * @see #setComponent
9299 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009300 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009301 mComponent = new ComponentName(packageContext, cls);
9302 return this;
9303 }
9304
9305 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009306 * Set the bounds of the sender of this intent, in screen coordinates. This can be
9307 * used as a hint to the receiver for animations and the like. Null means that there
9308 * is no source bounds.
9309 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009310 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009311 if (r != null) {
9312 mSourceBounds = new Rect(r);
9313 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07009314 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009315 }
9316 }
9317
Tor Norbyed9273d62013-05-30 15:59:53 -07009318 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07009319 @IntDef(flag = true, prefix = { "FILL_IN_" }, value = {
9320 FILL_IN_ACTION,
9321 FILL_IN_DATA,
9322 FILL_IN_CATEGORIES,
9323 FILL_IN_COMPONENT,
9324 FILL_IN_PACKAGE,
9325 FILL_IN_SOURCE_BOUNDS,
9326 FILL_IN_SELECTOR,
9327 FILL_IN_CLIP_DATA
9328 })
Tor Norbyed9273d62013-05-30 15:59:53 -07009329 @Retention(RetentionPolicy.SOURCE)
9330 public @interface FillInFlags {}
9331
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009332 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009333 * Use with {@link #fillIn} to allow the current action value to be
9334 * overwritten, even if it is already set.
9335 */
9336 public static final int FILL_IN_ACTION = 1<<0;
9337
9338 /**
9339 * Use with {@link #fillIn} to allow the current data or type value
9340 * overwritten, even if it is already set.
9341 */
9342 public static final int FILL_IN_DATA = 1<<1;
9343
9344 /**
9345 * Use with {@link #fillIn} to allow the current categories to be
9346 * overwritten, even if they are already set.
9347 */
9348 public static final int FILL_IN_CATEGORIES = 1<<2;
9349
9350 /**
9351 * Use with {@link #fillIn} to allow the current component value to be
9352 * overwritten, even if it is already set.
9353 */
9354 public static final int FILL_IN_COMPONENT = 1<<3;
9355
9356 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009357 * Use with {@link #fillIn} to allow the current package value to be
9358 * overwritten, even if it is already set.
9359 */
9360 public static final int FILL_IN_PACKAGE = 1<<4;
9361
9362 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009363 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009364 * overwritten, even if it is already set.
9365 */
9366 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
9367
9368 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009369 * Use with {@link #fillIn} to allow the current selector to be
9370 * overwritten, even if it is already set.
9371 */
9372 public static final int FILL_IN_SELECTOR = 1<<6;
9373
9374 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009375 * Use with {@link #fillIn} to allow the current ClipData to be
9376 * overwritten, even if it is already set.
9377 */
9378 public static final int FILL_IN_CLIP_DATA = 1<<7;
9379
9380 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009381 * Copy the contents of <var>other</var> in to this object, but only
9382 * where fields are not defined by this object. For purposes of a field
9383 * being defined, the following pieces of data in the Intent are
9384 * considered to be separate fields:
9385 *
9386 * <ul>
9387 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08009388 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009389 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
9390 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009391 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009392 * <li> component, as set by {@link #setComponent(ComponentName)} or
9393 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009394 * <li> source bounds, as set by {@link #setSourceBounds}.
9395 * <li> selector, as set by {@link #setSelector(Intent)}.
9396 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009397 * <li> each top-level name in the associated extras.
9398 * </ul>
9399 *
9400 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009401 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009402 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
9403 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
9404 * the restriction where the corresponding field will not be replaced if
9405 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009406 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009407 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
9408 * is explicitly specified. The selector will only be copied if
9409 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07009410 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009411 * <p>For example, consider Intent A with {data="foo", categories="bar"}
9412 * and Intent B with {action="gotit", data-type="some/thing",
9413 * categories="one","two"}.
9414 *
9415 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
9416 * containing: {action="gotit", data-type="some/thing",
9417 * categories="bar"}.
9418 *
9419 * @param other Another Intent whose values are to be used to fill in
9420 * the current one.
9421 * @param flags Options to control which fields can be filled in.
9422 *
9423 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009424 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07009425 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08009426 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07009427 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009428 */
Tor Norbyed9273d62013-05-30 15:59:53 -07009429 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009430 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009431 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009432 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009433 if (other.mAction != null
9434 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009435 mAction = other.mAction;
9436 changes |= FILL_IN_ACTION;
9437 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009438 if ((other.mData != null || other.mType != null)
9439 && ((mData == null && mType == null)
9440 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009441 mData = other.mData;
9442 mType = other.mType;
9443 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009444 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009445 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009446 if (other.mCategories != null
9447 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009448 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009449 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009450 }
9451 changes |= FILL_IN_CATEGORIES;
9452 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009453 if (other.mPackage != null
9454 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009455 // Only do this if mSelector is not set.
9456 if (mSelector == null) {
9457 mPackage = other.mPackage;
9458 changes |= FILL_IN_PACKAGE;
9459 }
9460 }
9461 // Selector is special: it can only be set if explicitly allowed,
9462 // for the same reason as the component name.
9463 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
9464 if (mPackage == null) {
9465 mSelector = new Intent(other.mSelector);
9466 mPackage = null;
9467 changes |= FILL_IN_SELECTOR;
9468 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009469 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009470 if (other.mClipData != null
9471 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
9472 mClipData = other.mClipData;
9473 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009474 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009475 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009476 // Component is special: it can -only- be set if explicitly allowed,
9477 // since otherwise the sender could force the intent somewhere the
9478 // originator didn't intend.
9479 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009480 mComponent = other.mComponent;
9481 changes |= FILL_IN_COMPONENT;
9482 }
9483 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009484 if (other.mSourceBounds != null
9485 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
9486 mSourceBounds = new Rect(other.mSourceBounds);
9487 changes |= FILL_IN_SOURCE_BOUNDS;
9488 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009489 if (mExtras == null) {
9490 if (other.mExtras != null) {
9491 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009492 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009493 }
9494 } else if (other.mExtras != null) {
9495 try {
9496 Bundle newb = new Bundle(other.mExtras);
9497 newb.putAll(mExtras);
9498 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009499 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009500 } catch (RuntimeException e) {
9501 // Modifying the extras can cause us to unparcel the contents
9502 // of the bundle, and if we do this in the system process that
9503 // may fail. We really should handle this (i.e., the Bundle
9504 // impl shouldn't be on top of a plain map), but for now just
9505 // ignore it and keep the original contents. :(
9506 Log.w("Intent", "Failure filling in extras", e);
9507 }
9508 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009509 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9510 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9511 mContentUserHint = other.mContentUserHint;
9512 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009513 return changes;
9514 }
9515
9516 /**
9517 * Wrapper class holding an Intent and implementing comparisons on it for
9518 * the purpose of filtering. The class implements its
9519 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9520 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9521 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9522 * on the wrapped Intent.
9523 */
9524 public static final class FilterComparison {
9525 private final Intent mIntent;
9526 private final int mHashCode;
9527
9528 public FilterComparison(Intent intent) {
9529 mIntent = intent;
9530 mHashCode = intent.filterHashCode();
9531 }
9532
9533 /**
9534 * Return the Intent that this FilterComparison represents.
9535 * @return Returns the Intent held by the FilterComparison. Do
9536 * not modify!
9537 */
9538 public Intent getIntent() {
9539 return mIntent;
9540 }
9541
9542 @Override
9543 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009544 if (obj instanceof FilterComparison) {
9545 Intent other = ((FilterComparison)obj).mIntent;
9546 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009547 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009548 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009549 }
9550
9551 @Override
9552 public int hashCode() {
9553 return mHashCode;
9554 }
9555 }
9556
9557 /**
9558 * Determine if two intents are the same for the purposes of intent
9559 * resolution (filtering). That is, if their action, data, type,
9560 * class, and categories are the same. This does <em>not</em> compare
9561 * any extra data included in the intents.
9562 *
9563 * @param other The other Intent to compare against.
9564 *
9565 * @return Returns true if action, data, type, class, and categories
9566 * are the same.
9567 */
9568 public boolean filterEquals(Intent other) {
9569 if (other == null) {
9570 return false;
9571 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009572 if (!Objects.equals(this.mAction, other.mAction)) return false;
9573 if (!Objects.equals(this.mData, other.mData)) return false;
9574 if (!Objects.equals(this.mType, other.mType)) return false;
9575 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9576 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9577 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009578
9579 return true;
9580 }
9581
9582 /**
9583 * Generate hash code that matches semantics of filterEquals().
9584 *
9585 * @return Returns the hash value of the action, data, type, class, and
9586 * categories.
9587 *
9588 * @see #filterEquals
9589 */
9590 public int filterHashCode() {
9591 int code = 0;
9592 if (mAction != null) {
9593 code += mAction.hashCode();
9594 }
9595 if (mData != null) {
9596 code += mData.hashCode();
9597 }
9598 if (mType != null) {
9599 code += mType.hashCode();
9600 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009601 if (mPackage != null) {
9602 code += mPackage.hashCode();
9603 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009604 if (mComponent != null) {
9605 code += mComponent.hashCode();
9606 }
9607 if (mCategories != null) {
9608 code += mCategories.hashCode();
9609 }
9610 return code;
9611 }
9612
9613 @Override
9614 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009615 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009616
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009617 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009618 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009619 b.append(" }");
9620
9621 return b.toString();
9622 }
9623
9624 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01009625 @UnsupportedAppUsage
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009626 public String toInsecureString() {
9627 StringBuilder b = new StringBuilder(128);
9628
9629 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009630 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009631 b.append(" }");
9632
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009633 return b.toString();
9634 }
Romain Guy4969af72009-06-17 10:53:19 -07009635
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009636 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009637 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009638 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009639
9640 b.append("Intent { ");
9641 toShortString(b, false, true, true, true);
9642 b.append(" }");
9643
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009644 return b.toString();
9645 }
9646
9647 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009648 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9649 StringBuilder b = new StringBuilder(128);
9650 toShortString(b, secure, comp, extras, clip);
9651 return b.toString();
9652 }
9653
9654 /** @hide */
9655 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9656 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009657 boolean first = true;
9658 if (mAction != null) {
9659 b.append("act=").append(mAction);
9660 first = false;
9661 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009662 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009663 if (!first) {
9664 b.append(' ');
9665 }
9666 first = false;
9667 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009668 for (int i=0; i<mCategories.size(); i++) {
9669 if (i > 0) b.append(',');
9670 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009671 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009672 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009673 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009674 if (mData != null) {
9675 if (!first) {
9676 b.append(' ');
9677 }
9678 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009679 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009680 if (secure) {
9681 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009682 } else {
9683 b.append(mData);
9684 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009685 }
9686 if (mType != null) {
9687 if (!first) {
9688 b.append(' ');
9689 }
9690 first = false;
9691 b.append("typ=").append(mType);
9692 }
9693 if (mFlags != 0) {
9694 if (!first) {
9695 b.append(' ');
9696 }
9697 first = false;
9698 b.append("flg=0x").append(Integer.toHexString(mFlags));
9699 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009700 if (mPackage != null) {
9701 if (!first) {
9702 b.append(' ');
9703 }
9704 first = false;
9705 b.append("pkg=").append(mPackage);
9706 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009707 if (comp && mComponent != null) {
9708 if (!first) {
9709 b.append(' ');
9710 }
9711 first = false;
9712 b.append("cmp=").append(mComponent.flattenToShortString());
9713 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009714 if (mSourceBounds != null) {
9715 if (!first) {
9716 b.append(' ');
9717 }
9718 first = false;
9719 b.append("bnds=").append(mSourceBounds.toShortString());
9720 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009721 if (mClipData != null) {
9722 if (!first) {
9723 b.append(' ');
9724 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009725 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009726 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009727 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009728 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009729 if (mClipData.getDescription() != null) {
9730 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9731 } else {
9732 first = true;
9733 }
9734 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009735 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009736 first = false;
9737 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009738 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009739 if (extras && mExtras != null) {
9740 if (!first) {
9741 b.append(' ');
9742 }
9743 first = false;
9744 b.append("(has extras)");
9745 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009746 if (mContentUserHint != UserHandle.USER_CURRENT) {
9747 if (!first) {
9748 b.append(' ');
9749 }
9750 first = false;
9751 b.append("u=").append(mContentUserHint);
9752 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009753 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009754 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009755 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009756 b.append("}");
9757 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009758 }
9759
Yi Jin129fc6c2017-09-28 15:48:38 -07009760 /** @hide */
Kweku Adams85f2fbc2017-12-18 12:04:12 -08009761 public void writeToProto(ProtoOutputStream proto, long fieldId) {
9762 // Same input parameters that toString() gives to toShortString().
9763 writeToProto(proto, fieldId, true, true, true, false);
9764 }
9765
9766 /** @hide */
Yi Jin129fc6c2017-09-28 15:48:38 -07009767 public void writeToProto(ProtoOutputStream proto, long fieldId, boolean secure, boolean comp,
9768 boolean extras, boolean clip) {
9769 long token = proto.start(fieldId);
9770 if (mAction != null) {
9771 proto.write(IntentProto.ACTION, mAction);
9772 }
9773 if (mCategories != null) {
9774 for (String category : mCategories) {
9775 proto.write(IntentProto.CATEGORIES, category);
9776 }
9777 }
9778 if (mData != null) {
9779 proto.write(IntentProto.DATA, secure ? mData.toSafeString() : mData.toString());
9780 }
9781 if (mType != null) {
9782 proto.write(IntentProto.TYPE, mType);
9783 }
9784 if (mFlags != 0) {
9785 proto.write(IntentProto.FLAG, "0x" + Integer.toHexString(mFlags));
9786 }
9787 if (mPackage != null) {
9788 proto.write(IntentProto.PACKAGE, mPackage);
9789 }
9790 if (comp && mComponent != null) {
Yi Jin676d1ac2018-01-25 15:40:28 -08009791 mComponent.writeToProto(proto, IntentProto.COMPONENT);
Yi Jin129fc6c2017-09-28 15:48:38 -07009792 }
9793 if (mSourceBounds != null) {
9794 proto.write(IntentProto.SOURCE_BOUNDS, mSourceBounds.toShortString());
9795 }
9796 if (mClipData != null) {
9797 StringBuilder b = new StringBuilder();
9798 if (clip) {
9799 mClipData.toShortString(b);
9800 } else {
9801 mClipData.toShortStringShortItems(b, false);
9802 }
9803 proto.write(IntentProto.CLIP_DATA, b.toString());
9804 }
9805 if (extras && mExtras != null) {
9806 proto.write(IntentProto.EXTRAS, mExtras.toShortString());
9807 }
9808 if (mContentUserHint != 0) {
9809 proto.write(IntentProto.CONTENT_USER_HINT, mContentUserHint);
9810 }
9811 if (mSelector != null) {
9812 proto.write(IntentProto.SELECTOR, mSelector.toShortString(secure, comp, extras, clip));
9813 }
9814 proto.end(token);
9815 }
9816
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009817 /**
9818 * Call {@link #toUri} with 0 flags.
9819 * @deprecated Use {@link #toUri} instead.
9820 */
9821 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009822 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009823 return toUri(0);
9824 }
9825
9826 /**
9827 * Convert this Intent into a String holding a URI representation of it.
9828 * The returned URI string has been properly URI encoded, so it can be
9829 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9830 * Intent's data as the base URI, with an additional fragment describing
9831 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009832 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009833 * <p>You can convert the returned string back to an Intent with
9834 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009835 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009836 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009837 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009838 * @return Returns a URI encoding URI string describing the entire contents
9839 * of the Intent.
9840 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009841 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009842 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009843 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9844 if (mPackage == null) {
9845 throw new IllegalArgumentException(
9846 "Intent must include an explicit package name to build an android-app: "
9847 + this);
9848 }
9849 uri.append("android-app://");
9850 uri.append(mPackage);
9851 String scheme = null;
9852 if (mData != null) {
9853 scheme = mData.getScheme();
9854 if (scheme != null) {
9855 uri.append('/');
9856 uri.append(scheme);
9857 String authority = mData.getEncodedAuthority();
9858 if (authority != null) {
9859 uri.append('/');
9860 uri.append(authority);
9861 String path = mData.getEncodedPath();
9862 if (path != null) {
9863 uri.append(path);
9864 }
9865 String queryParams = mData.getEncodedQuery();
9866 if (queryParams != null) {
9867 uri.append('?');
9868 uri.append(queryParams);
9869 }
9870 String fragment = mData.getEncodedFragment();
9871 if (fragment != null) {
9872 uri.append('#');
9873 uri.append(fragment);
9874 }
9875 }
9876 }
9877 }
9878 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9879 mPackage, flags);
9880 return uri.toString();
9881 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009882 String scheme = null;
9883 if (mData != null) {
9884 String data = mData.toString();
9885 if ((flags&URI_INTENT_SCHEME) != 0) {
9886 final int N = data.length();
9887 for (int i=0; i<N; i++) {
9888 char c = data.charAt(i);
9889 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
Christopher Schuster42c3a6e2017-07-21 14:53:52 -07009890 || (c >= '0' && c <= '9') || c == '.' || c == '-' || c == '+') {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009891 continue;
9892 }
9893 if (c == ':' && i > 0) {
9894 // Valid scheme.
9895 scheme = data.substring(0, i);
9896 uri.append("intent:");
9897 data = data.substring(i+1);
9898 break;
9899 }
Tom Taylord4a47292009-12-21 13:59:18 -08009900
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009901 // No scheme.
9902 break;
9903 }
9904 }
9905 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009906
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009907 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9908 uri.append("intent:");
9909 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009910
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009911 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009912
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009913 return uri.toString();
9914 }
9915
9916 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9917 String defPackage, int flags) {
9918 StringBuilder frag = new StringBuilder(128);
9919
9920 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009921 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009922 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009923 // Note that for now we are not going to try to handle the
9924 // data part; not clear how to represent this as a URI, and
9925 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009926 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9927 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009928 }
9929
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009930 if (frag.length() > 0) {
9931 uri.append("#Intent;");
9932 uri.append(frag);
9933 uri.append("end");
9934 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009935 }
9936
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009937 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9938 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009939 if (scheme != null) {
9940 uri.append("scheme=").append(scheme).append(';');
9941 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009942 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009943 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009944 }
9945 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009946 for (int i=0; i<mCategories.size(); i++) {
9947 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009948 }
9949 }
9950 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009951 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009952 }
9953 if (mFlags != 0) {
9954 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9955 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009956 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009957 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9958 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009959 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009960 uri.append("component=").append(Uri.encode(
9961 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009962 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009963 if (mSourceBounds != null) {
9964 uri.append("sourceBounds=")
9965 .append(Uri.encode(mSourceBounds.flattenToString()))
9966 .append(';');
9967 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009968 if (mExtras != null) {
9969 for (String key : mExtras.keySet()) {
9970 final Object value = mExtras.get(key);
9971 char entryType =
9972 value instanceof String ? 'S' :
9973 value instanceof Boolean ? 'B' :
9974 value instanceof Byte ? 'b' :
9975 value instanceof Character ? 'c' :
9976 value instanceof Double ? 'd' :
9977 value instanceof Float ? 'f' :
9978 value instanceof Integer ? 'i' :
9979 value instanceof Long ? 'l' :
9980 value instanceof Short ? 's' :
9981 '\0';
9982
9983 if (entryType != '\0') {
9984 uri.append(entryType);
9985 uri.append('.');
9986 uri.append(Uri.encode(key));
9987 uri.append('=');
9988 uri.append(Uri.encode(value.toString()));
9989 uri.append(';');
9990 }
9991 }
9992 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009993 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009994
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009995 public int describeContents() {
9996 return (mExtras != null) ? mExtras.describeContents() : 0;
9997 }
9998
9999 public void writeToParcel(Parcel out, int flags) {
10000 out.writeString(mAction);
10001 Uri.writeToParcel(out, mData);
10002 out.writeString(mType);
10003 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -070010004 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010005 ComponentName.writeToParcel(mComponent, out);
10006
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080010007 if (mSourceBounds != null) {
10008 out.writeInt(1);
10009 mSourceBounds.writeToParcel(out, flags);
10010 } else {
10011 out.writeInt(0);
10012 }
10013
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010014 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -070010015 final int N = mCategories.size();
10016 out.writeInt(N);
10017 for (int i=0; i<N; i++) {
10018 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010019 }
10020 } else {
10021 out.writeInt(0);
10022 }
10023
Dianne Hackbornf5b86712011-12-05 17:42:41 -080010024 if (mSelector != null) {
10025 out.writeInt(1);
10026 mSelector.writeToParcel(out, flags);
10027 } else {
10028 out.writeInt(0);
10029 }
10030
Dianne Hackborn21c241e2012-03-08 13:57:23 -080010031 if (mClipData != null) {
10032 out.writeInt(1);
10033 mClipData.writeToParcel(out, flags);
10034 } else {
10035 out.writeInt(0);
10036 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010037 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010038 out.writeBundle(mExtras);
10039 }
10040
10041 public static final Parcelable.Creator<Intent> CREATOR
10042 = new Parcelable.Creator<Intent>() {
10043 public Intent createFromParcel(Parcel in) {
10044 return new Intent(in);
10045 }
10046 public Intent[] newArray(int size) {
10047 return new Intent[size];
10048 }
10049 };
10050
Dianne Hackborneb034652009-09-07 00:49:58 -070010051 /** @hide */
10052 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010053 readFromParcel(in);
10054 }
10055
10056 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -080010057 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010058 mData = Uri.CREATOR.createFromParcel(in);
10059 mType = in.readString();
10060 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -070010061 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010062 mComponent = ComponentName.readFromParcel(in);
10063
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080010064 if (in.readInt() != 0) {
10065 mSourceBounds = Rect.CREATOR.createFromParcel(in);
10066 }
10067
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010068 int N = in.readInt();
10069 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -070010070 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010071 int i;
10072 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -080010073 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010074 }
10075 } else {
10076 mCategories = null;
10077 }
10078
Dianne Hackbornf5b86712011-12-05 17:42:41 -080010079 if (in.readInt() != 0) {
10080 mSelector = new Intent(in);
10081 }
10082
Dianne Hackborn21c241e2012-03-08 13:57:23 -080010083 if (in.readInt() != 0) {
10084 mClipData = new ClipData(in);
10085 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010086 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010087 mExtras = in.readBundle();
10088 }
10089
10090 /**
10091 * Parses the "intent" element (and its children) from XML and instantiates
10092 * an Intent object. The given XML parser should be located at the tag
10093 * where parsing should start (often named "intent"), from which the
10094 * basic action, data, type, and package and class name will be
10095 * retrieved. The function will then parse in to any child elements,
10096 * looking for <category android:name="xxx"> tags to add categories and
10097 * <extra android:name="xxx" android:value="yyy"> to attach extra data
10098 * to the intent.
10099 *
10100 * @param resources The Resources to use when inflating resources.
10101 * @param parser The XML parser pointing at an "intent" tag.
10102 * @param attrs The AttributeSet interface for retrieving extended
10103 * attribute data at the current <var>parser</var> location.
10104 * @return An Intent object matching the XML data.
10105 * @throws XmlPullParserException If there was an XML parsing error.
10106 * @throws IOException If there was an I/O error.
10107 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060010108 public static @NonNull Intent parseIntent(@NonNull Resources resources,
10109 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010110 throws XmlPullParserException, IOException {
10111 Intent intent = new Intent();
10112
10113 TypedArray sa = resources.obtainAttributes(attrs,
10114 com.android.internal.R.styleable.Intent);
10115
10116 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
10117
10118 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
10119 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
10120 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
10121
10122 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
10123 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
10124 if (packageName != null && className != null) {
10125 intent.setComponent(new ComponentName(packageName, className));
10126 }
10127
10128 sa.recycle();
10129
10130 int outerDepth = parser.getDepth();
10131 int type;
10132 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
10133 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
10134 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
10135 continue;
10136 }
10137
10138 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -070010139 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010140 sa = resources.obtainAttributes(attrs,
10141 com.android.internal.R.styleable.IntentCategory);
10142 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
10143 sa.recycle();
10144
10145 if (cat != null) {
10146 intent.addCategory(cat);
10147 }
10148 XmlUtils.skipCurrentTag(parser);
10149
Craig Mautner21d24a22014-04-23 11:45:37 -070010150 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -080010151 if (intent.mExtras == null) {
10152 intent.mExtras = new Bundle();
10153 }
Craig Mautner21d24a22014-04-23 11:45:37 -070010154 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -080010155 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010156
10157 } else {
10158 XmlUtils.skipCurrentTag(parser);
10159 }
10160 }
10161
10162 return intent;
10163 }
Nick Pellyccae4122012-01-09 14:12:58 -080010164
Craig Mautner21d24a22014-04-23 11:45:37 -070010165 /** @hide */
10166 public void saveToXml(XmlSerializer out) throws IOException {
10167 if (mAction != null) {
10168 out.attribute(null, ATTR_ACTION, mAction);
10169 }
10170 if (mData != null) {
10171 out.attribute(null, ATTR_DATA, mData.toString());
10172 }
10173 if (mType != null) {
10174 out.attribute(null, ATTR_TYPE, mType);
10175 }
10176 if (mComponent != null) {
10177 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
10178 }
10179 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
10180
10181 if (mCategories != null) {
10182 out.startTag(null, TAG_CATEGORIES);
10183 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
10184 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
10185 }
Craig Mautner43e52ed2014-06-16 17:18:52 -070010186 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -070010187 }
10188 }
10189
10190 /** @hide */
10191 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
10192 XmlPullParserException {
10193 Intent intent = new Intent();
10194 final int outerDepth = in.getDepth();
10195
10196 int attrCount = in.getAttributeCount();
10197 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
10198 final String attrName = in.getAttributeName(attrNdx);
10199 final String attrValue = in.getAttributeValue(attrNdx);
10200 if (ATTR_ACTION.equals(attrName)) {
10201 intent.setAction(attrValue);
10202 } else if (ATTR_DATA.equals(attrName)) {
10203 intent.setData(Uri.parse(attrValue));
10204 } else if (ATTR_TYPE.equals(attrName)) {
10205 intent.setType(attrValue);
10206 } else if (ATTR_COMPONENT.equals(attrName)) {
10207 intent.setComponent(ComponentName.unflattenFromString(attrValue));
10208 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +010010209 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -070010210 } else {
10211 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
10212 }
10213 }
10214
10215 int event;
10216 String name;
10217 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
10218 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
10219 if (event == XmlPullParser.START_TAG) {
10220 name = in.getName();
10221 if (TAG_CATEGORIES.equals(name)) {
10222 attrCount = in.getAttributeCount();
10223 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
10224 intent.addCategory(in.getAttributeValue(attrNdx));
10225 }
10226 } else {
10227 Log.w("Intent", "restoreFromXml: unknown name=" + name);
10228 XmlUtils.skipCurrentTag(in);
10229 }
10230 }
10231 }
10232
10233 return intent;
10234 }
10235
Nick Pellyccae4122012-01-09 14:12:58 -080010236 /**
10237 * Normalize a MIME data type.
10238 *
10239 * <p>A normalized MIME type has white-space trimmed,
10240 * content-type parameters removed, and is lower-case.
10241 * This aligns the type with Android best practices for
10242 * intent filtering.
10243 *
10244 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
10245 * "text/x-vCard" becomes "text/x-vcard".
10246 *
10247 * <p>All MIME types received from outside Android (such as user input,
10248 * or external sources like Bluetooth, NFC, or the Internet) should
10249 * be normalized before they are used to create an Intent.
10250 *
10251 * @param type MIME data type to normalize
10252 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -050010253 * @see #setType
10254 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -080010255 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060010256 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -080010257 if (type == null) {
10258 return null;
10259 }
10260
Elliott Hughescb64d432013-08-02 10:00:44 -070010261 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -080010262
10263 final int semicolonIndex = type.indexOf(';');
10264 if (semicolonIndex != -1) {
10265 type = type.substring(0, semicolonIndex);
10266 }
10267 return type;
10268 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010269
10270 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010271 * Prepare this {@link Intent} to leave an app process.
10272 *
10273 * @hide
10274 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +010010275 @UnsupportedAppUsage
Jeff Sharkey344744b2016-01-28 19:03:30 -070010276 public void prepareToLeaveProcess(Context context) {
10277 final boolean leavingPackage = (mComponent == null)
10278 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
10279 prepareToLeaveProcess(leavingPackage);
10280 }
10281
10282 /**
10283 * Prepare this {@link Intent} to leave an app process.
10284 *
10285 * @hide
10286 */
10287 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010288 setAllowFds(false);
10289
10290 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010291 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010292 }
10293 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010294 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010295 }
10296
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -070010297 if (mExtras != null && !mExtras.isParcelled()) {
10298 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
10299 if (intent instanceof Intent) {
10300 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
10301 }
10302 }
10303
Jeff Sharkeya8b42782016-01-30 17:58:09 -070010304 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
10305 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010306 switch (mAction) {
10307 case ACTION_MEDIA_REMOVED:
10308 case ACTION_MEDIA_UNMOUNTED:
10309 case ACTION_MEDIA_CHECKING:
10310 case ACTION_MEDIA_NOFS:
10311 case ACTION_MEDIA_MOUNTED:
10312 case ACTION_MEDIA_SHARED:
10313 case ACTION_MEDIA_UNSHARED:
10314 case ACTION_MEDIA_BAD_REMOVAL:
10315 case ACTION_MEDIA_UNMOUNTABLE:
10316 case ACTION_MEDIA_EJECT:
10317 case ACTION_MEDIA_SCANNER_STARTED:
10318 case ACTION_MEDIA_SCANNER_FINISHED:
10319 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -070010320 case ACTION_PACKAGE_NEEDS_VERIFICATION:
10321 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -070010322 // Ignore legacy actions
10323 break;
10324 default:
10325 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010326 }
10327 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010328
10329 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
10330 && leavingPackage) {
10331 switch (mAction) {
10332 case ACTION_PROVIDER_CHANGED:
Makoto Onuki7d1911f2017-06-09 12:30:09 -070010333 case QuickContact.ACTION_QUICK_CONTACT:
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010334 // Ignore actions that don't need to grant
10335 break;
10336 default:
10337 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
10338 }
10339 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010340 }
10341
10342 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010343 * @hide
10344 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010345 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -070010346 // We just entered destination process, so we should be able to read all
10347 // parcelables inside.
10348 setDefusable(true);
10349
10350 if (mSelector != null) {
10351 mSelector.prepareToEnterProcess();
10352 }
10353 if (mClipData != null) {
10354 mClipData.prepareToEnterProcess();
10355 }
10356
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010357 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000010358 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
10359 fixUris(mContentUserHint);
10360 mContentUserHint = UserHandle.USER_CURRENT;
10361 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010362 }
10363 }
10364
Patrick Baumann577d4022018-01-31 16:55:10 +000010365 /** @hide */
10366 public boolean hasWebURI() {
10367 if (getData() == null) {
10368 return false;
10369 }
10370 final String scheme = getScheme();
10371 if (TextUtils.isEmpty(scheme)) {
10372 return false;
10373 }
10374 return scheme.equals(IntentFilter.SCHEME_HTTP) || scheme.equals(IntentFilter.SCHEME_HTTPS);
10375 }
10376
10377 /** @hide */
Patrick Baumann0da85372018-02-02 16:07:35 -080010378 public boolean isWebIntent() {
Patrick Baumann577d4022018-01-31 16:55:10 +000010379 return ACTION_VIEW.equals(mAction)
Patrick Baumann577d4022018-01-31 16:55:10 +000010380 && hasWebURI();
10381 }
10382
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010383 /**
10384 * @hide
10385 */
10386 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010387 Uri data = getData();
10388 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010389 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010390 }
10391 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010392 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010393 }
10394 String action = getAction();
10395 if (ACTION_SEND.equals(action)) {
10396 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10397 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010398 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010399 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010400 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010401 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10402 if (streams != null) {
10403 ArrayList<Uri> newStreams = new ArrayList<Uri>();
10404 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010405 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010406 }
10407 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
10408 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010409 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10410 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10411 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10412 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10413 if (output != null) {
10414 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
10415 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010416 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010417 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010418
10419 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010420 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010421 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
10422 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010423 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010424 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010425 * @hide
10426 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010427 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010428 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010429 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010430
10431 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010432 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010433
10434 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010435 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010436 // Inspect contained intents to see if we need to migrate extras. We
10437 // don't promote ClipData to the parent, since ChooserActivity will
10438 // already start the picked item as the caller, and we can't combine
10439 // the flags in a safe way.
10440
10441 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -070010442 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010443 final Intent intent = getParcelableExtra(EXTRA_INTENT);
10444 if (intent != null) {
10445 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -070010446 }
10447 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010448 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010449 try {
10450 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
10451 if (intents != null) {
10452 for (int i = 0; i < intents.length; i++) {
10453 final Intent intent = (Intent) intents[i];
10454 if (intent != null) {
10455 migrated |= intent.migrateExtraStreamToClipData();
10456 }
10457 }
10458 }
10459 } catch (ClassCastException e) {
10460 }
10461 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010462
10463 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010464 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010465 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10466 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
10467 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
10468 if (stream != null || text != null || htmlText != null) {
10469 final ClipData clipData = new ClipData(
10470 null, new String[] { getType() },
10471 new ClipData.Item(text, htmlText, null, stream));
10472 setClipData(clipData);
10473 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010474 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010475 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010476 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010477 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010478
10479 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010480 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010481 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10482 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
10483 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
10484 int num = -1;
10485 if (streams != null) {
10486 num = streams.size();
10487 }
10488 if (texts != null) {
10489 if (num >= 0 && num != texts.size()) {
10490 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010491 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010492 }
10493 num = texts.size();
10494 }
10495 if (htmlTexts != null) {
10496 if (num >= 0 && num != htmlTexts.size()) {
10497 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010498 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010499 }
10500 num = htmlTexts.size();
10501 }
10502 if (num > 0) {
10503 final ClipData clipData = new ClipData(
10504 null, new String[] { getType() },
10505 makeClipItem(streams, texts, htmlTexts, 0));
10506
10507 for (int i = 1; i < num; i++) {
10508 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
10509 }
10510
10511 setClipData(clipData);
10512 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010513 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010514 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010515 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010516 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010517 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10518 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10519 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10520 final Uri output;
10521 try {
10522 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10523 } catch (ClassCastException e) {
10524 return false;
10525 }
10526 if (output != null) {
10527 setClipData(ClipData.newRawUri("", output));
10528 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
10529 return true;
10530 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010531 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010532
10533 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010534 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010535
Michael Wright19859762017-09-18 20:57:58 +010010536 /**
10537 * Convert the dock state to a human readable format.
10538 * @hide
10539 */
10540 public static String dockStateToString(int dock) {
10541 switch (dock) {
10542 case EXTRA_DOCK_STATE_HE_DESK:
10543 return "EXTRA_DOCK_STATE_HE_DESK";
10544 case EXTRA_DOCK_STATE_LE_DESK:
10545 return "EXTRA_DOCK_STATE_LE_DESK";
10546 case EXTRA_DOCK_STATE_CAR:
10547 return "EXTRA_DOCK_STATE_CAR";
10548 case EXTRA_DOCK_STATE_DESK:
10549 return "EXTRA_DOCK_STATE_DESK";
10550 case EXTRA_DOCK_STATE_UNDOCKED:
10551 return "EXTRA_DOCK_STATE_UNDOCKED";
10552 default:
10553 return Integer.toString(dock);
10554 }
10555 }
10556
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010557 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
10558 ArrayList<String> htmlTexts, int which) {
10559 Uri uri = streams != null ? streams.get(which) : null;
10560 CharSequence text = texts != null ? texts.get(which) : null;
10561 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
10562 return new ClipData.Item(text, htmlText, null, uri);
10563 }
Craig Mautnerd00f4742014-03-12 14:17:26 -070010564
10565 /** @hide */
10566 public boolean isDocument() {
10567 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
10568 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010569}