blob: de19bc0a24d76dbe3328f39cd8a4f80c3b1d4521 [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Makoto Onuki7d1911f2017-06-09 12:30:09 -070019import static android.content.ContentProvider.maybeAddUserId;
20
Tor Norbye7b9c9122013-05-30 16:48:33 -070021import android.annotation.AnyRes;
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -070022import android.annotation.BroadcastBehavior;
Tor Norbyed9273d62013-05-30 15:59:53 -070023import android.annotation.IntDef;
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060024import android.annotation.NonNull;
25import android.annotation.Nullable;
Joel Galenson78ec58d2018-10-24 10:06:25 -070026import android.annotation.RequiresPermission;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.annotation.SdkConstant;
28import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050029import android.annotation.SystemApi;
Mathew Inwood5c0d3542018-08-14 13:54:31 +010030import android.annotation.UnsupportedAppUsage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070031import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050032import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060033import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.content.pm.PackageManager;
35import android.content.pm.ResolveInfo;
36import android.content.res.Resources;
37import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080038import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060040import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070041import android.os.Bundle;
42import android.os.IBinder;
43import android.os.Parcel;
44import android.os.Parcelable;
Suprabh Shukla96212bc2018-04-10 15:04:51 -070045import android.os.PersistableBundle;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000046import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050047import android.os.ResultReceiver;
48import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070049import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010050import android.os.UserHandle;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070051import android.provider.ContactsContract.QuickContact;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070052import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070053import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050054import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070055import android.provider.OpenableColumns;
Patrick Baumann577d4022018-01-31 16:55:10 +000056import android.text.TextUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050057import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070058import android.util.AttributeSet;
59import android.util.Log;
Yi Jin129fc6c2017-09-28 15:48:38 -070060import android.util.proto.ProtoOutputStream;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070061
Dianne Hackborn2269d1572010-02-24 19:54:22 -080062import com.android.internal.util.XmlUtils;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070063
Jason Monk2f68e8a2016-02-23 17:57:28 -050064import org.xmlpull.v1.XmlPullParser;
65import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070066import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070067
68import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080069import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070070import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070071import java.lang.annotation.Retention;
72import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070073import java.net.URISyntaxException;
74import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080075import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070076import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080077import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070078import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070079import java.util.Set;
80
81/**
82 * An intent is an abstract description of an operation to be performed. It
83 * can be used with {@link Context#startActivity(Intent) startActivity} to
84 * launch an {@link android.app.Activity},
85 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
86 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
87 * and {@link android.content.Context#startService} or
88 * {@link android.content.Context#bindService} to communicate with a
89 * background {@link android.app.Service}.
90 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070091 * <p>An Intent provides a facility for performing late runtime binding between the code in
92 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070093 * can be thought of as the glue between activities. It is basically a passive data structure
94 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070095 *
96 * <div class="special reference">
97 * <h3>Developer Guides</h3>
98 * <p>For information about how to create and resolve intents, read the
99 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
100 * developer guide.</p>
101 * </div>
102 *
103 * <a name="IntentStructure"></a>
104 * <h3>Intent Structure</h3>
105 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700106 *
107 * <ul>
108 * <li> <p><b>action</b> -- The general action to be performed, such as
109 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
110 * etc.</p>
111 * </li>
112 * <li> <p><b>data</b> -- The data to operate on, such as a person record
113 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
114 * </li>
115 * </ul>
116 *
117 *
118 * <p>Some examples of action/data pairs are:</p>
119 *
120 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700121 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700122 * information about the person whose identifier is "1".</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * the phone dialer with the person filled in.</p>
126 * </li>
127 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
128 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700129 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700130 * a particular URI.</p>
131 * </li>
132 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
133 * the phone dialer with the given number filled in.</p>
134 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700135 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700136 * information about the person whose identifier is "1".</p>
137 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700138 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700139 * a list of people, which the user can browse through. This example is a
140 * typical top-level entry into the Contacts application, showing you the
141 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700142 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700143 * being used to start an activity to display that person.</p>
144 * </li>
145 * </ul>
146 *
147 * <p>In addition to these primary attributes, there are a number of secondary
148 * attributes that you can also include with an intent:</p>
149 *
150 * <ul>
151 * <li> <p><b>category</b> -- Gives additional information about the action
152 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
153 * appear in the Launcher as a top-level application, while
154 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
155 * of alternative actions the user can perform on a piece of data.</p>
156 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
157 * intent data. Normally the type is inferred from the data itself.
158 * By setting this attribute, you disable that evaluation and force
159 * an explicit type.</p>
160 * <li> <p><b>component</b> -- Specifies an explicit name of a component
161 * class to use for the intent. Normally this is determined by looking
162 * at the other information in the intent (the action, data/type, and
163 * categories) and matching that with a component that can handle it.
164 * If this attribute is set then none of the evaluation is performed,
165 * and this component is used exactly as is. By specifying this attribute,
166 * all of the other Intent attributes become optional.</p>
167 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
168 * This can be used to provide extended information to the component.
169 * For example, if we have a action to send an e-mail message, we could
170 * also include extra pieces of data here to supply a subject, body,
171 * etc.</p>
172 * </ul>
173 *
174 * <p>Here are some examples of other operations you can specify as intents
175 * using these additional parameters:</p>
176 *
177 * <ul>
178 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
179 * Launch the home screen.</p>
180 * </li>
181 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
182 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
183 * vnd.android.cursor.item/phone}</i></b>
184 * -- Display the list of people's phone numbers, allowing the user to
185 * browse through them and pick one and return it to the parent activity.</p>
186 * </li>
187 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
188 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
189 * -- Display all pickers for data that can be opened with
190 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
191 * allowing the user to pick one of them and then some data inside of it
192 * and returning the resulting URI to the caller. This can be used,
193 * for example, in an e-mail application to allow the user to pick some
194 * data to include as an attachment.</p>
195 * </li>
196 * </ul>
197 *
198 * <p>There are a variety of standard Intent action and category constants
199 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700200 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700201 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700202 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700203 *
204 * <p>Put together, the set of actions, data types, categories, and extra data
205 * defines a language for the system allowing for the expression of phrases
206 * such as "call john smith's cell". As applications are added to the system,
207 * they can extend this language by adding new actions, types, and categories, or
208 * they can modify the behavior of existing phrases by supplying their own
209 * activities that handle them.</p>
210 *
211 * <a name="IntentResolution"></a>
212 * <h3>Intent Resolution</h3>
213 *
214 * <p>There are two primary forms of intents you will use.
215 *
216 * <ul>
217 * <li> <p><b>Explicit Intents</b> have specified a component (via
218 * {@link #setComponent} or {@link #setClass}), which provides the exact
219 * class to be run. Often these will not include any other information,
220 * simply being a way for an application to launch various internal
221 * activities it has as the user interacts with the application.
222 *
223 * <li> <p><b>Implicit Intents</b> have not specified a component;
224 * instead, they must include enough information for the system to
225 * determine which of the available components is best to run for that
226 * intent.
227 * </ul>
228 *
229 * <p>When using implicit intents, given such an arbitrary intent we need to
230 * know what to do with it. This is handled by the process of <em>Intent
231 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
232 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
233 * more activities/receivers) that can handle it.</p>
234 *
235 * <p>The intent resolution mechanism basically revolves around matching an
236 * Intent against all of the &lt;intent-filter&gt; descriptions in the
237 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
238 * objects explicitly registered with {@link Context#registerReceiver}.) More
239 * details on this can be found in the documentation on the {@link
240 * IntentFilter} class.</p>
241 *
242 * <p>There are three pieces of information in the Intent that are used for
243 * resolution: the action, type, and category. Using this information, a query
244 * is done on the {@link PackageManager} for a component that can handle the
245 * intent. The appropriate component is determined based on the intent
246 * information supplied in the <code>AndroidManifest.xml</code> file as
247 * follows:</p>
248 *
249 * <ul>
250 * <li> <p>The <b>action</b>, if given, must be listed by the component as
251 * one it handles.</p>
252 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
253 * already supplied in the Intent. Like the action, if a type is
254 * included in the intent (either explicitly or implicitly in its
255 * data), then this must be listed by the component as one it handles.</p>
256 * <li> For data that is not a <code>content:</code> URI and where no explicit
257 * type is included in the Intent, instead the <b>scheme</b> of the
258 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
259 * considered. Again like the action, if we are matching a scheme it
260 * must be listed by the component as one it can handle.
261 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
262 * by the activity as categories it handles. That is, if you include
263 * the categories {@link #CATEGORY_LAUNCHER} and
264 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
265 * with an intent that lists <em>both</em> of those categories.
266 * Activities will very often need to support the
267 * {@link #CATEGORY_DEFAULT} so that they can be found by
268 * {@link Context#startActivity Context.startActivity()}.</p>
269 * </ul>
270 *
271 * <p>For example, consider the Note Pad sample application that
Joshua Baxter9a841a62018-03-27 14:42:03 -0700272 * allows a user to browse through a list of notes data and view details about
273 * individual items. Text in italics indicates places where you would replace a
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700274 * name with one specific to your own package.</p>
275 *
276 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
277 * package="<i>com.android.notepad</i>"&gt;
278 * &lt;application android:icon="@drawable/app_notes"
279 * android:label="@string/app_name"&gt;
280 *
281 * &lt;provider class=".NotePadProvider"
282 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
283 *
284 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
285 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700286 * &lt;action android:name="android.intent.action.MAIN" /&gt;
287 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700288 * &lt;/intent-filter&gt;
289 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="android.intent.action.VIEW" /&gt;
291 * &lt;action android:name="android.intent.action.EDIT" /&gt;
292 * &lt;action android:name="android.intent.action.PICK" /&gt;
293 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700297 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
298 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
299 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700300 * &lt;/intent-filter&gt;
301 * &lt;/activity&gt;
302 *
303 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
304 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700305 * &lt;action android:name="android.intent.action.VIEW" /&gt;
306 * &lt;action android:name="android.intent.action.EDIT" /&gt;
307 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
308 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700309 * &lt;/intent-filter&gt;
310 *
311 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700312 * &lt;action android:name="android.intent.action.INSERT" /&gt;
313 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
314 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700315 * &lt;/intent-filter&gt;
316 *
317 * &lt;/activity&gt;
318 *
319 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
320 * android:theme="@android:style/Theme.Dialog"&gt;
321 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700322 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
323 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
324 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
325 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
326 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700327 * &lt;/intent-filter&gt;
328 * &lt;/activity&gt;
329 *
330 * &lt;/application&gt;
331 * &lt;/manifest&gt;</pre>
332 *
333 * <p>The first activity,
334 * <code>com.android.notepad.NotesList</code>, serves as our main
335 * entry into the app. It can do three things as described by its three intent
336 * templates:
337 * <ol>
338 * <li><pre>
339 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700340 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
341 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700342 * &lt;/intent-filter&gt;</pre>
343 * <p>This provides a top-level entry into the NotePad application: the standard
344 * MAIN action is a main entry point (not requiring any other information in
345 * the Intent), and the LAUNCHER category says that this entry point should be
346 * listed in the application launcher.</p>
347 * <li><pre>
348 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700349 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
350 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
351 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
352 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700353 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700354 * &lt;/intent-filter&gt;</pre>
355 * <p>This declares the things that the activity can do on a directory of
356 * notes. The type being supported is given with the &lt;type&gt; tag, where
357 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
358 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
359 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
360 * The activity allows the user to view or edit the directory of data (via
361 * the VIEW and EDIT actions), or to pick a particular note and return it
362 * to the caller (via the PICK action). Note also the DEFAULT category
363 * supplied here: this is <em>required</em> for the
364 * {@link Context#startActivity Context.startActivity} method to resolve your
365 * activity when its component name is not explicitly specified.</p>
366 * <li><pre>
367 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700368 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
369 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
370 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700371 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700372 * <p>This filter describes the ability to return to the caller a note selected by
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700373 * the user without needing to know where it came from. The data type
374 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
375 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
376 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
377 * The GET_CONTENT action is similar to the PICK action, where the activity
378 * will return to its caller a piece of data selected by the user. Here,
379 * however, the caller specifies the type of data they desire instead of
380 * the type of data the user will be picking from.</p>
381 * </ol>
382 *
383 * <p>Given these capabilities, the following intents will resolve to the
384 * NotesList activity:</p>
385 *
386 * <ul>
387 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
388 * activities that can be used as top-level entry points into an
389 * application.</p>
390 * <li> <p><b>{ action=android.app.action.MAIN,
391 * category=android.app.category.LAUNCHER }</b> is the actual intent
392 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700393 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700394 * data=content://com.google.provider.NotePad/notes }</b>
395 * displays a list of all the notes under
396 * "content://com.google.provider.NotePad/notes", which
397 * the user can browse through and see the details on.</p>
398 * <li> <p><b>{ action=android.app.action.PICK
399 * data=content://com.google.provider.NotePad/notes }</b>
400 * provides a list of the notes under
401 * "content://com.google.provider.NotePad/notes", from which
402 * the user can pick a note whose data URL is returned back to the caller.</p>
403 * <li> <p><b>{ action=android.app.action.GET_CONTENT
404 * type=vnd.android.cursor.item/vnd.google.note }</b>
405 * is similar to the pick action, but allows the caller to specify the
406 * kind of data they want back so that the system can find the appropriate
407 * activity to pick something of that data type.</p>
408 * </ul>
409 *
410 * <p>The second activity,
411 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
412 * note entry and allows them to edit it. It can do two things as described
413 * by its two intent templates:
414 * <ol>
415 * <li><pre>
416 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700417 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
418 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
419 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
420 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700421 * &lt;/intent-filter&gt;</pre>
422 * <p>The first, primary, purpose of this activity is to let the user interact
423 * with a single note, as decribed by the MIME type
424 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
425 * either VIEW a note or allow the user to EDIT it. Again we support the
426 * DEFAULT category to allow the activity to be launched without explicitly
427 * specifying its component.</p>
428 * <li><pre>
429 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700430 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
431 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
432 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700433 * &lt;/intent-filter&gt;</pre>
434 * <p>The secondary use of this activity is to insert a new note entry into
435 * an existing directory of notes. This is used when the user creates a new
436 * note: the INSERT action is executed on the directory of notes, causing
437 * this activity to run and have the user create the new note data which
438 * it then adds to the content provider.</p>
439 * </ol>
440 *
441 * <p>Given these capabilities, the following intents will resolve to the
442 * NoteEditor activity:</p>
443 *
444 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700445 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700446 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
447 * shows the user the content of note <var>{ID}</var>.</p>
448 * <li> <p><b>{ action=android.app.action.EDIT
449 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
450 * allows the user to edit the content of note <var>{ID}</var>.</p>
451 * <li> <p><b>{ action=android.app.action.INSERT
452 * data=content://com.google.provider.NotePad/notes }</b>
453 * creates a new, empty note in the notes list at
454 * "content://com.google.provider.NotePad/notes"
455 * and allows the user to edit it. If they keep their changes, the URI
456 * of the newly created note is returned to the caller.</p>
457 * </ul>
458 *
459 * <p>The last activity,
460 * <code>com.android.notepad.TitleEditor</code>, allows the user to
461 * edit the title of a note. This could be implemented as a class that the
462 * application directly invokes (by explicitly setting its component in
463 * the Intent), but here we show a way you can publish alternative
464 * operations on existing data:</p>
465 *
466 * <pre>
467 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700468 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
469 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
470 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
471 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
472 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700473 * &lt;/intent-filter&gt;</pre>
474 *
475 * <p>In the single intent template here, we
476 * have created our own private action called
477 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
478 * edit the title of a note. It must be invoked on a specific note
479 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
480 * view and edit actions, but here displays and edits the title contained
481 * in the note data.
482 *
483 * <p>In addition to supporting the default category as usual, our title editor
484 * also supports two other standard categories: ALTERNATIVE and
485 * SELECTED_ALTERNATIVE. Implementing
486 * these categories allows others to find the special action it provides
487 * without directly knowing about it, through the
488 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
489 * more often to build dynamic menu items with
490 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
491 * template here was also supply an explicit name for the template
492 * (via <code>android:label="@string/resolve_title"</code>) to better control
493 * what the user sees when presented with this activity as an alternative
494 * action to the data they are viewing.
495 *
496 * <p>Given these capabilities, the following intent will resolve to the
497 * TitleEditor activity:</p>
498 *
499 * <ul>
500 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
501 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
502 * displays and allows the user to edit the title associated
503 * with note <var>{ID}</var>.</p>
504 * </ul>
505 *
506 * <h3>Standard Activity Actions</h3>
507 *
508 * <p>These are the current standard actions that Intent defines for launching
509 * activities (usually through {@link Context#startActivity}. The most
510 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
511 * {@link #ACTION_EDIT}.
512 *
513 * <ul>
514 * <li> {@link #ACTION_MAIN}
515 * <li> {@link #ACTION_VIEW}
516 * <li> {@link #ACTION_ATTACH_DATA}
517 * <li> {@link #ACTION_EDIT}
518 * <li> {@link #ACTION_PICK}
519 * <li> {@link #ACTION_CHOOSER}
520 * <li> {@link #ACTION_GET_CONTENT}
521 * <li> {@link #ACTION_DIAL}
522 * <li> {@link #ACTION_CALL}
523 * <li> {@link #ACTION_SEND}
524 * <li> {@link #ACTION_SENDTO}
525 * <li> {@link #ACTION_ANSWER}
526 * <li> {@link #ACTION_INSERT}
527 * <li> {@link #ACTION_DELETE}
528 * <li> {@link #ACTION_RUN}
529 * <li> {@link #ACTION_SYNC}
530 * <li> {@link #ACTION_PICK_ACTIVITY}
531 * <li> {@link #ACTION_SEARCH}
532 * <li> {@link #ACTION_WEB_SEARCH}
533 * <li> {@link #ACTION_FACTORY_TEST}
534 * </ul>
535 *
536 * <h3>Standard Broadcast Actions</h3>
537 *
538 * <p>These are the current standard actions that Intent defines for receiving
539 * broadcasts (usually through {@link Context#registerReceiver} or a
540 * &lt;receiver&gt; tag in a manifest).
541 *
542 * <ul>
543 * <li> {@link #ACTION_TIME_TICK}
544 * <li> {@link #ACTION_TIME_CHANGED}
545 * <li> {@link #ACTION_TIMEZONE_CHANGED}
546 * <li> {@link #ACTION_BOOT_COMPLETED}
547 * <li> {@link #ACTION_PACKAGE_ADDED}
548 * <li> {@link #ACTION_PACKAGE_CHANGED}
549 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800550 * <li> {@link #ACTION_PACKAGE_RESTARTED}
551 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000552 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
553 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700554 * <li> {@link #ACTION_UID_REMOVED}
555 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700556 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700557 * <li> {@link #ACTION_POWER_DISCONNECTED}
558 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700559 * </ul>
560 *
561 * <h3>Standard Categories</h3>
562 *
563 * <p>These are the current standard categories that can be used to further
564 * clarify an Intent via {@link #addCategory}.
565 *
566 * <ul>
567 * <li> {@link #CATEGORY_DEFAULT}
568 * <li> {@link #CATEGORY_BROWSABLE}
569 * <li> {@link #CATEGORY_TAB}
570 * <li> {@link #CATEGORY_ALTERNATIVE}
571 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
572 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800573 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700574 * <li> {@link #CATEGORY_HOME}
575 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700576 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400577 * <li> {@link #CATEGORY_CAR_DOCK}
578 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500579 * <li> {@link #CATEGORY_LE_DESK_DOCK}
580 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200581 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700582 * <li> {@link #CATEGORY_APP_MARKET}
Zak Cohendb6ca492017-01-26 14:09:00 -0800583 * <li> {@link #CATEGORY_VR_HOME}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700584 * </ul>
585 *
586 * <h3>Standard Extra Data</h3>
587 *
588 * <p>These are the current standard fields that can be used as extra data via
589 * {@link #putExtra}.
590 *
591 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800592 * <li> {@link #EXTRA_ALARM_COUNT}
593 * <li> {@link #EXTRA_BCC}
594 * <li> {@link #EXTRA_CC}
595 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
596 * <li> {@link #EXTRA_DATA_REMOVED}
597 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500598 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
599 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800600 * <li> {@link #EXTRA_DOCK_STATE_CAR}
601 * <li> {@link #EXTRA_DOCK_STATE_DESK}
602 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
603 * <li> {@link #EXTRA_DONT_KILL_APP}
604 * <li> {@link #EXTRA_EMAIL}
605 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700606 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800607 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700608 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800609 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700610 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800611 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
612 * <li> {@link #EXTRA_REPLACING}
613 * <li> {@link #EXTRA_SHORTCUT_ICON}
614 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
615 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700616 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800617 * <li> {@link #EXTRA_SHORTCUT_NAME}
618 * <li> {@link #EXTRA_SUBJECT}
619 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700620 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800621 * <li> {@link #EXTRA_TITLE}
622 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700623 * </ul>
624 *
625 * <h3>Flags</h3>
626 *
627 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800628 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
629 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800631public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700632 private static final String ATTR_ACTION = "action";
633 private static final String TAG_CATEGORIES = "categories";
634 private static final String ATTR_CATEGORY = "category";
635 private static final String TAG_EXTRA = "extra";
636 private static final String ATTR_TYPE = "type";
637 private static final String ATTR_COMPONENT = "component";
638 private static final String ATTR_DATA = "data";
639 private static final String ATTR_FLAGS = "flags";
640
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700641 // ---------------------------------------------------------------------
642 // ---------------------------------------------------------------------
643 // Standard intent activity actions (see action variable).
644
645 /**
646 * Activity Action: Start as a main entry point, does not expect to
647 * receive data.
648 * <p>Input: nothing
649 * <p>Output: nothing
650 */
651 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
652 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800653
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700654 /**
655 * Activity Action: Display the data to the user. This is the most common
656 * action performed on data -- it is the generic action you can use on
657 * a piece of data to get the most reasonable thing to occur. For example,
658 * when used on a contacts entry it will view the entry; when used on a
659 * mailto: URI it will bring up a compose window filled with the information
660 * supplied by the URI; when used with a tel: URI it will invoke the
661 * dialer.
662 * <p>Input: {@link #getData} is URI from which to retrieve data.
663 * <p>Output: nothing.
664 */
665 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
666 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800667
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700668 /**
Dianne Hackborna320f012017-04-07 13:57:48 -0700669 * Extra that can be included on activity intents coming from the storage UI
670 * when it launches sub-activities to manage various types of storage. For example,
671 * it may use {@link #ACTION_VIEW} with a "image/*" MIME type to have an app show
672 * the images on the device, and in that case also include this extra to tell the
673 * app it is coming from the storage UI so should help the user manage storage of
674 * this type.
675 */
676 public static final String EXTRA_FROM_STORAGE = "android.intent.extra.FROM_STORAGE";
677
678 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700679 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
680 * performed on a piece of data.
681 */
682 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800683
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700684 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900685 * Activity Action: Quick view the data. Launches a quick viewer for
686 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900687 * <p>Activities handling this intent action should handle the vast majority of
688 * MIME types rather than only specific ones.
Garfield Tance1d0e92017-03-23 10:52:48 -0700689 * <p>Quick viewers must render the quick view image locally, and must not send
690 * file content outside current device.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900691 * <p>Input: {@link #getData} is a mandatory content URI of the item to
692 * preview. {@link #getClipData} contains an optional list of content URIs
693 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
694 * optional index of the URI in the clip data to show first.
Garfield Tance1d0e92017-03-23 10:52:48 -0700695 * {@link #EXTRA_QUICK_VIEW_FEATURES} is an optional extra indicating the features
696 * that can be shown in the quick view UI.
Steve McKayc78bcb82015-07-31 14:35:22 -0700697 * <p>Output: nothing.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900698 * @see #EXTRA_INDEX
Garfield Tance1d0e92017-03-23 10:52:48 -0700699 * @see #EXTRA_QUICK_VIEW_FEATURES
Steve McKayc78bcb82015-07-31 14:35:22 -0700700 */
701 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
702 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
703
704 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700705 * Used to indicate that some piece of data should be attached to some other
706 * place. For example, image data could be attached to a contact. It is up
707 * to the recipient to decide where the data should be attached; the intent
708 * does not specify the ultimate destination.
709 * <p>Input: {@link #getData} is URI of data to be attached.
710 * <p>Output: nothing.
711 */
712 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
713 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 /**
716 * Activity Action: Provide explicit editable access to the given data.
717 * <p>Input: {@link #getData} is URI of data to be edited.
718 * <p>Output: nothing.
719 */
720 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
721 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800722
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700723 /**
724 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
725 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
726 * The extras can contain type specific data to pass through to the editing/creating
727 * activity.
728 * <p>Output: The URI of the item that was picked. This must be a content:
729 * URI so that any receiver can access it.
730 */
731 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
732 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800733
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700734 /**
735 * Activity Action: Pick an item from the data, returning what was selected.
736 * <p>Input: {@link #getData} is URI containing a directory of data
737 * (vnd.android.cursor.dir/*) from which to pick an item.
738 * <p>Output: The URI of the item that was picked.
739 */
740 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
741 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800742
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700743 /**
744 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800745 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800746 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
747 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700748 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
749 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800750 * (value: ShortcutIconResource).</p>
751 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800752 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700753 * @see #EXTRA_SHORTCUT_INTENT
754 * @see #EXTRA_SHORTCUT_NAME
755 * @see #EXTRA_SHORTCUT_ICON
756 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
757 * @see android.content.Intent.ShortcutIconResource
758 */
759 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
760 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
761
762 /**
763 * The name of the extra used to define the Intent of a shortcut.
764 *
765 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800766 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700767 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800768 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700769 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
770 /**
771 * The name of the extra used to define the name of a shortcut.
772 *
773 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800774 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700775 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800776 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700777 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
778 /**
779 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
780 *
781 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800782 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700783 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800784 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700785 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
786 /**
787 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
788 *
789 * @see #ACTION_CREATE_SHORTCUT
790 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800791 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700792 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800793 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700794 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
795 "android.intent.extra.shortcut.ICON_RESOURCE";
796
797 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500798 * An activity that provides a user interface for adjusting application preferences.
799 * Optional but recommended settings for all applications which have settings.
800 */
801 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
802 public static final String ACTION_APPLICATION_PREFERENCES
803 = "android.intent.action.APPLICATION_PREFERENCES";
804
805 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700806 * Activity Action: Launch an activity showing the app information.
807 * For applications which install other applications (such as app stores), it is recommended
808 * to handle this action for providing the app information to the user.
809 *
810 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
811 * to be displayed.
812 * <p>Output: Nothing.
813 */
814 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
815 public static final String ACTION_SHOW_APP_INFO
816 = "android.intent.action.SHOW_APP_INFO";
817
818 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800819 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700820 *
821 * @see Intent#ACTION_CREATE_SHORTCUT
822 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800823 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
824 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700825 */
826 public static class ShortcutIconResource implements Parcelable {
827 /**
828 * The package name of the application containing the icon.
829 */
830 public String packageName;
831
832 /**
833 * The resource name of the icon, including package, name and type.
834 */
835 public String resourceName;
836
837 /**
838 * Creates a new ShortcutIconResource for the specified context and resource
839 * identifier.
840 *
841 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700842 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700843 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700844 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700845 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700846 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700847 ShortcutIconResource icon = new ShortcutIconResource();
848 icon.packageName = context.getPackageName();
849 icon.resourceName = context.getResources().getResourceName(resourceId);
850 return icon;
851 }
852
853 /**
854 * Used to read a ShortcutIconResource from a Parcel.
855 */
856 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
857 new Parcelable.Creator<ShortcutIconResource>() {
858
859 public ShortcutIconResource createFromParcel(Parcel source) {
860 ShortcutIconResource icon = new ShortcutIconResource();
861 icon.packageName = source.readString();
862 icon.resourceName = source.readString();
863 return icon;
864 }
865
866 public ShortcutIconResource[] newArray(int size) {
867 return new ShortcutIconResource[size];
868 }
869 };
870
871 /**
872 * No special parcel contents.
873 */
874 public int describeContents() {
875 return 0;
876 }
877
878 public void writeToParcel(Parcel dest, int flags) {
879 dest.writeString(packageName);
880 dest.writeString(resourceName);
881 }
882
883 @Override
884 public String toString() {
885 return resourceName;
886 }
887 }
888
889 /**
890 * Activity Action: Display an activity chooser, allowing the user to pick
891 * what they want to before proceeding. This can be used as an alternative
892 * to the standard activity picker that is displayed by the system when
893 * you try to start an activity with multiple possible matches, with these
894 * differences in behavior:
895 * <ul>
896 * <li>You can specify the title that will appear in the activity chooser.
897 * <li>The user does not have the option to make one of the matching
898 * activities a preferred activity, and all possible activities will
899 * always be shown even if one of them is currently marked as the
900 * preferred activity.
901 * </ul>
902 * <p>
903 * This action should be used when the user will naturally expect to
904 * select an activity in order to proceed. An example if when not to use
905 * it is when the user clicks on a "mailto:" link. They would naturally
906 * expect to go directly to their mail app, so startActivity() should be
907 * called directly: it will
908 * either launch the current preferred app, or put up a dialog allowing the
909 * user to pick an app to use and optionally marking that as preferred.
910 * <p>
911 * In contrast, if the user is selecting a menu item to send a picture
912 * they are viewing to someone else, there are many different things they
913 * may want to do at this point: send it through e-mail, upload it to a
914 * web service, etc. In this case the CHOOSER action should be used, to
915 * always present to the user a list of the things they can do, with a
916 * nice title given by the caller such as "Send this photo with:".
917 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700918 * If you need to grant URI permissions through a chooser, you must specify
919 * the permissions to be granted on the ACTION_CHOOSER Intent
920 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
921 * {@link #setClipData} to specify the URIs to be granted as well as
922 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
923 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
924 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700925 * As a convenience, an Intent of this form can be created with the
926 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700927 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700928 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700929 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
930 * and can optionally have a {@link #EXTRA_TITLE} field containing the
931 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700932 * <p>
933 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700934 */
935 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
936 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
937
938 /**
939 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
940 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700941 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
942 * target intent, also optionally supplying a title. If the target
943 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
944 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
945 * set in the returned chooser intent, with its ClipData set appropriately:
946 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500947 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700948 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700949 * @param target The Intent that the user will be selecting an activity
950 * to perform.
951 * @param title Optional title that will be displayed in the chooser.
952 * @return Return a new Intent object that you can hand to
953 * {@link Context#startActivity(Intent) Context.startActivity()} and
954 * related methods.
955 */
956 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700957 return createChooser(target, title, null);
958 }
959
960 /**
961 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
962 *
963 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
964 * target intent, also optionally supplying a title. If the target
965 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
966 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
967 * set in the returned chooser intent, with its ClipData set appropriately:
968 * either a direct reflection of {@link #getClipData()} if that is non-null,
969 * or a new ClipData built from {@link #getData()}.</p>
970 *
971 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
972 * when the user makes a choice. This can be useful if the calling application wants
973 * to remember the last chosen target and surface it as a more prominent or one-touch
974 * affordance elsewhere in the UI for next time.</p>
975 *
976 * @param target The Intent that the user will be selecting an activity
977 * to perform.
978 * @param title Optional title that will be displayed in the chooser.
979 * @param sender Optional IntentSender to be called when a choice is made.
980 * @return Return a new Intent object that you can hand to
981 * {@link Context#startActivity(Intent) Context.startActivity()} and
982 * related methods.
983 */
984 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700985 Intent intent = new Intent(ACTION_CHOOSER);
986 intent.putExtra(EXTRA_INTENT, target);
987 if (title != null) {
988 intent.putExtra(EXTRA_TITLE, title);
989 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700990
Adam Powell0b3c1122014-10-09 12:50:14 -0700991 if (sender != null) {
992 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
993 }
994
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700995 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700996 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
997 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
998 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700999 if (permFlags != 0) {
1000 ClipData targetClipData = target.getClipData();
1001 if (targetClipData == null && target.getData() != null) {
1002 ClipData.Item item = new ClipData.Item(target.getData());
1003 String[] mimeTypes;
1004 if (target.getType() != null) {
1005 mimeTypes = new String[] { target.getType() };
1006 } else {
1007 mimeTypes = new String[] { };
1008 }
1009 targetClipData = new ClipData(null, mimeTypes, item);
1010 }
1011 if (targetClipData != null) {
1012 intent.setClipData(targetClipData);
1013 intent.addFlags(permFlags);
1014 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001015 }
Dianne Hackborne302a162012-05-15 14:58:32 -07001016
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001017 return intent;
1018 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001019
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001020 /**
1021 * Activity Action: Allow the user to select a particular kind of data and
1022 * return it. This is different than {@link #ACTION_PICK} in that here we
1023 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001024 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001025 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001026 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001027 * etc.
1028 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001029 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001030 * of data, such as a person contact, you set the MIME type to the kind of
1031 * data you want and launch it with {@link Context#startActivity(Intent)}.
1032 * The system will then launch the best application to select that kind
1033 * of data for you.
1034 * <p>
1035 * You may also be interested in any of a set of types of content the user
1036 * can pick. For example, an e-mail application that wants to allow the
1037 * user to add an attachment to an e-mail message can use this action to
1038 * bring up a list of all of the types of content the user can attach.
1039 * <p>
1040 * In this case, you should wrap the GET_CONTENT intent with a chooser
1041 * (through {@link #createChooser}), which will give the proper interface
1042 * for the user to pick how to send your data and allow you to specify
1043 * a prompt indicating what they are doing. You will usually specify a
1044 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1045 * broad range of content types the user can select from.
1046 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001047 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001048 * only pick from data that can be represented as a stream. This is
1049 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1050 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001051 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001052 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001053 * is locally available on the device. For example, if this extra is set
1054 * to true then an image picker should not show any pictures that are available
1055 * from a remote server but not already on the local device (thus requiring
1056 * they be downloaded when opened).
1057 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001058 * If the caller can handle multiple returned items (the user performing
1059 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1060 * to indicate this.
1061 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001062 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1063 * that no URI is supplied in the intent, as there are no constraints on
1064 * where the returned data originally comes from. You may also include the
1065 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001066 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001067 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1068 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001069 * <p>
1070 * Output: The URI of the item that was picked. This must be a content:
1071 * URI so that any receiver can access it.
1072 */
1073 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1074 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1075 /**
1076 * Activity Action: Dial a number as specified by the data. This shows a
1077 * UI with the number being dialed, allowing the user to explicitly
1078 * initiate the call.
1079 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1080 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1081 * number.
1082 * <p>Output: nothing.
1083 */
1084 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1085 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1086 /**
1087 * Activity Action: Perform a call to someone specified by the data.
1088 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1089 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1090 * number.
1091 * <p>Output: nothing.
1092 *
1093 * <p>Note: there will be restrictions on which applications can initiate a
1094 * call; most applications should use the {@link #ACTION_DIAL}.
1095 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1096 * numbers. Applications can <strong>dial</strong> emergency numbers using
1097 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001098 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001099 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001100 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001101 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001102 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001103 */
1104 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1105 public static final String ACTION_CALL = "android.intent.action.CALL";
1106 /**
1107 * Activity Action: Perform a call to an emergency number specified by the
1108 * data.
1109 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1110 * tel: URI of an explicit phone number.
1111 * <p>Output: nothing.
1112 * @hide
1113 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001114 @SystemApi
1115 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001116 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1117 /**
1118 * Activity action: Perform a call to any number (emergency or not)
1119 * specified by the data.
1120 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1121 * tel: URI of an explicit phone number.
1122 * <p>Output: nothing.
1123 * @hide
1124 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001125 @SystemApi
1126 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001127 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
fionaxu77a744c2017-03-17 14:35:39 -07001128
Santos Cordon15a13782015-03-31 18:32:31 -07001129 /**
fionaxuadfe7002017-02-17 17:20:46 -08001130 * Activity Action: Main entry point for carrier setup apps.
1131 * <p>Carrier apps that provide an implementation for this action may be invoked to configure
1132 * carrier service and typically require
1133 * {@link android.telephony.TelephonyManager#hasCarrierPrivileges() carrier privileges} to
1134 * fulfill their duties.
1135 */
1136 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1137 public static final String ACTION_CARRIER_SETUP = "android.intent.action.CARRIER_SETUP";
1138 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001139 * Activity Action: Send a message to someone specified by the data.
1140 * <p>Input: {@link #getData} is URI describing the target.
1141 * <p>Output: nothing.
1142 */
1143 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1144 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1145 /**
1146 * Activity Action: Deliver some data to someone else. Who the data is
1147 * being delivered to is not specified; it is up to the receiver of this
1148 * action to ask the user where the data should be sent.
1149 * <p>
1150 * When launching a SEND intent, you should usually wrap it in a chooser
1151 * (through {@link #createChooser}), which will give the proper interface
1152 * for the user to pick how to send your data and allow you to specify
1153 * a prompt indicating what they are doing.
1154 * <p>
1155 * Input: {@link #getType} is the MIME type of the data being sent.
1156 * get*Extra can have either a {@link #EXTRA_TEXT}
1157 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1158 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1159 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1160 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001161 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1162 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1163 * your text with HTML formatting.
1164 * <p>
1165 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1166 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1167 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1168 * content: URIs and other advanced features of {@link ClipData}. If
1169 * using this approach, you still must supply the same data through the
1170 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1171 * for compatibility with old applications. If you don't set a ClipData,
1172 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001173 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001174 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1175 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1176 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1177 * be openable only as asset typed files using
1178 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1179 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001180 * Optional standard extras, which may be interpreted by some recipients as
1181 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1182 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1183 * <p>
1184 * Output: nothing.
1185 */
1186 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1187 public static final String ACTION_SEND = "android.intent.action.SEND";
1188 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001189 * Activity Action: Deliver multiple data to someone else.
1190 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001191 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001192 * <p>
1193 * Input: {@link #getType} is the MIME type of the data being sent.
1194 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001195 * #EXTRA_STREAM} field, containing the data to be sent. If using
1196 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1197 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001198 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001199 * Multiple types are supported, and receivers should handle mixed types
1200 * whenever possible. The right way for the receiver to check them is to
1201 * use the content resolver on each URI. The intent sender should try to
1202 * put the most concrete mime type in the intent type, but it can fall
1203 * back to {@literal <type>/*} or {@literal *}/* as needed.
1204 * <p>
1205 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1206 * be image/jpg, but if you are sending image/jpg and image/png, then the
1207 * intent's type should be image/*.
1208 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001209 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1210 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1211 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1212 * content: URIs and other advanced features of {@link ClipData}. If
1213 * using this approach, you still must supply the same data through the
1214 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1215 * for compatibility with old applications. If you don't set a ClipData,
1216 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1217 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001218 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1219 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1220 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1221 * be openable only as asset typed files using
1222 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1223 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001224 * Optional standard extras, which may be interpreted by some recipients as
1225 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1226 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1227 * <p>
1228 * Output: nothing.
1229 */
1230 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1231 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1232 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001233 * Activity Action: Handle an incoming phone call.
1234 * <p>Input: nothing.
1235 * <p>Output: nothing.
1236 */
1237 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1238 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1239 /**
1240 * Activity Action: Insert an empty item into the given container.
1241 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1242 * in which to place the data.
1243 * <p>Output: URI of the new data that was created.
1244 */
1245 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1246 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1247 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001248 * Activity Action: Create a new item in the given container, initializing it
1249 * from the current contents of the clipboard.
1250 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1251 * in which to place the data.
1252 * <p>Output: URI of the new data that was created.
1253 */
1254 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1255 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1256 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001257 * Activity Action: Delete the given data from its container.
1258 * <p>Input: {@link #getData} is URI of data to be deleted.
1259 * <p>Output: nothing.
1260 */
1261 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1262 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1263 /**
1264 * Activity Action: Run the data, whatever that means.
1265 * <p>Input: ? (Note: this is currently specific to the test harness.)
1266 * <p>Output: nothing.
1267 */
1268 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1269 public static final String ACTION_RUN = "android.intent.action.RUN";
1270 /**
1271 * Activity Action: Perform a data synchronization.
1272 * <p>Input: ?
1273 * <p>Output: ?
1274 */
1275 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1276 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1277 /**
1278 * Activity Action: Pick an activity given an intent, returning the class
1279 * selected.
1280 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1281 * used with {@link PackageManager#queryIntentActivities} to determine the
1282 * set of activities from which to pick.
1283 * <p>Output: Class name of the activity that was selected.
1284 */
1285 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1286 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1287 /**
1288 * Activity Action: Perform a search.
1289 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1290 * is the text to search for. If empty, simply
1291 * enter your search results Activity with the search UI activated.
1292 * <p>Output: nothing.
1293 */
1294 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1295 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1296 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001297 * Activity Action: Start the platform-defined tutorial
1298 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1299 * is the text to search for. If empty, simply
1300 * enter your search results Activity with the search UI activated.
1301 * <p>Output: nothing.
1302 */
1303 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1304 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1305 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001306 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001307 * <p>
1308 * Input: {@link android.app.SearchManager#QUERY
1309 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1310 * a url starts with http or https, the site will be opened. If it is plain
1311 * text, Google search will be applied.
1312 * <p>
1313 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001314 */
1315 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1316 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001317
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001318 /**
Jim Miller07994402012-05-02 14:22:27 -07001319 * Activity Action: Perform assist action.
1320 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001321 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1322 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001323 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1324 * information.
Jim Miller07994402012-05-02 14:22:27 -07001325 * Output: nothing.
1326 */
1327 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1328 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001329
1330 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001331 * Activity Action: Perform voice assist action.
1332 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001333 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1334 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001335 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001336 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001337 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001338 */
Amith Yamasani16452032017-03-03 10:15:57 -08001339 @SystemApi
Bjorn Bringertbc086862013-03-01 12:59:24 +00001340 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1341 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1342
1343 /**
Adam Skory7140a252013-09-11 12:04:58 +01001344 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1345 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001346 */
1347 public static final String EXTRA_ASSIST_PACKAGE
1348 = "android.intent.extra.ASSIST_PACKAGE";
1349
1350 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001351 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1352 * application package at the time the assist was invoked.
1353 */
1354 public static final String EXTRA_ASSIST_UID
1355 = "android.intent.extra.ASSIST_UID";
1356
1357 /**
Adam Skory7140a252013-09-11 12:04:58 +01001358 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1359 * information supplied by the current foreground app at the time of the assist request.
1360 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001361 */
1362 public static final String EXTRA_ASSIST_CONTEXT
1363 = "android.intent.extra.ASSIST_CONTEXT";
1364
Jim Miller07994402012-05-02 14:22:27 -07001365 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001366 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1367 * keyboard as the primary input device for assistance.
1368 */
1369 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1370 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1371
1372 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001373 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1374 * that was used to invoke the assist.
1375 */
1376 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1377 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1378
1379 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001380 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001381 * <p>Input: Nothing.
1382 * <p>Output: nothing.
1383 */
1384 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1385 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1386 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001387 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001388 * <p>Input: Nothing.
1389 * <p>Output: Nothing.
1390 */
1391 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1392 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1393
1394 /**
1395 * Activity Action: Show activity for reporting a bug.
1396 * <p>Input: Nothing.
1397 * <p>Output: Nothing.
1398 */
1399 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1400 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1401
1402 /**
1403 * Activity Action: Main entry point for factory tests. Only used when
1404 * the device is booting in factory test node. The implementing package
1405 * must be installed in the system image.
1406 * <p>Input: nothing
1407 * <p>Output: nothing
1408 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06001409 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001410 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1411
1412 /**
1413 * Activity Action: The user pressed the "call" button to go to the dialer
1414 * or other appropriate UI for placing a call.
1415 * <p>Input: Nothing.
1416 * <p>Output: Nothing.
1417 */
1418 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1419 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1420
1421 /**
1422 * Activity Action: Start Voice Command.
1423 * <p>Input: Nothing.
1424 * <p>Output: Nothing.
Christopher Tate72da1e62018-05-10 13:09:48 -07001425 * <p class="note">
1426 * In some cases, a matching Activity may not exist, so ensure you
1427 * safeguard against this.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001428 */
1429 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1430 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001431
1432 /**
1433 * Activity Action: Start action associated with long pressing on the
1434 * search key.
1435 * <p>Input: Nothing.
1436 * <p>Output: Nothing.
1437 */
1438 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1439 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001440
Jacek Surazski86b6c532009-05-13 14:38:28 +02001441 /**
1442 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1443 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001444 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001445 * <p>Input: No data is specified. The bug report is passed in using
1446 * an {@link #EXTRA_BUG_REPORT} field.
1447 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001448 *
1449 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001450 */
1451 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1452 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001453
1454 /**
1455 * Activity Action: Show power usage information to the user.
1456 * <p>Input: Nothing.
1457 * <p>Output: Nothing.
1458 */
1459 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1460 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001461
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001462 /**
Russell Brenner4cd32e52017-02-24 11:11:47 -08001463 * Activity Action: Setup wizard action provided for OTA provisioning to determine if it needs
1464 * to run.
1465 * <p>Input: Nothing.
1466 * <p>Output: Nothing.
1467 * @deprecated As of {@link android.os.Build.VERSION_CODES#M}, setup wizard can be identified
1468 * using {@link #ACTION_MAIN} and {@link #CATEGORY_SETUP_WIZARD}
1469 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001470 * @removed
Russell Brenner4cd32e52017-02-24 11:11:47 -08001471 */
1472 @Deprecated
1473 @SystemApi
1474 public static final String ACTION_DEVICE_INITIALIZATION_WIZARD =
1475 "android.intent.action.DEVICE_INITIALIZATION_WIZARD";
1476
1477 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001478 * Activity Action: Setup wizard to launch after a platform update. This
1479 * activity should have a string meta-data field associated with it,
1480 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1481 * the platform for setup. The activity will be launched only if
1482 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1483 * same value.
1484 * <p>Input: Nothing.
1485 * <p>Output: Nothing.
1486 * @hide
1487 */
Russell Brenner4cd32e52017-02-24 11:11:47 -08001488 @SystemApi
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001489 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1490 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001491
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001492 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001493 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1494 * <p>Input: Nothing.
1495 * <p>Output: Nothing.
1496 * @hide
1497 */
1498 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1499 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001500 "com.android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001501
1502 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001503 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1504 * <p>Input: Nothing.
1505 * <p>Output: Nothing.
1506 * @hide
1507 */
1508 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1509 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001510 "com.android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001511
1512 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001513 * Activity Action: Show settings for managing network data usage of a
1514 * specific application. Applications should define an activity that offers
1515 * options to control data usage.
1516 */
1517 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1518 public static final String ACTION_MANAGE_NETWORK_USAGE =
1519 "android.intent.action.MANAGE_NETWORK_USAGE";
1520
1521 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001522 * Activity Action: Launch application installer.
1523 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001524 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001525 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1526 * you can also use "package:<package-name>" to install an application for the
1527 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001528 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1529 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1530 * <p>
1531 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1532 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001533 * <p>
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001534 * <strong>Note:</strong>If your app is targeting API level higher than 25 you
Svet Ganov86877e42015-05-28 08:19:48 -07001535 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1536 * in order to launch the application installer.
1537 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001538 *
1539 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1540 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1541 * @see #EXTRA_RETURN_RESULT
Philip P. Moltmannfe460102018-09-25 10:22:32 -07001542 *
1543 * @deprecated use {@link android.content.pm.PackageInstaller} instead
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001544 */
Philip P. Moltmannfe460102018-09-25 10:22:32 -07001545 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001546 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1547 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1548
1549 /**
Todd Kennedyd0084f72017-07-28 13:56:14 -07001550 * Activity Action: Activity to handle split installation failures.
1551 * <p>Splits may be installed dynamically. This happens when an Activity is launched,
1552 * but the split that contains the application isn't installed. When a split is
1553 * installed in this manner, the containing package usually doesn't know this is
1554 * happening. However, if an error occurs during installation, the containing
1555 * package can define a single activity handling this action to deal with such
1556 * failures.
1557 * <p>The activity handling this action must be in the base package.
1558 * <p>
1559 * Input: {@link #EXTRA_INTENT} the original intent that started split installation.
1560 * {@link #EXTRA_SPLIT_NAME} the name of the split that failed to be installed.
1561 */
1562 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1563 public static final String ACTION_INSTALL_FAILURE = "android.intent.action.INSTALL_FAILURE";
1564
1565 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001566 * Activity Action: Launch instant application installer.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001567 * <p class="note">
1568 * This is a protected intent that can only be sent by the system.
1569 * </p>
1570 *
1571 * @hide
1572 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001573 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001574 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001575 public static final String ACTION_INSTALL_INSTANT_APP_PACKAGE
1576 = "android.intent.action.INSTALL_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001577
1578 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001579 * Service Action: Resolve instant application.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001580 * <p>
1581 * The system will have a persistent connection to this service.
1582 * This is a protected intent that can only be sent by the system.
1583 * </p>
1584 *
1585 * @hide
1586 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001587 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001588 @SdkConstant(SdkConstantType.SERVICE_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001589 public static final String ACTION_RESOLVE_INSTANT_APP_PACKAGE
1590 = "android.intent.action.RESOLVE_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001591
1592 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001593 * Activity Action: Launch instant app settings.
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001594 *
1595 * <p class="note">
1596 * This is a protected intent that can only be sent by the system.
1597 * </p>
1598 *
1599 * @hide
1600 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001601 @SystemApi
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001602 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001603 public static final String ACTION_INSTANT_APP_RESOLVER_SETTINGS
1604 = "android.intent.action.INSTANT_APP_RESOLVER_SETTINGS";
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001605
1606 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001607 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1608 * package. Specifies the installer package name; this package will receive the
1609 * {@link #ACTION_APP_ERROR} intent.
1610 */
1611 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1612 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1613
1614 /**
1615 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1616 * package. Specifies that the application being installed should not be
1617 * treated as coming from an unknown source, but as coming from the app
1618 * invoking the Intent. For this to work you must start the installer with
1619 * startActivityForResult().
1620 */
1621 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1622 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1623
1624 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001625 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1626 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001627 * data field originated from.
1628 */
rich cannings706e8ba2012-08-20 13:20:14 -07001629 public static final String EXTRA_ORIGINATING_URI
1630 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001631
1632 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001633 * This extra can be used with any Intent used to launch an activity, supplying information
1634 * about who is launching that activity. This field contains a {@link android.net.Uri}
1635 * object, typically an http: or https: URI of the web site that the referral came from;
1636 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1637 * a native application that it came from.
1638 *
1639 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1640 * instead of directly retrieving the extra. It is also valid for applications to
1641 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1642 * a string, not a Uri; the field here, if supplied, will always take precedence,
1643 * however.</p>
1644 *
1645 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001646 */
1647 public static final String EXTRA_REFERRER
1648 = "android.intent.extra.REFERRER";
1649
1650 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001651 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1652 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1653 * not be created, in particular when Intent extras are supplied through the
1654 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1655 * schemes.
1656 *
1657 * @see #EXTRA_REFERRER
1658 */
1659 public static final String EXTRA_REFERRER_NAME
1660 = "android.intent.extra.REFERRER_NAME";
1661
1662 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001663 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001664 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001665 * Currently only a system app that hosts the provider authority "downloads" or holds the
1666 * permission {@link android.Manifest.permission.MANAGE_DOCUMENTS} can use this.
Ben Gruver37d83a32012-09-27 13:02:06 -07001667 * @hide
1668 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001669 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001670 public static final String EXTRA_ORIGINATING_UID
1671 = "android.intent.extra.ORIGINATING_UID";
1672
1673 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001674 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1675 * package. Tells the installer UI to skip the confirmation with the user
1676 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001677 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1678 * will no longer show an interstitial message about updating existing
1679 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001680 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001681 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001682 public static final String EXTRA_ALLOW_REPLACE
1683 = "android.intent.extra.ALLOW_REPLACE";
1684
1685 /**
1686 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1687 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1688 * return to the application the result code of the install/uninstall. The returned result
1689 * code will be {@link android.app.Activity#RESULT_OK} on success or
1690 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1691 */
1692 public static final String EXTRA_RETURN_RESULT
1693 = "android.intent.extra.RETURN_RESULT";
1694
1695 /**
1696 * Package manager install result code. @hide because result codes are not
1697 * yet ready to be exposed.
1698 */
1699 public static final String EXTRA_INSTALL_RESULT
1700 = "android.intent.extra.INSTALL_RESULT";
1701
1702 /**
1703 * Activity Action: Launch application uninstaller.
1704 * <p>
1705 * Input: The data must be a package: URI whose scheme specific part is
1706 * the package name of the current installed package to be uninstalled.
1707 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1708 * <p>
1709 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1710 * succeeded.
Philip P. Moltmannd9bb39a2017-09-05 12:41:15 -07001711 * <p>
1712 * Requires {@link android.Manifest.permission#REQUEST_DELETE_PACKAGES}
1713 * since {@link Build.VERSION_CODES#P}.
Philip P. Moltmannfe460102018-09-25 10:22:32 -07001714 *
1715 * @deprecated Use {@link android.content.pm.PackageInstaller#uninstall(String, IntentSender)}
1716 * instead
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001717 */
Philip P. Moltmannfe460102018-09-25 10:22:32 -07001718 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001719 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1720 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1721
1722 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001723 * Specify whether the package should be uninstalled for all users.
1724 * @hide because these should not be part of normal application flow.
1725 */
1726 public static final String EXTRA_UNINSTALL_ALL_USERS
1727 = "android.intent.extra.UNINSTALL_ALL_USERS";
1728
1729 /**
Varun Shahb9fd6be2018-10-22 19:16:33 -07001730 * A string that associates with a metadata entry, indicating the last run version of the
1731 * platform that was setup.
1732 *
1733 * @see #ACTION_UPGRADE_SETUP
1734 *
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001735 * @hide
1736 */
Varun Shahb9fd6be2018-10-22 19:16:33 -07001737 @SystemApi
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001738 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1739
Svet Ganov3695b8a2015-03-24 16:30:25 -07001740 /**
1741 * Activity action: Launch UI to manage the permissions of an app.
1742 * <p>
1743 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1744 * will be managed by the launched UI.
1745 * </p>
1746 * <p>
1747 * Output: Nothing.
1748 * </p>
1749 *
1750 * @see #EXTRA_PACKAGE_NAME
1751 *
1752 * @hide
1753 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001754 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001755 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1756 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1757 "android.intent.action.MANAGE_APP_PERMISSIONS";
1758
1759 /**
Philip P. Moltmanned988282018-11-07 16:19:42 -08001760 * Activity action: Launch UI to manage a specific permissions of an app.
1761 * <p>
1762 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permission
1763 * will be managed by the launched UI.
1764 * </p>
1765 * <p>
1766 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the (individual) permission
1767 * that should be managed by the launched UI.
1768 * </p>
1769 * <p>
1770 * Output: Nothing.
1771 * </p>
1772 *
1773 * @see #EXTRA_PACKAGE_NAME
1774 * @see #EXTRA_PERMISSION_NAME
1775 *
1776 * @hide
1777 */
1778 @SystemApi
1779 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1780 public static final String ACTION_MANAGE_APP_PERMISSION =
1781 "android.intent.action.MANAGE_APP_PERMISSION";
1782
1783 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001784 * Activity action: Launch UI to manage permissions.
1785 * <p>
1786 * Input: Nothing.
1787 * </p>
1788 * <p>
1789 * Output: Nothing.
1790 * </p>
1791 *
1792 * @hide
1793 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001794 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001795 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1796 public static final String ACTION_MANAGE_PERMISSIONS =
1797 "android.intent.action.MANAGE_PERMISSIONS";
1798
1799 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001800 * Activity action: Launch UI to review permissions for an app.
1801 * The system uses this intent if permission review for apps not
1802 * supporting the new runtime permissions model is enabled. In
1803 * this mode a permission review is required before any of the
1804 * app components can run.
1805 * <p>
1806 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1807 * permissions will be reviewed (mandatory).
1808 * </p>
1809 * <p>
1810 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1811 * be fired after the permission review (optional).
1812 * </p>
1813 * <p>
1814 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1815 * be invoked after the permission review (optional).
1816 * </p>
1817 * <p>
1818 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1819 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1820 * </p>
1821 * <p>
1822 * Output: Nothing.
1823 * </p>
1824 *
1825 * @see #EXTRA_PACKAGE_NAME
1826 * @see #EXTRA_INTENT
1827 * @see #EXTRA_REMOTE_CALLBACK
1828 * @see #EXTRA_RESULT_NEEDED
1829 *
1830 * @hide
1831 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001832 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001833 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1834 public static final String ACTION_REVIEW_PERMISSIONS =
1835 "android.intent.action.REVIEW_PERMISSIONS";
1836
1837 /**
1838 * Intent extra: A callback for reporting remote result as a bundle.
1839 * <p>
1840 * Type: IRemoteCallback
1841 * </p>
1842 *
1843 * @hide
1844 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001845 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001846 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1847
1848 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001849 * Intent extra: An app package name.
1850 * <p>
1851 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001852 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001853 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001854 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001855 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1856
1857 /**
Suprabh Shukla96212bc2018-04-10 15:04:51 -07001858 * Intent extra: A {@link Bundle} of extras for a package being suspended. Will be sent as an
1859 * extra with {@link #ACTION_MY_PACKAGE_SUSPENDED}.
1860 *
1861 * <p>The contents of this {@link Bundle} are a contract between the suspended app and the
1862 * suspending app, i.e. any app with the permission {@code android.permission.SUSPEND_APPS}.
1863 * This is meant to enable the suspended app to better handle the state of being suspended.
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07001864 *
1865 * @see #ACTION_MY_PACKAGE_SUSPENDED
1866 * @see #ACTION_MY_PACKAGE_UNSUSPENDED
1867 * @see PackageManager#isPackageSuspended()
1868 * @see PackageManager#getSuspendedPackageAppExtras()
1869 */
1870 public static final String EXTRA_SUSPENDED_PACKAGE_EXTRAS = "android.intent.extra.SUSPENDED_PACKAGE_EXTRAS";
1871
1872 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001873 * Intent extra: An app split name.
1874 * <p>
1875 * Type: String
1876 * </p>
Todd Kennedye5195dd2016-10-19 15:29:19 -07001877 */
Todd Kennedye5195dd2016-10-19 15:29:19 -07001878 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1879
1880 /**
Jeff Sharkey1a749422017-04-28 14:19:50 -06001881 * Intent extra: A {@link ComponentName} value.
1882 * <p>
1883 * Type: String
1884 * </p>
1885 */
1886 public static final String EXTRA_COMPONENT_NAME = "android.intent.extra.COMPONENT_NAME";
1887
1888 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001889 * Intent extra: An extra for specifying whether a result is needed.
1890 * <p>
1891 * Type: boolean
1892 * </p>
1893 *
1894 * @hide
1895 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001896 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001897 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1898
1899 /**
Suprabh Shukla19b41f32018-03-26 22:35:13 -07001900 * Intent extra: A {@link Bundle} of extras supplied for the launcher when any packages on
1901 * device are suspended. Will be sent with {@link #ACTION_PACKAGES_SUSPENDED}.
1902 *
1903 * @see PackageManager#isPackageSuspended()
1904 * @see #ACTION_PACKAGES_SUSPENDED
1905 *
1906 * @hide
1907 */
1908 public static final String EXTRA_LAUNCHER_EXTRAS = "android.intent.extra.LAUNCHER_EXTRAS";
1909
1910 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001911 * Activity action: Launch UI to manage which apps have a given permission.
1912 * <p>
Philip P. Moltmanned988282018-11-07 16:19:42 -08001913 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission group
1914 * which will be managed by the launched UI.
Svet Ganov3695b8a2015-03-24 16:30:25 -07001915 * </p>
1916 * <p>
1917 * Output: Nothing.
1918 * </p>
1919 *
1920 * @see #EXTRA_PERMISSION_NAME
1921 *
1922 * @hide
1923 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001924 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001925 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1926 public static final String ACTION_MANAGE_PERMISSION_APPS =
1927 "android.intent.action.MANAGE_PERMISSION_APPS";
1928
1929 /**
1930 * Intent extra: The name of a permission.
1931 * <p>
1932 * Type: String
1933 * </p>
1934 *
1935 * @hide
1936 */
1937 @SystemApi
1938 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1939
Joel Galenson13096ea2018-09-27 11:18:44 -07001940 /**
1941 * Activity action: Launch UI to review app uses of permissions.
1942 * <p>
1943 * Input: Nothing
1944 * </p>
1945 * <p>
1946 * Output: Nothing.
1947 * </p>
1948 *
1949 * @hide
1950 */
1951 @SystemApi
1952 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1953 public static final String ACTION_REVIEW_PERMISSION_USAGE =
1954 "android.intent.action.REVIEW_PERMISSION_USAGE";
1955
Joel Galenson78ec58d2018-10-24 10:06:25 -07001956 /**
1957 * Activity action: Launch UI to review uses of permissions for a single app.
1958 * <p>
1959 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1960 * permissions will be reviewed (mandatory).
1961 * </p>
1962 * <p>
1963 * Output: Nothing.
1964 * </p>
1965 * <p class="note">
1966 * This requires {@link android.Manifest.permission#GRANT_RUNTIME_PERMISSIONS} permission.
1967 * </p>
1968 *
1969 * @see #EXTRA_PACKAGE_NAME
1970 *
1971 * @hide
1972 */
1973 @SystemApi
1974 @RequiresPermission(android.Manifest.permission.GRANT_RUNTIME_PERMISSIONS)
1975 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1976 public static final String ACTION_REVIEW_APP_PERMISSION_USAGE =
1977 "android.intent.action.REVIEW_APP_PERMISSION_USAGE";
1978
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001979 // ---------------------------------------------------------------------
1980 // ---------------------------------------------------------------------
1981 // Standard intent broadcast actions (see action variable).
1982
1983 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001984 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1985 * <p>
1986 * For historical reasons, the name of this broadcast action refers to the power
1987 * state of the screen but it is actually sent in response to changes in the
1988 * overall interactive state of the device.
1989 * </p><p>
1990 * This broadcast is sent when the device becomes non-interactive which may have
1991 * nothing to do with the screen turning off. To determine the
1992 * actual state of the screen, use {@link android.view.Display#getState}.
1993 * </p><p>
1994 * See {@link android.os.PowerManager#isInteractive} for details.
1995 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001996 * You <em>cannot</em> receive this through components declared in
1997 * manifests, only by explicitly registering for it with
1998 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1999 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002000 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002001 * <p class="note">This is a protected intent that can only be sent
2002 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002003 */
2004 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2005 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07002006
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002007 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07002008 * Broadcast Action: Sent when the device wakes up and becomes interactive.
2009 * <p>
2010 * For historical reasons, the name of this broadcast action refers to the power
2011 * state of the screen but it is actually sent in response to changes in the
2012 * overall interactive state of the device.
2013 * </p><p>
2014 * This broadcast is sent when the device becomes interactive which may have
2015 * nothing to do with the screen turning on. To determine the
2016 * actual state of the screen, use {@link android.view.Display#getState}.
2017 * </p><p>
2018 * See {@link android.os.PowerManager#isInteractive} for details.
2019 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07002020 * You <em>cannot</em> receive this through components declared in
2021 * manifests, only by explicitly registering for it with
2022 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2023 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002024 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002025 * <p class="note">This is a protected intent that can only be sent
2026 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002027 */
2028 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2029 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07002030
2031 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07002032 * Broadcast Action: Sent after the system stops dreaming.
2033 *
2034 * <p class="note">This is a protected intent that can only be sent by the system.
2035 * It is only sent to registered receivers.</p>
2036 */
2037 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2038 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
2039
2040 /**
2041 * Broadcast Action: Sent after the system starts dreaming.
2042 *
2043 * <p class="note">This is a protected intent that can only be sent by the system.
2044 * It is only sent to registered receivers.</p>
2045 */
2046 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2047 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
2048
2049 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07002050 * Broadcast Action: Sent when the user is present after device wakes up (e.g when the
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07002051 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08002052 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002053 * <p class="note">This is a protected intent that can only be sent
2054 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07002055 */
2056 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002057 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07002058
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002059 /**
2060 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07002061 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04002062 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002063 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2064 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002065 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002066 * <p class="note">This is a protected intent that can only be sent
2067 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002068 */
2069 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2070 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
2071 /**
2072 * Broadcast Action: The time was set.
2073 */
2074 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2075 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
2076 /**
2077 * Broadcast Action: The date has changed.
2078 */
2079 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2080 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
2081 /**
2082 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
2083 * <ul>
2084 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
2085 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002086 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002087 * <p class="note">This is a protected intent that can only be sent
2088 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002089 */
2090 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2091 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
2092 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07002093 * Clear DNS Cache Action: This is broadcast when networks have changed and old
2094 * DNS entries should be tossed.
2095 * @hide
2096 */
2097 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2098 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
2099 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002100 * Alarm Changed Action: This is broadcast when the AlarmClock
2101 * application's alarm is set or unset. It is used by the
2102 * AlarmClock application and the StatusBar service.
2103 * @hide
2104 */
2105 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002106 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002107 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002108
2109 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002110 * Broadcast Action: This is broadcast once, after the user has finished
2111 * booting, but while still in the "locked" state. It can be used to perform
2112 * application-specific initialization, such as installing alarms. You must
2113 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
2114 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002115 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002116 * This broadcast is sent immediately at boot by all devices (regardless of
2117 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
2118 * higher. Upon receipt of this broadcast, the user is still locked and only
2119 * device-protected storage can be accessed safely. If you want to access
2120 * credential-protected storage, you need to wait for the user to be
2121 * unlocked (typically by entering their lock pattern or PIN for the first
2122 * time), after which the {@link #ACTION_USER_UNLOCKED} and
2123 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
2124 * <p>
2125 * To receive this broadcast, your receiver component must be marked as
2126 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002127 * <p class="note">
2128 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002129 *
2130 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002131 */
2132 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2133 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2134
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002135 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002136 * Broadcast Action: This is broadcast once, after the user has finished
2137 * booting. It can be used to perform application-specific initialization,
2138 * such as installing alarms. You must hold the
2139 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2140 * order to receive this broadcast.
2141 * <p>
2142 * This broadcast is sent at boot by all devices (both with and without
2143 * direct boot support). Upon receipt of this broadcast, the user is
2144 * unlocked and both device-protected and credential-protected storage can
2145 * accessed safely.
2146 * <p>
2147 * If you need to run while the user is still locked (before they've entered
2148 * their lock pattern or PIN for the first time), you can listen for the
2149 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2150 * <p class="note">
2151 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002152 */
2153 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002154 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002155 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002156
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002157 /**
2158 * Broadcast Action: This is broadcast when a user action should request a
2159 * temporary system dialog to dismiss. Some examples of temporary system
2160 * dialogs are the notification window-shade and the recent tasks dialog.
2161 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002162 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002163 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2164 /**
2165 * Broadcast Action: Trigger the download and eventual installation
2166 * of a package.
2167 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002168 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002169 * <p class="note">This is a protected intent that can only be sent
2170 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002171 *
2172 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002173 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002174 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002175 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2176 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2177 /**
Christopher Tate94b91db2017-04-19 15:49:17 -07002178 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002179 * device. The data contains the name of the package. Note that the
2180 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002181 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002182 * <ul>
Christopher Tate94b91db2017-04-19 15:49:17 -07002183 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2184 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002185 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2186 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002187 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002188 * <p class="note">This is a protected intent that can only be sent
2189 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002190 */
2191 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2192 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2193 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002194 * Broadcast Action: A new version of an application package has been
2195 * installed, replacing an existing version that was previously installed.
2196 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002197 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002198 * <ul>
2199 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2200 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002201 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002202 * <p class="note">This is a protected intent that can only be sent
2203 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002204 */
2205 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2206 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2207 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002208 * Broadcast Action: A new version of your application has been installed
2209 * over an existing one. This is only sent to the application that was
2210 * replaced. It does not contain any additional data; to receive it, just
2211 * use an intent filter for this action.
2212 *
2213 * <p class="note">This is a protected intent that can only be sent
2214 * by the system.
2215 */
2216 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2217 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2218 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002219 * Broadcast Action: An existing application package has been removed from
2220 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002221 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002222 * <ul>
2223 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2224 * to the package.
2225 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2226 * application -- data and code -- is being removed.
2227 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2228 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2229 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002230 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002231 * <p class="note">This is a protected intent that can only be sent
2232 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002233 */
2234 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2235 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2236 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002237 * Broadcast Action: An existing application package has been completely
2238 * removed from the device. The data contains the name of the package.
2239 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2240 * {@link #EXTRA_DATA_REMOVED} is true and
2241 * {@link #EXTRA_REPLACING} is false of that broadcast.
2242 *
2243 * <ul>
2244 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2245 * to the package.
2246 * </ul>
2247 *
2248 * <p class="note">This is a protected intent that can only be sent
2249 * by the system.
2250 */
2251 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2252 public static final String ACTION_PACKAGE_FULLY_REMOVED
2253 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2254 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002255 * Broadcast Action: An existing application package has been changed (for
2256 * example, a component has been enabled or disabled). The data contains
2257 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002258 * <ul>
2259 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002260 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002261 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002262 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2263 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002264 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002265 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002266 * <p class="note">This is a protected intent that can only be sent
2267 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002268 */
2269 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2270 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2271 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002272 * @hide
2273 * Broadcast Action: Ask system services if there is any reason to
2274 * restart the given package. The data contains the name of the
2275 * package.
2276 * <ul>
2277 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2278 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2279 * </ul>
2280 *
2281 * <p class="note">This is a protected intent that can only be sent
2282 * by the system.
2283 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002284 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002285 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2286 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2287 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002288 * Broadcast Action: The user has restarted a package, and all of its
2289 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002290 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002291 * be removed. Note that the restarted package does <em>not</em>
2292 * receive this broadcast.
2293 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002294 * <ul>
2295 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2296 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002297 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002298 * <p class="note">This is a protected intent that can only be sent
2299 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002300 */
2301 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2302 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2303 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002304 * Broadcast Action: The user has cleared the data of a package. This should
2305 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002306 * its persistent data is erased and this broadcast sent.
2307 * Note that the cleared package does <em>not</em>
2308 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002309 * <ul>
Svet Ganovf935a702017-08-22 12:15:58 -07002310 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package. If the
2311 * package whose data was cleared is an uninstalled instant app, then the UID
2312 * will be -1. The platform keeps some meta-data associated with instant apps
2313 * after they are uninstalled.
2314 * <li> {@link #EXTRA_PACKAGE_NAME} containing the package name only if the cleared
2315 * data was for an instant app.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002316 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002317 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002318 * <p class="note">This is a protected intent that can only be sent
2319 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002320 */
2321 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2322 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2323 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002324 * Broadcast Action: Packages have been suspended.
2325 * <p>Includes the following extras:
2326 * <ul>
2327 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
Julia Reynolds4bc42b92018-08-14 11:27:35 -04002328 * <li> {@link #EXTRA_CHANGED_UID_LIST} is the set of uids which have been suspended
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002329 * </ul>
2330 *
2331 * <p class="note">This is a protected intent that can only be sent
2332 * by the system. It is only sent to registered receivers.
2333 */
2334 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2335 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2336 /**
2337 * Broadcast Action: Packages have been unsuspended.
2338 * <p>Includes the following extras:
2339 * <ul>
2340 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
Julia Reynolds4bc42b92018-08-14 11:27:35 -04002341 * <li> {@link #EXTRA_CHANGED_UID_LIST} is the set of uids which have been unsuspended
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002342 * </ul>
2343 *
2344 * <p class="note">This is a protected intent that can only be sent
2345 * by the system. It is only sent to registered receivers.
2346 */
2347 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2348 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002349
2350 /**
2351 * Broadcast Action: Sent to a package that has been suspended by the system. This is sent
Suprabh Shukla19b41f32018-03-26 22:35:13 -07002352 * whenever a package is put into a suspended state or any of its app extras change while in the
2353 * suspended state.
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002354 * <p> Optionally includes the following extras:
2355 * <ul>
2356 * <li> {@link #EXTRA_SUSPENDED_PACKAGE_EXTRAS} which is a {@link Bundle} which will contain
2357 * useful information for the app being suspended.
2358 * </ul>
2359 * <p class="note">This is a protected intent that can only be sent
2360 * by the system. <em>This will be delivered to {@link BroadcastReceiver} components declared in
2361 * the manifest.</em>
2362 *
2363 * @see #ACTION_MY_PACKAGE_UNSUSPENDED
2364 * @see #EXTRA_SUSPENDED_PACKAGE_EXTRAS
2365 * @see PackageManager#isPackageSuspended()
2366 * @see PackageManager#getSuspendedPackageAppExtras()
2367 */
2368 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2369 public static final String ACTION_MY_PACKAGE_SUSPENDED = "android.intent.action.MY_PACKAGE_SUSPENDED";
2370
2371 /**
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002372 * Activity Action: Started to show more details about why an application was suspended.
2373 *
Suprabh Shukla3e03ab92018-04-11 16:03:49 -07002374 * <p>Whenever the system detects an activity launch for a suspended app, this action can
2375 * be used to show more details about the reason for suspension.
Suprabh Shukla96212bc2018-04-10 15:04:51 -07002376 *
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002377 * <p>Apps holding {@link android.Manifest.permission#SUSPEND_APPS} must declare an activity
2378 * handling this intent and protect it with
2379 * {@link android.Manifest.permission#SEND_SHOW_SUSPENDED_APP_DETAILS}.
2380 *
2381 * <p>Includes an extra {@link #EXTRA_PACKAGE_NAME} which is the name of the suspended package.
2382 *
2383 * <p class="note">This is a protected intent that can only be sent
2384 * by the system.
2385 *
Suprabh Shukla96212bc2018-04-10 15:04:51 -07002386 * @see PackageManager#setPackagesSuspended(String[], boolean, PersistableBundle,
2387 * PersistableBundle, String)
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002388 * @see PackageManager#isPackageSuspended()
2389 * @see #ACTION_PACKAGES_SUSPENDED
2390 *
2391 * @hide
2392 */
2393 @SystemApi
2394 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2395 public static final String ACTION_SHOW_SUSPENDED_APP_DETAILS =
2396 "android.intent.action.SHOW_SUSPENDED_APP_DETAILS";
2397
2398 /**
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002399 * Broadcast Action: Sent to a package that has been unsuspended.
2400 *
2401 * <p class="note">This is a protected intent that can only be sent
2402 * by the system. <em>This will be delivered to {@link BroadcastReceiver} components declared in
2403 * the manifest.</em>
2404 *
2405 * @see #ACTION_MY_PACKAGE_SUSPENDED
2406 * @see #EXTRA_SUSPENDED_PACKAGE_EXTRAS
2407 * @see PackageManager#isPackageSuspended()
2408 * @see PackageManager#getSuspendedPackageAppExtras()
2409 */
2410 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2411 public static final String ACTION_MY_PACKAGE_UNSUSPENDED = "android.intent.action.MY_PACKAGE_UNSUSPENDED";
2412
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002413 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002414 * Broadcast Action: A user ID has been removed from the system. The user
2415 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002416 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002417 * <p class="note">This is a protected intent that can only be sent
2418 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002419 */
2420 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2421 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002422
2423 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002424 * Broadcast Action: Sent to the installer package of an application when
2425 * that application is first launched (that is the first time it is moved
2426 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002427 *
2428 * <p class="note">This is a protected intent that can only be sent
2429 * by the system.
2430 */
2431 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2432 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2433
2434 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002435 * Broadcast Action: Sent to the system package verifier when a package
2436 * needs to be verified. The data contains the package URI.
2437 * <p class="note">
2438 * This is a protected intent that can only be sent by the system.
2439 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002440 */
2441 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2442 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2443
2444 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002445 * Broadcast Action: Sent to the system package verifier when a package is
2446 * verified. The data contains the package URI.
2447 * <p class="note">
2448 * This is a protected intent that can only be sent by the system.
2449 */
2450 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2451 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2452
2453 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002454 * Broadcast Action: Sent to the system intent filter verifier when an
2455 * intent filter needs to be verified. The data contains the filter data
2456 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002457 * <p class="note">
2458 * This is a protected intent that can only be sent by the system.
2459 * </p>
2460 *
2461 * @hide
2462 */
2463 @SystemApi
2464 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2465 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2466
2467 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002468 * Broadcast Action: Resources for a set of packages (which were
2469 * previously unavailable) are currently
2470 * available since the media on which they exist is available.
2471 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2472 * list of packages whose availability changed.
2473 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2474 * list of uids of packages whose availability changed.
2475 * Note that the
2476 * packages in this list do <em>not</em> receive this broadcast.
2477 * The specified set of packages are now available on the system.
2478 * <p>Includes the following extras:
2479 * <ul>
2480 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2481 * whose resources(were previously unavailable) are currently available.
2482 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2483 * packages whose resources(were previously unavailable)
2484 * are currently available.
2485 * </ul>
2486 *
2487 * <p class="note">This is a protected intent that can only be sent
2488 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002489 */
2490 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002491 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2492 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002493
2494 /**
2495 * Broadcast Action: Resources for a set of packages are currently
2496 * unavailable since the media on which they exist is unavailable.
2497 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2498 * list of packages whose availability changed.
2499 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2500 * list of uids of packages whose availability changed.
2501 * The specified set of packages can no longer be
2502 * launched and are practically unavailable on the system.
2503 * <p>Inclues the following extras:
2504 * <ul>
2505 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2506 * whose resources are no longer available.
2507 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2508 * whose resources are no longer available.
2509 * </ul>
2510 *
2511 * <p class="note">This is a protected intent that can only be sent
2512 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002513 */
2514 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002515 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002516 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002517
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002518 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002519 * Broadcast Action: preferred activities have changed *explicitly*.
2520 *
2521 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2522 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2523 * be sent.
2524 *
2525 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2526 *
2527 * @hide
2528 */
2529 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2530 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2531 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2532
2533
2534 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002535 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002536 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002537 * This should <em>only</em> be used to determine when the wallpaper
2538 * has changed to show the new wallpaper to the user. You should certainly
2539 * never, in response to this, change the wallpaper or other attributes of
2540 * it such as the suggested size. That would be crazy, right? You'd cause
2541 * all kinds of loops, especially if other apps are doing similar things,
2542 * right? Of course. So please don't do this.
2543 *
2544 * @deprecated Modern applications should use
2545 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2546 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2547 * shown behind their UI, rather than watching for this broadcast and
2548 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002549 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002550 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002551 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2552 /**
2553 * Broadcast Action: The current device {@link android.content.res.Configuration}
2554 * (orientation, locale, etc) has changed. When such a change happens, the
2555 * UIs (view hierarchy) will need to be rebuilt based on this new
2556 * information; for the most part, applications don't need to worry about
2557 * this, because the system will take care of stopping and restarting the
2558 * application to make sure it sees the new changes. Some system code that
2559 * can not be restarted will need to watch for this action and handle it
2560 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002561 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002562 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002563 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002564 * in manifests, only by explicitly registering for it with
2565 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2566 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002567 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002568 * <p class="note">This is a protected intent that can only be sent
2569 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002570 *
2571 * @see android.content.res.Configuration
2572 */
2573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2574 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
Adam Lesinski57fccd62018-01-25 13:03:57 -08002575
2576 /**
2577 * Broadcast Action: The current device {@link android.content.res.Configuration} has changed
2578 * such that the device may be eligible for the installation of additional configuration splits.
2579 * Configuration properties that can trigger this broadcast include locale and display density.
2580 *
2581 * <p class="note">
2582 * Unlike {@link #ACTION_CONFIGURATION_CHANGED}, you <em>can</em> receive this through
2583 * components declared in manifests. However, the receiver <em>must</em> hold the
2584 * {@link android.Manifest.permission#INSTALL_PACKAGES} permission.
2585 *
2586 * <p class="note">
2587 * This is a protected intent that can only be sent by the system.
2588 *
2589 * @hide
2590 */
2591 @SystemApi
2592 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2593 public static final String ACTION_SPLIT_CONFIGURATION_CHANGED =
2594 "android.intent.action.SPLIT_CONFIGURATION_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002595 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002596 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002597 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002598 * <p class="note">This is a protected intent that can only be sent
2599 * by the system.
2600 */
2601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2602 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2603 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002604 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2605 * charging state, level, and other information about the battery.
2606 * See {@link android.os.BatteryManager} for documentation on the
2607 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002608 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002609 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002610 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002611 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002612 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002613 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2614 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2615 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2616 * broadcasts that are sent and can be received through manifest
2617 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002618 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002619 * <p class="note">This is a protected intent that can only be sent
2620 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002621 */
2622 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2623 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
Fyodor Kupolov70e75432018-03-01 18:29:06 -08002624
2625
2626 /**
2627 * Broadcast Action: Sent when the current battery level changes.
2628 *
2629 * It has {@link android.os.BatteryManager#EXTRA_EVENTS} that carries a list of {@link Bundle}
2630 * instances representing individual battery level changes with associated
2631 * extras from {@link #ACTION_BATTERY_CHANGED}.
2632 *
2633 * <p class="note">
2634 * This broadcast requires {@link android.Manifest.permission#BATTERY_STATS} permission.
2635 *
2636 * @hide
2637 */
2638 @SystemApi
2639 public static final String ACTION_BATTERY_LEVEL_CHANGED =
2640 "android.intent.action.BATTERY_LEVEL_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002641 /**
2642 * Broadcast Action: Indicates low battery condition on the device.
2643 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002644 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002645 * <p class="note">This is a protected intent that can only be sent
2646 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002647 */
2648 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2649 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2650 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002651 * Broadcast Action: Indicates the battery is now okay after being low.
2652 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2653 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002654 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002655 * <p class="note">This is a protected intent that can only be sent
2656 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002657 */
2658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2659 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2660 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002661 * Broadcast Action: External power has been connected to the device.
2662 * This is intended for applications that wish to register specifically to this notification.
2663 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2664 * stay active to receive this notification. This action can be used to implement actions
2665 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002666 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002667 * <p class="note">This is a protected intent that can only be sent
2668 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002669 */
2670 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002671 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002672 /**
2673 * Broadcast Action: External power has been removed from the device.
2674 * This is intended for applications that wish to register specifically to this notification.
2675 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2676 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002677 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002678 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002679 * <p class="note">This is a protected intent that can only be sent
2680 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002681 */
2682 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002683 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002684 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002685 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002686 * Broadcast Action: Device is shutting down.
2687 * This is broadcast when the device is being shut down (completely turned
2688 * off, not sleeping). Once the broadcast is complete, the final shutdown
2689 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002690 * to handle this, since the foreground activity will be paused as well.
Fyodor Kupolov1fc62602018-02-01 15:48:53 -08002691 * <p>As of {@link Build.VERSION_CODES#P} this broadcast is only sent to receivers registered
2692 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2693 * Context.registerReceiver}.
Tom Taylord4a47292009-12-21 13:59:18 -08002694 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002695 * <p class="note">This is a protected intent that can only be sent
2696 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002697 * <p>May include the following extras:
2698 * <ul>
2699 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2700 * shutdown is only for userspace processes. If not set, assumed to be false.
2701 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002702 */
2703 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002704 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002705 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002706 * Activity Action: Start this activity to request system shutdown.
2707 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002708 * to request confirmation from the user before shutting down. The optional boolean
2709 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2710 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002711 *
2712 * <p class="note">This is a protected intent that can only be sent
2713 * by the system.
2714 *
2715 * {@hide}
2716 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002717 public static final String ACTION_REQUEST_SHUTDOWN
2718 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002719 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002720 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002721 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002722 * <p class="note">
2723 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002724 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002725 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2726 * or above, this broadcast will no longer be delivered to any
2727 * {@link BroadcastReceiver} defined in your manifest. Instead,
2728 * apps are strongly encouraged to use the improved
2729 * {@link Context#getCacheDir()} behavior so the system can
2730 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002731 */
2732 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002733 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002734 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2735 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002736 * Broadcast Action: Indicates low storage space condition on the device no
2737 * longer exists
2738 * <p class="note">
2739 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002740 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002741 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2742 * or above, this broadcast will no longer be delivered to any
2743 * {@link BroadcastReceiver} defined in your manifest. Instead,
2744 * apps are strongly encouraged to use the improved
2745 * {@link Context#getCacheDir()} behavior so the system can
2746 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002747 */
2748 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002749 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002750 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2751 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002752 * Broadcast Action: A sticky broadcast that indicates a storage space full
2753 * condition on the device. This is intended for activities that want to be
2754 * able to fill the data partition completely, leaving only enough free
2755 * space to prevent system-wide SQLite failures.
2756 * <p class="note">
2757 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002758 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002759 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2760 * or above, this broadcast will no longer be delivered to any
2761 * {@link BroadcastReceiver} defined in your manifest. Instead,
2762 * apps are strongly encouraged to use the improved
2763 * {@link Context#getCacheDir()} behavior so the system can
2764 * automatically free up storage when needed.
2765 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002766 */
2767 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002768 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002769 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2770 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002771 * Broadcast Action: Indicates storage space full condition on the device no
2772 * longer exists.
2773 * <p class="note">
2774 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002775 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002776 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2777 * or above, this broadcast will no longer be delivered to any
2778 * {@link BroadcastReceiver} defined in your manifest. Instead,
2779 * apps are strongly encouraged to use the improved
2780 * {@link Context#getCacheDir()} behavior so the system can
2781 * automatically free up storage when needed.
2782 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002783 */
2784 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002785 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002786 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2787 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002788 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2789 * and package management should be started.
2790 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2791 * notification.
2792 */
2793 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2794 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2795 /**
2796 * Broadcast Action: The device has entered USB Mass Storage mode.
2797 * This is used mainly for the USB Settings panel.
2798 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2799 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002800 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002801 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002802 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002803 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002804 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2805
2806 /**
2807 * Broadcast Action: The device has exited USB Mass Storage mode.
2808 * This is used mainly for the USB Settings panel.
2809 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2810 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002811 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002812 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002813 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002815 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2816
2817 /**
2818 * Broadcast Action: External media has been removed.
2819 * The path to the mount point for the removed media is contained in the Intent.mData field.
2820 */
2821 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2822 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2823
2824 /**
2825 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002826 * The path to the mount point for the unmounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002827 */
2828 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2829 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2830
2831 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002832 * Broadcast Action: External media is present, and being disk-checked
2833 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002834 */
2835 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2836 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2837
2838 /**
2839 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2840 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002841 */
2842 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2843 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2844
2845 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002846 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002847 * The path to the mount point for the mounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002848 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2849 * media was mounted read only.
2850 */
2851 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2852 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2853
2854 /**
2855 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002856 * The path to the mount point for the shared media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002857 */
2858 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2859 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2860
2861 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002862 * Broadcast Action: External media is no longer being shared via USB mass storage.
2863 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2864 *
2865 * @hide
2866 */
2867 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2868
2869 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002870 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2871 * The path to the mount point for the removed media is contained in the Intent.mData field.
2872 */
2873 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2874 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2875
2876 /**
2877 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002878 * The path to the mount point for the unmountable media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002879 */
2880 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2881 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2882
2883 /**
2884 * Broadcast Action: User has expressed the desire to remove the external storage media.
2885 * Applications should close all files they have open within the mount point when they receive this intent.
2886 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2887 */
2888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2889 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2890
2891 /**
2892 * Broadcast Action: The media scanner has started scanning a directory.
2893 * The path to the directory being scanned is contained in the Intent.mData field.
2894 */
2895 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2896 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2897
2898 /**
2899 * Broadcast Action: The media scanner has finished scanning a directory.
2900 * The path to the scanned directory is contained in the Intent.mData field.
2901 */
2902 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2903 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2904
2905 /**
2906 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2907 * The path to the file is contained in the Intent.mData field.
2908 */
2909 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2910 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2911
2912 /**
2913 * Broadcast Action: The "Media Button" was pressed. Includes a single
2914 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2915 * caused the broadcast.
2916 */
2917 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2918 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2919
2920 /**
2921 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2922 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2923 * caused the broadcast.
2924 */
2925 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2926 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2927
2928 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2929 // location; they are not general-purpose actions.
2930
2931 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002932 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002933 */
2934 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2935 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2936 "android.intent.action.GTALK_CONNECTED";
2937
2938 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002939 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002940 */
2941 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2942 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2943 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002944
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002945 /**
2946 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002947 */
2948 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2949 public static final String ACTION_INPUT_METHOD_CHANGED =
2950 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002951
2952 /**
2953 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2954 * more radios have been turned off or on. The intent will have the following extra value:</p>
2955 * <ul>
2956 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2957 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2958 * turned off</li>
2959 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002960 *
Peng Xua35b5532016-01-20 00:05:45 -08002961 * <p class="note">This is a protected intent that can only be sent by the system.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002962 */
2963 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2964 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2965
2966 /**
2967 * Broadcast Action: Some content providers have parts of their namespace
2968 * where they publish new events or items that the user may be especially
2969 * interested in. For these things, they may broadcast this action when the
2970 * set of interesting items change.
2971 *
2972 * For example, GmailProvider sends this notification when the set of unread
2973 * mail in the inbox changes.
2974 *
2975 * <p>The data of the intent identifies which part of which provider
2976 * changed. When queried through the content resolver, the data URI will
2977 * return the data set in question.
2978 *
2979 * <p>The intent will have the following extra values:
2980 * <ul>
2981 * <li><em>count</em> - The number of items in the data set. This is the
2982 * same as the number of items in the cursor returned by querying the
2983 * data URI. </li>
2984 * </ul>
2985 *
2986 * This intent will be sent at boot (if the count is non-zero) and when the
2987 * data set changes. It is possible for the data set to change without the
2988 * count changing (for example, if a new unread message arrives in the same
2989 * sync operation in which a message is archived). The phone should still
2990 * ring/vibrate/etc as normal in this case.
2991 */
2992 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2993 public static final String ACTION_PROVIDER_CHANGED =
2994 "android.intent.action.PROVIDER_CHANGED";
2995
2996 /**
2997 * Broadcast Action: Wired Headset plugged in or unplugged.
2998 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002999 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
3000 * and documentation.
3001 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07003002 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07003003 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003004 */
3005 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07003006 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07003007
3008 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07003009 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
3010 * <ul>
3011 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
3012 * </ul>
3013 *
3014 * <p class="note">This is a protected intent that can only be sent
3015 * by the system.
3016 *
3017 * @hide
3018 */
3019 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3020 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
3021 = "android.intent.action.ADVANCED_SETTINGS";
3022
3023 /**
Robin Lee66e5d962014-04-09 16:44:21 +01003024 * Broadcast Action: Sent after application restrictions are changed.
3025 *
3026 * <p class="note">This is a protected intent that can only be sent
3027 * by the system.</p>
3028 */
3029 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3030 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
3031 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
3032
3033 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003034 * Broadcast Action: An outgoing call is about to be placed.
3035 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07003036 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003037 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07003038 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003039 * the phone number originally intended to be dialed.</li>
3040 * </ul>
3041 * <p>Once the broadcast is finished, the resultData is used as the actual
3042 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07003043 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003044 * outgoing call in turn: for example, a parental control application
3045 * might verify that the user is authorized to place the call at that
3046 * time, then a number-rewriting application might add an area code if
3047 * one was not specified.</p>
3048 * <p>For consistency, any receiver whose purpose is to prohibit phone
3049 * calls should have a priority of 0, to ensure it will see the final
3050 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07003051 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003052 * should have a positive priority.
3053 * Negative priorities are reserved for the system for this broadcast;
3054 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07003055 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
3056 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003057 * <p>Emergency calls cannot be intercepted using this mechanism, and
3058 * other calls cannot be modified to call emergency numbers using this
3059 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07003060 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
3061 * call to use their own service instead. Those apps should first prevent
3062 * the call from being placed by setting resultData to <code>null</code>
3063 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07003064 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003065 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
3066 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08003067 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07003068 * <p class="note">This is a protected intent that can only be sent
3069 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003070 */
3071 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3072 public static final String ACTION_NEW_OUTGOING_CALL =
3073 "android.intent.action.NEW_OUTGOING_CALL";
3074
3075 /**
3076 * Broadcast Action: Have the device reboot. This is only for use by
3077 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08003078 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07003079 * <p class="note">This is a protected intent that can only be sent
3080 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003081 */
3082 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3083 public static final String ACTION_REBOOT =
3084 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003085
Wei Huang97ecc9c2009-05-11 17:44:20 -07003086 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08003087 * Broadcast Action: A sticky broadcast for changes in the physical
3088 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08003089 *
3090 * <p>The intent will have the following extra values:
3091 * <ul>
3092 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08003093 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08003094 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08003095 * <p>This is intended for monitoring the current physical dock state.
3096 * See {@link android.app.UiModeManager} for the normal API dealing with
3097 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07003098 */
3099 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3100 public static final String ACTION_DOCK_EVENT =
3101 "android.intent.action.DOCK_EVENT";
3102
3103 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08003104 * Broadcast Action: A broadcast when idle maintenance can be started.
3105 * This means that the user is not interacting with the device and is
3106 * not expected to do so soon. Typical use of the idle maintenance is
3107 * to perform somehow expensive tasks that can be postponed at a moment
3108 * when they will not degrade user experience.
3109 * <p>
3110 * <p class="note">In order to keep the device responsive in case of an
3111 * unexpected user interaction, implementations of a maintenance task
3112 * should be interruptible. In such a scenario a broadcast with action
3113 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
3114 * should not do the maintenance work in
3115 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
3116 * maintenance service by {@link Context#startService(Intent)}. Also
3117 * you should hold a wake lock while your maintenance service is running
3118 * to prevent the device going to sleep.
3119 * </p>
3120 * <p>
3121 * <p class="note">This is a protected intent that can only be sent by
3122 * the system.
3123 * </p>
3124 *
3125 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07003126 *
3127 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08003128 */
3129 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3130 public static final String ACTION_IDLE_MAINTENANCE_START =
3131 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
3132
3133 /**
3134 * Broadcast Action: A broadcast when idle maintenance should be stopped.
3135 * This means that the user was not interacting with the device as a result
3136 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
3137 * was sent and now the user started interacting with the device. Typical
3138 * use of the idle maintenance is to perform somehow expensive tasks that
3139 * can be postponed at a moment when they will not degrade user experience.
3140 * <p>
3141 * <p class="note">In order to keep the device responsive in case of an
3142 * unexpected user interaction, implementations of a maintenance task
3143 * should be interruptible. Hence, on receiving a broadcast with this
3144 * action, the maintenance task should be interrupted as soon as possible.
3145 * In other words, you should not do the maintenance work in
3146 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
3147 * maintenance service that was started on receiving of
3148 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
3149 * lock you acquired when your maintenance service started.
3150 * </p>
3151 * <p class="note">This is a protected intent that can only be sent
3152 * by the system.
3153 *
3154 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07003155 *
3156 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08003157 */
3158 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3159 public static final String ACTION_IDLE_MAINTENANCE_END =
3160 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
3161
3162 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003163 * Broadcast Action: a remote intent is to be broadcasted.
3164 *
3165 * A remote intent is used for remote RPC between devices. The remote intent
3166 * is serialized and sent from one device to another device. The receiving
3167 * device parses the remote intent and broadcasts it. Note that anyone can
3168 * broadcast a remote intent. However, if the intent receiver of the remote intent
3169 * does not trust intent broadcasts from arbitrary intent senders, it should require
3170 * the sender to hold certain permissions so only trusted sender's broadcast will be
3171 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07003172 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07003173 */
3174 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07003175 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07003176
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003177 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06003178 * Broadcast Action: This is broadcast once when the user is booting after a
3179 * system update. It can be used to perform cleanup or upgrades after a
3180 * system update.
3181 * <p>
3182 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
3183 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
3184 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
3185 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003186 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003187 * @hide
3188 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003189 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003190 public static final String ACTION_PRE_BOOT_COMPLETED =
3191 "android.intent.action.PRE_BOOT_COMPLETED";
3192
Amith Yamasani13593602012-03-22 16:16:17 -07003193 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003194 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003195 * on restricted users. The broadcast intent contains an extra
3196 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
3197 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
3198 * String[] depending on the restriction type.<p/>
3199 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07003200 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
3201 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
3202 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003203 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
3204 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003205 * @see RestrictionEntry
3206 */
3207 public static final String ACTION_GET_RESTRICTION_ENTRIES =
3208 "android.intent.action.GET_RESTRICTION_ENTRIES";
3209
3210 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003211 * Sent the first time a user is starting, to allow system apps to
3212 * perform one time initialization. (This will not be seen by third
3213 * party applications because a newly initialized user does not have any
3214 * third party applications installed for it.) This is sent early in
3215 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003216 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3217 * broadcast, since it is part of a visible user interaction; be as quick
3218 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003219 */
3220 public static final String ACTION_USER_INITIALIZE =
3221 "android.intent.action.USER_INITIALIZE";
3222
3223 /**
3224 * Sent when a user switch is happening, causing the process's user to be
3225 * brought to the foreground. This is only sent to receivers registered
3226 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3227 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003228 * foreground. This is sent as a foreground
3229 * broadcast, since it is part of a visible user interaction; be as quick
3230 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003231 */
3232 public static final String ACTION_USER_FOREGROUND =
3233 "android.intent.action.USER_FOREGROUND";
3234
3235 /**
3236 * Sent when a user switch is happening, causing the process's user to be
3237 * sent to the background. This is only sent to receivers registered
3238 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3239 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003240 * background. This is sent as a foreground
3241 * broadcast, since it is part of a visible user interaction; be as quick
3242 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003243 */
3244 public static final String ACTION_USER_BACKGROUND =
3245 "android.intent.action.USER_BACKGROUND";
3246
3247 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003248 * Broadcast sent to the system when a user is added. Carries an extra
3249 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3250 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003251 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003252 * @hide
3253 */
3254 public static final String ACTION_USER_ADDED =
3255 "android.intent.action.USER_ADDED";
3256
3257 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003258 * Broadcast sent by the system when a user is started. Carries an extra
3259 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003260 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003261 * that has been started. This is sent as a foreground
3262 * broadcast, since it is part of a visible user interaction; be as quick
3263 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003264 * @hide
3265 */
3266 public static final String ACTION_USER_STARTED =
3267 "android.intent.action.USER_STARTED";
3268
3269 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003270 * Broadcast sent when a user is in the process of starting. Carries an extra
3271 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3272 * sent to registered receivers, not manifest receivers. It is sent to all
3273 * users (including the one that is being started). You must hold
3274 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3275 * this broadcast. This is sent as a background broadcast, since
3276 * its result is not part of the primary UX flow; to safely keep track of
3277 * started/stopped state of a user you can use this in conjunction with
3278 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3279 * other user state broadcasts since those are foreground broadcasts so can
3280 * execute in a different order.
3281 * @hide
3282 */
3283 public static final String ACTION_USER_STARTING =
3284 "android.intent.action.USER_STARTING";
3285
3286 /**
3287 * Broadcast sent when a user is going to be stopped. Carries an extra
3288 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3289 * sent to registered receivers, not manifest receivers. It is sent to all
3290 * users (including the one that is being stopped). You must hold
3291 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3292 * this broadcast. The user will not stop until all receivers have
3293 * handled the broadcast. This is sent as a background broadcast, since
3294 * its result is not part of the primary UX flow; to safely keep track of
3295 * started/stopped state of a user you can use this in conjunction with
3296 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3297 * other user state broadcasts since those are foreground broadcasts so can
3298 * execute in a different order.
3299 * @hide
3300 */
3301 public static final String ACTION_USER_STOPPING =
3302 "android.intent.action.USER_STOPPING";
3303
3304 /**
3305 * Broadcast sent to the system when a user is stopped. Carries an extra
3306 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3307 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3308 * specific package. This is only sent to registered receivers, not manifest
3309 * receivers. It is sent to all running users <em>except</em> the one that
3310 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003311 * @hide
3312 */
3313 public static final String ACTION_USER_STOPPED =
3314 "android.intent.action.USER_STOPPED";
3315
3316 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003317 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003318 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003319 * one that has been removed. The user will not be completely removed until all receivers have
3320 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003321 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003322 * @hide
3323 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003324 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003325 public static final String ACTION_USER_REMOVED =
3326 "android.intent.action.USER_REMOVED";
3327
3328 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003329 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003330 * the userHandle of the user to become the current one. This is only sent to
3331 * registered receivers, not manifest receivers. It is sent to all running users.
3332 * You must hold
3333 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003334 * @hide
3335 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01003336 @UnsupportedAppUsage
Amith Yamasani13593602012-03-22 16:16:17 -07003337 public static final String ACTION_USER_SWITCHED =
3338 "android.intent.action.USER_SWITCHED";
3339
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003340 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003341 * Broadcast Action: Sent when the credential-encrypted private storage has
3342 * become unlocked for the target user. This is only sent to registered
3343 * receivers, not manifest receivers.
3344 */
3345 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3346 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3347
3348 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003349 * Broadcast sent to the system when a user's information changes. Carries an extra
3350 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003351 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003352 * @hide
3353 */
3354 public static final String ACTION_USER_INFO_CHANGED =
3355 "android.intent.action.USER_INFO_CHANGED";
3356
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003357 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003358 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3359 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003360 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3361 * that need to display merged content across both primary and managed profiles need to
3362 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003363 * not manifest receivers.
3364 */
3365 public static final String ACTION_MANAGED_PROFILE_ADDED =
3366 "android.intent.action.MANAGED_PROFILE_ADDED";
3367
3368 /**
3369 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003370 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3371 * Only applications (for example Launchers) that need to display merged content across both
3372 * primary and managed profiles need to worry about this broadcast. This is only sent to
3373 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003374 */
3375 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3376 "android.intent.action.MANAGED_PROFILE_REMOVED";
3377
3378 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003379 * Broadcast sent to the primary user when the credential-encrypted private storage for
3380 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3381 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3382 * Launchers) that need to display merged content across both primary and managed profiles
3383 * need to worry about this broadcast. This is only sent to registered receivers,
3384 * not manifest receivers.
3385 */
3386 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3387 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3388
3389 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003390 * Broadcast sent to the primary user when an associated managed profile has become available.
3391 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003392 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3393 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3394 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003395 */
Rubin Xue95057a2016-04-01 16:49:25 +01003396 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3397 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3398
3399 /**
3400 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3401 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3402 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3403 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3404 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3405 */
3406 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3407 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003408
3409 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003410 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3411 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3412 * the device was locked or unlocked.
3413 *
3414 * This is only sent to registered receivers.
3415 *
3416 * @hide
3417 */
3418 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3419 "android.intent.action.DEVICE_LOCKED_CHANGED";
3420
3421 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003422 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3423 */
3424 public static final String ACTION_QUICK_CLOCK =
3425 "android.intent.action.QUICK_CLOCK";
3426
Michael Wright0087a142013-02-05 16:29:39 -08003427 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003428 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003429 * @hide
3430 */
3431 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003432 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003433
Justin Kohd378ad72013-04-01 12:18:26 -07003434 /**
3435 * Broadcast Action: A global button was pressed. Includes a single
3436 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3437 * caused the broadcast.
3438 * @hide
3439 */
Sujith Ramakrishnan48e19c82017-04-24 15:57:58 -07003440 @SystemApi
Justin Kohd378ad72013-04-01 12:18:26 -07003441 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3442
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003443 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003444 * Broadcast Action: Sent when media resource is granted.
3445 * <p>
3446 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3447 * granted.
3448 * </p>
3449 * <p class="note">
3450 * This is a protected intent that can only be sent by the system.
3451 * </p>
3452 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003453 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003454 * </p>
3455 *
3456 * @hide
3457 */
3458 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3459 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3460
3461 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003462 * Broadcast Action: An overlay package has changed. The data contains the
3463 * name of the overlay package which has changed. This is broadcast on all
3464 * changes to the OverlayInfo returned by {@link
3465 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3466 * most common change is a state change that will change whether the
3467 * overlay is enabled or not.
3468 * @hide
3469 */
3470 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3471
3472 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003473 * Activity Action: Allow the user to select and return one or more existing
3474 * documents. When invoked, the system will display the various
3475 * {@link DocumentsProvider} instances installed on the device, letting the
3476 * user interactively navigate through them. These documents include local
3477 * media, such as photos and video, and documents provided by installed
3478 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003479 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003480 * Each document is represented as a {@code content://} URI backed by a
3481 * {@link DocumentsProvider}, which can be opened as a stream with
3482 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3483 * {@link android.provider.DocumentsContract.Document} metadata.
3484 * <p>
3485 * All selected documents are returned to the calling application with
3486 * persistable read and write permission grants. If you want to maintain
3487 * access to the documents across device reboots, you need to explicitly
3488 * take the persistable permissions using
3489 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3490 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003491 * Callers must indicate the acceptable document MIME types through
3492 * {@link #setType(String)}. For example, to select photos, use
3493 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3494 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3495 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003496 * <p>
3497 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003498 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3499 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003500 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003501 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3502 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003503 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003504 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003505 * Callers can set a document URI through
3506 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3507 * location of documents navigator. System will do its best to launch the
3508 * navigator in the specified document if it's a folder, or the folder that
3509 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003510 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003511 * Output: The URI of the item that was picked, returned in
3512 * {@link #getData()}. This must be a {@code content://} URI so that any
3513 * receiver can access it. If multiple documents were selected, they are
3514 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003515 *
3516 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003517 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003518 * @see #ACTION_CREATE_DOCUMENT
3519 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003520 */
3521 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3522 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3523
3524 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003525 * Activity Action: Allow the user to create a new document. When invoked,
3526 * the system will display the various {@link DocumentsProvider} instances
3527 * installed on the device, letting the user navigate through them. The
3528 * returned document may be a newly created document with no content, or it
3529 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003530 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003531 * Each document is represented as a {@code content://} URI backed by a
3532 * {@link DocumentsProvider}, which can be opened as a stream with
3533 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3534 * {@link android.provider.DocumentsContract.Document} metadata.
3535 * <p>
3536 * Callers must indicate the concrete MIME type of the document being
3537 * created by setting {@link #setType(String)}. This MIME type cannot be
3538 * changed after the document is created.
3539 * <p>
3540 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3541 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003542 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003543 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3544 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003545 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003546 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003547 * Callers can set a document URI through
3548 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3549 * location of documents navigator. System will do its best to launch the
3550 * navigator in the specified document if it's a folder, or the folder that
3551 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003552 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003553 * Output: The URI of the item that was created. This must be a
3554 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003555 *
3556 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003557 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003558 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003559 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003560 */
3561 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3562 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3563
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003564 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003565 * Activity Action: Allow the user to pick a directory subtree. When
3566 * invoked, the system will display the various {@link DocumentsProvider}
3567 * instances installed on the device, letting the user navigate through
3568 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003569 * <p>
3570 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003571 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3572 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3573 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003574 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003575 * Callers can set a document URI through
3576 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3577 * location of documents navigator. System will do its best to launch the
3578 * navigator in the specified document if it's a folder, or the folder that
3579 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003580 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003581 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003582 *
3583 * @see DocumentsContract
3584 */
3585 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003586 public static final String
3587 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003588
Abodunrinwa Toki4bad09c2018-10-25 18:12:28 +01003589
3590 /**
3591 * Activity Action: Perform text translation.
3592 * <p>
3593 * Input: {@link #EXTRA_TEXT getCharSequence(EXTRA_TEXT)} is the text to translate.
3594 * <p>
3595 * Output: nothing.
3596 */
3597 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3598 public static final String ACTION_TRANSLATE = "android.intent.action.TRANSLATE";
3599
Felipe Lemec7b1f892016-01-15 15:02:31 -08003600 /**
Peng Xua35b5532016-01-20 00:05:45 -08003601 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3602 * exisiting sensor being disconnected.
3603 *
3604 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3605 *
3606 * {@hide}
3607 */
3608 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3609 public static final String
3610 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3611
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003612 /**
Sam Line707f832017-04-13 17:00:55 -07003613 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003614 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003615 * @removed
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003616 */
3617 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003618 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003619 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3620
Christopher Tate6597e342015-02-17 12:15:25 -08003621 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003622 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3623 * is about to be performed.
3624 * @hide
3625 */
3626 @SystemApi
3627 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3628 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3629 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3630
3631 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003632 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3633 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3634 *
3635 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3636 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003637 * @hide
3638 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003639 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003640 public static final String EXTRA_FORCE_MASTER_CLEAR =
3641 "android.intent.extra.FORCE_MASTER_CLEAR";
3642
3643 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003644 * A broadcast action to trigger a factory reset.
3645 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003646 * <p>The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission. The
3647 * reason for the factory reset should be specified as {@link #EXTRA_REASON}.
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003648 *
3649 * <p>Not for use by third-party applications.
3650 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003651 * @see #EXTRA_FORCE_FACTORY_RESET
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003652 *
3653 * {@hide}
3654 */
3655 @SystemApi
3656 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3657 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3658
3659 /**
3660 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3661 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3662 *
3663 * <p>Not for use by third-party applications.
3664 *
3665 * @hide
3666 */
3667 @SystemApi
3668 public static final String EXTRA_FORCE_FACTORY_RESET =
3669 "android.intent.extra.FORCE_FACTORY_RESET";
3670
3671 /**
Michal Karpinski6135a262017-08-11 10:45:58 +01003672 * Broadcast action: report that a settings element is being restored from backup. The intent
3673 * contains four extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3674 * EXTRA_SETTING_NEW_VALUE is the value being restored, EXTRA_SETTING_PREVIOUS_VALUE
3675 * is the value of that settings entry prior to the restore operation, and
3676 * EXTRA_SETTING_RESTORED_FROM_SDK_INT is the version of the SDK that the setting has been
3677 * restored from (corresponds to {@link android.os.Build.VERSION#SDK_INT}). The first three
3678 * values are represented as strings, the fourth one as int.
Christopher Tate6597e342015-02-17 12:15:25 -08003679 *
3680 * <p>This broadcast is sent only for settings provider entries known to require special handling
3681 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3682 * the provider's backup agent implementation.
3683 *
3684 * @see #EXTRA_SETTING_NAME
3685 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3686 * @see #EXTRA_SETTING_NEW_VALUE
Michal Karpinski6135a262017-08-11 10:45:58 +01003687 * @see #EXTRA_SETTING_RESTORED_FROM_SDK_INT
Christopher Tate6597e342015-02-17 12:15:25 -08003688 * {@hide}
3689 */
3690 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3691
3692 /** {@hide} */
3693 public static final String EXTRA_SETTING_NAME = "setting_name";
3694 /** {@hide} */
3695 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3696 /** {@hide} */
3697 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
Michal Karpinski6135a262017-08-11 10:45:58 +01003698 /** {@hide} */
3699 public static final String EXTRA_SETTING_RESTORED_FROM_SDK_INT = "restored_from_sdk_int";
Christopher Tate6597e342015-02-17 12:15:25 -08003700
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003701 /**
3702 * Activity Action: Process a piece of text.
3703 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3704 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3705 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3706 */
3707 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3708 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003709
3710 /**
3711 * Broadcast Action: The sim card state has changed.
3712 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3713 * because TelephonyIntents is an internal class.
3714 * @hide
Amit Mahajan052e1e22018-01-12 17:40:29 -08003715 * @deprecated Use {@link #ACTION_SIM_CARD_STATE_CHANGED} or
3716 * {@link #ACTION_SIM_APPLICATION_STATE_CHANGED}
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003717 */
Amit Mahajan052e1e22018-01-12 17:40:29 -08003718 @Deprecated
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003719 @SystemApi
3720 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3721 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3722
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003723 /**
fionaxu90fee272017-03-31 12:45:12 -07003724 * Broadcast Action: indicate that the phone service state has changed.
3725 * The intent will have the following extra values:</p>
3726 * <p>
3727 * @see #EXTRA_VOICE_REG_STATE
3728 * @see #EXTRA_DATA_REG_STATE
3729 * @see #EXTRA_VOICE_ROAMING_TYPE
3730 * @see #EXTRA_DATA_ROAMING_TYPE
3731 * @see #EXTRA_OPERATOR_ALPHA_LONG
3732 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3733 * @see #EXTRA_OPERATOR_NUMERIC
3734 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3735 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3736 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3737 * @see #EXTRA_MANUAL
3738 * @see #EXTRA_VOICE_RADIO_TECH
3739 * @see #EXTRA_DATA_RADIO_TECH
3740 * @see #EXTRA_CSS_INDICATOR
3741 * @see #EXTRA_NETWORK_ID
3742 * @see #EXTRA_SYSTEM_ID
3743 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3744 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3745 * @see #EXTRA_EMERGENCY_ONLY
3746 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3747 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3748 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3749 *
3750 * <p class="note">
3751 * Requires the READ_PHONE_STATE permission.
3752 *
3753 * <p class="note">This is a protected intent that can only be sent by the system.
3754 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003755 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003756 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable} and the helper
3757 * functions {@code ServiceStateTable.getUriForSubscriptionIdAndField} and
3758 * {@code ServiceStateTable.getUriForSubscriptionId} to subscribe to changes to the ServiceState
3759 * for a given subscription id and field with a ContentObserver or using JobScheduler.
fionaxu90fee272017-03-31 12:45:12 -07003760 */
3761 @Deprecated
3762 @SystemApi
3763 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3764 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3765
3766 /**
3767 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3768 * state.
3769 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3770 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3771 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3772 * @see android.telephony.ServiceState#STATE_POWER_OFF
3773 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003774 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003775 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_REG_STATE}.
fionaxu90fee272017-03-31 12:45:12 -07003776 */
3777 @Deprecated
3778 @SystemApi
3779 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3780
3781 /**
3782 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3783 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3784 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3785 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3786 * @see android.telephony.ServiceState#STATE_POWER_OFF
3787 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003788 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003789 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_REG_STATE}.
fionaxu90fee272017-03-31 12:45:12 -07003790 */
3791 @Deprecated
3792 @SystemApi
3793 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3794
3795 /**
3796 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3797 * type.
3798 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003799 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003800 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_ROAMING_TYPE}.
fionaxu90fee272017-03-31 12:45:12 -07003801 */
3802 @Deprecated
3803 @SystemApi
3804 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3805
3806 /**
3807 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3808 * type.
3809 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003810 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003811 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_ROAMING_TYPE}.
fionaxu90fee272017-03-31 12:45:12 -07003812 */
3813 @Deprecated
3814 @SystemApi
3815 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3816
3817 /**
3818 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3819 * registered voice operator name in long alphanumeric format.
3820 * {@code null} if the operator name is not known or unregistered.
3821 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003822 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003823 * @deprecated Use
3824 * {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_ALPHA_LONG}.
fionaxu90fee272017-03-31 12:45:12 -07003825 */
3826 @Deprecated
3827 @SystemApi
3828 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3829
3830 /**
3831 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3832 * registered voice operator name in short alphanumeric format.
3833 * {@code null} if the operator name is not known or unregistered.
3834 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003835 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003836 * @deprecated Use
3837 * {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_ALPHA_SHORT}.
fionaxu90fee272017-03-31 12:45:12 -07003838 */
3839 @Deprecated
3840 @SystemApi
3841 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3842
3843 /**
3844 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3845 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3846 * network.
3847 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003848 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003849 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_NUMERIC}.
fionaxu90fee272017-03-31 12:45:12 -07003850 */
3851 @Deprecated
3852 @SystemApi
3853 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3854
3855 /**
3856 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3857 * registered data operator name in long alphanumeric format.
3858 * {@code null} if the operator name is not known or unregistered.
3859 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003860 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003861 * @deprecated Use
3862 * {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_ALPHA_LONG}.
fionaxu90fee272017-03-31 12:45:12 -07003863 */
3864 @Deprecated
3865 @SystemApi
3866 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3867
3868 /**
3869 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3870 * registered data operator name in short alphanumeric format.
3871 * {@code null} if the operator name is not known or unregistered.
3872 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003873 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003874 * @deprecated Use
3875 * {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_ALPHA_SHORT}.
fionaxu90fee272017-03-31 12:45:12 -07003876 */
3877 @Deprecated
3878 @SystemApi
3879 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3880
3881 /**
3882 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3883 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3884 * data operator.
3885 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003886 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003887 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_NUMERIC}.
fionaxu90fee272017-03-31 12:45:12 -07003888 */
3889 @Deprecated
3890 @SystemApi
3891 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3892
3893 /**
3894 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3895 * network selection mode is manual.
3896 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3897 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003898 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003899 * @deprecated Use
3900 * {@link android.provider.Telephony.ServiceStateTable#IS_MANUAL_NETWORK_SELECTION}.
fionaxu90fee272017-03-31 12:45:12 -07003901 */
3902 @Deprecated
3903 @SystemApi
3904 public static final String EXTRA_MANUAL = "manual";
3905
3906 /**
3907 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3908 * radio technology.
3909 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003910 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003911 * @deprecated Use
3912 * {@link android.provider.Telephony.ServiceStateTable#RIL_VOICE_RADIO_TECHNOLOGY}.
fionaxu90fee272017-03-31 12:45:12 -07003913 */
3914 @Deprecated
3915 @SystemApi
3916 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3917
3918 /**
3919 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3920 * radio technology.
3921 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003922 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003923 * @deprecated Use
3924 * {@link android.provider.Telephony.ServiceStateTable#RIL_DATA_RADIO_TECHNOLOGY}.
fionaxu90fee272017-03-31 12:45:12 -07003925 */
3926 @Deprecated
3927 @SystemApi
3928 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3929
3930 /**
3931 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3932 * support on CDMA network.
3933 * Will be {@code true} if support, {@code false} otherwise.
3934 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003935 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003936 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#CSS_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003937 */
3938 @Deprecated
3939 @SystemApi
3940 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3941
3942 /**
3943 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3944 * id. {@code Integer.MAX_VALUE} if unknown.
3945 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003946 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003947 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#NETWORK_ID}.
fionaxu90fee272017-03-31 12:45:12 -07003948 */
3949 @Deprecated
3950 @SystemApi
3951 public static final String EXTRA_NETWORK_ID = "networkId";
3952
3953 /**
3954 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3955 * {@code Integer.MAX_VALUE} if unknown.
3956 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003957 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003958 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#SYSTEM_ID}.
fionaxu90fee272017-03-31 12:45:12 -07003959 */
3960 @Deprecated
3961 @SystemApi
3962 public static final String EXTRA_SYSTEM_ID = "systemId";
3963
3964 /**
3965 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3966 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3967 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003968 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003969 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#CDMA_ROAMING_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003970 */
3971 @Deprecated
3972 @SystemApi
3973 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3974
3975 /**
3976 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3977 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3978 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003979 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003980 * @deprecated Use
3981 * {@link android.provider.Telephony.ServiceStateTable#CDMA_DEFAULT_ROAMING_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003982 */
3983 @Deprecated
3984 @SystemApi
3985 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3986
3987 /**
3988 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3989 * only mode.
3990 * {@code true} if in emergency only mode, {@code false} otherwise.
3991 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003992 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003993 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#IS_EMERGENCY_ONLY}.
fionaxu90fee272017-03-31 12:45:12 -07003994 */
3995 @Deprecated
3996 @SystemApi
3997 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3998
3999 /**
4000 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
4001 * registration state is roaming.
4002 * {@code true} if registration indicates roaming, {@code false} otherwise
4003 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06004004 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07004005 * @deprecated Use
4006 * {@link android.provider.Telephony.ServiceStateTable#IS_DATA_ROAMING_FROM_REGISTRATION}.
fionaxu90fee272017-03-31 12:45:12 -07004007 */
4008 @Deprecated
4009 @SystemApi
4010 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
4011 "isDataRoamingFromRegistration";
4012
4013 /**
4014 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
4015 * aggregation is in use.
4016 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
4017 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06004018 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07004019 * @deprecated Use
4020 * {@link android.provider.Telephony.ServiceStateTable#IS_USING_CARRIER_AGGREGATION}.
fionaxu90fee272017-03-31 12:45:12 -07004021 */
4022 @Deprecated
4023 @SystemApi
4024 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
4025
4026 /**
4027 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
4028 * is reduced from the rsrp threshold while calculating signal strength level.
4029 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06004030 * @removed
fionaxu90fee272017-03-31 12:45:12 -07004031 */
4032 @Deprecated
4033 @SystemApi
4034 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
4035
4036 /**
chen xu02811692018-10-03 19:07:09 -07004037 * An parcelable extra used with {@link #ACTION_SERVICE_STATE} representing the service state.
4038 * @hide
4039 */
4040 public static final String EXTRA_SERVICE_STATE = "android.intent.extra.SERVICE_STATE";
4041
4042 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01004043 * The name of the extra used to define the text to be processed, as a
4044 * CharSequence. Note that this may be a styled CharSequence, so you must use
4045 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00004046 */
4047 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
4048 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01004049 * 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 +00004050 */
4051 public static final String EXTRA_PROCESS_TEXT_READONLY =
4052 "android.intent.extra.PROCESS_TEXT_READONLY";
4053
Bryce Leebc58f592015-09-25 16:43:01 -07004054 /**
4055 * Broadcast action: reports when a new thermal event has been reached. When the device
4056 * is reaching its maximum temperatue, the thermal level reported
4057 * {@hide}
4058 */
4059 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
4060 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
4061
4062 /** {@hide} */
4063 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
4064
4065 /**
4066 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08004067 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07004068 * {@hide}
4069 */
4070 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
4071
4072 /**
4073 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08004074 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07004075 * {@hide}
4076 */
4077 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
4078
4079 /**
4080 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08004081 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07004082 * {@hide}
4083 */
4084 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
4085
lpeter318abc92018-05-04 16:13:14 +08004086 /**
4087 * Broadcast Action: Indicates the dock in idle state while device is docked.
4088 *
4089 * <p class="note">This is a protected intent that can only be sent
4090 * by the system.
4091 *
4092 * @hide
4093 */
4094 public static final String ACTION_DOCK_IDLE = "android.intent.action.DOCK_IDLE";
4095
4096 /**
4097 * Broadcast Action: Indicates the dock in active state while device is docked.
4098 *
4099 * <p class="note">This is a protected intent that can only be sent
4100 * by the system.
4101 *
4102 * @hide
4103 */
4104 public static final String ACTION_DOCK_ACTIVE = "android.intent.action.DOCK_ACTIVE";
4105
Bryce Leebc58f592015-09-25 16:43:01 -07004106
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004107 // ---------------------------------------------------------------------
4108 // ---------------------------------------------------------------------
4109 // Standard intent categories (see addCategory()).
4110
4111 /**
4112 * Set if the activity should be an option for the default action
4113 * (center press) to perform on a piece of data. Setting this will
4114 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04004115 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004116 * Intent when initiating an action -- it is for use in intent filters
4117 * specified in packages.
4118 */
4119 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4120 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
4121 /**
4122 * Activities that can be safely invoked from a browser must support this
4123 * category. For example, if the user is viewing a web page or an e-mail
4124 * and clicks on a link in the text, the Intent generated execute that
4125 * link will require the BROWSABLE category, so that only activities
4126 * supporting this category will be considered as possible actions. By
4127 * supporting this category, you are promising that there is nothing
4128 * damaging (without user intervention) that can happen by invoking any
4129 * matching Intent.
4130 */
4131 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4132 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
4133 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07004134 * Categories for activities that can participate in voice interaction.
4135 * An activity that supports this category must be prepared to run with
4136 * no UI shown at all (though in some case it may have a UI shown), and
4137 * rely on {@link android.app.VoiceInteractor} to interact with the user.
4138 */
4139 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4140 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
4141 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004142 * Set if the activity should be considered as an alternative action to
4143 * the data the user is currently viewing. See also
4144 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
4145 * applies to the selection in a list of items.
4146 *
4147 * <p>Supporting this category means that you would like your activity to be
4148 * displayed in the set of alternative things the user can do, usually as
4149 * part of the current activity's options menu. You will usually want to
4150 * include a specific label in the &lt;intent-filter&gt; of this action
4151 * describing to the user what it does.
4152 *
4153 * <p>The action of IntentFilter with this category is important in that it
4154 * describes the specific action the target will perform. This generally
4155 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
4156 * a specific name such as "com.android.camera.action.CROP. Only one
4157 * alternative of any particular action will be shown to the user, so using
4158 * a specific action like this makes sure that your alternative will be
4159 * displayed while also allowing other applications to provide their own
4160 * overrides of that particular action.
4161 */
4162 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4163 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
4164 /**
4165 * Set if the activity should be considered as an alternative selection
4166 * action to the data the user has currently selected. This is like
4167 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
4168 * of items from which the user can select, giving them alternatives to the
4169 * default action that will be performed on it.
4170 */
4171 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4172 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
4173 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004174 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004175 */
4176 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4177 public static final String CATEGORY_TAB = "android.intent.category.TAB";
4178 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004179 * Should be displayed in the top-level launcher.
4180 */
4181 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4182 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
4183 /**
Jose Lima38b75b62014-03-11 10:41:39 -07004184 * Indicates an activity optimized for Leanback mode, and that should
4185 * be displayed in the Leanback launcher.
4186 */
4187 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4188 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
4189 /**
Roberto Perez7ee1a7a2017-12-04 17:14:33 -08004190 * Indicates the preferred entry-point activity when an application is launched from a Car
4191 * launcher. If not present, Car launcher can optionally use {@link #CATEGORY_LAUNCHER} as a
4192 * fallback, or exclude the application entirely.
4193 * @hide
4194 */
4195 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4196 public static final String CATEGORY_CAR_LAUNCHER = "android.intent.category.CAR_LAUNCHER";
4197 /**
Jose Lima73915cf2014-07-29 17:16:31 -07004198 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
4199 * @hide
4200 */
4201 @SystemApi
4202 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
4203 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004204 * Provides information about the package it is in; typically used if
4205 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
4206 * a front-door to the user without having to be shown in the all apps list.
4207 */
4208 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4209 public static final String CATEGORY_INFO = "android.intent.category.INFO";
4210 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004211 * This is the home activity, that is the first activity that is displayed
4212 * when the device boots.
4213 */
4214 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4215 public static final String CATEGORY_HOME = "android.intent.category.HOME";
4216 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07004217 * This is the home activity that is displayed when the device is finished setting up and ready
4218 * for use.
4219 * @hide
4220 */
4221 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4222 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
4223 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07004224 * This is the setup wizard activity, that is the first activity that is displayed
4225 * when the user sets up the device for the first time.
4226 * @hide
4227 */
4228 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4229 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
4230 /**
Svet Ganov5bb6bc62017-08-28 12:39:35 -07004231 * This is the home activity, that is the activity that serves as the launcher app
4232 * from there the user can start other apps. Often components with lower/higher
4233 * priority intent filters handle the home intent, for example SetupWizard, to
4234 * setup the device and we need to be able to distinguish the home app from these
4235 * setup helpers.
4236 * @hide
4237 */
4238 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4239 public static final String CATEGORY_LAUNCHER_APP = "android.intent.category.LAUNCHER_APP";
4240 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004241 * This activity is a preference panel.
4242 */
4243 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4244 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
4245 /**
4246 * This activity is a development preference panel.
4247 */
4248 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4249 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
4250 /**
4251 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004252 */
4253 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4254 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
4255 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07004256 * This activity allows the user to browse and download new applications.
4257 */
4258 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4259 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
4260 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004261 * This activity may be exercised by the monkey or other automated test tools.
4262 */
4263 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4264 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
4265 /**
4266 * To be used as a test (not part of the normal user experience).
4267 */
4268 public static final String CATEGORY_TEST = "android.intent.category.TEST";
4269 /**
4270 * To be used as a unit test (run through the Test Harness).
4271 */
4272 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
4273 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004274 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004275 * experience).
4276 */
4277 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004278
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004279 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004280 * Used to indicate that an intent only wants URIs that can be opened with
4281 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
4282 * must support at least the columns defined in {@link OpenableColumns} when
4283 * queried.
4284 *
4285 * @see #ACTION_GET_CONTENT
4286 * @see #ACTION_OPEN_DOCUMENT
4287 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004288 */
4289 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4290 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
4291
4292 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09004293 * Used to indicate that an intent filter can accept files which are not necessarily
4294 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
4295 * at least streamable via
4296 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
4297 * using one of the stream types exposed via
4298 * {@link ContentResolver#getStreamTypes(Uri, String)}.
4299 *
4300 * @see #ACTION_SEND
4301 * @see #ACTION_SEND_MULTIPLE
4302 */
4303 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4304 public static final String CATEGORY_TYPED_OPENABLE =
4305 "android.intent.category.TYPED_OPENABLE";
4306
4307 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004308 * To be used as code under test for framework instrumentation tests.
4309 */
4310 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
4311 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04004312 /**
4313 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004314 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4315 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004316 */
4317 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4318 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
4319 /**
4320 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004321 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4322 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004323 */
4324 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4325 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004326 /**
4327 * An activity to run when device is inserted into a analog (low 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_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
4333
4334 /**
4335 * An activity to run when device is inserted into a digital (high end) dock.
4336 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4337 * information, see {@link android.app.UiModeManager}.
4338 */
4339 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4340 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004341
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004342 /**
4343 * Used to indicate that the activity can be used in a car environment.
4344 */
4345 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4346 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4347
Zak Cohendb6ca492017-01-26 14:09:00 -08004348 /**
4349 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4350 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4351 * information, see {@link android.app.UiModeManager}.
4352 */
4353 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4354 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004355 // ---------------------------------------------------------------------
4356 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004357 // Application launch intent categories (see addCategory()).
4358
4359 /**
4360 * Used with {@link #ACTION_MAIN} to launch the browser application.
4361 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004362 * <p>NOTE: This should not be used as the primary key of an Intent,
4363 * since it will not result in the app launching with the correct
4364 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004365 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004366 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004367 */
4368 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4369 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4370
4371 /**
4372 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4373 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004374 * <p>NOTE: This should not be used as the primary key of an Intent,
4375 * since it will not result in the app launching with the correct
4376 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004377 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004378 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004379 */
4380 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4381 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4382
4383 /**
4384 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4385 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004386 * <p>NOTE: This should not be used as the primary key of an Intent,
4387 * since it will not result in the app launching with the correct
4388 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004389 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004390 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004391 */
4392 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4393 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4394
4395 /**
4396 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4397 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004398 * <p>NOTE: This should not be used as the primary key of an Intent,
4399 * since it will not result in the app launching with the correct
4400 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004401 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004402 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004403 */
4404 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4405 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4406
4407 /**
4408 * Used with {@link #ACTION_MAIN} to launch the email application.
4409 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004410 * <p>NOTE: This should not be used as the primary key of an Intent,
4411 * since it will not result in the app launching with the correct
4412 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004413 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004414 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004415 */
4416 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4417 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4418
4419 /**
4420 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4421 * The activity should be able to view and manipulate image and video files
4422 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004423 * <p>NOTE: This should not be used as the primary key of an Intent,
4424 * since it will not result in the app launching with the correct
4425 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004426 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004427 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004428 */
4429 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4430 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4431
4432 /**
4433 * Used with {@link #ACTION_MAIN} to launch the maps application.
4434 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004435 * <p>NOTE: This should not be used as the primary key of an Intent,
4436 * since it will not result in the app launching with the correct
4437 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004438 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004439 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004440 */
4441 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4442 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4443
4444 /**
4445 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4446 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004447 * <p>NOTE: This should not be used as the primary key of an Intent,
4448 * since it will not result in the app launching with the correct
4449 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004450 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004451 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004452 */
4453 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4454 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4455
4456 /**
4457 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004458 * The activity should be able to play, browse, or manipulate music files
4459 * stored on the device.
4460 * <p>NOTE: This should not be used as the primary key of an Intent,
4461 * since it will not result in the app launching with the correct
4462 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004463 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004464 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004465 */
4466 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4467 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4468
4469 // ---------------------------------------------------------------------
4470 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004471 // Standard extra data keys.
4472
4473 /**
4474 * The initial data to place in a newly created record. Use with
4475 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4476 * fields as would be given to the underlying ContentProvider.insert()
4477 * call.
4478 */
4479 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4480
4481 /**
4482 * A constant CharSequence that is associated with the Intent, used with
4483 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4484 * this may be a styled CharSequence, so you must use
4485 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4486 * retrieve it.
4487 */
4488 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4489
4490 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004491 * A constant String that is associated with the Intent, used with
4492 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4493 * as HTML formatted text. Note that you <em>must</em> also supply
4494 * {@link #EXTRA_TEXT}.
4495 */
4496 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4497
4498 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004499 * A content: URI holding a stream of data associated with the Intent,
4500 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004501 */
4502 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4503
4504 /**
4505 * A String[] holding e-mail addresses that should be delivered to.
4506 */
4507 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4508
4509 /**
4510 * A String[] holding e-mail addresses that should be carbon copied.
4511 */
4512 public static final String EXTRA_CC = "android.intent.extra.CC";
4513
4514 /**
4515 * A String[] holding e-mail addresses that should be blind carbon copied.
4516 */
4517 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4518
4519 /**
4520 * A constant string holding the desired subject line of a message.
4521 */
4522 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4523
4524 /**
4525 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004526 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004527 */
4528 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4529
4530 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004531 * An int representing the user id to be used.
4532 *
4533 * @hide
4534 */
4535 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4536
4537 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004538 * An int representing the task id to be retrieved. This is used when a launch from recents is
4539 * intercepted by another action such as credentials confirmation to remember which task should
4540 * be resumed when complete.
4541 *
4542 * @hide
4543 */
4544 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4545
4546 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004547 * An Intent[] describing additional, alternate choices you would like shown with
4548 * {@link #ACTION_CHOOSER}.
4549 *
4550 * <p>An app may be capable of providing several different payload types to complete a
4551 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4552 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4553 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4554 * photo data or a hosted link where the photos can be viewed.</p>
4555 *
4556 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4557 * first/primary/preferred intent in the set. Additional intents specified in
4558 * this extra are ordered; by default intents that appear earlier in the array will be
4559 * preferred over intents that appear later in the array as matches for the same
4560 * target component. To alter this preference, a calling app may also supply
4561 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4562 */
4563 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4564
4565 /**
Adam Powell52c39212016-04-07 15:14:18 -07004566 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4567 * and omitted from a list of components presented to the user.
4568 *
4569 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4570 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4571 * from your own package or other apps from your organization if the idea of sending to those
4572 * targets would be redundant with other app functionality. Filtered components will not
4573 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4574 */
4575 public static final String EXTRA_EXCLUDE_COMPONENTS
4576 = "android.intent.extra.EXCLUDE_COMPONENTS";
4577
4578 /**
4579 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4580 * describing additional high-priority deep-link targets for the chooser to present to the user.
4581 *
4582 * <p>Targets provided in this way will be presented inline with all other targets provided
4583 * by services from other apps. They will be prioritized before other service targets, but
4584 * after those targets provided by sources that the user has manually pinned to the front.</p>
4585 *
4586 * @see #ACTION_CHOOSER
4587 */
4588 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4589
4590 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004591 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4592 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4593 *
4594 * <p>An app preparing an action for another app to complete may wish to allow the user to
4595 * disambiguate between several options for completing the action based on the chosen target
4596 * or otherwise refine the action before it is invoked.
4597 * </p>
4598 *
4599 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4600 * <ul>
4601 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4602 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4603 * chosen target beyond the first</li>
4604 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4605 * should fill in and send once the disambiguation is complete</li>
4606 * </ul>
4607 */
4608 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4609 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4610
4611 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004612 * An {@code ArrayList} of {@code String} annotations describing content for
4613 * {@link #ACTION_CHOOSER}.
4614 *
4615 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4616 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4617 *
4618 * <p>Annotations should describe the major components or topics of the content. It is up to
4619 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4620 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004621 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4622 * character. Performance on customized annotations can suffer, if they are rarely used for
4623 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4624 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004625 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004626 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004627 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004628 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004629 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004630 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004631 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004632 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004633 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004634 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4635 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4636 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4637 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4638 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004639 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004640 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4641 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004642 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004643 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004644 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004645 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004646 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004647 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004648 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004649 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004650 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004651 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004652 * Christmas and Thanksgiving.</li>
4653 * </ul>
4654 */
4655 public static final String EXTRA_CONTENT_ANNOTATIONS
4656 = "android.intent.extra.CONTENT_ANNOTATIONS";
4657
4658 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004659 * A {@link ResultReceiver} used to return data back to the sender.
4660 *
4661 * <p>Used to complete an app-specific
4662 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4663 *
4664 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4665 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4666 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4667 * when the user selects a target component from the chooser. It is up to the recipient
4668 * to send a result to this ResultReceiver to signal that disambiguation is complete
4669 * and that the chooser should invoke the user's choice.</p>
4670 *
4671 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4672 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4673 * to match and fill in the final Intent or ChooserTarget before starting it.
4674 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4675 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4676 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4677 *
4678 * <p>The result code passed to the ResultReceiver should be
4679 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4680 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4681 * the chooser should finish without starting a target.</p>
4682 */
4683 public static final String EXTRA_RESULT_RECEIVER
4684 = "android.intent.extra.RESULT_RECEIVER";
4685
4686 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004687 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004688 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004689 */
4690 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4691
4692 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004693 * A Parcelable[] of {@link Intent} or
4694 * {@link android.content.pm.LabeledIntent} objects as set with
4695 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4696 * a the front of the list of choices, when shown to the user with a
4697 * {@link #ACTION_CHOOSER}.
4698 */
4699 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4700
4701 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004702 * A {@link IntentSender} to start after instant app installation success.
Todd Kennedy7440f172015-12-09 14:31:22 -08004703 * @hide
4704 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004705 @SystemApi
4706 public static final String EXTRA_INSTANT_APP_SUCCESS =
4707 "android.intent.extra.INSTANT_APP_SUCCESS";
4708
4709 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004710 * A {@link IntentSender} to start after instant app installation failure.
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_FAILURE =
4715 "android.intent.extra.INSTANT_APP_FAILURE";
4716
4717 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004718 * The host name that triggered an instant app resolution.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004719 * @hide
4720 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004721 @SystemApi
4722 public static final String EXTRA_INSTANT_APP_HOSTNAME =
4723 "android.intent.extra.INSTANT_APP_HOSTNAME";
4724
4725 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004726 * An opaque token to track instant app resolution.
4727 * @hide
4728 */
4729 @SystemApi
4730 public static final String EXTRA_INSTANT_APP_TOKEN =
4731 "android.intent.extra.INSTANT_APP_TOKEN";
4732
4733 /**
Patrick Baumannb4165d72017-12-04 11:29:24 -08004734 * The action that triggered an instant application resolution.
4735 * @hide
4736 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004737 @SystemApi
Patrick Baumannb4165d72017-12-04 11:29:24 -08004738 public static final String EXTRA_INSTANT_APP_ACTION = "android.intent.extra.INSTANT_APP_ACTION";
4739
4740 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004741 * An array of {@link Bundle}s containing details about resolved instant apps..
4742 * @hide
4743 */
4744 @SystemApi
4745 public static final String EXTRA_INSTANT_APP_BUNDLES =
4746 "android.intent.extra.INSTANT_APP_BUNDLES";
4747
4748 /**
4749 * A {@link Bundle} of metadata that describes the instant application that needs to be
Patrick Baumann709ee152017-12-04 16:12:52 -08004750 * installed. This data is populated from the response to
4751 * {@link android.content.pm.InstantAppResolveInfo#getExtras()} as provided by the registered
4752 * instant application resolver.
4753 * @hide
4754 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004755 @SystemApi
Patrick Baumann709ee152017-12-04 16:12:52 -08004756 public static final String EXTRA_INSTANT_APP_EXTRAS =
4757 "android.intent.extra.INSTANT_APP_EXTRAS";
4758
4759 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004760 * A boolean value indicating that the instant app resolver was unable to state with certainty
4761 * that it did or did not have an app for the sanitized {@link Intent} defined at
4762 * {@link #EXTRA_INTENT}.
4763 * @hide
4764 */
4765 @SystemApi
4766 public static final String EXTRA_UNKNOWN_INSTANT_APP =
4767 "android.intent.extra.UNKNOWN_INSTANT_APP";
4768
4769 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004770 * The version code of the app to install components from.
Dianne Hackborn3accca02013-09-20 09:32:11 -07004771 * @deprecated Use {@link #EXTRA_LONG_VERSION_CODE).
Todd Kennedy316c2f22017-01-23 15:40:07 -08004772 * @hide
4773 */
Dianne Hackborn3accca02013-09-20 09:32:11 -07004774 @Deprecated
Todd Kennedy316c2f22017-01-23 15:40:07 -08004775 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4776
4777 /**
Dianne Hackborn3accca02013-09-20 09:32:11 -07004778 * The version code of the app to install components from.
4779 * @hide
4780 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004781 @SystemApi
Dianne Hackborn3accca02013-09-20 09:32:11 -07004782 public static final String EXTRA_LONG_VERSION_CODE = "android.intent.extra.LONG_VERSION_CODE";
4783
4784 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004785 * The app that triggered the instant app installation.
Chad Brubaker06068612017-04-06 09:43:47 -07004786 * @hide
4787 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004788 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004789 public static final String EXTRA_CALLING_PACKAGE
4790 = "android.intent.extra.CALLING_PACKAGE";
4791
4792 /**
4793 * Optional calling app provided bundle containing additional launch information the
4794 * installer may use.
4795 * @hide
4796 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004797 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004798 public static final String EXTRA_VERIFICATION_BUNDLE
4799 = "android.intent.extra.VERIFICATION_BUNDLE";
4800
4801 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004802 * A Bundle forming a mapping of potential target package names to different extras Bundles
4803 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4804 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4805 * be currently installed on the device.
4806 *
4807 * <p>An application may choose to provide alternate extras for the case where a user
4808 * selects an activity from a predetermined set of target packages. If the activity
4809 * the user selects from the chooser belongs to a package with its package name as
4810 * a key in this bundle, the corresponding extras for that package will be merged with
4811 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4812 * extra has the same key as an extra already present in the intent it will overwrite
4813 * the extra from the intent.</p>
4814 *
4815 * <p><em>Examples:</em>
4816 * <ul>
4817 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4818 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4819 * parameters for that target.</li>
4820 * <li>An application may offer additional metadata for known targets of a given intent
4821 * to pass along information only relevant to that target such as account or content
4822 * identifiers already known to that application.</li>
4823 * </ul></p>
4824 */
4825 public static final String EXTRA_REPLACEMENT_EXTRAS =
4826 "android.intent.extra.REPLACEMENT_EXTRAS";
4827
4828 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004829 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4830 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4831 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4832 * {@link ComponentName} of the chosen component.
4833 *
4834 * <p>In some situations this callback may never come, for example if the user abandons
4835 * the chooser, switches to another task or any number of other reasons. Apps should not
4836 * be written assuming that this callback will always occur.</p>
4837 */
4838 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4839 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4840
4841 /**
4842 * The {@link ComponentName} chosen by the user to complete an action.
4843 *
4844 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4845 */
4846 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4847
4848 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004849 * A {@link android.view.KeyEvent} object containing the event that
4850 * triggered the creation of the Intent it is in.
4851 */
4852 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4853
4854 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004855 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4856 * before shutting down.
4857 *
4858 * {@hide}
4859 */
4860 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4861
4862 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004863 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4864 * requested by the user.
4865 *
4866 * {@hide}
4867 */
4868 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4869 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4870
4871 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004872 * 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 -07004873 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4874 * of restarting the application.
4875 */
4876 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4877
4878 /**
4879 * A String holding the phone number originally entered in
4880 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4881 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4882 */
4883 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004884
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004885 /**
4886 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4887 * intents to supply the uid the package had been assigned. Also an optional
4888 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4889 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4890 * purpose.
4891 */
4892 public static final String EXTRA_UID = "android.intent.extra.UID";
4893
4894 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004895 * @hide String array of package names.
4896 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004897 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004898 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4899
4900 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004901 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4902 * intents to indicate whether this represents a full uninstall (removing
4903 * both the code and its data) or a partial uninstall (leaving its data,
4904 * implying that this is an update).
4905 */
4906 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004907
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004908 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004909 * @hide
4910 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4911 * intents to indicate that at this point the package has been removed for
4912 * all users on the device.
4913 */
4914 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4915 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4916
4917 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004918 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4919 * intents to indicate that this is a replacement of the package, so this
4920 * broadcast will immediately be followed by an add broadcast for a
4921 * different version of the same package.
4922 */
4923 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004924
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004925 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004926 * Used as an int extra field in {@link android.app.AlarmManager} intents
4927 * to tell the application being invoked how many pending alarms are being
4928 * delievered with the intent. For one-shot alarms this will always be 1.
4929 * For recurring alarms, this might be greater than 1 if the device was
4930 * asleep or powered off at the time an earlier alarm would have been
4931 * delivered.
4932 */
4933 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004934
Jacek Surazski86b6c532009-05-13 14:38:28 +02004935 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004936 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4937 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004938 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4939 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004940 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4941 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4942 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004943 */
4944 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4945
4946 /**
4947 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4948 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004949 */
4950 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4951
4952 /**
4953 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4954 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004955 */
4956 public static final int EXTRA_DOCK_STATE_DESK = 1;
4957
4958 /**
4959 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4960 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004961 */
4962 public static final int EXTRA_DOCK_STATE_CAR = 2;
4963
4964 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004965 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4966 * to represent that the phone is in a analog (low end) dock.
4967 */
4968 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4969
4970 /**
4971 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4972 * to represent that the phone is in a digital (high end) dock.
4973 */
4974 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4975
4976 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004977 * Boolean that can be supplied as meta-data with a dock activity, to
4978 * indicate that the dock should take over the home key when it is active.
4979 */
4980 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004981
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004982 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004983 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4984 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004985 */
4986 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4987
4988 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004989 * Used in the extra field in the remote intent. It's astring token passed with the
4990 * remote intent.
4991 */
4992 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4993 "android.intent.extra.remote_intent_token";
4994
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004995 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004996 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004997 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004998 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004999 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07005000 "android.intent.extra.changed_component_name";
5001
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07005002 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005003 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08005004 * and contains a string array of all of the components that have changed. If
5005 * the state of the overall package has changed, then it will contain an entry
5006 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08005007 */
5008 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
5009 "android.intent.extra.changed_component_name_list";
5010
5011 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005012 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08005013 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00005014 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
5015 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
5016 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005017 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005018 */
5019 public static final String EXTRA_CHANGED_PACKAGE_LIST =
5020 "android.intent.extra.changed_package_list";
5021
5022 /**
5023 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08005024 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
5025 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005026 * and contains an integer array of uids of all of the components
5027 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08005028 */
5029 public static final String EXTRA_CHANGED_UID_LIST =
5030 "android.intent.extra.changed_uid_list";
5031
5032 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07005033 * @hide
5034 * Magic extra system code can use when binding, to give a label for
5035 * who it is that has bound to a service. This is an integer giving
5036 * a framework string resource that can be displayed to the user.
5037 */
5038 public static final String EXTRA_CLIENT_LABEL =
5039 "android.intent.extra.client_label";
5040
5041 /**
5042 * @hide
5043 * Magic extra system code can use when binding, to give a PendingIntent object
5044 * that can be launched for the user to disable the system's use of this
5045 * service.
5046 */
5047 public static final String EXTRA_CLIENT_INTENT =
5048 "android.intent.extra.client_intent";
5049
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08005050 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005051 * Extra used to indicate that an intent should only return data that is on
5052 * the local device. This is a boolean extra; the default is false. If true,
5053 * an implementation should only allow the user to select data that is
5054 * already on the device, not requiring it be downloaded from a remote
5055 * service when opened.
5056 *
5057 * @see #ACTION_GET_CONTENT
5058 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07005059 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005060 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08005061 */
5062 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005063 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005064
Amith Yamasani13593602012-03-22 16:16:17 -07005065 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005066 * Extra used to indicate that an intent can allow the user to select and
5067 * return multiple items. This is a boolean extra; the default is false. If
5068 * true, an implementation is allowed to present the user with a UI where
5069 * they can pick multiple items that are all returned to the caller. When
5070 * this happens, they should be returned as the {@link #getClipData()} part
5071 * of the result Intent.
5072 *
5073 * @see #ACTION_GET_CONTENT
5074 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08005075 */
5076 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005077 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08005078
5079 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01005080 * The integer userHandle carried with broadcast intents related to addition, removal and
5081 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
5082 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
5083 *
Amith Yamasani13593602012-03-22 16:16:17 -07005084 * @hide
5085 */
Amith Yamasani2a003292012-08-14 18:25:45 -07005086 public static final String EXTRA_USER_HANDLE =
5087 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07005088
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005089 /**
Philip P. Moltmannc54c36d2018-10-08 15:51:07 -07005090 * The UserHandle carried with intents.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01005091 */
5092 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01005093 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01005094
5095 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005096 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07005097 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
5098 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005099 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07005100 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
5101
5102 /**
5103 * Extra sent in the intent to the BroadcastReceiver that handles
5104 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
5105 * the restrictions as key/value pairs.
5106 */
5107 public static final String EXTRA_RESTRICTIONS_BUNDLE =
5108 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005109
Amith Yamasani86118ba2013-03-28 14:33:16 -07005110 /**
5111 * Extra used in the response from a BroadcastReceiver that handles
5112 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
5113 */
5114 public static final String EXTRA_RESTRICTIONS_INTENT =
5115 "android.intent.extra.restrictions_intent";
5116
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07005117 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005118 * Extra used to communicate a set of acceptable MIME types. The type of the
5119 * extra is {@code String[]}. Values may be a combination of concrete MIME
5120 * types (such as "image/png") and/or partial MIME types (such as
5121 * "audio/*").
5122 *
5123 * @see #ACTION_GET_CONTENT
5124 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07005125 */
5126 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
5127
Dianne Hackborn57a7f592013-07-22 18:21:32 -07005128 /**
5129 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
5130 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07005131 * When this is true, hardware devices can use this information to determine that
5132 * they shouldn't do a complete shutdown of their device since this is not a
5133 * complete shutdown down to the kernel, but only user space restarting.
5134 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07005135 */
5136 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
5137 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
5138
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005139 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00005140 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
5141 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
5142 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
5143 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005144 *
5145 * @hide for internal use only.
5146 */
5147 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
5148 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00005149 /** @hide */
5150 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
5151 /** @hide */
5152 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
5153 /** @hide */
5154 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005155
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07005156 /**
5157 * Intent extra: the reason that the operation associated with this intent is being performed.
5158 *
5159 * <p>Type: String
5160 * @hide
5161 */
5162 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07005163 public static final String EXTRA_REASON = "android.intent.extra.REASON";
5164
qingxi240c2bb2017-04-12 17:31:18 -07005165 /**
5166 * {@hide}
5167 * This extra will be send together with {@link #ACTION_FACTORY_RESET}
5168 */
Rubin Xue8490f12015-06-25 12:17:48 +01005169 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
5170
Santos Cordon15a13782015-03-31 18:32:31 -07005171 /**
qingxi240c2bb2017-04-12 17:31:18 -07005172 * {@hide}
5173 * This extra will be set to true when the user choose to wipe the data on eSIM during factory
5174 * reset for the device with eSIM. This extra will be sent together with
5175 * {@link #ACTION_FACTORY_RESET}
5176 */
5177 public static final String EXTRA_WIPE_ESIMS = "com.android.internal.intent.extra.WIPE_ESIMS";
5178
5179 /**
Santos Cordon15a13782015-03-31 18:32:31 -07005180 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
5181 * activation request.
5182 * TODO: Add information about the structure and response data used with the pending intent.
5183 * @hide
5184 */
5185 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
5186 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
5187
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09005188 /**
5189 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09005190 *
5191 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07005192 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09005193 */
Steve McKay6eaf38632015-08-04 10:11:01 -07005194 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
5195
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005196 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09005197 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
5198 * such as opening in other apps, sharing, opening, editing, printing, deleting,
5199 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005200 *
5201 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07005202 * @see #ACTION_QUICK_VIEW
5203 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005204 */
Garfield Tance1d0e92017-03-23 10:52:48 -07005205 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09005206 public static final String EXTRA_QUICK_VIEW_ADVANCED =
5207 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005208
5209 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07005210 * An optional extra of {@code String[]} indicating which quick view features should be made
5211 * available to the user in the quick view UI while handing a
5212 * {@link Intent#ACTION_QUICK_VIEW} intent.
5213 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
5214 * Quick viewer can implement features not listed below.
5215 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
Geoffrey Pitschbc02b772017-12-06 11:24:15 -05005216 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DELETE},
5217 * {@link QuickViewConstants#FEATURE_DOWNLOAD}, {@link QuickViewConstants#FEATURE_SEND},
5218 * {@link QuickViewConstants#FEATURE_PRINT}.
Garfield Tance1d0e92017-03-23 10:52:48 -07005219 * <p>
5220 * Requirements:
5221 * <li>Quick viewer shouldn't show a feature if the feature is absent in
5222 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
5223 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
5224 * internal policies.
5225 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
5226 * requirement that the feature be shown. Quick viewer may, according to its own policies,
5227 * disable or hide features.
5228 *
5229 * @see #ACTION_QUICK_VIEW
5230 */
5231 public static final String EXTRA_QUICK_VIEW_FEATURES =
5232 "android.intent.extra.QUICK_VIEW_FEATURES";
5233
5234 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005235 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01005236 * When a profile goes into quiet mode, all apps in the profile are killed and the
5237 * profile user is stopped. Widgets originating from the profile are masked, and app
5238 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005239 */
5240 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005241
5242 /**
Amin Shaikh710d1232018-11-14 16:58:13 -05005243 * Optional CharSequence extra to provide a search query.
5244 *
5245 * <p>Applicable to {@link Intent} with actions:
5246 * <ul>
5247 * <li>{@link Intent#ACTION_GET_CONTENT}</li>
5248 * <li>{@link Intent#ACTION_OPEN_DOCUMENT}</li>
5249 * </ul>
5250 */
5251 public static final String EXTRA_CONTENT_QUERY = "android.intent.extra.CONTENT_QUERY";
5252
5253 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005254 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005255 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005256 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
5257 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005258 *
5259 * @hide
5260 */
5261 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
5262 "android.intent.extra.MEDIA_RESOURCE_TYPE";
5263
5264 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07005265 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
5266 * whether to show the chooser or not when there is only one application available
5267 * to choose from.
5268 *
5269 * @hide
5270 */
5271 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
5272 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
5273
5274 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005275 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005276 * to represent that a video codec is allowed to use.
5277 *
5278 * @hide
5279 */
5280 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
5281
5282 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005283 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005284 * to represent that a audio codec is allowed to use.
5285 *
5286 * @hide
5287 */
5288 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
5289
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005290 // ---------------------------------------------------------------------
5291 // ---------------------------------------------------------------------
5292 // Intent flags (see mFlags variable).
5293
Tor Norbyed9273d62013-05-30 15:59:53 -07005294 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005295 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005296 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
5297 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07005298 @Retention(RetentionPolicy.SOURCE)
5299 public @interface GrantUriMode {}
5300
Jeff Sharkey846318a2014-04-04 12:12:41 -07005301 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005302 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005303 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
5304 @Retention(RetentionPolicy.SOURCE)
5305 public @interface AccessUriMode {}
5306
5307 /**
5308 * Test if given mode flags specify an access mode, which must be at least
5309 * read and/or write.
5310 *
5311 * @hide
5312 */
5313 public static boolean isAccessUriMode(int modeFlags) {
5314 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
5315 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
5316 }
5317
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005318 /** @hide */
5319 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5320 FLAG_GRANT_READ_URI_PERMISSION,
5321 FLAG_GRANT_WRITE_URI_PERMISSION,
5322 FLAG_FROM_BACKGROUND,
5323 FLAG_DEBUG_LOG_RESOLUTION,
5324 FLAG_EXCLUDE_STOPPED_PACKAGES,
5325 FLAG_INCLUDE_STOPPED_PACKAGES,
5326 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
5327 FLAG_GRANT_PREFIX_URI_PERMISSION,
5328 FLAG_DEBUG_TRIAGED_MISSING,
5329 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005330 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005331 FLAG_ACTIVITY_NO_HISTORY,
5332 FLAG_ACTIVITY_SINGLE_TOP,
5333 FLAG_ACTIVITY_NEW_TASK,
5334 FLAG_ACTIVITY_MULTIPLE_TASK,
5335 FLAG_ACTIVITY_CLEAR_TOP,
5336 FLAG_ACTIVITY_FORWARD_RESULT,
5337 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5338 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5339 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5340 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5341 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5342 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5343 FLAG_ACTIVITY_NEW_DOCUMENT,
5344 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5345 FLAG_ACTIVITY_NO_USER_ACTION,
5346 FLAG_ACTIVITY_REORDER_TO_FRONT,
5347 FLAG_ACTIVITY_NO_ANIMATION,
5348 FLAG_ACTIVITY_CLEAR_TASK,
5349 FLAG_ACTIVITY_TASK_ON_HOME,
5350 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5351 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5352 FLAG_RECEIVER_REGISTERED_ONLY,
5353 FLAG_RECEIVER_REPLACE_PENDING,
5354 FLAG_RECEIVER_FOREGROUND,
5355 FLAG_RECEIVER_NO_ABORT,
5356 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5357 FLAG_RECEIVER_BOOT_UPGRADE,
5358 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5359 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5360 FLAG_RECEIVER_FROM_SHELL,
5361 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
Ng Zhi An150a6ba2018-08-13 09:08:11 -07005362 FLAG_RECEIVER_OFFLOAD,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005363 })
5364 @Retention(RetentionPolicy.SOURCE)
5365 public @interface Flags {}
5366
5367 /** @hide */
5368 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5369 FLAG_FROM_BACKGROUND,
5370 FLAG_DEBUG_LOG_RESOLUTION,
5371 FLAG_EXCLUDE_STOPPED_PACKAGES,
5372 FLAG_INCLUDE_STOPPED_PACKAGES,
5373 FLAG_DEBUG_TRIAGED_MISSING,
5374 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005375 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005376 FLAG_ACTIVITY_NO_HISTORY,
5377 FLAG_ACTIVITY_SINGLE_TOP,
5378 FLAG_ACTIVITY_NEW_TASK,
5379 FLAG_ACTIVITY_MULTIPLE_TASK,
5380 FLAG_ACTIVITY_CLEAR_TOP,
5381 FLAG_ACTIVITY_FORWARD_RESULT,
5382 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5383 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5384 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5385 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5386 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5387 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5388 FLAG_ACTIVITY_NEW_DOCUMENT,
5389 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5390 FLAG_ACTIVITY_NO_USER_ACTION,
5391 FLAG_ACTIVITY_REORDER_TO_FRONT,
5392 FLAG_ACTIVITY_NO_ANIMATION,
5393 FLAG_ACTIVITY_CLEAR_TASK,
5394 FLAG_ACTIVITY_TASK_ON_HOME,
5395 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5396 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5397 FLAG_RECEIVER_REGISTERED_ONLY,
5398 FLAG_RECEIVER_REPLACE_PENDING,
5399 FLAG_RECEIVER_FOREGROUND,
5400 FLAG_RECEIVER_NO_ABORT,
5401 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5402 FLAG_RECEIVER_BOOT_UPGRADE,
5403 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5404 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5405 FLAG_RECEIVER_FROM_SHELL,
5406 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
Ng Zhi An150a6ba2018-08-13 09:08:11 -07005407 FLAG_RECEIVER_OFFLOAD,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005408 })
5409 @Retention(RetentionPolicy.SOURCE)
5410 public @interface MutableFlags {}
5411
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005412 /**
5413 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005414 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005415 * specified in its ClipData. When applying to an Intent's ClipData,
5416 * all URIs as well as recursive traversals through data or other ClipData
5417 * in Intent items will be granted; only the grant flags of the top-level
5418 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005419 */
5420 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5421 /**
5422 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005423 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005424 * specified in its ClipData. When applying to an Intent's ClipData,
5425 * all URIs as well as recursive traversals through data or other ClipData
5426 * in Intent items will be granted; only the grant flags of the top-level
5427 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005428 */
5429 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5430 /**
5431 * Can be set by the caller to indicate that this Intent is coming from
5432 * a background operation, not from direct user interaction.
5433 */
5434 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5435 /**
5436 * A flag you can enable for debugging: when set, log messages will be
5437 * printed during the resolution of this intent to show you what has
5438 * been found to create the final resolved list.
5439 */
5440 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005441 /**
5442 * If set, this intent will not match any components in packages that
5443 * are currently stopped. If this is not set, then the default behavior
5444 * is to include such applications in the result.
5445 */
5446 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5447 /**
5448 * If set, this intent will always match any components in packages that
5449 * are currently stopped. This is the default behavior when
5450 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5451 * flags are set, this one wins (it allows overriding of exclude for
5452 * places where the framework may automatically set the exclude flag).
5453 */
5454 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005455
5456 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005457 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005458 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005459 * persisted across device reboots until explicitly revoked with
5460 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5461 * grant for possible persisting; the receiving application must call
5462 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5463 * actually persist.
5464 *
5465 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5466 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5467 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005468 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005469 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005470 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005471
5472 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005473 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5474 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5475 * applies to any URI that is a prefix match against the original granted
5476 * URI. (Without this flag, the URI must match exactly for access to be
5477 * granted.) Another URI is considered a prefix match only when scheme,
5478 * authority, and all path segments defined by the prefix are an exact
5479 * match.
5480 */
5481 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5482
5483 /**
Jeff Sharkeyc59a5e72018-06-21 19:14:58 -06005484 * Flag used to automatically match intents based on their Direct Boot
5485 * awareness and the current user state.
5486 * <p>
5487 * Since the default behavior is to automatically apply the current user
5488 * state, this is effectively a sentinel value that doesn't change the
5489 * output of any queries based on its presence or absence.
5490 * <p>
5491 * Instead, this value can be useful in conjunction with
5492 * {@link android.os.StrictMode.VmPolicy.Builder#detectImplicitDirectBoot()}
5493 * to detect when a caller is relying on implicit automatic matching,
5494 * instead of confirming the explicit behavior they want.
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005495 */
Jeff Sharkeyc59a5e72018-06-21 19:14:58 -06005496 public static final int FLAG_DIRECT_BOOT_AUTO = 0x00000100;
5497
5498 /** {@hide} */
5499 @Deprecated
5500 public static final int FLAG_DEBUG_TRIAGED_MISSING = FLAG_DIRECT_BOOT_AUTO;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005501
5502 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005503 * Internal flag used to indicate ephemeral applications should not be
5504 * considered when resolving the intent.
5505 *
5506 * @hide
5507 */
5508 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5509
5510 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005511 * If set, the new activity is not kept in the history stack. As soon as
5512 * the user navigates away from it, the activity is finished. This may also
5513 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5514 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005515 *
5516 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5517 * is never invoked when the current activity starts a new activity which
5518 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005519 */
5520 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5521 /**
5522 * If set, the activity will not be launched if it is already running
5523 * at the top of the history stack.
5524 */
5525 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5526 /**
5527 * If set, this activity will become the start of a new task on this
5528 * history stack. A task (from the activity that started it to the
5529 * next task activity) defines an atomic group of activities that the
5530 * user can move to. Tasks can be moved to the foreground and background;
5531 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005532 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005533 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5534 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005535 *
5536 * <p>This flag is generally used by activities that want
5537 * to present a "launcher" style behavior: they give the user a list of
5538 * separate things that can be done, which otherwise run completely
5539 * independently of the activity launching them.
5540 *
5541 * <p>When using this flag, if a task is already running for the activity
5542 * you are now starting, then a new activity will not be started; instead,
5543 * the current task will simply be brought to the front of the screen with
5544 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5545 * to disable this behavior.
5546 *
5547 * <p>This flag can not be used when the caller is requesting a result from
5548 * the activity being launched.
5549 */
5550 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5551 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005552 * This flag is used to create a new task and launch an activity into it.
5553 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5554 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5555 * search through existing tasks for ones matching this Intent. Only if no such
5556 * task is found would a new task be created. When paired with
5557 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5558 * the search for a matching task and unconditionally start a new task.
5559 *
5560 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5561 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005562 * top-level application launcher.</strong> Used in conjunction with
5563 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5564 * behavior of bringing an existing task to the foreground. When set,
5565 * a new task is <em>always</em> started to host the Activity for the
5566 * Intent, regardless of whether there is already an existing task running
5567 * the same thing.
5568 *
5569 * <p><strong>Because the default system does not include graphical task management,
5570 * you should not use this flag unless you provide some way for a user to
5571 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005572 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005573 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5574 * creating new document tasks.
5575 *
5576 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005577 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005578 *
Scott Main7aee61f2011-02-08 11:25:01 -08005579 * <p>See
5580 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5581 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005582 *
5583 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5584 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005585 */
5586 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5587 /**
5588 * If set, and the activity being launched is already running in the
5589 * current task, then instead of launching a new instance of that activity,
5590 * all of the other activities on top of it will be closed and this Intent
5591 * will be delivered to the (now on top) old activity as a new Intent.
5592 *
5593 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5594 * If D calls startActivity() with an Intent that resolves to the component
5595 * of activity B, then C and D will be finished and B receive the given
5596 * Intent, resulting in the stack now being: A, B.
5597 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005598 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005599 * either receive the new intent you are starting here in its
5600 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005601 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005602 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5603 * the same intent, then it will be finished and re-created; for all other
5604 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5605 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005606 *
5607 * <p>This launch mode can also be used to good effect in conjunction with
5608 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5609 * of a task, it will bring any currently running instance of that task
5610 * to the foreground, and then clear it to its root state. This is
5611 * especially useful, for example, when launching an activity from the
5612 * notification manager.
5613 *
Scott Main7aee61f2011-02-08 11:25:01 -08005614 * <p>See
5615 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5616 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005617 */
5618 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5619 /**
5620 * If set and this intent is being used to launch a new activity from an
5621 * existing one, then the reply target of the existing activity will be
kopriva219f7dc2018-10-09 13:42:28 -07005622 * transferred to the new activity. This way, the new activity can call
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005623 * {@link android.app.Activity#setResult} and have that result sent back to
5624 * the reply target of the original activity.
5625 */
5626 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5627 /**
5628 * If set and this intent is being used to launch a new activity from an
5629 * existing one, the current activity will not be counted as the top
5630 * activity for deciding whether the new intent should be delivered to
5631 * the top instead of starting a new one. The previous activity will
5632 * be used as the top, with the assumption being that the current activity
5633 * will finish itself immediately.
5634 */
5635 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5636 /**
5637 * If set, the new activity is not kept in the list of recently launched
5638 * activities.
5639 */
5640 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5641 /**
5642 * This flag is not normally set by application code, but set for you by
5643 * the system as described in the
5644 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5645 * launchMode} documentation for the singleTask mode.
5646 */
5647 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5648 /**
5649 * If set, and this activity is either being started in a new task or
5650 * bringing to the top an existing task, then it will be launched as
5651 * the front door of the task. This will result in the application of
5652 * any affinities needed to have that task in the proper state (either
5653 * moving activities to or from it), or simply resetting that task to
5654 * its initial state if needed.
5655 */
5656 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5657 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005658 * This flag is not normally set by application code, but set for you by
5659 * the system if this activity is being launched from history
5660 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005661 */
5662 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005663 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005664 * @deprecated As of API 21 this performs identically to
5665 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005666 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005667 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005668 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005669 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005670 * This flag is used to open a document into a new task rooted at the activity launched
5671 * by this Intent. Through the use of this flag, or its equivalent attribute,
5672 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005673 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005674 *
Craig Mautner026596b2014-05-21 15:35:44 -07005675 * <p>The use of the activity attribute form of this,
5676 * {@link android.R.attr#documentLaunchMode}, is
5677 * preferred over the Intent flag described here. The attribute form allows the
5678 * Activity to specify multiple document behavior for all launchers of the Activity
5679 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005680 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005681 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5682 * it is kept after the activity is finished is different than the use of
5683 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5684 * this flag is being used to create a new recents entry, then by default that entry
5685 * will be removed once the activity is finished. You can modify this behavior with
5686 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5687 *
Craig Mautner026596b2014-05-21 15:35:44 -07005688 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5689 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5690 * equivalent of the Activity manifest specifying {@link
5691 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5692 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5693 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005694 *
Craig Mautner026596b2014-05-21 15:35:44 -07005695 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005696 *
Craig Mautner026596b2014-05-21 15:35:44 -07005697 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005698 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5699 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005700 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005701 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005702 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005703 * callback from occurring on the current frontmost activity before it is
5704 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005705 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005706 * <p>Typically, an activity can rely on that callback to indicate that an
5707 * explicit user action has caused their activity to be moved out of the
5708 * foreground. The callback marks an appropriate point in the activity's
5709 * lifecycle for it to dismiss any notifications that it intends to display
5710 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005711 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005712 * <p>If an activity is ever started via any non-user-driven events such as
5713 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5714 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005715 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005716 */
5717 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005718 /**
5719 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5720 * this flag will cause the launched activity to be brought to the front of its
5721 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005722 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005723 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5724 * If D calls startActivity() with an Intent that resolves to the component
5725 * of activity B, then B will be brought to the front of the history stack,
5726 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005727 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005728 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005729 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005730 */
5731 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005732 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005733 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5734 * this flag will prevent the system from applying an activity transition
5735 * animation to go to the next activity state. This doesn't mean an
5736 * animation will never run -- if another activity change happens that doesn't
5737 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005738 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005739 * when you are going to do a series of activity operations but the
5740 * animation seen by the user shouldn't be driven by the first activity
5741 * change but rather a later one.
5742 */
5743 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5744 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005745 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5746 * this flag will cause any existing task that would be associated with the
5747 * activity to be cleared before the activity is started. That is, the activity
5748 * becomes the new root of an otherwise empty task, and any old activities
5749 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5750 */
5751 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5752 /**
5753 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5754 * this flag will cause a newly launching task to be placed on top of the current
5755 * home activity task (if there is one). That is, pressing back from the task
5756 * will always return the user to home even if that was not the last activity they
5757 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5758 */
5759 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5760 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005761 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5762 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005763 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005764 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005765 * this flag. When set and the task's activity is finished, the recents
5766 * entry will remain in the interface for the user to re-launch it, like a
5767 * recents entry for a top-level application.
5768 * <p>
5769 * The receiving activity can override this request with
5770 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5771 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005772 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005773 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005774 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005775
5776 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005777 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5778 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005779 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5780 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005781 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005782 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005783
Patrick Baumann577d4022018-01-31 16:55:10 +00005784
5785 /**
Patrick Baumann92ae2c62018-05-10 10:10:26 -07005786 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5787 * this flag will attempt to launch an instant app if no full app on the device can already
5788 * handle the intent.
5789 * <p>
5790 * When attempting to resolve instant apps externally, the following {@link Intent} properties
5791 * are supported:
5792 * <ul>
5793 * <li>{@link Intent#setAction(String)}</li>
5794 * <li>{@link Intent#addCategory(String)}</li>
5795 * <li>{@link Intent#setData(Uri)}</li>
5796 * <li>{@link Intent#setType(String)}</li>
5797 * <li>{@link Intent#setPackage(String)}</li>
5798 * <li>{@link Intent#addFlags(int)}</li>
5799 * </ul>
5800 * <p>
5801 * In the case that no instant app can be found, the installer will be launched to notify the
5802 * user that the intent could not be resolved. On devices that do not support instant apps,
5803 * the flag will be ignored.
Patrick Baumann577d4022018-01-31 16:55:10 +00005804 */
5805 public static final int FLAG_ACTIVITY_MATCH_EXTERNAL = 0x00000800;
5806
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005807 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005808 * If set, when sending a broadcast only registered receivers will be
5809 * called -- no BroadcastReceiver components will be launched.
5810 */
5811 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005812 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005813 * If set, when sending a broadcast the new broadcast will replace
5814 * any existing pending broadcast that matches it. Matching is defined
5815 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5816 * true for the intents of the two broadcasts. When a match is found,
5817 * the new broadcast (and receivers associated with it) will replace the
5818 * existing one in the pending broadcast list, remaining at the same
5819 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005820 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005821 * <p>This flag is most typically used with sticky broadcasts, which
5822 * only care about delivering the most recent values of the broadcast
5823 * to their receivers.
5824 */
5825 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5826 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005827 * If set, when sending a broadcast the recipient is allowed to run at
5828 * foreground priority, with a shorter timeout interval. During normal
5829 * broadcasts the receivers are not automatically hoisted out of the
5830 * background priority class.
5831 */
5832 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5833 /**
Ng Zhi An150a6ba2018-08-13 09:08:11 -07005834 * If set, when sending a broadcast the recipient will be run on the offload queue.
5835 *
5836 * @hide
5837 */
5838 public static final int FLAG_RECEIVER_OFFLOAD = 0x80000000;
5839 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005840 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5841 * They can still propagate results through to later receivers, but they can not prevent
5842 * later receivers from seeing the broadcast.
5843 */
5844 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5845 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005846 * If set, when sending a broadcast <i>before boot has completed</i> only
5847 * registered receivers will be called -- no BroadcastReceiver components
5848 * will be launched. Sticky intent state will be recorded properly even
5849 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5850 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005851 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005852 * <p>This flag is only for use by system sevices as a convenience to
5853 * avoid having to implement a more complex mechanism around detection
5854 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005855 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005856 * @hide
5857 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01005858 @UnsupportedAppUsage
Dianne Hackborn6285a322013-09-18 12:09:47 -07005859 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005860 /**
5861 * Set when this broadcast is for a boot upgrade, a special mode that
5862 * allows the broadcast to be sent before the system is ready and launches
5863 * the app process with no providers running in it.
5864 * @hide
5865 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005866 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005867 /**
5868 * If set, the broadcast will always go to manifest receivers in background (cached
5869 * or not running) apps, regardless of whether that would be done by default. By
5870 * default they will only receive broadcasts if the broadcast has specified an
5871 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005872 *
5873 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5874 * the broadcast code there must also be changed to match.
5875 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005876 * @hide
5877 */
5878 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5879 /**
5880 * If set, the broadcast will never go to manifest receivers in background (cached
5881 * or not running) apps, regardless of whether that would be done by default. By
5882 * default they will receive broadcasts if the broadcast has specified an
5883 * explicit component or package name.
5884 * @hide
5885 */
5886 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005887 /**
5888 * If set, this broadcast is being sent from the shell.
5889 * @hide
5890 */
5891 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005892
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005893 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005894 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5895 * will not receive broadcasts.
5896 *
5897 * <em>This flag has no effect when used by an Instant App.</em>
5898 */
5899 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5900
5901 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005902 * @hide Flags that can't be changed with PendingIntent.
5903 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005904 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5905 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5906 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005907
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005908 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005909 // ---------------------------------------------------------------------
5910 // toUri() and parseUri() options.
5911
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005912 /** @hide */
5913 @IntDef(flag = true, prefix = { "URI_" }, value = {
5914 URI_ALLOW_UNSAFE,
5915 URI_ANDROID_APP_SCHEME,
5916 URI_INTENT_SCHEME,
5917 })
5918 @Retention(RetentionPolicy.SOURCE)
5919 public @interface UriFlags {}
5920
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005921 /**
5922 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5923 * always has the "intent:" scheme. This syntax can be used when you want
5924 * to later disambiguate between URIs that are intended to describe an
5925 * Intent vs. all others that should be treated as raw URIs. When used
5926 * with {@link #parseUri}, any other scheme will result in a generic
5927 * VIEW action for that raw URI.
5928 */
5929 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005930
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005931 /**
5932 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5933 * always has the "android-app:" scheme. This is a variation of
5934 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5935 * http/https URI being delivered to a specific package name. The format
5936 * is:
5937 *
5938 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005939 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005940 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005941 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5942 * you must also include a scheme; including a path also requires both a host and a scheme.
5943 * The final #Intent; fragment can be used without a scheme, host, or path.
5944 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005945 * used with intents that have a {@link #setSelector}, since the base intent
5946 * will always have an explicit package name.</p>
5947 *
5948 * <p>Some examples of how this scheme maps to Intent objects:</p>
5949 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5950 * <colgroup align="left" />
5951 * <colgroup align="left" />
5952 * <thead>
5953 * <tr><th>URI</th> <th>Intent</th></tr>
5954 * </thead>
5955 *
5956 * <tbody>
5957 * <tr><td><code>android-app://com.example.app</code></td>
5958 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5959 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5960 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5961 * </table></td>
5962 * </tr>
5963 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5964 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5965 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5966 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5967 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5968 * </table></td>
5969 * </tr>
5970 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5971 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5972 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5973 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5974 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5975 * </table></td>
5976 * </tr>
5977 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5978 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5979 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5980 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5981 * </table></td>
5982 * </tr>
5983 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5984 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5985 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5986 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5987 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5988 * </table></td>
5989 * </tr>
5990 * <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>
5991 * <td><table border="" style="margin:0" >
5992 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5993 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5994 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5995 * </table></td>
5996 * </tr>
5997 * </tbody>
5998 * </table>
5999 */
6000 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
6001
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006002 /**
6003 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
6004 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
6005 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
6006 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
6007 * generated Intent can not cause unexpected data access to happen.
6008 *
6009 * <p>If you do not trust the source of the URI being parsed, you should still do further
6010 * processing to protect yourself from it. In particular, when using it to start an
6011 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
6012 * that can handle it.</p>
6013 */
6014 public static final int URI_ALLOW_UNSAFE = 1<<2;
6015
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006016 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006017
6018 private String mAction;
6019 private Uri mData;
6020 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006021 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006022 private ComponentName mComponent;
6023 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006024 private ArraySet<String> mCategories;
Mathew Inwood5c0d3542018-08-14 13:54:31 +01006025 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006026 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006027 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006028 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006029 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006030 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07006031 /** Token to track instant app launches. Local only; do not copy cross-process. */
6032 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006033
6034 // ---------------------------------------------------------------------
6035
Makoto Onuki97f82f22017-05-31 16:20:21 -07006036 private static final int COPY_MODE_ALL = 0;
6037 private static final int COPY_MODE_FILTER = 1;
6038 private static final int COPY_MODE_HISTORY = 2;
6039
6040 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07006041 @IntDef(prefix = { "COPY_MODE_" }, value = {
6042 COPY_MODE_ALL,
6043 COPY_MODE_FILTER,
6044 COPY_MODE_HISTORY
6045 })
Makoto Onuki97f82f22017-05-31 16:20:21 -07006046 @Retention(RetentionPolicy.SOURCE)
6047 public @interface CopyMode {}
6048
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006049 /**
6050 * Create an empty intent.
6051 */
6052 public Intent() {
6053 }
6054
6055 /**
6056 * Copy constructor.
6057 */
6058 public Intent(Intent o) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07006059 this(o, COPY_MODE_ALL);
6060 }
6061
6062 private Intent(Intent o, @CopyMode int copyMode) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006063 this.mAction = o.mAction;
6064 this.mData = o.mData;
6065 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006066 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006067 this.mComponent = o.mComponent;
Makoto Onuki97f82f22017-05-31 16:20:21 -07006068
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006069 if (o.mCategories != null) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07006070 this.mCategories = new ArraySet<>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006071 }
Makoto Onuki97f82f22017-05-31 16:20:21 -07006072
6073 if (copyMode != COPY_MODE_FILTER) {
6074 this.mFlags = o.mFlags;
6075 this.mContentUserHint = o.mContentUserHint;
6076 this.mLaunchToken = o.mLaunchToken;
6077 if (o.mSourceBounds != null) {
6078 this.mSourceBounds = new Rect(o.mSourceBounds);
6079 }
6080 if (o.mSelector != null) {
6081 this.mSelector = new Intent(o.mSelector);
6082 }
6083
6084 if (copyMode != COPY_MODE_HISTORY) {
6085 if (o.mExtras != null) {
6086 this.mExtras = new Bundle(o.mExtras);
6087 }
6088 if (o.mClipData != null) {
6089 this.mClipData = new ClipData(o.mClipData);
6090 }
6091 } else {
6092 if (o.mExtras != null && !o.mExtras.maybeIsEmpty()) {
6093 this.mExtras = Bundle.STRIPPED;
6094 }
6095
6096 // Also set "stripped" clip data when we ever log mClipData in the (broadcast)
6097 // history.
6098 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006099 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006100 }
6101
6102 @Override
6103 public Object clone() {
6104 return new Intent(this);
6105 }
6106
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006107 /**
6108 * Make a clone of only the parts of the Intent that are relevant for
6109 * filter matching: the action, data, type, component, and categories.
6110 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006111 public @NonNull Intent cloneFilter() {
Makoto Onuki97f82f22017-05-31 16:20:21 -07006112 return new Intent(this, COPY_MODE_FILTER);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006113 }
6114
6115 /**
6116 * Create an intent with a given action. All other fields (data, type,
6117 * class) are null. Note that the action <em>must</em> be in a
6118 * namespace because Intents are used globally in the system -- for
6119 * example the system VIEW action is android.intent.action.VIEW; an
6120 * application's custom action would be something like
6121 * com.google.app.myapp.CUSTOM_ACTION.
6122 *
6123 * @param action The Intent action, such as ACTION_VIEW.
6124 */
6125 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006126 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006127 }
6128
6129 /**
6130 * Create an intent with a given action and for a given data url. Note
6131 * that the action <em>must</em> be in a namespace because Intents are
6132 * used globally in the system -- for example the system VIEW action is
6133 * android.intent.action.VIEW; an application's custom action would be
6134 * something like com.google.app.myapp.CUSTOM_ACTION.
6135 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006136 * <p><em>Note: scheme and host name matching in the Android framework is
6137 * case-sensitive, unlike the formal RFC. As a result,
6138 * you should always ensure that you write your Uri with these elements
6139 * using lower case letters, and normalize any Uris you receive from
6140 * outside of Android to ensure the scheme and host is lower case.</em></p>
6141 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006142 * @param action The Intent action, such as ACTION_VIEW.
6143 * @param uri The Intent data URI.
6144 */
6145 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006146 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006147 mData = uri;
6148 }
6149
6150 /**
6151 * Create an intent for a specific component. All other fields (action, data,
6152 * type, class) are null, though they can be modified later with explicit
6153 * calls. This provides a convenient way to create an intent that is
6154 * intended to execute a hard-coded class name, rather than relying on the
6155 * system to find an appropriate class for you; see {@link #setComponent}
6156 * for more information on the repercussions of this.
6157 *
6158 * @param packageContext A Context of the application package implementing
6159 * this class.
6160 * @param cls The component class that is to be used for the intent.
6161 *
6162 * @see #setClass
6163 * @see #setComponent
6164 * @see #Intent(String, android.net.Uri , Context, Class)
6165 */
6166 public Intent(Context packageContext, Class<?> cls) {
6167 mComponent = new ComponentName(packageContext, cls);
6168 }
6169
6170 /**
6171 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07006172 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006173 * construct the Intent and then calling {@link #setClass} to set its
6174 * class.
6175 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006176 * <p><em>Note: scheme and host name matching in the Android framework is
6177 * case-sensitive, unlike the formal RFC. As a result,
6178 * you should always ensure that you write your Uri with these elements
6179 * using lower case letters, and normalize any Uris you receive from
6180 * outside of Android to ensure the scheme and host is lower case.</em></p>
6181 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006182 * @param action The Intent action, such as ACTION_VIEW.
6183 * @param uri The Intent data URI.
6184 * @param packageContext A Context of the application package implementing
6185 * this class.
6186 * @param cls The component class that is to be used for the intent.
6187 *
6188 * @see #Intent(String, android.net.Uri)
6189 * @see #Intent(Context, Class)
6190 * @see #setClass
6191 * @see #setComponent
6192 */
6193 public Intent(String action, Uri uri,
6194 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006195 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006196 mData = uri;
6197 mComponent = new ComponentName(packageContext, cls);
6198 }
6199
6200 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08006201 * Create an intent to launch the main (root) activity of a task. This
6202 * is the Intent that is started when the application's is launched from
6203 * Home. For anything else that wants to launch an application in the
6204 * same way, it is important that they use an Intent structured the same
6205 * way, and can use this function to ensure this is the case.
6206 *
6207 * <p>The returned Intent has the given Activity component as its explicit
6208 * component, {@link #ACTION_MAIN} as its action, and includes the
6209 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
6210 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
6211 * to do that through {@link #addFlags(int)} on the returned Intent.
6212 *
6213 * @param mainActivity The main activity component that this Intent will
6214 * launch.
6215 * @return Returns a newly created Intent that can be used to launch the
6216 * activity as a main application entry.
6217 *
6218 * @see #setClass
6219 * @see #setComponent
6220 */
6221 public static Intent makeMainActivity(ComponentName mainActivity) {
6222 Intent intent = new Intent(ACTION_MAIN);
6223 intent.setComponent(mainActivity);
6224 intent.addCategory(CATEGORY_LAUNCHER);
6225 return intent;
6226 }
6227
6228 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006229 * Make an Intent for the main activity of an application, without
6230 * specifying a specific activity to run but giving a selector to find
6231 * the activity. This results in a final Intent that is structured
6232 * the same as when the application is launched from
6233 * Home. For anything else that wants to launch an application in the
6234 * same way, it is important that they use an Intent structured the same
6235 * way, and can use this function to ensure this is the case.
6236 *
6237 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
6238 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
6239 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
6240 * to do that through {@link #addFlags(int)} on the returned Intent.
6241 *
6242 * @param selectorAction The action name of the Intent's selector.
6243 * @param selectorCategory The name of a category to add to the Intent's
6244 * selector.
6245 * @return Returns a newly created Intent that can be used to launch the
6246 * activity as a main application entry.
6247 *
6248 * @see #setSelector(Intent)
6249 */
6250 public static Intent makeMainSelectorActivity(String selectorAction,
6251 String selectorCategory) {
6252 Intent intent = new Intent(ACTION_MAIN);
6253 intent.addCategory(CATEGORY_LAUNCHER);
6254 Intent selector = new Intent();
6255 selector.setAction(selectorAction);
6256 selector.addCategory(selectorCategory);
6257 intent.setSelector(selector);
6258 return intent;
6259 }
6260
6261 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08006262 * Make an Intent that can be used to re-launch an application's task
6263 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
6264 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
6265 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
6266 *
6267 * @param mainActivity The activity component that is the root of the
6268 * task; this is the activity that has been published in the application's
6269 * manifest as the main launcher icon.
6270 *
6271 * @return Returns a newly created Intent that can be used to relaunch the
6272 * activity's task in its root state.
6273 */
6274 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
6275 Intent intent = makeMainActivity(mainActivity);
6276 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
6277 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
6278 return intent;
6279 }
6280
6281 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006282 * Call {@link #parseUri} with 0 flags.
6283 * @deprecated Use {@link #parseUri} instead.
6284 */
6285 @Deprecated
6286 public static Intent getIntent(String uri) throws URISyntaxException {
6287 return parseUri(uri, 0);
6288 }
Tom Taylord4a47292009-12-21 13:59:18 -08006289
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006290 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006291 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006292 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07006293 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006294 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006295 *
6296 * <p>The URI given here must not be relative -- that is, it must include
6297 * the scheme and full path.
6298 *
6299 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006300 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006301 *
6302 * @return Intent The newly created Intent object.
6303 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006304 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
6305 * it bad (as parsed by the Uri class) or the Intent data within the
6306 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08006307 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006308 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006309 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006310 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006311 int i = 0;
6312 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006313 final boolean androidApp = uri.startsWith("android-app:");
6314
6315 // Validate intent scheme if requested.
6316 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
6317 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006318 Intent intent = new Intent(ACTION_VIEW);
6319 try {
6320 intent.setData(Uri.parse(uri));
6321 } catch (IllegalArgumentException e) {
6322 throw new URISyntaxException(uri, e.getMessage());
6323 }
6324 return intent;
6325 }
6326 }
Tom Taylord4a47292009-12-21 13:59:18 -08006327
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006328 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006329 // simple case
6330 if (i == -1) {
6331 if (!androidApp) {
6332 return new Intent(ACTION_VIEW, Uri.parse(uri));
6333 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006334
6335 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006336 } else if (!uri.startsWith("#Intent;", i)) {
6337 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006338 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006339 } else {
6340 i = -1;
6341 }
6342 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006343
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006344 // new format
6345 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006346 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006347 boolean explicitAction = false;
6348 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006349
6350 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006351 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006352 String data;
6353 if (i >= 0) {
6354 data = uri.substring(0, i);
6355 i += 8; // length of "#Intent;"
6356 } else {
6357 data = uri;
6358 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006359
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006360 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006361 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006362 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006363 if (eq < 0) eq = i-1;
6364 int semi = uri.indexOf(';', i);
6365 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006366
6367 // action
6368 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006369 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006370 if (!inSelector) {
6371 explicitAction = true;
6372 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006373 }
6374
6375 // categories
6376 else if (uri.startsWith("category=", i)) {
6377 intent.addCategory(value);
6378 }
6379
6380 // type
6381 else if (uri.startsWith("type=", i)) {
6382 intent.mType = value;
6383 }
6384
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006385 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006386 else if (uri.startsWith("launchFlags=", i)) {
6387 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006388 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6389 intent.mFlags &= ~IMMUTABLE_FLAGS;
6390 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006391 }
6392
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006393 // package
6394 else if (uri.startsWith("package=", i)) {
6395 intent.mPackage = value;
6396 }
6397
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006398 // component
6399 else if (uri.startsWith("component=", i)) {
6400 intent.mComponent = ComponentName.unflattenFromString(value);
6401 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006402
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006403 // scheme
6404 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006405 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006406 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006407 } else {
6408 scheme = value;
6409 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006410 }
6411
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006412 // source bounds
6413 else if (uri.startsWith("sourceBounds=", i)) {
6414 intent.mSourceBounds = Rect.unflattenFromString(value);
6415 }
6416
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006417 // selector
6418 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
6419 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006420 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006421 }
6422
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006423 // extra
6424 else {
6425 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006426 // create Bundle if it doesn't already exist
6427 if (intent.mExtras == null) intent.mExtras = new Bundle();
6428 Bundle b = intent.mExtras;
6429 // add EXTRA
6430 if (uri.startsWith("S.", i)) b.putString(key, value);
6431 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
6432 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
6433 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
6434 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
6435 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
6436 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
6437 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
6438 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
6439 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
6440 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006441
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006442 // move to the next item
6443 i = semi + 1;
6444 }
6445
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006446 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006447 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006448 if (baseIntent.mPackage == null) {
6449 baseIntent.setSelector(intent);
6450 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006451 intent = baseIntent;
6452 }
6453
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006454 if (data != null) {
6455 if (data.startsWith("intent:")) {
6456 data = data.substring(7);
6457 if (scheme != null) {
6458 data = scheme + ':' + data;
6459 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006460 } else if (data.startsWith("android-app:")) {
6461 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
6462 // Correctly formed android-app, first part is package name.
6463 int end = data.indexOf('/', 14);
6464 if (end < 0) {
6465 // All we have is a package name.
6466 intent.mPackage = data.substring(14);
6467 if (!explicitAction) {
6468 intent.setAction(ACTION_MAIN);
6469 }
6470 data = "";
6471 } else {
6472 // Target the Intent at the given package name always.
6473 String authority = null;
6474 intent.mPackage = data.substring(14, end);
6475 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006476 if ((end+1) < data.length()) {
6477 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6478 // Found a scheme, remember it.
6479 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006480 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006481 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6482 // Found a authority, remember it.
6483 authority = data.substring(end+1, newEnd);
6484 end = newEnd;
6485 }
6486 } else {
6487 // All we have is a scheme.
6488 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006489 }
6490 }
6491 if (scheme == null) {
6492 // If there was no scheme, then this just targets the package.
6493 if (!explicitAction) {
6494 intent.setAction(ACTION_MAIN);
6495 }
6496 data = "";
6497 } else if (authority == null) {
6498 data = scheme + ":";
6499 } else {
6500 data = scheme + "://" + authority + data.substring(end);
6501 }
6502 }
6503 } else {
6504 data = "";
6505 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006506 }
Tom Taylord4a47292009-12-21 13:59:18 -08006507
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006508 if (data.length() > 0) {
6509 try {
6510 intent.mData = Uri.parse(data);
6511 } catch (IllegalArgumentException e) {
6512 throw new URISyntaxException(uri, e.getMessage());
6513 }
6514 }
6515 }
Tom Taylord4a47292009-12-21 13:59:18 -08006516
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006517 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006518
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006519 } catch (IndexOutOfBoundsException e) {
6520 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6521 }
6522 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006523
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006524 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006525 return getIntentOld(uri, 0);
6526 }
6527
6528 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006529 Intent intent;
6530
6531 int i = uri.lastIndexOf('#');
6532 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006533 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006534 final int intentFragmentStart = i;
6535 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006536
6537 i++;
6538
6539 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006540 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006541 i += 7;
6542 int j = uri.indexOf(')', i);
6543 action = uri.substring(i, j);
6544 i = j + 1;
6545 }
6546
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006547 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006548
6549 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006550 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006551 i += 11;
6552 int j = uri.indexOf(')', i);
6553 while (i < j) {
6554 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006555 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006556 if (i < sep) {
6557 intent.addCategory(uri.substring(i, sep));
6558 }
6559 i = sep + 1;
6560 }
6561 i = j + 1;
6562 }
6563
6564 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006565 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006566 i += 5;
6567 int j = uri.indexOf(')', i);
6568 intent.mType = uri.substring(i, j);
6569 i = j + 1;
6570 }
6571
6572 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006573 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006574 i += 12;
6575 int j = uri.indexOf(')', i);
6576 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006577 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6578 intent.mFlags &= ~IMMUTABLE_FLAGS;
6579 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006580 i = j + 1;
6581 }
6582
6583 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006584 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006585 i += 10;
6586 int j = uri.indexOf(')', i);
6587 int sep = uri.indexOf('!', i);
6588 if (sep >= 0 && sep < j) {
6589 String pkg = uri.substring(i, sep);
6590 String cls = uri.substring(sep + 1, j);
6591 intent.mComponent = new ComponentName(pkg, cls);
6592 }
6593 i = j + 1;
6594 }
6595
6596 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006597 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006598 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006599
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006600 final int closeParen = uri.indexOf(')', i);
6601 if (closeParen == -1) throw new URISyntaxException(uri,
6602 "EXTRA missing trailing ')'", i);
6603
6604 while (i < closeParen) {
6605 // fetch the key value
6606 int j = uri.indexOf('=', i);
6607 if (j <= i + 1 || i >= closeParen) {
6608 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6609 }
6610 char type = uri.charAt(i);
6611 i++;
6612 String key = uri.substring(i, j);
6613 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006614
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006615 // get type-value
6616 j = uri.indexOf('!', i);
6617 if (j == -1 || j >= closeParen) j = closeParen;
6618 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6619 String value = uri.substring(i, j);
6620 i = j;
6621
6622 // create Bundle if it doesn't already exist
6623 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006624
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006625 // add item to bundle
6626 try {
6627 switch (type) {
6628 case 'S':
6629 intent.mExtras.putString(key, Uri.decode(value));
6630 break;
6631 case 'B':
6632 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6633 break;
6634 case 'b':
6635 intent.mExtras.putByte(key, Byte.parseByte(value));
6636 break;
6637 case 'c':
6638 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6639 break;
6640 case 'd':
6641 intent.mExtras.putDouble(key, Double.parseDouble(value));
6642 break;
6643 case 'f':
6644 intent.mExtras.putFloat(key, Float.parseFloat(value));
6645 break;
6646 case 'i':
6647 intent.mExtras.putInt(key, Integer.parseInt(value));
6648 break;
6649 case 'l':
6650 intent.mExtras.putLong(key, Long.parseLong(value));
6651 break;
6652 case 's':
6653 intent.mExtras.putShort(key, Short.parseShort(value));
6654 break;
6655 default:
6656 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6657 }
6658 } catch (NumberFormatException e) {
6659 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6660 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006661
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006662 char ch = uri.charAt(i);
6663 if (ch == ')') break;
6664 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6665 i++;
6666 }
6667 }
6668
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006669 if (isIntentFragment) {
6670 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6671 } else {
6672 intent.mData = Uri.parse(uri);
6673 }
Tom Taylord4a47292009-12-21 13:59:18 -08006674
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006675 if (intent.mAction == null) {
6676 // By default, if no action is specified, then use VIEW.
6677 intent.mAction = ACTION_VIEW;
6678 }
6679
6680 } else {
6681 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6682 }
6683
6684 return intent;
6685 }
6686
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006687 /** @hide */
6688 public interface CommandOptionHandler {
6689 boolean handleOption(String opt, ShellCommand cmd);
6690 }
6691
6692 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01006693 @UnsupportedAppUsage
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006694 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6695 throws URISyntaxException {
6696 Intent intent = new Intent();
6697 Intent baseIntent = intent;
6698 boolean hasIntentInfo = false;
6699
6700 Uri data = null;
6701 String type = null;
6702
6703 String opt;
6704 while ((opt=cmd.getNextOption()) != null) {
6705 switch (opt) {
6706 case "-a":
6707 intent.setAction(cmd.getNextArgRequired());
6708 if (intent == baseIntent) {
6709 hasIntentInfo = true;
6710 }
6711 break;
6712 case "-d":
6713 data = Uri.parse(cmd.getNextArgRequired());
6714 if (intent == baseIntent) {
6715 hasIntentInfo = true;
6716 }
6717 break;
6718 case "-t":
6719 type = cmd.getNextArgRequired();
6720 if (intent == baseIntent) {
6721 hasIntentInfo = true;
6722 }
6723 break;
6724 case "-c":
6725 intent.addCategory(cmd.getNextArgRequired());
6726 if (intent == baseIntent) {
6727 hasIntentInfo = true;
6728 }
6729 break;
6730 case "-e":
6731 case "--es": {
6732 String key = cmd.getNextArgRequired();
6733 String value = cmd.getNextArgRequired();
6734 intent.putExtra(key, value);
6735 }
6736 break;
6737 case "--esn": {
6738 String key = cmd.getNextArgRequired();
6739 intent.putExtra(key, (String) null);
6740 }
6741 break;
6742 case "--ei": {
6743 String key = cmd.getNextArgRequired();
6744 String value = cmd.getNextArgRequired();
6745 intent.putExtra(key, Integer.decode(value));
6746 }
6747 break;
6748 case "--eu": {
6749 String key = cmd.getNextArgRequired();
6750 String value = cmd.getNextArgRequired();
6751 intent.putExtra(key, Uri.parse(value));
6752 }
6753 break;
6754 case "--ecn": {
6755 String key = cmd.getNextArgRequired();
6756 String value = cmd.getNextArgRequired();
6757 ComponentName cn = ComponentName.unflattenFromString(value);
6758 if (cn == null)
6759 throw new IllegalArgumentException("Bad component name: " + value);
6760 intent.putExtra(key, cn);
6761 }
6762 break;
6763 case "--eia": {
6764 String key = cmd.getNextArgRequired();
6765 String value = cmd.getNextArgRequired();
6766 String[] strings = value.split(",");
6767 int[] list = new int[strings.length];
6768 for (int i = 0; i < strings.length; i++) {
6769 list[i] = Integer.decode(strings[i]);
6770 }
6771 intent.putExtra(key, list);
6772 }
6773 break;
6774 case "--eial": {
6775 String key = cmd.getNextArgRequired();
6776 String value = cmd.getNextArgRequired();
6777 String[] strings = value.split(",");
6778 ArrayList<Integer> list = new ArrayList<>(strings.length);
6779 for (int i = 0; i < strings.length; i++) {
6780 list.add(Integer.decode(strings[i]));
6781 }
6782 intent.putExtra(key, list);
6783 }
6784 break;
6785 case "--el": {
6786 String key = cmd.getNextArgRequired();
6787 String value = cmd.getNextArgRequired();
6788 intent.putExtra(key, Long.valueOf(value));
6789 }
6790 break;
6791 case "--ela": {
6792 String key = cmd.getNextArgRequired();
6793 String value = cmd.getNextArgRequired();
6794 String[] strings = value.split(",");
6795 long[] list = new long[strings.length];
6796 for (int i = 0; i < strings.length; i++) {
6797 list[i] = Long.valueOf(strings[i]);
6798 }
6799 intent.putExtra(key, list);
6800 hasIntentInfo = true;
6801 }
6802 break;
6803 case "--elal": {
6804 String key = cmd.getNextArgRequired();
6805 String value = cmd.getNextArgRequired();
6806 String[] strings = value.split(",");
6807 ArrayList<Long> list = new ArrayList<>(strings.length);
6808 for (int i = 0; i < strings.length; i++) {
6809 list.add(Long.valueOf(strings[i]));
6810 }
6811 intent.putExtra(key, list);
6812 hasIntentInfo = true;
6813 }
6814 break;
6815 case "--ef": {
6816 String key = cmd.getNextArgRequired();
6817 String value = cmd.getNextArgRequired();
6818 intent.putExtra(key, Float.valueOf(value));
6819 hasIntentInfo = true;
6820 }
6821 break;
6822 case "--efa": {
6823 String key = cmd.getNextArgRequired();
6824 String value = cmd.getNextArgRequired();
6825 String[] strings = value.split(",");
6826 float[] list = new float[strings.length];
6827 for (int i = 0; i < strings.length; i++) {
6828 list[i] = Float.valueOf(strings[i]);
6829 }
6830 intent.putExtra(key, list);
6831 hasIntentInfo = true;
6832 }
6833 break;
6834 case "--efal": {
6835 String key = cmd.getNextArgRequired();
6836 String value = cmd.getNextArgRequired();
6837 String[] strings = value.split(",");
6838 ArrayList<Float> list = new ArrayList<>(strings.length);
6839 for (int i = 0; i < strings.length; i++) {
6840 list.add(Float.valueOf(strings[i]));
6841 }
6842 intent.putExtra(key, list);
6843 hasIntentInfo = true;
6844 }
6845 break;
6846 case "--esa": {
6847 String key = cmd.getNextArgRequired();
6848 String value = cmd.getNextArgRequired();
6849 // Split on commas unless they are preceeded by an escape.
6850 // The escape character must be escaped for the string and
6851 // again for the regex, thus four escape characters become one.
6852 String[] strings = value.split("(?<!\\\\),");
6853 intent.putExtra(key, strings);
6854 hasIntentInfo = true;
6855 }
6856 break;
6857 case "--esal": {
6858 String key = cmd.getNextArgRequired();
6859 String value = cmd.getNextArgRequired();
6860 // Split on commas unless they are preceeded by an escape.
6861 // The escape character must be escaped for the string and
6862 // again for the regex, thus four escape characters become one.
6863 String[] strings = value.split("(?<!\\\\),");
6864 ArrayList<String> list = new ArrayList<>(strings.length);
6865 for (int i = 0; i < strings.length; i++) {
6866 list.add(strings[i]);
6867 }
6868 intent.putExtra(key, list);
6869 hasIntentInfo = true;
6870 }
6871 break;
6872 case "--ez": {
6873 String key = cmd.getNextArgRequired();
6874 String value = cmd.getNextArgRequired().toLowerCase();
6875 // Boolean.valueOf() results in false for anything that is not "true", which is
6876 // error-prone in shell commands
6877 boolean arg;
6878 if ("true".equals(value) || "t".equals(value)) {
6879 arg = true;
6880 } else if ("false".equals(value) || "f".equals(value)) {
6881 arg = false;
6882 } else {
6883 try {
6884 arg = Integer.decode(value) != 0;
6885 } catch (NumberFormatException ex) {
6886 throw new IllegalArgumentException("Invalid boolean value: " + value);
6887 }
6888 }
6889
6890 intent.putExtra(key, arg);
6891 }
6892 break;
6893 case "-n": {
6894 String str = cmd.getNextArgRequired();
6895 ComponentName cn = ComponentName.unflattenFromString(str);
6896 if (cn == null)
6897 throw new IllegalArgumentException("Bad component name: " + str);
6898 intent.setComponent(cn);
6899 if (intent == baseIntent) {
6900 hasIntentInfo = true;
6901 }
6902 }
6903 break;
6904 case "-p": {
6905 String str = cmd.getNextArgRequired();
6906 intent.setPackage(str);
6907 if (intent == baseIntent) {
6908 hasIntentInfo = true;
6909 }
6910 }
6911 break;
6912 case "-f":
6913 String str = cmd.getNextArgRequired();
6914 intent.setFlags(Integer.decode(str).intValue());
6915 break;
6916 case "--grant-read-uri-permission":
6917 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6918 break;
6919 case "--grant-write-uri-permission":
6920 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6921 break;
6922 case "--grant-persistable-uri-permission":
6923 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6924 break;
6925 case "--grant-prefix-uri-permission":
6926 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6927 break;
6928 case "--exclude-stopped-packages":
6929 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6930 break;
6931 case "--include-stopped-packages":
6932 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6933 break;
6934 case "--debug-log-resolution":
6935 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6936 break;
6937 case "--activity-brought-to-front":
6938 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6939 break;
6940 case "--activity-clear-top":
6941 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6942 break;
6943 case "--activity-clear-when-task-reset":
6944 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6945 break;
6946 case "--activity-exclude-from-recents":
6947 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6948 break;
6949 case "--activity-launched-from-history":
6950 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6951 break;
6952 case "--activity-multiple-task":
6953 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6954 break;
6955 case "--activity-no-animation":
6956 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6957 break;
6958 case "--activity-no-history":
6959 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6960 break;
6961 case "--activity-no-user-action":
6962 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6963 break;
6964 case "--activity-previous-is-top":
6965 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6966 break;
6967 case "--activity-reorder-to-front":
6968 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6969 break;
6970 case "--activity-reset-task-if-needed":
6971 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6972 break;
6973 case "--activity-single-top":
6974 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6975 break;
6976 case "--activity-clear-task":
6977 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6978 break;
6979 case "--activity-task-on-home":
6980 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6981 break;
Patrick Baumann229141f2018-04-06 13:53:25 -07006982 case "--activity-match-external":
6983 intent.addFlags(Intent.FLAG_ACTIVITY_MATCH_EXTERNAL);
6984 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006985 case "--receiver-registered-only":
6986 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6987 break;
6988 case "--receiver-replace-pending":
6989 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6990 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006991 case "--receiver-foreground":
6992 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6993 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006994 case "--receiver-no-abort":
6995 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6996 break;
6997 case "--receiver-include-background":
6998 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6999 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007000 case "--selector":
7001 intent.setDataAndType(data, type);
7002 intent = new Intent();
7003 break;
7004 default:
7005 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
7006 // Okay, caller handled this option.
7007 } else {
7008 throw new IllegalArgumentException("Unknown option: " + opt);
7009 }
7010 break;
7011 }
7012 }
7013 intent.setDataAndType(data, type);
7014
7015 final boolean hasSelector = intent != baseIntent;
7016 if (hasSelector) {
7017 // A selector was specified; fix up.
7018 baseIntent.setSelector(intent);
7019 intent = baseIntent;
7020 }
7021
7022 String arg = cmd.getNextArg();
7023 baseIntent = null;
7024 if (arg == null) {
7025 if (hasSelector) {
7026 // If a selector has been specified, and no arguments
7027 // have been supplied for the main Intent, then we can
7028 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
7029 // need to have a component name specified yet, the
7030 // selector will take care of that.
7031 baseIntent = new Intent(Intent.ACTION_MAIN);
7032 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
7033 }
7034 } else if (arg.indexOf(':') >= 0) {
7035 // The argument is a URI. Fully parse it, and use that result
7036 // to fill in any data not specified so far.
7037 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
7038 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
7039 } else if (arg.indexOf('/') >= 0) {
7040 // The argument is a component name. Build an Intent to launch
7041 // it.
7042 baseIntent = new Intent(Intent.ACTION_MAIN);
7043 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
7044 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
7045 } else {
7046 // Assume the argument is a package name.
7047 baseIntent = new Intent(Intent.ACTION_MAIN);
7048 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
7049 baseIntent.setPackage(arg);
7050 }
7051 if (baseIntent != null) {
7052 Bundle extras = intent.getExtras();
7053 intent.replaceExtras((Bundle)null);
7054 Bundle uriExtras = baseIntent.getExtras();
7055 baseIntent.replaceExtras((Bundle)null);
7056 if (intent.getAction() != null && baseIntent.getCategories() != null) {
7057 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
7058 for (String c : cats) {
7059 baseIntent.removeCategory(c);
7060 }
7061 }
7062 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
7063 if (extras == null) {
7064 extras = uriExtras;
7065 } else if (uriExtras != null) {
7066 uriExtras.putAll(extras);
7067 extras = uriExtras;
7068 }
7069 intent.replaceExtras(extras);
7070 hasIntentInfo = true;
7071 }
7072
7073 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
7074 return intent;
7075 }
7076
7077 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007078 @UnsupportedAppUsage
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007079 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
7080 final String[] lines = new String[] {
7081 "<INTENT> specifications include these flags and arguments:",
7082 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
7083 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
Felipe Leme4e02e252018-04-20 11:25:59 -07007084 " [-n <COMPONENT_NAME>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007085 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
7086 " [--esn <EXTRA_KEY> ...]",
7087 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
7088 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
7089 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
7090 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
7091 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
7092 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
7093 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
7094 " (mutiple extras passed as Integer[])",
7095 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
7096 " (mutiple extras passed as List<Integer>)",
7097 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
7098 " (mutiple extras passed as Long[])",
7099 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
7100 " (mutiple extras passed as List<Long>)",
7101 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
7102 " (mutiple extras passed as Float[])",
7103 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
7104 " (mutiple extras passed as List<Float>)",
7105 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
7106 " (mutiple extras passed as String[]; to embed a comma into a string,",
7107 " escape it using \"\\,\")",
7108 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
7109 " (mutiple extras passed as List<String>; to embed a comma into a string,",
7110 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08007111 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007112 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
7113 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
7114 " [--debug-log-resolution] [--exclude-stopped-packages]",
7115 " [--include-stopped-packages]",
7116 " [--activity-brought-to-front] [--activity-clear-top]",
7117 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
7118 " [--activity-launched-from-history] [--activity-multiple-task]",
7119 " [--activity-no-animation] [--activity-no-history]",
7120 " [--activity-no-user-action] [--activity-previous-is-top]",
7121 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
7122 " [--activity-single-top] [--activity-clear-task]",
Patrick Baumann229141f2018-04-06 13:53:25 -07007123 " [--activity-task-on-home] [--activity-match-external]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007124 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08007125 " [--receiver-foreground] [--receiver-no-abort]",
7126 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007127 " [--selector]",
7128 " [<URI> | <PACKAGE> | <COMPONENT>]"
7129 };
7130 for (String line : lines) {
7131 pw.print(prefix);
7132 pw.println(line);
7133 }
7134 }
7135
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007136 /**
7137 * Retrieve the general action to be performed, such as
7138 * {@link #ACTION_VIEW}. The action describes the general way the rest of
7139 * the information in the intent should be interpreted -- most importantly,
7140 * what to do with the data returned by {@link #getData}.
7141 *
7142 * @return The action of this intent or null if none is specified.
7143 *
7144 * @see #setAction
7145 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007146 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007147 return mAction;
7148 }
7149
7150 /**
7151 * Retrieve data this intent is operating on. This URI specifies the name
7152 * of the data; often it uses the content: scheme, specifying data in a
7153 * content provider. Other schemes may be handled by specific activities,
7154 * such as http: by the web browser.
7155 *
7156 * @return The URI of the data this intent is targeting or null.
7157 *
7158 * @see #getScheme
7159 * @see #setData
7160 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007161 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007162 return mData;
7163 }
7164
7165 /**
7166 * The same as {@link #getData()}, but returns the URI as an encoded
7167 * String.
7168 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007169 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007170 return mData != null ? mData.toString() : null;
7171 }
7172
7173 /**
7174 * Return the scheme portion of the intent's data. If the data is null or
7175 * does not include a scheme, null is returned. Otherwise, the scheme
7176 * prefix without the final ':' is returned, i.e. "http".
7177 *
7178 * <p>This is the same as calling getData().getScheme() (and checking for
7179 * null data).
7180 *
7181 * @return The scheme of this intent.
7182 *
7183 * @see #getData
7184 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007185 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007186 return mData != null ? mData.getScheme() : null;
7187 }
7188
7189 /**
7190 * Retrieve any explicit MIME type included in the intent. This is usually
7191 * null, as the type is determined by the intent data.
7192 *
7193 * @return If a type was manually set, it is returned; else null is
7194 * returned.
7195 *
7196 * @see #resolveType(ContentResolver)
7197 * @see #setType
7198 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007199 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007200 return mType;
7201 }
7202
7203 /**
7204 * Return the MIME data type of this intent. If the type field is
7205 * explicitly set, that is simply returned. Otherwise, if the data is set,
7206 * the type of that data is returned. If neither fields are set, a null is
7207 * returned.
7208 *
7209 * @return The MIME type of this intent.
7210 *
7211 * @see #getType
7212 * @see #resolveType(ContentResolver)
7213 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007214 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007215 return resolveType(context.getContentResolver());
7216 }
7217
7218 /**
7219 * Return the MIME data type of this intent. If the type field is
7220 * explicitly set, that is simply returned. Otherwise, if the data is set,
7221 * the type of that data is returned. If neither fields are set, a null is
7222 * returned.
7223 *
7224 * @param resolver A ContentResolver that can be used to determine the MIME
7225 * type of the intent's data.
7226 *
7227 * @return The MIME type of this intent.
7228 *
7229 * @see #getType
7230 * @see #resolveType(Context)
7231 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007232 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007233 if (mType != null) {
7234 return mType;
7235 }
7236 if (mData != null) {
7237 if ("content".equals(mData.getScheme())) {
7238 return resolver.getType(mData);
7239 }
7240 }
7241 return null;
7242 }
7243
7244 /**
7245 * Return the MIME data type of this intent, only if it will be needed for
7246 * intent resolution. This is not generally useful for application code;
7247 * it is used by the frameworks for communicating with back-end system
7248 * services.
7249 *
7250 * @param resolver A ContentResolver that can be used to determine the MIME
7251 * type of the intent's data.
7252 *
7253 * @return The MIME type of this intent, or null if it is unknown or not
7254 * needed.
7255 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007256 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007257 if (mComponent != null) {
7258 return mType;
7259 }
7260 return resolveType(resolver);
7261 }
7262
7263 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007264 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007265 *
7266 * @param category The category to check.
7267 *
7268 * @return boolean True if the intent contains the category, else false.
7269 *
7270 * @see #getCategories
7271 * @see #addCategory
7272 */
7273 public boolean hasCategory(String category) {
7274 return mCategories != null && mCategories.contains(category);
7275 }
7276
7277 /**
7278 * Return the set of all categories in the intent. If there are no categories,
7279 * returns NULL.
7280 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007281 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007282 *
7283 * @see #hasCategory
7284 * @see #addCategory
7285 */
7286 public Set<String> getCategories() {
7287 return mCategories;
7288 }
7289
7290 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007291 * Return the specific selector associated with this Intent. If there is
7292 * none, returns null. See {@link #setSelector} for more information.
7293 *
7294 * @see #setSelector
7295 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007296 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007297 return mSelector;
7298 }
7299
7300 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007301 * Return the {@link ClipData} associated with this Intent. If there is
7302 * none, returns null. See {@link #setClipData} for more information.
7303 *
John Spurlock125d1332013-11-25 11:58:37 -05007304 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007305 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007306 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007307 return mClipData;
7308 }
7309
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007310 /** @hide */
7311 public int getContentUserHint() {
7312 return mContentUserHint;
7313 }
7314
Todd Kennedyb3b431302017-03-20 16:05:48 -07007315 /** @hide */
7316 public String getLaunchToken() {
7317 return mLaunchToken;
7318 }
7319
7320 /** @hide */
7321 public void setLaunchToken(String launchToken) {
7322 mLaunchToken = launchToken;
7323 }
7324
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007325 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007326 * Sets the ClassLoader that will be used when unmarshalling
7327 * any Parcelable values from the extras of this Intent.
7328 *
7329 * @param loader a ClassLoader, or null to use the default loader
7330 * at the time of unmarshalling.
7331 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007332 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007333 if (mExtras != null) {
7334 mExtras.setClassLoader(loader);
7335 }
7336 }
7337
7338 /**
7339 * Returns true if an extra value is associated with the given name.
7340 * @param name the extra's name
7341 * @return true if the given extra is present.
7342 */
7343 public boolean hasExtra(String name) {
7344 return mExtras != null && mExtras.containsKey(name);
7345 }
7346
7347 /**
7348 * Returns true if the Intent's extras contain a parcelled file descriptor.
7349 * @return true if the Intent contains a parcelled file descriptor.
7350 */
7351 public boolean hasFileDescriptors() {
7352 return mExtras != null && mExtras.hasFileDescriptors();
7353 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007354
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007355 /** {@hide} */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007356 @UnsupportedAppUsage
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04007357 public void setAllowFds(boolean allowFds) {
7358 if (mExtras != null) {
7359 mExtras.setAllowFds(allowFds);
7360 }
7361 }
7362
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007363 /** {@hide} */
7364 public void setDefusable(boolean defusable) {
7365 if (mExtras != null) {
7366 mExtras.setDefusable(defusable);
7367 }
7368 }
7369
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007370 /**
7371 * Retrieve extended data from the intent.
7372 *
7373 * @param name The name of the desired item.
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 null if none was found.
7377 *
7378 * @deprecated
7379 * @hide
7380 */
7381 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007382 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007383 public Object getExtra(String name) {
7384 return getExtra(name, null);
7385 }
7386
7387 /**
7388 * Retrieve extended data from the intent.
7389 *
7390 * @param name The name of the desired item.
7391 * @param defaultValue the value to be returned if no value of the desired
7392 * type is stored with the given name.
7393 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007394 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007395 * or the default value if none was found.
7396 *
7397 * @see #putExtra(String, boolean)
7398 */
7399 public boolean getBooleanExtra(String name, boolean defaultValue) {
7400 return mExtras == null ? defaultValue :
7401 mExtras.getBoolean(name, defaultValue);
7402 }
7403
7404 /**
7405 * Retrieve extended data from the intent.
7406 *
7407 * @param name The name of the desired item.
7408 * @param defaultValue the value to be returned if no value of the desired
7409 * type is stored with the given name.
7410 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007411 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007412 * or the default value if none was found.
7413 *
7414 * @see #putExtra(String, byte)
7415 */
7416 public byte getByteExtra(String name, byte defaultValue) {
7417 return mExtras == null ? defaultValue :
7418 mExtras.getByte(name, defaultValue);
7419 }
7420
7421 /**
7422 * Retrieve extended data from the intent.
7423 *
7424 * @param name The name of the desired item.
7425 * @param defaultValue the value to be returned if no value of the desired
7426 * type is stored with the given name.
7427 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007428 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007429 * or the default value if none was found.
7430 *
7431 * @see #putExtra(String, short)
7432 */
7433 public short getShortExtra(String name, short defaultValue) {
7434 return mExtras == null ? defaultValue :
7435 mExtras.getShort(name, defaultValue);
7436 }
7437
7438 /**
7439 * Retrieve extended data from the intent.
7440 *
7441 * @param name The name of the desired item.
7442 * @param defaultValue the value to be returned if no value of the desired
7443 * type is stored with the given name.
7444 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007445 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007446 * or the default value if none was found.
7447 *
7448 * @see #putExtra(String, char)
7449 */
7450 public char getCharExtra(String name, char defaultValue) {
7451 return mExtras == null ? defaultValue :
7452 mExtras.getChar(name, defaultValue);
7453 }
7454
7455 /**
7456 * Retrieve extended data from the intent.
7457 *
7458 * @param name The name of the desired item.
7459 * @param defaultValue the value to be returned if no value of the desired
7460 * type is stored with the given name.
7461 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007462 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007463 * or the default value if none was found.
7464 *
7465 * @see #putExtra(String, int)
7466 */
7467 public int getIntExtra(String name, int defaultValue) {
7468 return mExtras == null ? defaultValue :
7469 mExtras.getInt(name, defaultValue);
7470 }
7471
7472 /**
7473 * Retrieve extended data from the intent.
7474 *
7475 * @param name The name of the desired item.
7476 * @param defaultValue the value to be returned if no value of the desired
7477 * type is stored with the given name.
7478 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007479 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007480 * or the default value if none was found.
7481 *
7482 * @see #putExtra(String, long)
7483 */
7484 public long getLongExtra(String name, long defaultValue) {
7485 return mExtras == null ? defaultValue :
7486 mExtras.getLong(name, defaultValue);
7487 }
7488
7489 /**
7490 * Retrieve extended data from the intent.
7491 *
7492 * @param name The name of the desired item.
7493 * @param defaultValue the value to be returned if no value of the desired
7494 * type is stored with the given name.
7495 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007496 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007497 * or the default value if no such item is present
7498 *
7499 * @see #putExtra(String, float)
7500 */
7501 public float getFloatExtra(String name, float defaultValue) {
7502 return mExtras == null ? defaultValue :
7503 mExtras.getFloat(name, defaultValue);
7504 }
7505
7506 /**
7507 * Retrieve extended data from the intent.
7508 *
7509 * @param name The name of the desired item.
7510 * @param defaultValue the value to be returned if no value of the desired
7511 * type is stored with the given name.
7512 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007513 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007514 * or the default value if none was found.
7515 *
7516 * @see #putExtra(String, double)
7517 */
7518 public double getDoubleExtra(String name, double defaultValue) {
7519 return mExtras == null ? defaultValue :
7520 mExtras.getDouble(name, defaultValue);
7521 }
7522
7523 /**
7524 * Retrieve extended data from the intent.
7525 *
7526 * @param name The name of the desired item.
7527 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007528 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007529 * or null if no String value was found.
7530 *
7531 * @see #putExtra(String, String)
7532 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007533 public @Nullable String getStringExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007534 return mExtras == null ? null : mExtras.getString(name);
7535 }
7536
7537 /**
7538 * Retrieve extended data from the intent.
7539 *
7540 * @param name The name of the desired item.
7541 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007542 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007543 * or null if no CharSequence value was found.
7544 *
7545 * @see #putExtra(String, CharSequence)
7546 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007547 public @Nullable CharSequence getCharSequenceExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007548 return mExtras == null ? null : mExtras.getCharSequence(name);
7549 }
7550
7551 /**
7552 * Retrieve extended data from the intent.
7553 *
7554 * @param name The name of the desired item.
7555 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007556 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007557 * or null if no Parcelable value was found.
7558 *
7559 * @see #putExtra(String, Parcelable)
7560 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007561 public @Nullable <T extends Parcelable> T getParcelableExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007562 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7563 }
7564
7565 /**
7566 * Retrieve extended data from the intent.
7567 *
7568 * @param name The name of the desired item.
7569 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007570 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007571 * or null if no Parcelable[] value was found.
7572 *
7573 * @see #putExtra(String, Parcelable[])
7574 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007575 public @Nullable Parcelable[] getParcelableArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007576 return mExtras == null ? null : mExtras.getParcelableArray(name);
7577 }
7578
7579 /**
7580 * Retrieve extended data from the intent.
7581 *
7582 * @param name The name of the desired item.
7583 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007584 * @return the value of an item previously added with
7585 * putParcelableArrayListExtra(), or null if no
7586 * ArrayList<Parcelable> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007587 *
7588 * @see #putParcelableArrayListExtra(String, ArrayList)
7589 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007590 public @Nullable <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007591 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7592 }
7593
7594 /**
7595 * Retrieve extended data from the intent.
7596 *
7597 * @param name The name of the desired item.
7598 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007599 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007600 * or null if no Serializable value was found.
7601 *
7602 * @see #putExtra(String, Serializable)
7603 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007604 public @Nullable Serializable getSerializableExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007605 return mExtras == null ? null : mExtras.getSerializable(name);
7606 }
7607
7608 /**
7609 * Retrieve extended data from the intent.
7610 *
7611 * @param name The name of the desired item.
7612 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007613 * @return the value of an item previously added with
7614 * putIntegerArrayListExtra(), or null if no
7615 * ArrayList<Integer> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007616 *
7617 * @see #putIntegerArrayListExtra(String, ArrayList)
7618 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007619 public @Nullable ArrayList<Integer> getIntegerArrayListExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007620 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7621 }
7622
7623 /**
7624 * Retrieve extended data from the intent.
7625 *
7626 * @param name The name of the desired item.
7627 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007628 * @return the value of an item previously added with
7629 * putStringArrayListExtra(), or null if no
7630 * ArrayList<String> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007631 *
7632 * @see #putStringArrayListExtra(String, ArrayList)
7633 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007634 public @Nullable ArrayList<String> getStringArrayListExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007635 return mExtras == null ? null : mExtras.getStringArrayList(name);
7636 }
7637
7638 /**
7639 * Retrieve extended data from the intent.
7640 *
7641 * @param name The name of the desired item.
7642 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007643 * @return the value of an item previously added with
7644 * putCharSequenceArrayListExtra, or null if no
7645 * ArrayList<CharSequence> value was found.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007646 *
7647 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7648 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007649 public @Nullable ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007650 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7651 }
7652
7653 /**
7654 * Retrieve extended data from the intent.
7655 *
7656 * @param name The name of the desired item.
7657 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007658 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007659 * or null if no boolean array value was found.
7660 *
7661 * @see #putExtra(String, boolean[])
7662 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007663 public @Nullable boolean[] getBooleanArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007664 return mExtras == null ? null : mExtras.getBooleanArray(name);
7665 }
7666
7667 /**
7668 * Retrieve extended data from the intent.
7669 *
7670 * @param name The name of the desired item.
7671 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007672 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007673 * or null if no byte array value was found.
7674 *
7675 * @see #putExtra(String, byte[])
7676 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007677 public @Nullable byte[] getByteArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007678 return mExtras == null ? null : mExtras.getByteArray(name);
7679 }
7680
7681 /**
7682 * Retrieve extended data from the intent.
7683 *
7684 * @param name The name of the desired item.
7685 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007686 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007687 * or null if no short array value was found.
7688 *
7689 * @see #putExtra(String, short[])
7690 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007691 public @Nullable short[] getShortArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007692 return mExtras == null ? null : mExtras.getShortArray(name);
7693 }
7694
7695 /**
7696 * Retrieve extended data from the intent.
7697 *
7698 * @param name The name of the desired item.
7699 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007700 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007701 * or null if no char array value was found.
7702 *
7703 * @see #putExtra(String, char[])
7704 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007705 public @Nullable char[] getCharArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007706 return mExtras == null ? null : mExtras.getCharArray(name);
7707 }
7708
7709 /**
7710 * Retrieve extended data from the intent.
7711 *
7712 * @param name The name of the desired item.
7713 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007714 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007715 * or null if no int array value was found.
7716 *
7717 * @see #putExtra(String, int[])
7718 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007719 public @Nullable int[] getIntArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007720 return mExtras == null ? null : mExtras.getIntArray(name);
7721 }
7722
7723 /**
7724 * Retrieve extended data from the intent.
7725 *
7726 * @param name The name of the desired item.
7727 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007728 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007729 * or null if no long array value was found.
7730 *
7731 * @see #putExtra(String, long[])
7732 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007733 public @Nullable long[] getLongArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007734 return mExtras == null ? null : mExtras.getLongArray(name);
7735 }
7736
7737 /**
7738 * Retrieve extended data from the intent.
7739 *
7740 * @param name The name of the desired item.
7741 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007742 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007743 * or null if no float array value was found.
7744 *
7745 * @see #putExtra(String, float[])
7746 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007747 public @Nullable float[] getFloatArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007748 return mExtras == null ? null : mExtras.getFloatArray(name);
7749 }
7750
7751 /**
7752 * Retrieve extended data from the intent.
7753 *
7754 * @param name The name of the desired item.
7755 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007756 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007757 * or null if no double array value was found.
7758 *
7759 * @see #putExtra(String, double[])
7760 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007761 public @Nullable double[] getDoubleArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007762 return mExtras == null ? null : mExtras.getDoubleArray(name);
7763 }
7764
7765 /**
7766 * Retrieve extended data from the intent.
7767 *
7768 * @param name The name of the desired item.
7769 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007770 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007771 * or null if no String array value was found.
7772 *
7773 * @see #putExtra(String, String[])
7774 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007775 public @Nullable String[] getStringArrayExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007776 return mExtras == null ? null : mExtras.getStringArray(name);
7777 }
7778
7779 /**
7780 * Retrieve extended data from the intent.
7781 *
7782 * @param name The name of the desired item.
7783 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007784 * @return the value of an item previously added with putExtra(),
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007785 * or null if no CharSequence array value was found.
7786 *
7787 * @see #putExtra(String, CharSequence[])
7788 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007789 public @Nullable CharSequence[] getCharSequenceArrayExtra(String name) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007790 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7791 }
7792
7793 /**
7794 * Retrieve extended data from the intent.
7795 *
7796 * @param name The name of the desired item.
7797 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007798 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007799 * or null if no Bundle value was found.
7800 *
7801 * @see #putExtra(String, Bundle)
7802 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00007803 public @Nullable Bundle getBundleExtra(String name) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007804 return mExtras == null ? null : mExtras.getBundle(name);
7805 }
7806
7807 /**
7808 * Retrieve extended data from the intent.
7809 *
7810 * @param name The name of the desired item.
7811 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007812 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007813 * or null if no IBinder value was found.
7814 *
7815 * @see #putExtra(String, IBinder)
7816 *
7817 * @deprecated
7818 * @hide
7819 */
7820 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007821 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007822 public IBinder getIBinderExtra(String name) {
7823 return mExtras == null ? null : mExtras.getIBinder(name);
7824 }
7825
7826 /**
7827 * Retrieve extended data from the intent.
7828 *
7829 * @param name The name of the desired item.
7830 * @param defaultValue The default value to return in case no item is
7831 * associated with the key 'name'
7832 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007833 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007834 * or defaultValue if none was found.
7835 *
7836 * @see #putExtra
7837 *
7838 * @deprecated
7839 * @hide
7840 */
7841 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007842 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007843 public Object getExtra(String name, Object defaultValue) {
7844 Object result = defaultValue;
7845 if (mExtras != null) {
7846 Object result2 = mExtras.get(name);
7847 if (result2 != null) {
7848 result = result2;
7849 }
7850 }
7851
7852 return result;
7853 }
7854
7855 /**
7856 * Retrieves a map of extended data from the intent.
7857 *
7858 * @return the map of all extras previously added with putExtra(),
7859 * or null if none have been added.
7860 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007861 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007862 return (mExtras != null)
7863 ? new Bundle(mExtras)
7864 : null;
7865 }
7866
7867 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007868 * Filter extras to only basic types.
7869 * @hide
7870 */
7871 public void removeUnsafeExtras() {
7872 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007873 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007874 }
7875 }
7876
7877 /**
Makoto Onuki97f82f22017-05-31 16:20:21 -07007878 * @return Whether {@link #maybeStripForHistory} will return an lightened intent or
7879 * return itself as-is.
7880 * @hide
7881 */
7882 public boolean canStripForHistory() {
7883 return ((mExtras != null) && mExtras.isParcelled()) || (mClipData != null);
7884 }
7885
7886 /**
7887 * Call it when the system needs to keep an intent for logging purposes to remove fields
7888 * that are not needed for logging.
7889 * @hide
7890 */
7891 public Intent maybeStripForHistory() {
7892 // TODO Scan and remove possibly heavy instances like Bitmaps from unparcelled extras?
7893
7894 if (!canStripForHistory()) {
7895 return this;
7896 }
7897 return new Intent(this, COPY_MODE_HISTORY);
7898 }
7899
7900 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007901 * Retrieve any special flags associated with this intent. You will
7902 * normally just set them with {@link #setFlags} and let the system
7903 * take the appropriate action with them.
7904 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007905 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007906 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007907 * @see #addFlags
7908 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007909 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007910 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007911 return mFlags;
7912 }
7913
Dianne Hackborne7f97212011-02-24 14:40:20 -08007914 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007915 @UnsupportedAppUsage
Dianne Hackborne7f97212011-02-24 14:40:20 -08007916 public boolean isExcludingStopped() {
7917 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7918 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7919 }
7920
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007921 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007922 * Retrieve the application package name this Intent is limited to. When
7923 * resolving an Intent, if non-null this limits the resolution to only
7924 * components in the given application package.
7925 *
7926 * @return The name of the application package for the Intent.
7927 *
7928 * @see #resolveActivity
7929 * @see #setPackage
7930 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007931 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007932 return mPackage;
7933 }
7934
7935 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007936 * Retrieve the concrete component associated with the intent. When receiving
7937 * an intent, this is the component that was found to best handle it (that is,
7938 * yourself) and will always be non-null; in all other cases it will be
7939 * null unless explicitly set.
7940 *
7941 * @return The name of the application component to handle the intent.
7942 *
7943 * @see #resolveActivity
7944 * @see #setComponent
7945 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007946 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007947 return mComponent;
7948 }
7949
7950 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007951 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7952 * used as a hint to the receiver for animations and the like. Null means that there
7953 * is no source bounds.
7954 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007955 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007956 return mSourceBounds;
7957 }
7958
7959 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007960 * Return the Activity component that should be used to handle this intent.
7961 * The appropriate component is determined based on the information in the
7962 * intent, evaluated as follows:
7963 *
7964 * <p>If {@link #getComponent} returns an explicit class, that is returned
7965 * without any further consideration.
7966 *
7967 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7968 * category to be considered.
7969 *
7970 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7971 * action.
7972 *
7973 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7974 * this type.
7975 *
7976 * <p>If {@link #addCategory} has added any categories, the activity must
7977 * handle ALL of the categories specified.
7978 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007979 * <p>If {@link #getPackage} is non-NULL, only activity components in
7980 * that application package will be considered.
7981 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007982 * <p>If there are no activities that satisfy all of these conditions, a
7983 * null string is returned.
7984 *
7985 * <p>If multiple activities are found to satisfy the intent, the one with
7986 * the highest priority will be used. If there are multiple activities
7987 * with the same priority, the system will either pick the best activity
7988 * based on user preference, or resolve to a system class that will allow
7989 * the user to pick an activity and forward from there.
7990 *
7991 * <p>This method is implemented simply by calling
7992 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7993 * true.</p>
7994 * <p> This API is called for you as part of starting an activity from an
7995 * intent. You do not normally need to call it yourself.</p>
7996 *
7997 * @param pm The package manager with which to resolve the Intent.
7998 *
7999 * @return Name of the component implementing an activity that can
8000 * display the intent.
8001 *
8002 * @see #setComponent
8003 * @see #getComponent
8004 * @see #resolveActivityInfo
8005 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008006 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008007 if (mComponent != null) {
8008 return mComponent;
8009 }
8010
8011 ResolveInfo info = pm.resolveActivity(
8012 this, PackageManager.MATCH_DEFAULT_ONLY);
8013 if (info != null) {
8014 return new ComponentName(
8015 info.activityInfo.applicationInfo.packageName,
8016 info.activityInfo.name);
8017 }
8018
8019 return null;
8020 }
8021
8022 /**
8023 * Resolve the Intent into an {@link ActivityInfo}
8024 * describing the activity that should execute the intent. Resolution
8025 * follows the same rules as described for {@link #resolveActivity}, but
8026 * you get back the completely information about the resolved activity
8027 * instead of just its class name.
8028 *
8029 * @param pm The package manager with which to resolve the Intent.
8030 * @param flags Addition information to retrieve as per
8031 * {@link PackageManager#getActivityInfo(ComponentName, int)
8032 * PackageManager.getActivityInfo()}.
8033 *
8034 * @return PackageManager.ActivityInfo
8035 *
8036 * @see #resolveActivity
8037 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008038 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
8039 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008040 ActivityInfo ai = null;
8041 if (mComponent != null) {
8042 try {
8043 ai = pm.getActivityInfo(mComponent, flags);
8044 } catch (PackageManager.NameNotFoundException e) {
8045 // ignore
8046 }
8047 } else {
8048 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07008049 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008050 if (info != null) {
8051 ai = info.activityInfo;
8052 }
8053 }
8054
8055 return ai;
8056 }
8057
8058 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07008059 * Special function for use by the system to resolve service
8060 * intents to system apps. Throws an exception if there are
8061 * multiple potential matches to the Intent. Returns null if
8062 * there are no matches.
8063 * @hide
8064 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01008065 @UnsupportedAppUsage
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008066 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
8067 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07008068 if (mComponent != null) {
8069 return mComponent;
8070 }
8071
8072 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
8073 if (results == null) {
8074 return null;
8075 }
8076 ComponentName comp = null;
8077 for (int i=0; i<results.size(); i++) {
8078 ResolveInfo ri = results.get(i);
8079 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
8080 continue;
8081 }
8082 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
8083 ri.serviceInfo.name);
8084 if (comp != null) {
8085 throw new IllegalStateException("Multiple system services handle " + this
8086 + ": " + comp + ", " + foundComp);
8087 }
8088 comp = foundComp;
8089 }
8090 return comp;
8091 }
8092
8093 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008094 * Set the general action to be performed.
8095 *
8096 * @param action An action name, such as ACTION_VIEW. Application-specific
8097 * actions should be prefixed with the vendor's package name.
8098 *
8099 * @return Returns the same Intent object, for chaining multiple calls
8100 * into a single statement.
8101 *
8102 * @see #getAction
8103 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008104 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008105 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008106 return this;
8107 }
8108
8109 /**
8110 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08008111 * clears any type that was previously set by {@link #setType} or
8112 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008113 *
Nick Pellyccae4122012-01-09 14:12:58 -08008114 * <p><em>Note: scheme matching in the Android framework is
8115 * case-sensitive, unlike the formal RFC. As a result,
8116 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008117 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08008118 * {@link #setDataAndNormalize}
8119 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008120 *
Nick Pellyccae4122012-01-09 14:12:58 -08008121 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008122 *
8123 * @return Returns the same Intent object, for chaining multiple calls
8124 * into a single statement.
8125 *
8126 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08008127 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07008128 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008129 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008130 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008131 mData = data;
8132 mType = null;
8133 return this;
8134 }
8135
8136 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008137 * Normalize and set the data this intent is operating on.
8138 *
8139 * <p>This method automatically clears any type that was
8140 * previously set (for example, by {@link #setType}).
8141 *
8142 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008143 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08008144 * so really this is just a convenience method for
8145 * <pre>
8146 * setData(data.normalize())
8147 * </pre>
8148 *
8149 * @param data The Uri of the data this intent is now targeting.
8150 *
8151 * @return Returns the same Intent object, for chaining multiple calls
8152 * into a single statement.
8153 *
8154 * @see #getData
8155 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008156 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008157 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008158 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008159 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08008160 }
8161
8162 /**
8163 * Set an explicit MIME data type.
8164 *
8165 * <p>This is used to create intents that only specify a type and not data,
8166 * for example to indicate the type of data to return.
8167 *
8168 * <p>This method automatically clears any data that was
8169 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07008170 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008171 * <p><em>Note: MIME type matching in the Android framework is
8172 * case-sensitive, unlike formal RFC MIME types. As a result,
8173 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08008174 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
8175 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008176 *
8177 * @param type The MIME type of the data being handled by this intent.
8178 *
8179 * @return Returns the same Intent object, for chaining multiple calls
8180 * into a single statement.
8181 *
8182 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08008183 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008184 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08008185 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008186 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008187 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008188 mData = null;
8189 mType = type;
8190 return this;
8191 }
8192
8193 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008194 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008195 *
Nick Pellyccae4122012-01-09 14:12:58 -08008196 * <p>This is used to create intents that only specify a type and not data,
8197 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008198 *
Nick Pellyccae4122012-01-09 14:12:58 -08008199 * <p>This method automatically clears any data that was
8200 * previously set (for example by {@link #setData}).
8201 *
8202 * <p>The MIME type is normalized using
8203 * {@link #normalizeMimeType} before it is set,
8204 * so really this is just a convenience method for
8205 * <pre>
8206 * setType(Intent.normalizeMimeType(type))
8207 * </pre>
8208 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008209 * @param type The MIME type of the data being handled by this intent.
8210 *
8211 * @return Returns the same Intent object, for chaining multiple calls
8212 * into a single statement.
8213 *
Nick Pellyccae4122012-01-09 14:12:58 -08008214 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008215 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08008216 * @see #normalizeMimeType
8217 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008218 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08008219 return setType(normalizeMimeType(type));
8220 }
8221
8222 /**
8223 * (Usually optional) Set the data for the intent along with an explicit
8224 * MIME data type. This method should very rarely be used -- it allows you
8225 * to override the MIME type that would ordinarily be inferred from the
8226 * data with your own type given here.
8227 *
8228 * <p><em>Note: MIME type and Uri scheme matching in the
8229 * Android framework is case-sensitive, unlike the formal RFC definitions.
8230 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008231 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08008232 * {@link #setDataAndTypeAndNormalize}
8233 * to ensure that they are converted to lower case.</em>
8234 *
8235 * @param data The Uri of the data this intent is now targeting.
8236 * @param type The MIME type of the data being handled by this intent.
8237 *
8238 * @return Returns the same Intent object, for chaining multiple calls
8239 * into a single statement.
8240 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008241 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08008242 * @see #setData
8243 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008244 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008245 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008246 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008247 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008248 mData = data;
8249 mType = type;
8250 return this;
8251 }
8252
8253 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008254 * (Usually optional) Normalize and set both the data Uri and an explicit
8255 * MIME data type. This method should very rarely be used -- it allows you
8256 * to override the MIME type that would ordinarily be inferred from the
8257 * data with your own type given here.
8258 *
8259 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008260 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08008261 * before they are set, so really this is just a convenience method for
8262 * <pre>
8263 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
8264 * </pre>
8265 *
8266 * @param data The Uri of the data this intent is now targeting.
8267 * @param type The MIME type of the data being handled by this intent.
8268 *
8269 * @return Returns the same Intent object, for chaining multiple calls
8270 * into a single statement.
8271 *
8272 * @see #setType
8273 * @see #setData
8274 * @see #setDataAndType
8275 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008276 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008277 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008278 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008279 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08008280 }
8281
8282 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008283 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008284 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008285 * activities that provide <em>all</em> of the requested categories will be
8286 * used.
8287 *
8288 * @param category The desired category. This can be either one of the
8289 * predefined Intent categories, or a custom category in your own
8290 * namespace.
8291 *
8292 * @return Returns the same Intent object, for chaining multiple calls
8293 * into a single statement.
8294 *
8295 * @see #hasCategory
8296 * @see #removeCategory
8297 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008298 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008299 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008300 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008301 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08008302 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008303 return this;
8304 }
8305
8306 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008307 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008308 *
8309 * @param category The category to remove.
8310 *
8311 * @see #addCategory
8312 */
8313 public void removeCategory(String category) {
8314 if (mCategories != null) {
8315 mCategories.remove(category);
8316 if (mCategories.size() == 0) {
8317 mCategories = null;
8318 }
8319 }
8320 }
8321
8322 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008323 * Set a selector for this Intent. This is a modification to the kinds of
8324 * things the Intent will match. If the selector is set, it will be used
8325 * when trying to find entities that can handle the Intent, instead of the
8326 * main contents of the Intent. This allows you build an Intent containing
8327 * a generic protocol while targeting it more specifically.
8328 *
8329 * <p>An example of where this may be used is with things like
8330 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
8331 * Intent that will launch the Browser application. However, the correct
8332 * main entry point of an application is actually {@link #ACTION_MAIN}
8333 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
8334 * used to specify the actual Activity to launch. If you launch the browser
8335 * with something different, undesired behavior may happen if the user has
8336 * previously or later launches it the normal way, since they do not match.
8337 * Instead, you can build an Intent with the MAIN action (but no ComponentName
8338 * yet specified) and set a selector with {@link #ACTION_MAIN} and
8339 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
8340 *
8341 * <p>Setting a selector does not impact the behavior of
8342 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
8343 * desired behavior of a selector -- it does not impact the base meaning
8344 * of the Intent, just what kinds of things will be matched against it
8345 * when determining who can handle it.</p>
8346 *
8347 * <p>You can not use both a selector and {@link #setPackage(String)} on
8348 * the same base Intent.</p>
8349 *
8350 * @param selector The desired selector Intent; set to null to not use
8351 * a special selector.
8352 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008353 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008354 if (selector == this) {
8355 throw new IllegalArgumentException(
8356 "Intent being set as a selector of itself");
8357 }
8358 if (selector != null && mPackage != null) {
8359 throw new IllegalArgumentException(
8360 "Can't set selector when package name is already set");
8361 }
8362 mSelector = selector;
8363 }
8364
8365 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008366 * Set a {@link ClipData} associated with this Intent. This replaces any
8367 * previously set ClipData.
8368 *
8369 * <p>The ClipData in an intent is not used for Intent matching or other
8370 * such operations. Semantically it is like extras, used to transmit
8371 * additional data with the Intent. The main feature of using this over
8372 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
8373 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
8374 * items included in the clip data. This is useful, in particular, if
8375 * you want to transmit an Intent containing multiple <code>content:</code>
8376 * URIs for which the recipient may not have global permission to access the
8377 * content provider.
8378 *
8379 * <p>If the ClipData contains items that are themselves Intents, any
8380 * grant flags in those Intents will be ignored. Only the top-level flags
8381 * of the main Intent are respected, and will be applied to all Uri or
8382 * Intent items in the clip (or sub-items of the clip).
8383 *
8384 * <p>The MIME type, label, and icon in the ClipData object are not
8385 * directly used by Intent. Applications should generally rely on the
8386 * MIME type of the Intent itself, not what it may find in the ClipData.
8387 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05008388 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008389 *
8390 * @param clip The new clip to set. May be null to clear the current clip.
8391 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008392 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008393 mClipData = clip;
8394 }
8395
8396 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008397 * This is NOT a secure mechanism to identify the user who sent the intent.
8398 * When the intent is sent to a different user, it is used to fix uris by adding the userId
8399 * who sent the intent.
8400 * @hide
8401 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01008402 public void prepareToLeaveUser(int userId) {
8403 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
8404 // We want mContentUserHint to refer to the original user, so don't do anything.
8405 if (mContentUserHint == UserHandle.USER_CURRENT) {
8406 mContentUserHint = userId;
8407 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008408 }
8409
8410 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008411 * Add extended data to the intent. The name must include a package
8412 * prefix, for example the app com.android.contacts would use names
8413 * like "com.android.contacts.ShowAll".
8414 *
8415 * @param name The name of the extra data, with package prefix.
8416 * @param value The boolean data value.
8417 *
8418 * @return Returns the same Intent object, for chaining multiple calls
8419 * into a single statement.
8420 *
8421 * @see #putExtras
8422 * @see #removeExtra
8423 * @see #getBooleanExtra(String, boolean)
8424 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008425 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008426 if (mExtras == null) {
8427 mExtras = new Bundle();
8428 }
8429 mExtras.putBoolean(name, value);
8430 return this;
8431 }
8432
8433 /**
8434 * Add extended data to the intent. The name must include a package
8435 * prefix, for example the app com.android.contacts would use names
8436 * like "com.android.contacts.ShowAll".
8437 *
8438 * @param name The name of the extra data, with package prefix.
8439 * @param value The byte data value.
8440 *
8441 * @return Returns the same Intent object, for chaining multiple calls
8442 * into a single statement.
8443 *
8444 * @see #putExtras
8445 * @see #removeExtra
8446 * @see #getByteExtra(String, byte)
8447 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008448 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008449 if (mExtras == null) {
8450 mExtras = new Bundle();
8451 }
8452 mExtras.putByte(name, value);
8453 return this;
8454 }
8455
8456 /**
8457 * Add extended data to the intent. The name must include a package
8458 * prefix, for example the app com.android.contacts would use names
8459 * like "com.android.contacts.ShowAll".
8460 *
8461 * @param name The name of the extra data, with package prefix.
8462 * @param value The char data value.
8463 *
8464 * @return Returns the same Intent object, for chaining multiple calls
8465 * into a single statement.
8466 *
8467 * @see #putExtras
8468 * @see #removeExtra
8469 * @see #getCharExtra(String, char)
8470 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008471 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008472 if (mExtras == null) {
8473 mExtras = new Bundle();
8474 }
8475 mExtras.putChar(name, value);
8476 return this;
8477 }
8478
8479 /**
8480 * Add extended data to the intent. The name must include a package
8481 * prefix, for example the app com.android.contacts would use names
8482 * like "com.android.contacts.ShowAll".
8483 *
8484 * @param name The name of the extra data, with package prefix.
8485 * @param value The short data value.
8486 *
8487 * @return Returns the same Intent object, for chaining multiple calls
8488 * into a single statement.
8489 *
8490 * @see #putExtras
8491 * @see #removeExtra
8492 * @see #getShortExtra(String, short)
8493 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008494 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008495 if (mExtras == null) {
8496 mExtras = new Bundle();
8497 }
8498 mExtras.putShort(name, value);
8499 return this;
8500 }
8501
8502 /**
8503 * Add extended data to the intent. The name must include a package
8504 * prefix, for example the app com.android.contacts would use names
8505 * like "com.android.contacts.ShowAll".
8506 *
8507 * @param name The name of the extra data, with package prefix.
8508 * @param value The integer data value.
8509 *
8510 * @return Returns the same Intent object, for chaining multiple calls
8511 * into a single statement.
8512 *
8513 * @see #putExtras
8514 * @see #removeExtra
8515 * @see #getIntExtra(String, int)
8516 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008517 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008518 if (mExtras == null) {
8519 mExtras = new Bundle();
8520 }
8521 mExtras.putInt(name, value);
8522 return this;
8523 }
8524
8525 /**
8526 * Add extended data to the intent. The name must include a package
8527 * prefix, for example the app com.android.contacts would use names
8528 * like "com.android.contacts.ShowAll".
8529 *
8530 * @param name The name of the extra data, with package prefix.
8531 * @param value The long data value.
8532 *
8533 * @return Returns the same Intent object, for chaining multiple calls
8534 * into a single statement.
8535 *
8536 * @see #putExtras
8537 * @see #removeExtra
8538 * @see #getLongExtra(String, long)
8539 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008540 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008541 if (mExtras == null) {
8542 mExtras = new Bundle();
8543 }
8544 mExtras.putLong(name, value);
8545 return this;
8546 }
8547
8548 /**
8549 * Add extended data to the intent. The name must include a package
8550 * prefix, for example the app com.android.contacts would use names
8551 * like "com.android.contacts.ShowAll".
8552 *
8553 * @param name The name of the extra data, with package prefix.
8554 * @param value The float data value.
8555 *
8556 * @return Returns the same Intent object, for chaining multiple calls
8557 * into a single statement.
8558 *
8559 * @see #putExtras
8560 * @see #removeExtra
8561 * @see #getFloatExtra(String, float)
8562 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008563 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008564 if (mExtras == null) {
8565 mExtras = new Bundle();
8566 }
8567 mExtras.putFloat(name, value);
8568 return this;
8569 }
8570
8571 /**
8572 * Add extended data to the intent. The name must include a package
8573 * prefix, for example the app com.android.contacts would use names
8574 * like "com.android.contacts.ShowAll".
8575 *
8576 * @param name The name of the extra data, with package prefix.
8577 * @param value The double data value.
8578 *
8579 * @return Returns the same Intent object, for chaining multiple calls
8580 * into a single statement.
8581 *
8582 * @see #putExtras
8583 * @see #removeExtra
8584 * @see #getDoubleExtra(String, double)
8585 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008586 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008587 if (mExtras == null) {
8588 mExtras = new Bundle();
8589 }
8590 mExtras.putDouble(name, value);
8591 return this;
8592 }
8593
8594 /**
8595 * Add extended data to the intent. The name must include a package
8596 * prefix, for example the app com.android.contacts would use names
8597 * like "com.android.contacts.ShowAll".
8598 *
8599 * @param name The name of the extra data, with package prefix.
8600 * @param value The String data value.
8601 *
8602 * @return Returns the same Intent object, for chaining multiple calls
8603 * into a single statement.
8604 *
8605 * @see #putExtras
8606 * @see #removeExtra
8607 * @see #getStringExtra(String)
8608 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008609 public @NonNull Intent putExtra(String name, @Nullable String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008610 if (mExtras == null) {
8611 mExtras = new Bundle();
8612 }
8613 mExtras.putString(name, value);
8614 return this;
8615 }
8616
8617 /**
8618 * Add extended data to the intent. The name must include a package
8619 * prefix, for example the app com.android.contacts would use names
8620 * like "com.android.contacts.ShowAll".
8621 *
8622 * @param name The name of the extra data, with package prefix.
8623 * @param value The CharSequence data value.
8624 *
8625 * @return Returns the same Intent object, for chaining multiple calls
8626 * into a single statement.
8627 *
8628 * @see #putExtras
8629 * @see #removeExtra
8630 * @see #getCharSequenceExtra(String)
8631 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008632 public @NonNull Intent putExtra(String name, @Nullable CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008633 if (mExtras == null) {
8634 mExtras = new Bundle();
8635 }
8636 mExtras.putCharSequence(name, value);
8637 return this;
8638 }
8639
8640 /**
8641 * Add extended data to the intent. The name must include a package
8642 * prefix, for example the app com.android.contacts would use names
8643 * like "com.android.contacts.ShowAll".
8644 *
8645 * @param name The name of the extra data, with package prefix.
8646 * @param value The Parcelable data value.
8647 *
8648 * @return Returns the same Intent object, for chaining multiple calls
8649 * into a single statement.
8650 *
8651 * @see #putExtras
8652 * @see #removeExtra
8653 * @see #getParcelableExtra(String)
8654 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008655 public @NonNull Intent putExtra(String name, @Nullable Parcelable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008656 if (mExtras == null) {
8657 mExtras = new Bundle();
8658 }
8659 mExtras.putParcelable(name, value);
8660 return this;
8661 }
8662
8663 /**
8664 * Add extended data to the intent. The name must include a package
8665 * prefix, for example the app com.android.contacts would use names
8666 * like "com.android.contacts.ShowAll".
8667 *
8668 * @param name The name of the extra data, with package prefix.
8669 * @param value The Parcelable[] data value.
8670 *
8671 * @return Returns the same Intent object, for chaining multiple calls
8672 * into a single statement.
8673 *
8674 * @see #putExtras
8675 * @see #removeExtra
8676 * @see #getParcelableArrayExtra(String)
8677 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008678 public @NonNull Intent putExtra(String name, @Nullable Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008679 if (mExtras == null) {
8680 mExtras = new Bundle();
8681 }
8682 mExtras.putParcelableArray(name, value);
8683 return this;
8684 }
8685
8686 /**
8687 * Add extended data to the intent. The name must include a package
8688 * prefix, for example the app com.android.contacts would use names
8689 * like "com.android.contacts.ShowAll".
8690 *
8691 * @param name The name of the extra data, with package prefix.
8692 * @param value The ArrayList<Parcelable> data value.
8693 *
8694 * @return Returns the same Intent object, for chaining multiple calls
8695 * into a single statement.
8696 *
8697 * @see #putExtras
8698 * @see #removeExtra
8699 * @see #getParcelableArrayListExtra(String)
8700 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008701 public @NonNull Intent putParcelableArrayListExtra(String name,
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008702 @Nullable ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008703 if (mExtras == null) {
8704 mExtras = new Bundle();
8705 }
8706 mExtras.putParcelableArrayList(name, value);
8707 return this;
8708 }
8709
8710 /**
8711 * Add extended data to the intent. The name must include a package
8712 * prefix, for example the app com.android.contacts would use names
8713 * like "com.android.contacts.ShowAll".
8714 *
8715 * @param name The name of the extra data, with package prefix.
8716 * @param value The ArrayList<Integer> data value.
8717 *
8718 * @return Returns the same Intent object, for chaining multiple calls
8719 * into a single statement.
8720 *
8721 * @see #putExtras
8722 * @see #removeExtra
8723 * @see #getIntegerArrayListExtra(String)
8724 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008725 public @NonNull Intent putIntegerArrayListExtra(String name,
8726 @Nullable ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008727 if (mExtras == null) {
8728 mExtras = new Bundle();
8729 }
8730 mExtras.putIntegerArrayList(name, value);
8731 return this;
8732 }
8733
8734 /**
8735 * Add extended data to the intent. The name must include a package
8736 * prefix, for example the app com.android.contacts would use names
8737 * like "com.android.contacts.ShowAll".
8738 *
8739 * @param name The name of the extra data, with package prefix.
8740 * @param value The ArrayList<String> data value.
8741 *
8742 * @return Returns the same Intent object, for chaining multiple calls
8743 * into a single statement.
8744 *
8745 * @see #putExtras
8746 * @see #removeExtra
8747 * @see #getStringArrayListExtra(String)
8748 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008749 public @NonNull Intent putStringArrayListExtra(String name, @Nullable ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008750 if (mExtras == null) {
8751 mExtras = new Bundle();
8752 }
8753 mExtras.putStringArrayList(name, value);
8754 return this;
8755 }
8756
8757 /**
8758 * Add extended data to the intent. The name must include a package
8759 * prefix, for example the app com.android.contacts would use names
8760 * like "com.android.contacts.ShowAll".
8761 *
8762 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008763 * @param value The ArrayList<CharSequence> data value.
8764 *
8765 * @return Returns the same Intent object, for chaining multiple calls
8766 * into a single statement.
8767 *
8768 * @see #putExtras
8769 * @see #removeExtra
8770 * @see #getCharSequenceArrayListExtra(String)
8771 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008772 public @NonNull Intent putCharSequenceArrayListExtra(String name,
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008773 @Nullable ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008774 if (mExtras == null) {
8775 mExtras = new Bundle();
8776 }
8777 mExtras.putCharSequenceArrayList(name, value);
8778 return this;
8779 }
8780
8781 /**
8782 * Add extended data to the intent. The name must include a package
8783 * prefix, for example the app com.android.contacts would use names
8784 * like "com.android.contacts.ShowAll".
8785 *
8786 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008787 * @param value The Serializable data value.
8788 *
8789 * @return Returns the same Intent object, for chaining multiple calls
8790 * into a single statement.
8791 *
8792 * @see #putExtras
8793 * @see #removeExtra
8794 * @see #getSerializableExtra(String)
8795 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008796 public @NonNull Intent putExtra(String name, @Nullable Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008797 if (mExtras == null) {
8798 mExtras = new Bundle();
8799 }
8800 mExtras.putSerializable(name, value);
8801 return this;
8802 }
8803
8804 /**
8805 * Add extended data to the intent. The name must include a package
8806 * prefix, for example the app com.android.contacts would use names
8807 * like "com.android.contacts.ShowAll".
8808 *
8809 * @param name The name of the extra data, with package prefix.
8810 * @param value The boolean array data value.
8811 *
8812 * @return Returns the same Intent object, for chaining multiple calls
8813 * into a single statement.
8814 *
8815 * @see #putExtras
8816 * @see #removeExtra
8817 * @see #getBooleanArrayExtra(String)
8818 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008819 public @NonNull Intent putExtra(String name, @Nullable boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008820 if (mExtras == null) {
8821 mExtras = new Bundle();
8822 }
8823 mExtras.putBooleanArray(name, value);
8824 return this;
8825 }
8826
8827 /**
8828 * Add extended data to the intent. The name must include a package
8829 * prefix, for example the app com.android.contacts would use names
8830 * like "com.android.contacts.ShowAll".
8831 *
8832 * @param name The name of the extra data, with package prefix.
8833 * @param value The byte array data value.
8834 *
8835 * @return Returns the same Intent object, for chaining multiple calls
8836 * into a single statement.
8837 *
8838 * @see #putExtras
8839 * @see #removeExtra
8840 * @see #getByteArrayExtra(String)
8841 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008842 public @NonNull Intent putExtra(String name, @Nullable byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008843 if (mExtras == null) {
8844 mExtras = new Bundle();
8845 }
8846 mExtras.putByteArray(name, value);
8847 return this;
8848 }
8849
8850 /**
8851 * Add extended data to the intent. The name must include a package
8852 * prefix, for example the app com.android.contacts would use names
8853 * like "com.android.contacts.ShowAll".
8854 *
8855 * @param name The name of the extra data, with package prefix.
8856 * @param value The short array data value.
8857 *
8858 * @return Returns the same Intent object, for chaining multiple calls
8859 * into a single statement.
8860 *
8861 * @see #putExtras
8862 * @see #removeExtra
8863 * @see #getShortArrayExtra(String)
8864 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008865 public @NonNull Intent putExtra(String name, @Nullable short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008866 if (mExtras == null) {
8867 mExtras = new Bundle();
8868 }
8869 mExtras.putShortArray(name, value);
8870 return this;
8871 }
8872
8873 /**
8874 * Add extended data to the intent. The name must include a package
8875 * prefix, for example the app com.android.contacts would use names
8876 * like "com.android.contacts.ShowAll".
8877 *
8878 * @param name The name of the extra data, with package prefix.
8879 * @param value The char array data value.
8880 *
8881 * @return Returns the same Intent object, for chaining multiple calls
8882 * into a single statement.
8883 *
8884 * @see #putExtras
8885 * @see #removeExtra
8886 * @see #getCharArrayExtra(String)
8887 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008888 public @NonNull Intent putExtra(String name, @Nullable char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008889 if (mExtras == null) {
8890 mExtras = new Bundle();
8891 }
8892 mExtras.putCharArray(name, value);
8893 return this;
8894 }
8895
8896 /**
8897 * Add extended data to the intent. The name must include a package
8898 * prefix, for example the app com.android.contacts would use names
8899 * like "com.android.contacts.ShowAll".
8900 *
8901 * @param name The name of the extra data, with package prefix.
8902 * @param value The int array data value.
8903 *
8904 * @return Returns the same Intent object, for chaining multiple calls
8905 * into a single statement.
8906 *
8907 * @see #putExtras
8908 * @see #removeExtra
8909 * @see #getIntArrayExtra(String)
8910 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008911 public @NonNull Intent putExtra(String name, @Nullable int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008912 if (mExtras == null) {
8913 mExtras = new Bundle();
8914 }
8915 mExtras.putIntArray(name, value);
8916 return this;
8917 }
8918
8919 /**
8920 * Add extended data to the intent. The name must include a package
8921 * prefix, for example the app com.android.contacts would use names
8922 * like "com.android.contacts.ShowAll".
8923 *
8924 * @param name The name of the extra data, with package prefix.
8925 * @param value The byte array data value.
8926 *
8927 * @return Returns the same Intent object, for chaining multiple calls
8928 * into a single statement.
8929 *
8930 * @see #putExtras
8931 * @see #removeExtra
8932 * @see #getLongArrayExtra(String)
8933 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008934 public @NonNull Intent putExtra(String name, @Nullable long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008935 if (mExtras == null) {
8936 mExtras = new Bundle();
8937 }
8938 mExtras.putLongArray(name, value);
8939 return this;
8940 }
8941
8942 /**
8943 * Add extended data to the intent. The name must include a package
8944 * prefix, for example the app com.android.contacts would use names
8945 * like "com.android.contacts.ShowAll".
8946 *
8947 * @param name The name of the extra data, with package prefix.
8948 * @param value The float array data value.
8949 *
8950 * @return Returns the same Intent object, for chaining multiple calls
8951 * into a single statement.
8952 *
8953 * @see #putExtras
8954 * @see #removeExtra
8955 * @see #getFloatArrayExtra(String)
8956 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008957 public @NonNull Intent putExtra(String name, @Nullable float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008958 if (mExtras == null) {
8959 mExtras = new Bundle();
8960 }
8961 mExtras.putFloatArray(name, value);
8962 return this;
8963 }
8964
8965 /**
8966 * Add extended data to the intent. The name must include a package
8967 * prefix, for example the app com.android.contacts would use names
8968 * like "com.android.contacts.ShowAll".
8969 *
8970 * @param name The name of the extra data, with package prefix.
8971 * @param value The double array data value.
8972 *
8973 * @return Returns the same Intent object, for chaining multiple calls
8974 * into a single statement.
8975 *
8976 * @see #putExtras
8977 * @see #removeExtra
8978 * @see #getDoubleArrayExtra(String)
8979 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00008980 public @NonNull Intent putExtra(String name, @Nullable double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008981 if (mExtras == null) {
8982 mExtras = new Bundle();
8983 }
8984 mExtras.putDoubleArray(name, value);
8985 return this;
8986 }
8987
8988 /**
8989 * Add extended data to the intent. The name must include a package
8990 * prefix, for example the app com.android.contacts would use names
8991 * like "com.android.contacts.ShowAll".
8992 *
8993 * @param name The name of the extra data, with package prefix.
8994 * @param value The String array data value.
8995 *
8996 * @return Returns the same Intent object, for chaining multiple calls
8997 * into a single statement.
8998 *
8999 * @see #putExtras
9000 * @see #removeExtra
9001 * @see #getStringArrayExtra(String)
9002 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00009003 public @NonNull Intent putExtra(String name, @Nullable String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009004 if (mExtras == null) {
9005 mExtras = new Bundle();
9006 }
9007 mExtras.putStringArray(name, value);
9008 return this;
9009 }
9010
9011 /**
9012 * Add extended data to the intent. The name must include a package
9013 * prefix, for example the app com.android.contacts would use names
9014 * like "com.android.contacts.ShowAll".
9015 *
9016 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00009017 * @param value The CharSequence array data value.
9018 *
9019 * @return Returns the same Intent object, for chaining multiple calls
9020 * into a single statement.
9021 *
9022 * @see #putExtras
9023 * @see #removeExtra
9024 * @see #getCharSequenceArrayExtra(String)
9025 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00009026 public @NonNull Intent putExtra(String name, @Nullable CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00009027 if (mExtras == null) {
9028 mExtras = new Bundle();
9029 }
9030 mExtras.putCharSequenceArray(name, value);
9031 return this;
9032 }
9033
9034 /**
9035 * Add extended data to the intent. The name must include a package
9036 * prefix, for example the app com.android.contacts would use names
9037 * like "com.android.contacts.ShowAll".
9038 *
9039 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009040 * @param value The Bundle data value.
9041 *
9042 * @return Returns the same Intent object, for chaining multiple calls
9043 * into a single statement.
9044 *
9045 * @see #putExtras
9046 * @see #removeExtra
9047 * @see #getBundleExtra(String)
9048 */
Andrey Kulikov641c15c2018-11-13 16:44:40 +00009049 public @NonNull Intent putExtra(String name, @Nullable Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009050 if (mExtras == null) {
9051 mExtras = new Bundle();
9052 }
9053 mExtras.putBundle(name, value);
9054 return this;
9055 }
9056
9057 /**
9058 * Add extended data to the intent. The name must include a package
9059 * prefix, for example the app com.android.contacts would use names
9060 * like "com.android.contacts.ShowAll".
9061 *
9062 * @param name The name of the extra data, with package prefix.
9063 * @param value The IBinder data value.
9064 *
9065 * @return Returns the same Intent object, for chaining multiple calls
9066 * into a single statement.
9067 *
9068 * @see #putExtras
9069 * @see #removeExtra
9070 * @see #getIBinderExtra(String)
9071 *
9072 * @deprecated
9073 * @hide
9074 */
9075 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01009076 @UnsupportedAppUsage
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009077 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009078 if (mExtras == null) {
9079 mExtras = new Bundle();
9080 }
9081 mExtras.putIBinder(name, value);
9082 return this;
9083 }
9084
9085 /**
9086 * Copy all extras in 'src' in to this intent.
9087 *
9088 * @param src Contains the extras to copy.
9089 *
9090 * @see #putExtra
9091 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009092 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009093 if (src.mExtras != null) {
9094 if (mExtras == null) {
9095 mExtras = new Bundle(src.mExtras);
9096 } else {
9097 mExtras.putAll(src.mExtras);
9098 }
9099 }
9100 return this;
9101 }
9102
9103 /**
9104 * Add a set of extended data to the intent. The keys must include a package
9105 * prefix, for example the app com.android.contacts would use names
9106 * like "com.android.contacts.ShowAll".
9107 *
9108 * @param extras The Bundle of extras to add to this intent.
9109 *
9110 * @see #putExtra
9111 * @see #removeExtra
9112 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009113 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009114 if (mExtras == null) {
9115 mExtras = new Bundle();
9116 }
9117 mExtras.putAll(extras);
9118 return this;
9119 }
9120
9121 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009122 * Completely replace the extras in the Intent with the extras in the
9123 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07009124 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009125 * @param src The exact extras contained in this Intent are copied
9126 * into the target intent, replacing any that were previously there.
9127 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009128 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009129 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
9130 return this;
9131 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009132
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009133 /**
9134 * Completely replace the extras in the Intent with the given Bundle of
9135 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07009136 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009137 * @param extras The new set of extras in the Intent, or null to erase
9138 * all extras.
9139 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009140 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009141 mExtras = extras != null ? new Bundle(extras) : null;
9142 return this;
9143 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009144
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009145 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009146 * Remove extended data from the intent.
9147 *
9148 * @see #putExtra
9149 */
9150 public void removeExtra(String name) {
9151 if (mExtras != null) {
9152 mExtras.remove(name);
9153 if (mExtras.size() == 0) {
9154 mExtras = null;
9155 }
9156 }
9157 }
9158
9159 /**
9160 * Set special flags controlling how this intent is handled. Most values
9161 * here depend on the type of component being executed by the Intent,
9162 * specifically the FLAG_ACTIVITY_* flags are all for use with
9163 * {@link Context#startActivity Context.startActivity()} and the
9164 * FLAG_RECEIVER_* flags are all for use with
9165 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
9166 *
Scott Main7aee61f2011-02-08 11:25:01 -08009167 * <p>See the
9168 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
9169 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009170 * the behavior of your application.
9171 *
9172 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009173 * @return Returns the same Intent object, for chaining multiple calls
9174 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009175 * @see #getFlags
9176 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009177 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009178 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009179 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009180 mFlags = flags;
9181 return this;
9182 }
9183
9184 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009185 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009186 *
9187 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009188 * @return Returns the same Intent object, for chaining multiple calls into
9189 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009190 * @see #setFlags
9191 * @see #getFlags
9192 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009193 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009194 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009195 mFlags |= flags;
9196 return this;
9197 }
9198
9199 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009200 * Remove these flags from the intent.
9201 *
9202 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009203 * @see #setFlags
9204 * @see #getFlags
9205 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009206 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009207 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009208 mFlags &= ~flags;
9209 }
9210
9211 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009212 * (Usually optional) Set an explicit application package name that limits
9213 * the components this Intent will resolve to. If left to the default
9214 * value of null, all components in all applications will considered.
9215 * If non-null, the Intent can only match the components in the given
9216 * application package.
9217 *
9218 * @param packageName The name of the application package to handle the
9219 * intent, or null to allow any application package.
9220 *
9221 * @return Returns the same Intent object, for chaining multiple calls
9222 * into a single statement.
9223 *
9224 * @see #getPackage
9225 * @see #resolveActivity
9226 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009227 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009228 if (packageName != null && mSelector != null) {
9229 throw new IllegalArgumentException(
9230 "Can't set package name when selector is already set");
9231 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009232 mPackage = packageName;
9233 return this;
9234 }
9235
9236 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009237 * (Usually optional) Explicitly set the component to handle the intent.
9238 * If left with the default value of null, the system will determine the
9239 * appropriate class to use based on the other fields (action, data,
9240 * type, categories) in the Intent. If this class is defined, the
9241 * specified class will always be used regardless of the other fields. You
9242 * should only set this value when you know you absolutely want a specific
9243 * class to be used; otherwise it is better to let the system find the
9244 * appropriate class so that you will respect the installed applications
9245 * and user preferences.
9246 *
9247 * @param component The name of the application component to handle the
9248 * intent, or null to let the system find one for you.
9249 *
9250 * @return Returns the same Intent object, for chaining multiple calls
9251 * into a single statement.
9252 *
9253 * @see #setClass
9254 * @see #setClassName(Context, String)
9255 * @see #setClassName(String, String)
9256 * @see #getComponent
9257 * @see #resolveActivity
9258 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009259 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009260 mComponent = component;
9261 return this;
9262 }
9263
9264 /**
9265 * Convenience for calling {@link #setComponent} with an
9266 * explicit class name.
9267 *
9268 * @param packageContext A Context of the application package implementing
9269 * this class.
9270 * @param className The name of a class inside of the application package
9271 * that will be used as the component for this Intent.
9272 *
9273 * @return Returns the same Intent object, for chaining multiple calls
9274 * into a single statement.
9275 *
9276 * @see #setComponent
9277 * @see #setClass
9278 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009279 public @NonNull Intent setClassName(@NonNull Context packageContext,
9280 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009281 mComponent = new ComponentName(packageContext, className);
9282 return this;
9283 }
9284
9285 /**
9286 * Convenience for calling {@link #setComponent} with an
9287 * explicit application package name and class name.
9288 *
9289 * @param packageName The name of the package implementing the desired
9290 * component.
9291 * @param className The name of a class inside of the application package
9292 * that will be used as the component for this Intent.
9293 *
9294 * @return Returns the same Intent object, for chaining multiple calls
9295 * into a single statement.
9296 *
9297 * @see #setComponent
9298 * @see #setClass
9299 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009300 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009301 mComponent = new ComponentName(packageName, className);
9302 return this;
9303 }
9304
9305 /**
9306 * Convenience for calling {@link #setComponent(ComponentName)} with the
9307 * name returned by a {@link Class} object.
9308 *
9309 * @param packageContext A Context of the application package implementing
9310 * this class.
9311 * @param cls The class name to set, equivalent to
9312 * <code>setClassName(context, cls.getName())</code>.
9313 *
9314 * @return Returns the same Intent object, for chaining multiple calls
9315 * into a single statement.
9316 *
9317 * @see #setComponent
9318 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009319 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009320 mComponent = new ComponentName(packageContext, cls);
9321 return this;
9322 }
9323
9324 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009325 * Set the bounds of the sender of this intent, in screen coordinates. This can be
9326 * used as a hint to the receiver for animations and the like. Null means that there
9327 * is no source bounds.
9328 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009329 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009330 if (r != null) {
9331 mSourceBounds = new Rect(r);
9332 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07009333 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009334 }
9335 }
9336
Tor Norbyed9273d62013-05-30 15:59:53 -07009337 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07009338 @IntDef(flag = true, prefix = { "FILL_IN_" }, value = {
9339 FILL_IN_ACTION,
9340 FILL_IN_DATA,
9341 FILL_IN_CATEGORIES,
9342 FILL_IN_COMPONENT,
9343 FILL_IN_PACKAGE,
9344 FILL_IN_SOURCE_BOUNDS,
9345 FILL_IN_SELECTOR,
9346 FILL_IN_CLIP_DATA
9347 })
Tor Norbyed9273d62013-05-30 15:59:53 -07009348 @Retention(RetentionPolicy.SOURCE)
9349 public @interface FillInFlags {}
9350
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009351 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009352 * Use with {@link #fillIn} to allow the current action value to be
9353 * overwritten, even if it is already set.
9354 */
9355 public static final int FILL_IN_ACTION = 1<<0;
9356
9357 /**
9358 * Use with {@link #fillIn} to allow the current data or type value
9359 * overwritten, even if it is already set.
9360 */
9361 public static final int FILL_IN_DATA = 1<<1;
9362
9363 /**
9364 * Use with {@link #fillIn} to allow the current categories to be
9365 * overwritten, even if they are already set.
9366 */
9367 public static final int FILL_IN_CATEGORIES = 1<<2;
9368
9369 /**
9370 * Use with {@link #fillIn} to allow the current component value to be
9371 * overwritten, even if it is already set.
9372 */
9373 public static final int FILL_IN_COMPONENT = 1<<3;
9374
9375 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009376 * Use with {@link #fillIn} to allow the current package value to be
9377 * overwritten, even if it is already set.
9378 */
9379 public static final int FILL_IN_PACKAGE = 1<<4;
9380
9381 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009382 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009383 * overwritten, even if it is already set.
9384 */
9385 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
9386
9387 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009388 * Use with {@link #fillIn} to allow the current selector to be
9389 * overwritten, even if it is already set.
9390 */
9391 public static final int FILL_IN_SELECTOR = 1<<6;
9392
9393 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009394 * Use with {@link #fillIn} to allow the current ClipData to be
9395 * overwritten, even if it is already set.
9396 */
9397 public static final int FILL_IN_CLIP_DATA = 1<<7;
9398
9399 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009400 * Copy the contents of <var>other</var> in to this object, but only
9401 * where fields are not defined by this object. For purposes of a field
9402 * being defined, the following pieces of data in the Intent are
9403 * considered to be separate fields:
9404 *
9405 * <ul>
9406 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08009407 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009408 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
9409 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009410 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009411 * <li> component, as set by {@link #setComponent(ComponentName)} or
9412 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009413 * <li> source bounds, as set by {@link #setSourceBounds}.
9414 * <li> selector, as set by {@link #setSelector(Intent)}.
9415 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009416 * <li> each top-level name in the associated extras.
9417 * </ul>
9418 *
9419 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009420 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009421 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
9422 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
9423 * the restriction where the corresponding field will not be replaced if
9424 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009425 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009426 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
9427 * is explicitly specified. The selector will only be copied if
9428 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07009429 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009430 * <p>For example, consider Intent A with {data="foo", categories="bar"}
9431 * and Intent B with {action="gotit", data-type="some/thing",
9432 * categories="one","two"}.
9433 *
9434 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
9435 * containing: {action="gotit", data-type="some/thing",
9436 * categories="bar"}.
9437 *
9438 * @param other Another Intent whose values are to be used to fill in
9439 * the current one.
9440 * @param flags Options to control which fields can be filled in.
9441 *
9442 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009443 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07009444 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08009445 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07009446 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009447 */
Tor Norbyed9273d62013-05-30 15:59:53 -07009448 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009449 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009450 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009451 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009452 if (other.mAction != null
9453 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009454 mAction = other.mAction;
9455 changes |= FILL_IN_ACTION;
9456 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009457 if ((other.mData != null || other.mType != null)
9458 && ((mData == null && mType == null)
9459 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009460 mData = other.mData;
9461 mType = other.mType;
9462 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009463 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009464 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009465 if (other.mCategories != null
9466 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009467 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009468 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009469 }
9470 changes |= FILL_IN_CATEGORIES;
9471 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009472 if (other.mPackage != null
9473 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009474 // Only do this if mSelector is not set.
9475 if (mSelector == null) {
9476 mPackage = other.mPackage;
9477 changes |= FILL_IN_PACKAGE;
9478 }
9479 }
9480 // Selector is special: it can only be set if explicitly allowed,
9481 // for the same reason as the component name.
9482 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
9483 if (mPackage == null) {
9484 mSelector = new Intent(other.mSelector);
9485 mPackage = null;
9486 changes |= FILL_IN_SELECTOR;
9487 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009488 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009489 if (other.mClipData != null
9490 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
9491 mClipData = other.mClipData;
9492 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009493 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009494 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009495 // Component is special: it can -only- be set if explicitly allowed,
9496 // since otherwise the sender could force the intent somewhere the
9497 // originator didn't intend.
9498 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009499 mComponent = other.mComponent;
9500 changes |= FILL_IN_COMPONENT;
9501 }
9502 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009503 if (other.mSourceBounds != null
9504 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
9505 mSourceBounds = new Rect(other.mSourceBounds);
9506 changes |= FILL_IN_SOURCE_BOUNDS;
9507 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009508 if (mExtras == null) {
9509 if (other.mExtras != null) {
9510 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009511 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009512 }
9513 } else if (other.mExtras != null) {
9514 try {
9515 Bundle newb = new Bundle(other.mExtras);
9516 newb.putAll(mExtras);
9517 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009518 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009519 } catch (RuntimeException e) {
9520 // Modifying the extras can cause us to unparcel the contents
9521 // of the bundle, and if we do this in the system process that
9522 // may fail. We really should handle this (i.e., the Bundle
9523 // impl shouldn't be on top of a plain map), but for now just
9524 // ignore it and keep the original contents. :(
9525 Log.w("Intent", "Failure filling in extras", e);
9526 }
9527 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009528 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9529 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9530 mContentUserHint = other.mContentUserHint;
9531 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009532 return changes;
9533 }
9534
9535 /**
9536 * Wrapper class holding an Intent and implementing comparisons on it for
9537 * the purpose of filtering. The class implements its
9538 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9539 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9540 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9541 * on the wrapped Intent.
9542 */
9543 public static final class FilterComparison {
9544 private final Intent mIntent;
9545 private final int mHashCode;
9546
9547 public FilterComparison(Intent intent) {
9548 mIntent = intent;
9549 mHashCode = intent.filterHashCode();
9550 }
9551
9552 /**
9553 * Return the Intent that this FilterComparison represents.
9554 * @return Returns the Intent held by the FilterComparison. Do
9555 * not modify!
9556 */
9557 public Intent getIntent() {
9558 return mIntent;
9559 }
9560
9561 @Override
9562 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009563 if (obj instanceof FilterComparison) {
9564 Intent other = ((FilterComparison)obj).mIntent;
9565 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009566 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009567 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009568 }
9569
9570 @Override
9571 public int hashCode() {
9572 return mHashCode;
9573 }
9574 }
9575
9576 /**
9577 * Determine if two intents are the same for the purposes of intent
9578 * resolution (filtering). That is, if their action, data, type,
9579 * class, and categories are the same. This does <em>not</em> compare
9580 * any extra data included in the intents.
9581 *
9582 * @param other The other Intent to compare against.
9583 *
9584 * @return Returns true if action, data, type, class, and categories
9585 * are the same.
9586 */
9587 public boolean filterEquals(Intent other) {
9588 if (other == null) {
9589 return false;
9590 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009591 if (!Objects.equals(this.mAction, other.mAction)) return false;
9592 if (!Objects.equals(this.mData, other.mData)) return false;
9593 if (!Objects.equals(this.mType, other.mType)) return false;
9594 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9595 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9596 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009597
9598 return true;
9599 }
9600
9601 /**
9602 * Generate hash code that matches semantics of filterEquals().
9603 *
9604 * @return Returns the hash value of the action, data, type, class, and
9605 * categories.
9606 *
9607 * @see #filterEquals
9608 */
9609 public int filterHashCode() {
9610 int code = 0;
9611 if (mAction != null) {
9612 code += mAction.hashCode();
9613 }
9614 if (mData != null) {
9615 code += mData.hashCode();
9616 }
9617 if (mType != null) {
9618 code += mType.hashCode();
9619 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009620 if (mPackage != null) {
9621 code += mPackage.hashCode();
9622 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009623 if (mComponent != null) {
9624 code += mComponent.hashCode();
9625 }
9626 if (mCategories != null) {
9627 code += mCategories.hashCode();
9628 }
9629 return code;
9630 }
9631
9632 @Override
9633 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009634 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009635
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009636 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009637 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009638 b.append(" }");
9639
9640 return b.toString();
9641 }
9642
9643 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01009644 @UnsupportedAppUsage
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009645 public String toInsecureString() {
9646 StringBuilder b = new StringBuilder(128);
9647
9648 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009649 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009650 b.append(" }");
9651
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009652 return b.toString();
9653 }
Romain Guy4969af72009-06-17 10:53:19 -07009654
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009655 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009656 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009657 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009658
9659 b.append("Intent { ");
9660 toShortString(b, false, true, true, true);
9661 b.append(" }");
9662
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009663 return b.toString();
9664 }
9665
9666 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009667 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9668 StringBuilder b = new StringBuilder(128);
9669 toShortString(b, secure, comp, extras, clip);
9670 return b.toString();
9671 }
9672
9673 /** @hide */
9674 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9675 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009676 boolean first = true;
9677 if (mAction != null) {
9678 b.append("act=").append(mAction);
9679 first = false;
9680 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009681 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009682 if (!first) {
9683 b.append(' ');
9684 }
9685 first = false;
9686 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009687 for (int i=0; i<mCategories.size(); i++) {
9688 if (i > 0) b.append(',');
9689 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009690 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009691 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009692 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009693 if (mData != null) {
9694 if (!first) {
9695 b.append(' ');
9696 }
9697 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009698 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009699 if (secure) {
9700 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009701 } else {
9702 b.append(mData);
9703 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009704 }
9705 if (mType != null) {
9706 if (!first) {
9707 b.append(' ');
9708 }
9709 first = false;
9710 b.append("typ=").append(mType);
9711 }
9712 if (mFlags != 0) {
9713 if (!first) {
9714 b.append(' ');
9715 }
9716 first = false;
9717 b.append("flg=0x").append(Integer.toHexString(mFlags));
9718 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009719 if (mPackage != null) {
9720 if (!first) {
9721 b.append(' ');
9722 }
9723 first = false;
9724 b.append("pkg=").append(mPackage);
9725 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009726 if (comp && mComponent != null) {
9727 if (!first) {
9728 b.append(' ');
9729 }
9730 first = false;
9731 b.append("cmp=").append(mComponent.flattenToShortString());
9732 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009733 if (mSourceBounds != null) {
9734 if (!first) {
9735 b.append(' ');
9736 }
9737 first = false;
9738 b.append("bnds=").append(mSourceBounds.toShortString());
9739 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009740 if (mClipData != null) {
9741 if (!first) {
9742 b.append(' ');
9743 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009744 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009745 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009746 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009747 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009748 if (mClipData.getDescription() != null) {
9749 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9750 } else {
9751 first = true;
9752 }
9753 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009754 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009755 first = false;
9756 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009757 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009758 if (extras && mExtras != null) {
9759 if (!first) {
9760 b.append(' ');
9761 }
9762 first = false;
9763 b.append("(has extras)");
9764 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009765 if (mContentUserHint != UserHandle.USER_CURRENT) {
9766 if (!first) {
9767 b.append(' ');
9768 }
9769 first = false;
9770 b.append("u=").append(mContentUserHint);
9771 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009772 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009773 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009774 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009775 b.append("}");
9776 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009777 }
9778
Yi Jin129fc6c2017-09-28 15:48:38 -07009779 /** @hide */
Kweku Adams85f2fbc2017-12-18 12:04:12 -08009780 public void writeToProto(ProtoOutputStream proto, long fieldId) {
9781 // Same input parameters that toString() gives to toShortString().
9782 writeToProto(proto, fieldId, true, true, true, false);
9783 }
9784
9785 /** @hide */
Yi Jin129fc6c2017-09-28 15:48:38 -07009786 public void writeToProto(ProtoOutputStream proto, long fieldId, boolean secure, boolean comp,
9787 boolean extras, boolean clip) {
9788 long token = proto.start(fieldId);
9789 if (mAction != null) {
9790 proto.write(IntentProto.ACTION, mAction);
9791 }
9792 if (mCategories != null) {
9793 for (String category : mCategories) {
9794 proto.write(IntentProto.CATEGORIES, category);
9795 }
9796 }
9797 if (mData != null) {
9798 proto.write(IntentProto.DATA, secure ? mData.toSafeString() : mData.toString());
9799 }
9800 if (mType != null) {
9801 proto.write(IntentProto.TYPE, mType);
9802 }
9803 if (mFlags != 0) {
9804 proto.write(IntentProto.FLAG, "0x" + Integer.toHexString(mFlags));
9805 }
9806 if (mPackage != null) {
9807 proto.write(IntentProto.PACKAGE, mPackage);
9808 }
9809 if (comp && mComponent != null) {
Yi Jin676d1ac2018-01-25 15:40:28 -08009810 mComponent.writeToProto(proto, IntentProto.COMPONENT);
Yi Jin129fc6c2017-09-28 15:48:38 -07009811 }
9812 if (mSourceBounds != null) {
9813 proto.write(IntentProto.SOURCE_BOUNDS, mSourceBounds.toShortString());
9814 }
9815 if (mClipData != null) {
9816 StringBuilder b = new StringBuilder();
9817 if (clip) {
9818 mClipData.toShortString(b);
9819 } else {
9820 mClipData.toShortStringShortItems(b, false);
9821 }
9822 proto.write(IntentProto.CLIP_DATA, b.toString());
9823 }
9824 if (extras && mExtras != null) {
9825 proto.write(IntentProto.EXTRAS, mExtras.toShortString());
9826 }
9827 if (mContentUserHint != 0) {
9828 proto.write(IntentProto.CONTENT_USER_HINT, mContentUserHint);
9829 }
9830 if (mSelector != null) {
9831 proto.write(IntentProto.SELECTOR, mSelector.toShortString(secure, comp, extras, clip));
9832 }
9833 proto.end(token);
9834 }
9835
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009836 /**
9837 * Call {@link #toUri} with 0 flags.
9838 * @deprecated Use {@link #toUri} instead.
9839 */
9840 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009841 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009842 return toUri(0);
9843 }
9844
9845 /**
9846 * Convert this Intent into a String holding a URI representation of it.
9847 * The returned URI string has been properly URI encoded, so it can be
9848 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9849 * Intent's data as the base URI, with an additional fragment describing
9850 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009851 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009852 * <p>You can convert the returned string back to an Intent with
9853 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009854 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009855 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009856 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009857 * @return Returns a URI encoding URI string describing the entire contents
9858 * of the Intent.
9859 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009860 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009861 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009862 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9863 if (mPackage == null) {
9864 throw new IllegalArgumentException(
9865 "Intent must include an explicit package name to build an android-app: "
9866 + this);
9867 }
9868 uri.append("android-app://");
9869 uri.append(mPackage);
9870 String scheme = null;
9871 if (mData != null) {
9872 scheme = mData.getScheme();
9873 if (scheme != null) {
9874 uri.append('/');
9875 uri.append(scheme);
9876 String authority = mData.getEncodedAuthority();
9877 if (authority != null) {
9878 uri.append('/');
9879 uri.append(authority);
9880 String path = mData.getEncodedPath();
9881 if (path != null) {
9882 uri.append(path);
9883 }
9884 String queryParams = mData.getEncodedQuery();
9885 if (queryParams != null) {
9886 uri.append('?');
9887 uri.append(queryParams);
9888 }
9889 String fragment = mData.getEncodedFragment();
9890 if (fragment != null) {
9891 uri.append('#');
9892 uri.append(fragment);
9893 }
9894 }
9895 }
9896 }
9897 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9898 mPackage, flags);
9899 return uri.toString();
9900 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009901 String scheme = null;
9902 if (mData != null) {
9903 String data = mData.toString();
9904 if ((flags&URI_INTENT_SCHEME) != 0) {
9905 final int N = data.length();
9906 for (int i=0; i<N; i++) {
9907 char c = data.charAt(i);
9908 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
Christopher Schuster42c3a6e2017-07-21 14:53:52 -07009909 || (c >= '0' && c <= '9') || c == '.' || c == '-' || c == '+') {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009910 continue;
9911 }
9912 if (c == ':' && i > 0) {
9913 // Valid scheme.
9914 scheme = data.substring(0, i);
9915 uri.append("intent:");
9916 data = data.substring(i+1);
9917 break;
9918 }
Tom Taylord4a47292009-12-21 13:59:18 -08009919
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009920 // No scheme.
9921 break;
9922 }
9923 }
9924 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009925
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009926 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9927 uri.append("intent:");
9928 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009929
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009930 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009931
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009932 return uri.toString();
9933 }
9934
9935 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9936 String defPackage, int flags) {
9937 StringBuilder frag = new StringBuilder(128);
9938
9939 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009940 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009941 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009942 // Note that for now we are not going to try to handle the
9943 // data part; not clear how to represent this as a URI, and
9944 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009945 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9946 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009947 }
9948
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009949 if (frag.length() > 0) {
9950 uri.append("#Intent;");
9951 uri.append(frag);
9952 uri.append("end");
9953 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009954 }
9955
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009956 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9957 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009958 if (scheme != null) {
9959 uri.append("scheme=").append(scheme).append(';');
9960 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009961 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009962 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009963 }
9964 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009965 for (int i=0; i<mCategories.size(); i++) {
9966 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009967 }
9968 }
9969 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009970 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009971 }
9972 if (mFlags != 0) {
9973 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9974 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009975 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009976 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9977 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009978 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009979 uri.append("component=").append(Uri.encode(
9980 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009981 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009982 if (mSourceBounds != null) {
9983 uri.append("sourceBounds=")
9984 .append(Uri.encode(mSourceBounds.flattenToString()))
9985 .append(';');
9986 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009987 if (mExtras != null) {
9988 for (String key : mExtras.keySet()) {
9989 final Object value = mExtras.get(key);
9990 char entryType =
9991 value instanceof String ? 'S' :
9992 value instanceof Boolean ? 'B' :
9993 value instanceof Byte ? 'b' :
9994 value instanceof Character ? 'c' :
9995 value instanceof Double ? 'd' :
9996 value instanceof Float ? 'f' :
9997 value instanceof Integer ? 'i' :
9998 value instanceof Long ? 'l' :
9999 value instanceof Short ? 's' :
10000 '\0';
10001
10002 if (entryType != '\0') {
10003 uri.append(entryType);
10004 uri.append('.');
10005 uri.append(Uri.encode(key));
10006 uri.append('=');
10007 uri.append(Uri.encode(value.toString()));
10008 uri.append(';');
10009 }
10010 }
10011 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010012 }
The Android Open Source Project10592532009-03-18 17:39:46 -070010013
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010014 public int describeContents() {
10015 return (mExtras != null) ? mExtras.describeContents() : 0;
10016 }
10017
10018 public void writeToParcel(Parcel out, int flags) {
10019 out.writeString(mAction);
10020 Uri.writeToParcel(out, mData);
10021 out.writeString(mType);
10022 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -070010023 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010024 ComponentName.writeToParcel(mComponent, out);
10025
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080010026 if (mSourceBounds != null) {
10027 out.writeInt(1);
10028 mSourceBounds.writeToParcel(out, flags);
10029 } else {
10030 out.writeInt(0);
10031 }
10032
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010033 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -070010034 final int N = mCategories.size();
10035 out.writeInt(N);
10036 for (int i=0; i<N; i++) {
10037 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010038 }
10039 } else {
10040 out.writeInt(0);
10041 }
10042
Dianne Hackbornf5b86712011-12-05 17:42:41 -080010043 if (mSelector != null) {
10044 out.writeInt(1);
10045 mSelector.writeToParcel(out, flags);
10046 } else {
10047 out.writeInt(0);
10048 }
10049
Dianne Hackborn21c241e2012-03-08 13:57:23 -080010050 if (mClipData != null) {
10051 out.writeInt(1);
10052 mClipData.writeToParcel(out, flags);
10053 } else {
10054 out.writeInt(0);
10055 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010056 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010057 out.writeBundle(mExtras);
10058 }
10059
10060 public static final Parcelable.Creator<Intent> CREATOR
10061 = new Parcelable.Creator<Intent>() {
10062 public Intent createFromParcel(Parcel in) {
10063 return new Intent(in);
10064 }
10065 public Intent[] newArray(int size) {
10066 return new Intent[size];
10067 }
10068 };
10069
Dianne Hackborneb034652009-09-07 00:49:58 -070010070 /** @hide */
10071 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010072 readFromParcel(in);
10073 }
10074
10075 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -080010076 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010077 mData = Uri.CREATOR.createFromParcel(in);
10078 mType = in.readString();
10079 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -070010080 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010081 mComponent = ComponentName.readFromParcel(in);
10082
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080010083 if (in.readInt() != 0) {
10084 mSourceBounds = Rect.CREATOR.createFromParcel(in);
10085 }
10086
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010087 int N = in.readInt();
10088 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -070010089 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010090 int i;
10091 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -080010092 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010093 }
10094 } else {
10095 mCategories = null;
10096 }
10097
Dianne Hackbornf5b86712011-12-05 17:42:41 -080010098 if (in.readInt() != 0) {
10099 mSelector = new Intent(in);
10100 }
10101
Dianne Hackborn21c241e2012-03-08 13:57:23 -080010102 if (in.readInt() != 0) {
10103 mClipData = new ClipData(in);
10104 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010105 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010106 mExtras = in.readBundle();
10107 }
10108
10109 /**
10110 * Parses the "intent" element (and its children) from XML and instantiates
10111 * an Intent object. The given XML parser should be located at the tag
10112 * where parsing should start (often named "intent"), from which the
10113 * basic action, data, type, and package and class name will be
10114 * retrieved. The function will then parse in to any child elements,
10115 * looking for <category android:name="xxx"> tags to add categories and
10116 * <extra android:name="xxx" android:value="yyy"> to attach extra data
10117 * to the intent.
10118 *
10119 * @param resources The Resources to use when inflating resources.
10120 * @param parser The XML parser pointing at an "intent" tag.
10121 * @param attrs The AttributeSet interface for retrieving extended
10122 * attribute data at the current <var>parser</var> location.
10123 * @return An Intent object matching the XML data.
10124 * @throws XmlPullParserException If there was an XML parsing error.
10125 * @throws IOException If there was an I/O error.
10126 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060010127 public static @NonNull Intent parseIntent(@NonNull Resources resources,
10128 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010129 throws XmlPullParserException, IOException {
10130 Intent intent = new Intent();
10131
10132 TypedArray sa = resources.obtainAttributes(attrs,
10133 com.android.internal.R.styleable.Intent);
10134
10135 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
10136
10137 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
10138 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
10139 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
10140
10141 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
10142 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
10143 if (packageName != null && className != null) {
10144 intent.setComponent(new ComponentName(packageName, className));
10145 }
10146
10147 sa.recycle();
10148
10149 int outerDepth = parser.getDepth();
10150 int type;
10151 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
10152 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
10153 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
10154 continue;
10155 }
10156
10157 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -070010158 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010159 sa = resources.obtainAttributes(attrs,
10160 com.android.internal.R.styleable.IntentCategory);
10161 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
10162 sa.recycle();
10163
10164 if (cat != null) {
10165 intent.addCategory(cat);
10166 }
10167 XmlUtils.skipCurrentTag(parser);
10168
Craig Mautner21d24a22014-04-23 11:45:37 -070010169 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -080010170 if (intent.mExtras == null) {
10171 intent.mExtras = new Bundle();
10172 }
Craig Mautner21d24a22014-04-23 11:45:37 -070010173 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -080010174 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010175
10176 } else {
10177 XmlUtils.skipCurrentTag(parser);
10178 }
10179 }
10180
10181 return intent;
10182 }
Nick Pellyccae4122012-01-09 14:12:58 -080010183
Craig Mautner21d24a22014-04-23 11:45:37 -070010184 /** @hide */
10185 public void saveToXml(XmlSerializer out) throws IOException {
10186 if (mAction != null) {
10187 out.attribute(null, ATTR_ACTION, mAction);
10188 }
10189 if (mData != null) {
10190 out.attribute(null, ATTR_DATA, mData.toString());
10191 }
10192 if (mType != null) {
10193 out.attribute(null, ATTR_TYPE, mType);
10194 }
10195 if (mComponent != null) {
10196 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
10197 }
10198 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
10199
10200 if (mCategories != null) {
10201 out.startTag(null, TAG_CATEGORIES);
10202 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
10203 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
10204 }
Craig Mautner43e52ed2014-06-16 17:18:52 -070010205 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -070010206 }
10207 }
10208
10209 /** @hide */
10210 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
10211 XmlPullParserException {
10212 Intent intent = new Intent();
10213 final int outerDepth = in.getDepth();
10214
10215 int attrCount = in.getAttributeCount();
10216 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
10217 final String attrName = in.getAttributeName(attrNdx);
10218 final String attrValue = in.getAttributeValue(attrNdx);
10219 if (ATTR_ACTION.equals(attrName)) {
10220 intent.setAction(attrValue);
10221 } else if (ATTR_DATA.equals(attrName)) {
10222 intent.setData(Uri.parse(attrValue));
10223 } else if (ATTR_TYPE.equals(attrName)) {
10224 intent.setType(attrValue);
10225 } else if (ATTR_COMPONENT.equals(attrName)) {
10226 intent.setComponent(ComponentName.unflattenFromString(attrValue));
10227 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +010010228 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -070010229 } else {
10230 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
10231 }
10232 }
10233
10234 int event;
10235 String name;
10236 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
10237 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
10238 if (event == XmlPullParser.START_TAG) {
10239 name = in.getName();
10240 if (TAG_CATEGORIES.equals(name)) {
10241 attrCount = in.getAttributeCount();
10242 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
10243 intent.addCategory(in.getAttributeValue(attrNdx));
10244 }
10245 } else {
10246 Log.w("Intent", "restoreFromXml: unknown name=" + name);
10247 XmlUtils.skipCurrentTag(in);
10248 }
10249 }
10250 }
10251
10252 return intent;
10253 }
10254
Nick Pellyccae4122012-01-09 14:12:58 -080010255 /**
10256 * Normalize a MIME data type.
10257 *
10258 * <p>A normalized MIME type has white-space trimmed,
10259 * content-type parameters removed, and is lower-case.
10260 * This aligns the type with Android best practices for
10261 * intent filtering.
10262 *
10263 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
10264 * "text/x-vCard" becomes "text/x-vcard".
10265 *
10266 * <p>All MIME types received from outside Android (such as user input,
10267 * or external sources like Bluetooth, NFC, or the Internet) should
10268 * be normalized before they are used to create an Intent.
10269 *
10270 * @param type MIME data type to normalize
10271 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -050010272 * @see #setType
10273 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -080010274 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060010275 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -080010276 if (type == null) {
10277 return null;
10278 }
10279
Elliott Hughescb64d432013-08-02 10:00:44 -070010280 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -080010281
10282 final int semicolonIndex = type.indexOf(';');
10283 if (semicolonIndex != -1) {
10284 type = type.substring(0, semicolonIndex);
10285 }
10286 return type;
10287 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010288
10289 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010290 * Prepare this {@link Intent} to leave an app process.
10291 *
10292 * @hide
10293 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +010010294 @UnsupportedAppUsage
Jeff Sharkey344744b2016-01-28 19:03:30 -070010295 public void prepareToLeaveProcess(Context context) {
10296 final boolean leavingPackage = (mComponent == null)
10297 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
10298 prepareToLeaveProcess(leavingPackage);
10299 }
10300
10301 /**
10302 * Prepare this {@link Intent} to leave an app process.
10303 *
10304 * @hide
10305 */
10306 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010307 setAllowFds(false);
10308
10309 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010310 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010311 }
10312 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010313 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010314 }
10315
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -070010316 if (mExtras != null && !mExtras.isParcelled()) {
10317 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
10318 if (intent instanceof Intent) {
10319 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
10320 }
10321 }
10322
Jeff Sharkeya8b42782016-01-30 17:58:09 -070010323 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
10324 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010325 switch (mAction) {
10326 case ACTION_MEDIA_REMOVED:
10327 case ACTION_MEDIA_UNMOUNTED:
10328 case ACTION_MEDIA_CHECKING:
10329 case ACTION_MEDIA_NOFS:
10330 case ACTION_MEDIA_MOUNTED:
10331 case ACTION_MEDIA_SHARED:
10332 case ACTION_MEDIA_UNSHARED:
10333 case ACTION_MEDIA_BAD_REMOVAL:
10334 case ACTION_MEDIA_UNMOUNTABLE:
10335 case ACTION_MEDIA_EJECT:
10336 case ACTION_MEDIA_SCANNER_STARTED:
10337 case ACTION_MEDIA_SCANNER_FINISHED:
10338 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -070010339 case ACTION_PACKAGE_NEEDS_VERIFICATION:
10340 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -070010341 // Ignore legacy actions
10342 break;
10343 default:
10344 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010345 }
10346 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010347
10348 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
10349 && leavingPackage) {
10350 switch (mAction) {
10351 case ACTION_PROVIDER_CHANGED:
Makoto Onuki7d1911f2017-06-09 12:30:09 -070010352 case QuickContact.ACTION_QUICK_CONTACT:
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010353 // Ignore actions that don't need to grant
10354 break;
10355 default:
10356 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
10357 }
10358 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010359 }
10360
10361 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010362 * @hide
10363 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010364 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -070010365 // We just entered destination process, so we should be able to read all
10366 // parcelables inside.
10367 setDefusable(true);
10368
10369 if (mSelector != null) {
10370 mSelector.prepareToEnterProcess();
10371 }
10372 if (mClipData != null) {
10373 mClipData.prepareToEnterProcess();
10374 }
10375
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010376 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000010377 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
10378 fixUris(mContentUserHint);
10379 mContentUserHint = UserHandle.USER_CURRENT;
10380 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010381 }
10382 }
10383
Patrick Baumann577d4022018-01-31 16:55:10 +000010384 /** @hide */
10385 public boolean hasWebURI() {
10386 if (getData() == null) {
10387 return false;
10388 }
10389 final String scheme = getScheme();
10390 if (TextUtils.isEmpty(scheme)) {
10391 return false;
10392 }
10393 return scheme.equals(IntentFilter.SCHEME_HTTP) || scheme.equals(IntentFilter.SCHEME_HTTPS);
10394 }
10395
10396 /** @hide */
Patrick Baumann0da85372018-02-02 16:07:35 -080010397 public boolean isWebIntent() {
Patrick Baumann577d4022018-01-31 16:55:10 +000010398 return ACTION_VIEW.equals(mAction)
Patrick Baumann577d4022018-01-31 16:55:10 +000010399 && hasWebURI();
10400 }
10401
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010402 /**
10403 * @hide
10404 */
10405 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010406 Uri data = getData();
10407 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010408 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010409 }
10410 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010411 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010412 }
10413 String action = getAction();
10414 if (ACTION_SEND.equals(action)) {
10415 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10416 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010417 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010418 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010419 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010420 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10421 if (streams != null) {
10422 ArrayList<Uri> newStreams = new ArrayList<Uri>();
10423 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010424 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010425 }
10426 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
10427 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010428 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10429 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10430 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10431 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10432 if (output != null) {
10433 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
10434 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010435 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010436 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010437
10438 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010439 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010440 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
10441 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010442 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010443 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010444 * @hide
10445 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010446 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010447 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010448 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010449
10450 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010451 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010452
10453 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010454 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010455 // Inspect contained intents to see if we need to migrate extras. We
10456 // don't promote ClipData to the parent, since ChooserActivity will
10457 // already start the picked item as the caller, and we can't combine
10458 // the flags in a safe way.
10459
10460 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -070010461 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010462 final Intent intent = getParcelableExtra(EXTRA_INTENT);
10463 if (intent != null) {
10464 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -070010465 }
10466 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010467 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010468 try {
10469 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
10470 if (intents != null) {
10471 for (int i = 0; i < intents.length; i++) {
10472 final Intent intent = (Intent) intents[i];
10473 if (intent != null) {
10474 migrated |= intent.migrateExtraStreamToClipData();
10475 }
10476 }
10477 }
10478 } catch (ClassCastException e) {
10479 }
10480 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010481
10482 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010483 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010484 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10485 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
10486 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
10487 if (stream != null || text != null || htmlText != null) {
10488 final ClipData clipData = new ClipData(
10489 null, new String[] { getType() },
10490 new ClipData.Item(text, htmlText, null, stream));
10491 setClipData(clipData);
10492 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010493 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010494 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010495 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010496 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010497
10498 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010499 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010500 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10501 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
10502 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
10503 int num = -1;
10504 if (streams != null) {
10505 num = streams.size();
10506 }
10507 if (texts != null) {
10508 if (num >= 0 && num != texts.size()) {
10509 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010510 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010511 }
10512 num = texts.size();
10513 }
10514 if (htmlTexts != null) {
10515 if (num >= 0 && num != htmlTexts.size()) {
10516 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010517 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010518 }
10519 num = htmlTexts.size();
10520 }
10521 if (num > 0) {
10522 final ClipData clipData = new ClipData(
10523 null, new String[] { getType() },
10524 makeClipItem(streams, texts, htmlTexts, 0));
10525
10526 for (int i = 1; i < num; i++) {
10527 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
10528 }
10529
10530 setClipData(clipData);
10531 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010532 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010533 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010534 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010535 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010536 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10537 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10538 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10539 final Uri output;
10540 try {
10541 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10542 } catch (ClassCastException e) {
10543 return false;
10544 }
10545 if (output != null) {
10546 setClipData(ClipData.newRawUri("", output));
10547 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
10548 return true;
10549 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010550 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010551
10552 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010553 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010554
Michael Wright19859762017-09-18 20:57:58 +010010555 /**
10556 * Convert the dock state to a human readable format.
10557 * @hide
10558 */
10559 public static String dockStateToString(int dock) {
10560 switch (dock) {
10561 case EXTRA_DOCK_STATE_HE_DESK:
10562 return "EXTRA_DOCK_STATE_HE_DESK";
10563 case EXTRA_DOCK_STATE_LE_DESK:
10564 return "EXTRA_DOCK_STATE_LE_DESK";
10565 case EXTRA_DOCK_STATE_CAR:
10566 return "EXTRA_DOCK_STATE_CAR";
10567 case EXTRA_DOCK_STATE_DESK:
10568 return "EXTRA_DOCK_STATE_DESK";
10569 case EXTRA_DOCK_STATE_UNDOCKED:
10570 return "EXTRA_DOCK_STATE_UNDOCKED";
10571 default:
10572 return Integer.toString(dock);
10573 }
10574 }
10575
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010576 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
10577 ArrayList<String> htmlTexts, int which) {
10578 Uri uri = streams != null ? streams.get(which) : null;
10579 CharSequence text = texts != null ? texts.get(which) : null;
10580 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
10581 return new ClipData.Item(text, htmlText, null, uri);
10582 }
Craig Mautnerd00f4742014-03-12 14:17:26 -070010583
10584 /** @hide */
10585 public boolean isDocument() {
10586 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
10587 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010588}