blob: 5f7947fea3332f663b39ae9f16ed9786a7be2375 [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
Tor Norbye7b9c9122013-05-30 16:48:33 -070019import android.annotation.AnyRes;
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -070020import android.annotation.BroadcastBehavior;
Tor Norbyed9273d62013-05-30 15:59:53 -070021import android.annotation.IntDef;
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060022import android.annotation.NonNull;
23import android.annotation.Nullable;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070024import android.annotation.SdkConstant;
25import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050026import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050028import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060029import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.content.pm.PackageManager;
31import android.content.pm.ResolveInfo;
32import android.content.res.Resources;
33import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080034import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070035import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060036import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070037import android.os.Bundle;
38import android.os.IBinder;
39import android.os.Parcel;
40import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000041import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050042import android.os.ResultReceiver;
43import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070044import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010045import android.os.UserHandle;
Jeff Sharkey81aebe72017-04-03 20:14:10 +000046import android.os.storage.StorageManager;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070047import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070048import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050049import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070050import android.provider.OpenableColumns;
Jason Monk2f68e8a2016-02-23 17:57:28 -050051import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070052import android.util.AttributeSet;
53import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080054import com.android.internal.util.XmlUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050055import org.xmlpull.v1.XmlPullParser;
56import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070057import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070058
59import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080060import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070061import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070062import java.lang.annotation.Retention;
63import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070064import java.net.URISyntaxException;
65import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080066import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070067import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080068import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070069import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070070import java.util.Set;
71
Jeff Sharkey81aebe72017-04-03 20:14:10 +000072import static android.content.ContentProvider.maybeAddUserId;
73
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070074/**
75 * An intent is an abstract description of an operation to be performed. It
76 * can be used with {@link Context#startActivity(Intent) startActivity} to
77 * launch an {@link android.app.Activity},
78 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
79 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
80 * and {@link android.content.Context#startService} or
81 * {@link android.content.Context#bindService} to communicate with a
82 * background {@link android.app.Service}.
83 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070084 * <p>An Intent provides a facility for performing late runtime binding between the code in
85 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070086 * can be thought of as the glue between activities. It is basically a passive data structure
87 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070088 *
89 * <div class="special reference">
90 * <h3>Developer Guides</h3>
91 * <p>For information about how to create and resolve intents, read the
92 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
93 * developer guide.</p>
94 * </div>
95 *
96 * <a name="IntentStructure"></a>
97 * <h3>Intent Structure</h3>
98 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070099 *
100 * <ul>
101 * <li> <p><b>action</b> -- The general action to be performed, such as
102 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
103 * etc.</p>
104 * </li>
105 * <li> <p><b>data</b> -- The data to operate on, such as a person record
106 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
107 * </li>
108 * </ul>
109 *
110 *
111 * <p>Some examples of action/data pairs are:</p>
112 *
113 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700114 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700115 * information about the person whose identifier is "1".</p>
116 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700117 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700118 * the phone dialer with the person filled in.</p>
119 * </li>
120 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
121 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700122 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700123 * a particular URI.</p>
124 * </li>
125 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
126 * the phone dialer with the given number filled in.</p>
127 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700128 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700129 * information about the person whose identifier is "1".</p>
130 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700131 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700132 * a list of people, which the user can browse through. This example is a
133 * typical top-level entry into the Contacts application, showing you the
134 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700135 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700136 * being used to start an activity to display that person.</p>
137 * </li>
138 * </ul>
139 *
140 * <p>In addition to these primary attributes, there are a number of secondary
141 * attributes that you can also include with an intent:</p>
142 *
143 * <ul>
144 * <li> <p><b>category</b> -- Gives additional information about the action
145 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
146 * appear in the Launcher as a top-level application, while
147 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
148 * of alternative actions the user can perform on a piece of data.</p>
149 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
150 * intent data. Normally the type is inferred from the data itself.
151 * By setting this attribute, you disable that evaluation and force
152 * an explicit type.</p>
153 * <li> <p><b>component</b> -- Specifies an explicit name of a component
154 * class to use for the intent. Normally this is determined by looking
155 * at the other information in the intent (the action, data/type, and
156 * categories) and matching that with a component that can handle it.
157 * If this attribute is set then none of the evaluation is performed,
158 * and this component is used exactly as is. By specifying this attribute,
159 * all of the other Intent attributes become optional.</p>
160 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
161 * This can be used to provide extended information to the component.
162 * For example, if we have a action to send an e-mail message, we could
163 * also include extra pieces of data here to supply a subject, body,
164 * etc.</p>
165 * </ul>
166 *
167 * <p>Here are some examples of other operations you can specify as intents
168 * using these additional parameters:</p>
169 *
170 * <ul>
171 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
172 * Launch the home screen.</p>
173 * </li>
174 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
175 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
176 * vnd.android.cursor.item/phone}</i></b>
177 * -- Display the list of people's phone numbers, allowing the user to
178 * browse through them and pick one and return it to the parent activity.</p>
179 * </li>
180 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
181 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
182 * -- Display all pickers for data that can be opened with
183 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
184 * allowing the user to pick one of them and then some data inside of it
185 * and returning the resulting URI to the caller. This can be used,
186 * for example, in an e-mail application to allow the user to pick some
187 * data to include as an attachment.</p>
188 * </li>
189 * </ul>
190 *
191 * <p>There are a variety of standard Intent action and category constants
192 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700193 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700194 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700195 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700196 *
197 * <p>Put together, the set of actions, data types, categories, and extra data
198 * defines a language for the system allowing for the expression of phrases
199 * such as "call john smith's cell". As applications are added to the system,
200 * they can extend this language by adding new actions, types, and categories, or
201 * they can modify the behavior of existing phrases by supplying their own
202 * activities that handle them.</p>
203 *
204 * <a name="IntentResolution"></a>
205 * <h3>Intent Resolution</h3>
206 *
207 * <p>There are two primary forms of intents you will use.
208 *
209 * <ul>
210 * <li> <p><b>Explicit Intents</b> have specified a component (via
211 * {@link #setComponent} or {@link #setClass}), which provides the exact
212 * class to be run. Often these will not include any other information,
213 * simply being a way for an application to launch various internal
214 * activities it has as the user interacts with the application.
215 *
216 * <li> <p><b>Implicit Intents</b> have not specified a component;
217 * instead, they must include enough information for the system to
218 * determine which of the available components is best to run for that
219 * intent.
220 * </ul>
221 *
222 * <p>When using implicit intents, given such an arbitrary intent we need to
223 * know what to do with it. This is handled by the process of <em>Intent
224 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
225 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
226 * more activities/receivers) that can handle it.</p>
227 *
228 * <p>The intent resolution mechanism basically revolves around matching an
229 * Intent against all of the &lt;intent-filter&gt; descriptions in the
230 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
231 * objects explicitly registered with {@link Context#registerReceiver}.) More
232 * details on this can be found in the documentation on the {@link
233 * IntentFilter} class.</p>
234 *
235 * <p>There are three pieces of information in the Intent that are used for
236 * resolution: the action, type, and category. Using this information, a query
237 * is done on the {@link PackageManager} for a component that can handle the
238 * intent. The appropriate component is determined based on the intent
239 * information supplied in the <code>AndroidManifest.xml</code> file as
240 * follows:</p>
241 *
242 * <ul>
243 * <li> <p>The <b>action</b>, if given, must be listed by the component as
244 * one it handles.</p>
245 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
246 * already supplied in the Intent. Like the action, if a type is
247 * included in the intent (either explicitly or implicitly in its
248 * data), then this must be listed by the component as one it handles.</p>
249 * <li> For data that is not a <code>content:</code> URI and where no explicit
250 * type is included in the Intent, instead the <b>scheme</b> of the
251 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
252 * considered. Again like the action, if we are matching a scheme it
253 * must be listed by the component as one it can handle.
254 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
255 * by the activity as categories it handles. That is, if you include
256 * the categories {@link #CATEGORY_LAUNCHER} and
257 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
258 * with an intent that lists <em>both</em> of those categories.
259 * Activities will very often need to support the
260 * {@link #CATEGORY_DEFAULT} so that they can be found by
261 * {@link Context#startActivity Context.startActivity()}.</p>
262 * </ul>
263 *
264 * <p>For example, consider the Note Pad sample application that
265 * allows user to browse through a list of notes data and view details about
266 * individual items. Text in italics indicate places were you would replace a
267 * name with one specific to your own package.</p>
268 *
269 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
270 * package="<i>com.android.notepad</i>"&gt;
271 * &lt;application android:icon="@drawable/app_notes"
272 * android:label="@string/app_name"&gt;
273 *
274 * &lt;provider class=".NotePadProvider"
275 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
276 *
277 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
278 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="android.intent.action.MAIN" /&gt;
280 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700281 * &lt;/intent-filter&gt;
282 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700283 * &lt;action android:name="android.intent.action.VIEW" /&gt;
284 * &lt;action android:name="android.intent.action.EDIT" /&gt;
285 * &lt;action android:name="android.intent.action.PICK" /&gt;
286 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
287 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&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.GET_CONTENT" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700293 * &lt;/intent-filter&gt;
294 * &lt;/activity&gt;
295 *
296 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
297 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700298 * &lt;action android:name="android.intent.action.VIEW" /&gt;
299 * &lt;action android:name="android.intent.action.EDIT" /&gt;
300 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
301 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700302 * &lt;/intent-filter&gt;
303 *
304 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700305 * &lt;action android:name="android.intent.action.INSERT" /&gt;
306 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
307 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700308 * &lt;/intent-filter&gt;
309 *
310 * &lt;/activity&gt;
311 *
312 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
313 * android:theme="@android:style/Theme.Dialog"&gt;
314 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700315 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
316 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
317 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
318 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
319 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700320 * &lt;/intent-filter&gt;
321 * &lt;/activity&gt;
322 *
323 * &lt;/application&gt;
324 * &lt;/manifest&gt;</pre>
325 *
326 * <p>The first activity,
327 * <code>com.android.notepad.NotesList</code>, serves as our main
328 * entry into the app. It can do three things as described by its three intent
329 * templates:
330 * <ol>
331 * <li><pre>
332 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700333 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
334 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700335 * &lt;/intent-filter&gt;</pre>
336 * <p>This provides a top-level entry into the NotePad application: the standard
337 * MAIN action is a main entry point (not requiring any other information in
338 * the Intent), and the LAUNCHER category says that this entry point should be
339 * listed in the application launcher.</p>
340 * <li><pre>
341 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700342 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
343 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
344 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
345 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700346 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700347 * &lt;/intent-filter&gt;</pre>
348 * <p>This declares the things that the activity can do on a directory of
349 * notes. The type being supported is given with the &lt;type&gt; tag, where
350 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
351 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
352 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
353 * The activity allows the user to view or edit the directory of data (via
354 * the VIEW and EDIT actions), or to pick a particular note and return it
355 * to the caller (via the PICK action). Note also the DEFAULT category
356 * supplied here: this is <em>required</em> for the
357 * {@link Context#startActivity Context.startActivity} method to resolve your
358 * activity when its component name is not explicitly specified.</p>
359 * <li><pre>
360 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700361 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
362 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
363 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700364 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700365 * <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 -0700366 * the user without needing to know where it came from. The data type
367 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
368 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
369 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
370 * The GET_CONTENT action is similar to the PICK action, where the activity
371 * will return to its caller a piece of data selected by the user. Here,
372 * however, the caller specifies the type of data they desire instead of
373 * the type of data the user will be picking from.</p>
374 * </ol>
375 *
376 * <p>Given these capabilities, the following intents will resolve to the
377 * NotesList activity:</p>
378 *
379 * <ul>
380 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
381 * activities that can be used as top-level entry points into an
382 * application.</p>
383 * <li> <p><b>{ action=android.app.action.MAIN,
384 * category=android.app.category.LAUNCHER }</b> is the actual intent
385 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700386 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700387 * data=content://com.google.provider.NotePad/notes }</b>
388 * displays a list of all the notes under
389 * "content://com.google.provider.NotePad/notes", which
390 * the user can browse through and see the details on.</p>
391 * <li> <p><b>{ action=android.app.action.PICK
392 * data=content://com.google.provider.NotePad/notes }</b>
393 * provides a list of the notes under
394 * "content://com.google.provider.NotePad/notes", from which
395 * the user can pick a note whose data URL is returned back to the caller.</p>
396 * <li> <p><b>{ action=android.app.action.GET_CONTENT
397 * type=vnd.android.cursor.item/vnd.google.note }</b>
398 * is similar to the pick action, but allows the caller to specify the
399 * kind of data they want back so that the system can find the appropriate
400 * activity to pick something of that data type.</p>
401 * </ul>
402 *
403 * <p>The second activity,
404 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
405 * note entry and allows them to edit it. It can do two things as described
406 * by its two intent templates:
407 * <ol>
408 * <li><pre>
409 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700410 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
411 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
412 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
413 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700414 * &lt;/intent-filter&gt;</pre>
415 * <p>The first, primary, purpose of this activity is to let the user interact
416 * with a single note, as decribed by the MIME type
417 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
418 * either VIEW a note or allow the user to EDIT it. Again we support the
419 * DEFAULT category to allow the activity to be launched without explicitly
420 * specifying its component.</p>
421 * <li><pre>
422 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700423 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
424 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
425 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700426 * &lt;/intent-filter&gt;</pre>
427 * <p>The secondary use of this activity is to insert a new note entry into
428 * an existing directory of notes. This is used when the user creates a new
429 * note: the INSERT action is executed on the directory of notes, causing
430 * this activity to run and have the user create the new note data which
431 * it then adds to the content provider.</p>
432 * </ol>
433 *
434 * <p>Given these capabilities, the following intents will resolve to the
435 * NoteEditor activity:</p>
436 *
437 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700438 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700439 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
440 * shows the user the content of note <var>{ID}</var>.</p>
441 * <li> <p><b>{ action=android.app.action.EDIT
442 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
443 * allows the user to edit the content of note <var>{ID}</var>.</p>
444 * <li> <p><b>{ action=android.app.action.INSERT
445 * data=content://com.google.provider.NotePad/notes }</b>
446 * creates a new, empty note in the notes list at
447 * "content://com.google.provider.NotePad/notes"
448 * and allows the user to edit it. If they keep their changes, the URI
449 * of the newly created note is returned to the caller.</p>
450 * </ul>
451 *
452 * <p>The last activity,
453 * <code>com.android.notepad.TitleEditor</code>, allows the user to
454 * edit the title of a note. This could be implemented as a class that the
455 * application directly invokes (by explicitly setting its component in
456 * the Intent), but here we show a way you can publish alternative
457 * operations on existing data:</p>
458 *
459 * <pre>
460 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700461 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
462 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
463 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
464 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
465 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700466 * &lt;/intent-filter&gt;</pre>
467 *
468 * <p>In the single intent template here, we
469 * have created our own private action called
470 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
471 * edit the title of a note. It must be invoked on a specific note
472 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
473 * view and edit actions, but here displays and edits the title contained
474 * in the note data.
475 *
476 * <p>In addition to supporting the default category as usual, our title editor
477 * also supports two other standard categories: ALTERNATIVE and
478 * SELECTED_ALTERNATIVE. Implementing
479 * these categories allows others to find the special action it provides
480 * without directly knowing about it, through the
481 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
482 * more often to build dynamic menu items with
483 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
484 * template here was also supply an explicit name for the template
485 * (via <code>android:label="@string/resolve_title"</code>) to better control
486 * what the user sees when presented with this activity as an alternative
487 * action to the data they are viewing.
488 *
489 * <p>Given these capabilities, the following intent will resolve to the
490 * TitleEditor activity:</p>
491 *
492 * <ul>
493 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
494 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
495 * displays and allows the user to edit the title associated
496 * with note <var>{ID}</var>.</p>
497 * </ul>
498 *
499 * <h3>Standard Activity Actions</h3>
500 *
501 * <p>These are the current standard actions that Intent defines for launching
502 * activities (usually through {@link Context#startActivity}. The most
503 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
504 * {@link #ACTION_EDIT}.
505 *
506 * <ul>
507 * <li> {@link #ACTION_MAIN}
508 * <li> {@link #ACTION_VIEW}
509 * <li> {@link #ACTION_ATTACH_DATA}
510 * <li> {@link #ACTION_EDIT}
511 * <li> {@link #ACTION_PICK}
512 * <li> {@link #ACTION_CHOOSER}
513 * <li> {@link #ACTION_GET_CONTENT}
514 * <li> {@link #ACTION_DIAL}
515 * <li> {@link #ACTION_CALL}
516 * <li> {@link #ACTION_SEND}
517 * <li> {@link #ACTION_SENDTO}
518 * <li> {@link #ACTION_ANSWER}
519 * <li> {@link #ACTION_INSERT}
520 * <li> {@link #ACTION_DELETE}
521 * <li> {@link #ACTION_RUN}
522 * <li> {@link #ACTION_SYNC}
523 * <li> {@link #ACTION_PICK_ACTIVITY}
524 * <li> {@link #ACTION_SEARCH}
525 * <li> {@link #ACTION_WEB_SEARCH}
526 * <li> {@link #ACTION_FACTORY_TEST}
527 * </ul>
528 *
529 * <h3>Standard Broadcast Actions</h3>
530 *
531 * <p>These are the current standard actions that Intent defines for receiving
532 * broadcasts (usually through {@link Context#registerReceiver} or a
533 * &lt;receiver&gt; tag in a manifest).
534 *
535 * <ul>
536 * <li> {@link #ACTION_TIME_TICK}
537 * <li> {@link #ACTION_TIME_CHANGED}
538 * <li> {@link #ACTION_TIMEZONE_CHANGED}
539 * <li> {@link #ACTION_BOOT_COMPLETED}
540 * <li> {@link #ACTION_PACKAGE_ADDED}
541 * <li> {@link #ACTION_PACKAGE_CHANGED}
542 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800543 * <li> {@link #ACTION_PACKAGE_RESTARTED}
544 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000545 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
546 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700547 * <li> {@link #ACTION_UID_REMOVED}
548 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700549 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700550 * <li> {@link #ACTION_POWER_DISCONNECTED}
551 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700552 * </ul>
553 *
554 * <h3>Standard Categories</h3>
555 *
556 * <p>These are the current standard categories that can be used to further
557 * clarify an Intent via {@link #addCategory}.
558 *
559 * <ul>
560 * <li> {@link #CATEGORY_DEFAULT}
561 * <li> {@link #CATEGORY_BROWSABLE}
562 * <li> {@link #CATEGORY_TAB}
563 * <li> {@link #CATEGORY_ALTERNATIVE}
564 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
565 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800566 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700567 * <li> {@link #CATEGORY_HOME}
568 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700569 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400570 * <li> {@link #CATEGORY_CAR_DOCK}
571 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500572 * <li> {@link #CATEGORY_LE_DESK_DOCK}
573 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200574 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700575 * <li> {@link #CATEGORY_APP_MARKET}
Zak Cohendb6ca492017-01-26 14:09:00 -0800576 * <li> {@link #CATEGORY_VR_HOME}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700577 * </ul>
578 *
579 * <h3>Standard Extra Data</h3>
580 *
581 * <p>These are the current standard fields that can be used as extra data via
582 * {@link #putExtra}.
583 *
584 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800585 * <li> {@link #EXTRA_ALARM_COUNT}
586 * <li> {@link #EXTRA_BCC}
587 * <li> {@link #EXTRA_CC}
588 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
589 * <li> {@link #EXTRA_DATA_REMOVED}
590 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500591 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
592 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800593 * <li> {@link #EXTRA_DOCK_STATE_CAR}
594 * <li> {@link #EXTRA_DOCK_STATE_DESK}
595 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
596 * <li> {@link #EXTRA_DONT_KILL_APP}
597 * <li> {@link #EXTRA_EMAIL}
598 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700599 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800600 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700601 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800602 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700603 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800604 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
605 * <li> {@link #EXTRA_REPLACING}
606 * <li> {@link #EXTRA_SHORTCUT_ICON}
607 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
608 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700609 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800610 * <li> {@link #EXTRA_SHORTCUT_NAME}
611 * <li> {@link #EXTRA_SUBJECT}
612 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700613 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800614 * <li> {@link #EXTRA_TITLE}
615 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700616 * </ul>
617 *
618 * <h3>Flags</h3>
619 *
620 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800621 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
622 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700623 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800624public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700625 private static final String ATTR_ACTION = "action";
626 private static final String TAG_CATEGORIES = "categories";
627 private static final String ATTR_CATEGORY = "category";
628 private static final String TAG_EXTRA = "extra";
629 private static final String ATTR_TYPE = "type";
630 private static final String ATTR_COMPONENT = "component";
631 private static final String ATTR_DATA = "data";
632 private static final String ATTR_FLAGS = "flags";
633
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700634 // ---------------------------------------------------------------------
635 // ---------------------------------------------------------------------
636 // Standard intent activity actions (see action variable).
637
638 /**
639 * Activity Action: Start as a main entry point, does not expect to
640 * receive data.
641 * <p>Input: nothing
642 * <p>Output: nothing
643 */
644 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
645 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800646
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700647 /**
648 * Activity Action: Display the data to the user. This is the most common
649 * action performed on data -- it is the generic action you can use on
650 * a piece of data to get the most reasonable thing to occur. For example,
651 * when used on a contacts entry it will view the entry; when used on a
652 * mailto: URI it will bring up a compose window filled with the information
653 * supplied by the URI; when used with a tel: URI it will invoke the
654 * dialer.
655 * <p>Input: {@link #getData} is URI from which to retrieve data.
656 * <p>Output: nothing.
657 */
658 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
659 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800660
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700661 /**
Dianne Hackborna320f012017-04-07 13:57:48 -0700662 * Extra that can be included on activity intents coming from the storage UI
663 * when it launches sub-activities to manage various types of storage. For example,
664 * it may use {@link #ACTION_VIEW} with a "image/*" MIME type to have an app show
665 * the images on the device, and in that case also include this extra to tell the
666 * app it is coming from the storage UI so should help the user manage storage of
667 * this type.
668 */
669 public static final String EXTRA_FROM_STORAGE = "android.intent.extra.FROM_STORAGE";
670
671 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700672 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
673 * performed on a piece of data.
674 */
675 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800676
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900678 * Activity Action: Quick view the data. Launches a quick viewer for
679 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900680 * <p>Activities handling this intent action should handle the vast majority of
681 * MIME types rather than only specific ones.
Garfield Tance1d0e92017-03-23 10:52:48 -0700682 * <p>Quick viewers must render the quick view image locally, and must not send
683 * file content outside current device.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900684 * <p>Input: {@link #getData} is a mandatory content URI of the item to
685 * preview. {@link #getClipData} contains an optional list of content URIs
686 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
687 * optional index of the URI in the clip data to show first.
Garfield Tance1d0e92017-03-23 10:52:48 -0700688 * {@link #EXTRA_QUICK_VIEW_FEATURES} is an optional extra indicating the features
689 * that can be shown in the quick view UI.
Steve McKayc78bcb82015-07-31 14:35:22 -0700690 * <p>Output: nothing.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900691 * @see #EXTRA_INDEX
Garfield Tance1d0e92017-03-23 10:52:48 -0700692 * @see #EXTRA_QUICK_VIEW_FEATURES
Steve McKayc78bcb82015-07-31 14:35:22 -0700693 */
694 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
695 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
696
697 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700698 * Used to indicate that some piece of data should be attached to some other
699 * place. For example, image data could be attached to a contact. It is up
700 * to the recipient to decide where the data should be attached; the intent
701 * does not specify the ultimate destination.
702 * <p>Input: {@link #getData} is URI of data to be attached.
703 * <p>Output: nothing.
704 */
705 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
706 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800707
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700708 /**
709 * Activity Action: Provide explicit editable access to the given data.
710 * <p>Input: {@link #getData} is URI of data to be edited.
711 * <p>Output: nothing.
712 */
713 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
714 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800715
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700716 /**
717 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
718 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
719 * The extras can contain type specific data to pass through to the editing/creating
720 * activity.
721 * <p>Output: The URI of the item that was picked. This must be a content:
722 * URI so that any receiver can access it.
723 */
724 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
725 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800726
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700727 /**
728 * Activity Action: Pick an item from the data, returning what was selected.
729 * <p>Input: {@link #getData} is URI containing a directory of data
730 * (vnd.android.cursor.dir/*) from which to pick an item.
731 * <p>Output: The URI of the item that was picked.
732 */
733 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
734 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800735
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700736 /**
737 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800738 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800739 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
740 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700741 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
742 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800743 * (value: ShortcutIconResource).</p>
744 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800745 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700746 * @see #EXTRA_SHORTCUT_INTENT
747 * @see #EXTRA_SHORTCUT_NAME
748 * @see #EXTRA_SHORTCUT_ICON
749 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
750 * @see android.content.Intent.ShortcutIconResource
751 */
752 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
753 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
754
755 /**
756 * The name of the extra used to define the Intent of a shortcut.
757 *
758 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800759 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700760 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800761 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700762 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
763 /**
764 * The name of the extra used to define the name of a shortcut.
765 *
766 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800767 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700768 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800769 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700770 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
771 /**
772 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
773 *
774 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800775 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700776 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800777 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700778 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
779 /**
780 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
781 *
782 * @see #ACTION_CREATE_SHORTCUT
783 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800784 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700785 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800786 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700787 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
788 "android.intent.extra.shortcut.ICON_RESOURCE";
789
790 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500791 * An activity that provides a user interface for adjusting application preferences.
792 * Optional but recommended settings for all applications which have settings.
793 */
794 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
795 public static final String ACTION_APPLICATION_PREFERENCES
796 = "android.intent.action.APPLICATION_PREFERENCES";
797
798 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700799 * Activity Action: Launch an activity showing the app information.
800 * For applications which install other applications (such as app stores), it is recommended
801 * to handle this action for providing the app information to the user.
802 *
803 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
804 * to be displayed.
805 * <p>Output: Nothing.
806 */
807 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
808 public static final String ACTION_SHOW_APP_INFO
809 = "android.intent.action.SHOW_APP_INFO";
810
811 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800812 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700813 *
814 * @see Intent#ACTION_CREATE_SHORTCUT
815 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800816 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
817 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700818 */
819 public static class ShortcutIconResource implements Parcelable {
820 /**
821 * The package name of the application containing the icon.
822 */
823 public String packageName;
824
825 /**
826 * The resource name of the icon, including package, name and type.
827 */
828 public String resourceName;
829
830 /**
831 * Creates a new ShortcutIconResource for the specified context and resource
832 * identifier.
833 *
834 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700835 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700836 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700837 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700838 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700839 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700840 ShortcutIconResource icon = new ShortcutIconResource();
841 icon.packageName = context.getPackageName();
842 icon.resourceName = context.getResources().getResourceName(resourceId);
843 return icon;
844 }
845
846 /**
847 * Used to read a ShortcutIconResource from a Parcel.
848 */
849 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
850 new Parcelable.Creator<ShortcutIconResource>() {
851
852 public ShortcutIconResource createFromParcel(Parcel source) {
853 ShortcutIconResource icon = new ShortcutIconResource();
854 icon.packageName = source.readString();
855 icon.resourceName = source.readString();
856 return icon;
857 }
858
859 public ShortcutIconResource[] newArray(int size) {
860 return new ShortcutIconResource[size];
861 }
862 };
863
864 /**
865 * No special parcel contents.
866 */
867 public int describeContents() {
868 return 0;
869 }
870
871 public void writeToParcel(Parcel dest, int flags) {
872 dest.writeString(packageName);
873 dest.writeString(resourceName);
874 }
875
876 @Override
877 public String toString() {
878 return resourceName;
879 }
880 }
881
882 /**
883 * Activity Action: Display an activity chooser, allowing the user to pick
884 * what they want to before proceeding. This can be used as an alternative
885 * to the standard activity picker that is displayed by the system when
886 * you try to start an activity with multiple possible matches, with these
887 * differences in behavior:
888 * <ul>
889 * <li>You can specify the title that will appear in the activity chooser.
890 * <li>The user does not have the option to make one of the matching
891 * activities a preferred activity, and all possible activities will
892 * always be shown even if one of them is currently marked as the
893 * preferred activity.
894 * </ul>
895 * <p>
896 * This action should be used when the user will naturally expect to
897 * select an activity in order to proceed. An example if when not to use
898 * it is when the user clicks on a "mailto:" link. They would naturally
899 * expect to go directly to their mail app, so startActivity() should be
900 * called directly: it will
901 * either launch the current preferred app, or put up a dialog allowing the
902 * user to pick an app to use and optionally marking that as preferred.
903 * <p>
904 * In contrast, if the user is selecting a menu item to send a picture
905 * they are viewing to someone else, there are many different things they
906 * may want to do at this point: send it through e-mail, upload it to a
907 * web service, etc. In this case the CHOOSER action should be used, to
908 * always present to the user a list of the things they can do, with a
909 * nice title given by the caller such as "Send this photo with:".
910 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700911 * If you need to grant URI permissions through a chooser, you must specify
912 * the permissions to be granted on the ACTION_CHOOSER Intent
913 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
914 * {@link #setClipData} to specify the URIs to be granted as well as
915 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
916 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
917 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700918 * As a convenience, an Intent of this form can be created with the
919 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700920 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700921 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700922 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
923 * and can optionally have a {@link #EXTRA_TITLE} field containing the
924 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700925 * <p>
926 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700927 */
928 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
929 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
930
931 /**
932 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
933 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700934 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
935 * target intent, also optionally supplying a title. If the target
936 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
937 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
938 * set in the returned chooser intent, with its ClipData set appropriately:
939 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500940 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700941 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700942 * @param target The Intent that the user will be selecting an activity
943 * to perform.
944 * @param title Optional title that will be displayed in the chooser.
945 * @return Return a new Intent object that you can hand to
946 * {@link Context#startActivity(Intent) Context.startActivity()} and
947 * related methods.
948 */
949 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700950 return createChooser(target, title, null);
951 }
952
953 /**
954 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
955 *
956 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
957 * target intent, also optionally supplying a title. If the target
958 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
959 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
960 * set in the returned chooser intent, with its ClipData set appropriately:
961 * either a direct reflection of {@link #getClipData()} if that is non-null,
962 * or a new ClipData built from {@link #getData()}.</p>
963 *
964 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
965 * when the user makes a choice. This can be useful if the calling application wants
966 * to remember the last chosen target and surface it as a more prominent or one-touch
967 * affordance elsewhere in the UI for next time.</p>
968 *
969 * @param target The Intent that the user will be selecting an activity
970 * to perform.
971 * @param title Optional title that will be displayed in the chooser.
972 * @param sender Optional IntentSender to be called when a choice is made.
973 * @return Return a new Intent object that you can hand to
974 * {@link Context#startActivity(Intent) Context.startActivity()} and
975 * related methods.
976 */
977 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700978 Intent intent = new Intent(ACTION_CHOOSER);
979 intent.putExtra(EXTRA_INTENT, target);
980 if (title != null) {
981 intent.putExtra(EXTRA_TITLE, title);
982 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700983
Adam Powell0b3c1122014-10-09 12:50:14 -0700984 if (sender != null) {
985 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
986 }
987
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700988 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700989 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
990 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
991 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700992 if (permFlags != 0) {
993 ClipData targetClipData = target.getClipData();
994 if (targetClipData == null && target.getData() != null) {
995 ClipData.Item item = new ClipData.Item(target.getData());
996 String[] mimeTypes;
997 if (target.getType() != null) {
998 mimeTypes = new String[] { target.getType() };
999 } else {
1000 mimeTypes = new String[] { };
1001 }
1002 targetClipData = new ClipData(null, mimeTypes, item);
1003 }
1004 if (targetClipData != null) {
1005 intent.setClipData(targetClipData);
1006 intent.addFlags(permFlags);
1007 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001008 }
Dianne Hackborne302a162012-05-15 14:58:32 -07001009
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001010 return intent;
1011 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001012
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001013 /**
1014 * Activity Action: Allow the user to select a particular kind of data and
1015 * return it. This is different than {@link #ACTION_PICK} in that here we
1016 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001017 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001018 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001019 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001020 * etc.
1021 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001022 * 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 -07001023 * of data, such as a person contact, you set the MIME type to the kind of
1024 * data you want and launch it with {@link Context#startActivity(Intent)}.
1025 * The system will then launch the best application to select that kind
1026 * of data for you.
1027 * <p>
1028 * You may also be interested in any of a set of types of content the user
1029 * can pick. For example, an e-mail application that wants to allow the
1030 * user to add an attachment to an e-mail message can use this action to
1031 * bring up a list of all of the types of content the user can attach.
1032 * <p>
1033 * In this case, you should wrap the GET_CONTENT intent with a chooser
1034 * (through {@link #createChooser}), which will give the proper interface
1035 * for the user to pick how to send your data and allow you to specify
1036 * a prompt indicating what they are doing. You will usually specify a
1037 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1038 * broad range of content types the user can select from.
1039 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001040 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001041 * only pick from data that can be represented as a stream. This is
1042 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1043 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001044 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001045 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001046 * is locally available on the device. For example, if this extra is set
1047 * to true then an image picker should not show any pictures that are available
1048 * from a remote server but not already on the local device (thus requiring
1049 * they be downloaded when opened).
1050 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001051 * If the caller can handle multiple returned items (the user performing
1052 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1053 * to indicate this.
1054 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001055 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1056 * that no URI is supplied in the intent, as there are no constraints on
1057 * where the returned data originally comes from. You may also include the
1058 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001059 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001060 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1061 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001062 * <p>
1063 * Output: The URI of the item that was picked. This must be a content:
1064 * URI so that any receiver can access it.
1065 */
1066 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1067 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1068 /**
1069 * Activity Action: Dial a number as specified by the data. This shows a
1070 * UI with the number being dialed, allowing the user to explicitly
1071 * initiate the call.
1072 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1073 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1074 * number.
1075 * <p>Output: nothing.
1076 */
1077 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1078 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1079 /**
1080 * Activity Action: Perform a call to someone specified by the data.
1081 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1082 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1083 * number.
1084 * <p>Output: nothing.
1085 *
1086 * <p>Note: there will be restrictions on which applications can initiate a
1087 * call; most applications should use the {@link #ACTION_DIAL}.
1088 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1089 * numbers. Applications can <strong>dial</strong> emergency numbers using
1090 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001091 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001092 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001093 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001094 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001095 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001096 */
1097 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1098 public static final String ACTION_CALL = "android.intent.action.CALL";
1099 /**
1100 * Activity Action: Perform a call to an emergency number specified by the
1101 * data.
1102 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1103 * tel: URI of an explicit phone number.
1104 * <p>Output: nothing.
1105 * @hide
1106 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001107 @SystemApi
1108 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001109 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1110 /**
1111 * Activity action: Perform a call to any number (emergency or not)
1112 * specified by the data.
1113 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1114 * tel: URI of an explicit phone number.
1115 * <p>Output: nothing.
1116 * @hide
1117 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001118 @SystemApi
1119 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001120 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
fionaxu77a744c2017-03-17 14:35:39 -07001121
Santos Cordon15a13782015-03-31 18:32:31 -07001122 /**
fionaxuadfe7002017-02-17 17:20:46 -08001123 * Activity Action: Main entry point for carrier setup apps.
1124 * <p>Carrier apps that provide an implementation for this action may be invoked to configure
1125 * carrier service and typically require
1126 * {@link android.telephony.TelephonyManager#hasCarrierPrivileges() carrier privileges} to
1127 * fulfill their duties.
1128 */
1129 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1130 public static final String ACTION_CARRIER_SETUP = "android.intent.action.CARRIER_SETUP";
1131 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001132 * Activity Action: Send a message to someone specified by the data.
1133 * <p>Input: {@link #getData} is URI describing the target.
1134 * <p>Output: nothing.
1135 */
1136 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1137 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1138 /**
1139 * Activity Action: Deliver some data to someone else. Who the data is
1140 * being delivered to is not specified; it is up to the receiver of this
1141 * action to ask the user where the data should be sent.
1142 * <p>
1143 * When launching a SEND intent, you should usually wrap it in a chooser
1144 * (through {@link #createChooser}), which will give the proper interface
1145 * for the user to pick how to send your data and allow you to specify
1146 * a prompt indicating what they are doing.
1147 * <p>
1148 * Input: {@link #getType} is the MIME type of the data being sent.
1149 * get*Extra can have either a {@link #EXTRA_TEXT}
1150 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1151 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1152 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1153 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001154 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1155 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1156 * your text with HTML formatting.
1157 * <p>
1158 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1159 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1160 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1161 * content: URIs and other advanced features of {@link ClipData}. If
1162 * using this approach, you still must supply the same data through the
1163 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1164 * for compatibility with old applications. If you don't set a ClipData,
1165 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001166 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001167 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1168 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1169 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1170 * be openable only as asset typed files using
1171 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1172 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001173 * Optional standard extras, which may be interpreted by some recipients as
1174 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1175 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1176 * <p>
1177 * Output: nothing.
1178 */
1179 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1180 public static final String ACTION_SEND = "android.intent.action.SEND";
1181 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001182 * Activity Action: Deliver multiple data to someone else.
1183 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001184 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001185 * <p>
1186 * Input: {@link #getType} is the MIME type of the data being sent.
1187 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001188 * #EXTRA_STREAM} field, containing the data to be sent. If using
1189 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1190 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001191 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001192 * Multiple types are supported, and receivers should handle mixed types
1193 * whenever possible. The right way for the receiver to check them is to
1194 * use the content resolver on each URI. The intent sender should try to
1195 * put the most concrete mime type in the intent type, but it can fall
1196 * back to {@literal <type>/*} or {@literal *}/* as needed.
1197 * <p>
1198 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1199 * be image/jpg, but if you are sending image/jpg and image/png, then the
1200 * intent's type should be image/*.
1201 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001202 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1203 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1204 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1205 * content: URIs and other advanced features of {@link ClipData}. If
1206 * using this approach, you still must supply the same data through the
1207 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1208 * for compatibility with old applications. If you don't set a ClipData,
1209 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1210 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001211 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1212 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1213 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1214 * be openable only as asset typed files using
1215 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1216 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001217 * Optional standard extras, which may be interpreted by some recipients as
1218 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1219 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1220 * <p>
1221 * Output: nothing.
1222 */
1223 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1224 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1225 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001226 * Activity Action: Handle an incoming phone call.
1227 * <p>Input: nothing.
1228 * <p>Output: nothing.
1229 */
1230 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1231 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1232 /**
1233 * Activity Action: Insert an empty item into the given container.
1234 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1235 * in which to place the data.
1236 * <p>Output: URI of the new data that was created.
1237 */
1238 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1239 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1240 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001241 * Activity Action: Create a new item in the given container, initializing it
1242 * from the current contents of the clipboard.
1243 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1244 * in which to place the data.
1245 * <p>Output: URI of the new data that was created.
1246 */
1247 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1248 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1249 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001250 * Activity Action: Delete the given data from its container.
1251 * <p>Input: {@link #getData} is URI of data to be deleted.
1252 * <p>Output: nothing.
1253 */
1254 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1255 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1256 /**
1257 * Activity Action: Run the data, whatever that means.
1258 * <p>Input: ? (Note: this is currently specific to the test harness.)
1259 * <p>Output: nothing.
1260 */
1261 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1262 public static final String ACTION_RUN = "android.intent.action.RUN";
1263 /**
1264 * Activity Action: Perform a data synchronization.
1265 * <p>Input: ?
1266 * <p>Output: ?
1267 */
1268 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1269 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1270 /**
1271 * Activity Action: Pick an activity given an intent, returning the class
1272 * selected.
1273 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1274 * used with {@link PackageManager#queryIntentActivities} to determine the
1275 * set of activities from which to pick.
1276 * <p>Output: Class name of the activity that was selected.
1277 */
1278 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1279 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1280 /**
1281 * Activity Action: Perform a search.
1282 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1283 * is the text to search for. If empty, simply
1284 * enter your search results Activity with the search UI activated.
1285 * <p>Output: nothing.
1286 */
1287 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1288 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1289 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001290 * Activity Action: Start the platform-defined tutorial
1291 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1292 * is the text to search for. If empty, simply
1293 * enter your search results Activity with the search UI activated.
1294 * <p>Output: nothing.
1295 */
1296 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1297 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1298 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001299 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001300 * <p>
1301 * Input: {@link android.app.SearchManager#QUERY
1302 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1303 * a url starts with http or https, the site will be opened. If it is plain
1304 * text, Google search will be applied.
1305 * <p>
1306 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001307 */
1308 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1309 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001310
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001311 /**
Jim Miller07994402012-05-02 14:22:27 -07001312 * Activity Action: Perform assist action.
1313 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001314 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1315 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001316 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1317 * information.
Jim Miller07994402012-05-02 14:22:27 -07001318 * Output: nothing.
1319 */
1320 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1321 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001322
1323 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001324 * Activity Action: Perform voice assist action.
1325 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001326 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1327 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001328 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001329 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001330 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001331 */
Amith Yamasani16452032017-03-03 10:15:57 -08001332 @SystemApi
Bjorn Bringertbc086862013-03-01 12:59:24 +00001333 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1334 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1335
1336 /**
Adam Skory7140a252013-09-11 12:04:58 +01001337 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1338 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001339 */
1340 public static final String EXTRA_ASSIST_PACKAGE
1341 = "android.intent.extra.ASSIST_PACKAGE";
1342
1343 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001344 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1345 * application package at the time the assist was invoked.
1346 */
1347 public static final String EXTRA_ASSIST_UID
1348 = "android.intent.extra.ASSIST_UID";
1349
1350 /**
Adam Skory7140a252013-09-11 12:04:58 +01001351 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1352 * information supplied by the current foreground app at the time of the assist request.
1353 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001354 */
1355 public static final String EXTRA_ASSIST_CONTEXT
1356 = "android.intent.extra.ASSIST_CONTEXT";
1357
Jim Miller07994402012-05-02 14:22:27 -07001358 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001359 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1360 * keyboard as the primary input device for assistance.
1361 */
1362 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1363 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1364
1365 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001366 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1367 * that was used to invoke the assist.
1368 */
1369 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1370 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1371
1372 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001373 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001374 * <p>Input: Nothing.
1375 * <p>Output: nothing.
1376 */
1377 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1378 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1379 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001380 * Activity Action: Show settings for choosing wallpaper.
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_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1386
1387 /**
1388 * Activity Action: Show activity for reporting a bug.
1389 * <p>Input: Nothing.
1390 * <p>Output: Nothing.
1391 */
1392 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1393 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1394
1395 /**
1396 * Activity Action: Main entry point for factory tests. Only used when
1397 * the device is booting in factory test node. The implementing package
1398 * must be installed in the system image.
1399 * <p>Input: nothing
1400 * <p>Output: nothing
1401 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06001402 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001403 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1404
1405 /**
1406 * Activity Action: The user pressed the "call" button to go to the dialer
1407 * or other appropriate UI for placing a call.
1408 * <p>Input: Nothing.
1409 * <p>Output: Nothing.
1410 */
1411 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1412 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1413
1414 /**
1415 * Activity Action: Start Voice Command.
1416 * <p>Input: Nothing.
1417 * <p>Output: Nothing.
1418 */
1419 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1420 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001421
1422 /**
1423 * Activity Action: Start action associated with long pressing on the
1424 * search key.
1425 * <p>Input: Nothing.
1426 * <p>Output: Nothing.
1427 */
1428 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1429 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001430
Jacek Surazski86b6c532009-05-13 14:38:28 +02001431 /**
1432 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1433 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001434 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001435 * <p>Input: No data is specified. The bug report is passed in using
1436 * an {@link #EXTRA_BUG_REPORT} field.
1437 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001438 *
1439 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001440 */
1441 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1442 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001443
1444 /**
1445 * Activity Action: Show power usage information to the user.
1446 * <p>Input: Nothing.
1447 * <p>Output: Nothing.
1448 */
1449 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1450 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001451
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001452 /**
Russell Brenner880994d2017-02-24 11:11:47 -08001453 * Activity Action: Setup wizard action provided for OTA provisioning to determine if it needs
1454 * to run.
1455 * <p>Input: Nothing.
1456 * <p>Output: Nothing.
1457 * @deprecated As of {@link android.os.Build.VERSION_CODES#M}, setup wizard can be identified
1458 * using {@link #ACTION_MAIN} and {@link #CATEGORY_SETUP_WIZARD}
1459 * @hide
1460 */
1461 @Deprecated
1462 @SystemApi
1463 public static final String ACTION_DEVICE_INITIALIZATION_WIZARD =
1464 "android.intent.action.DEVICE_INITIALIZATION_WIZARD";
1465
1466 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001467 * Activity Action: Setup wizard to launch after a platform update. This
1468 * activity should have a string meta-data field associated with it,
1469 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1470 * the platform for setup. The activity will be launched only if
1471 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1472 * same value.
1473 * <p>Input: Nothing.
1474 * <p>Output: Nothing.
1475 * @hide
1476 */
Russell Brenner880994d2017-02-24 11:11:47 -08001477 @SystemApi
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001478 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1479 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001480
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001481 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001482 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1483 * <p>Input: Nothing.
1484 * <p>Output: Nothing.
1485 * @hide
1486 */
1487 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1488 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001489 "com.android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001490
1491 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001492 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1493 * <p>Input: Nothing.
1494 * <p>Output: Nothing.
1495 * @hide
1496 */
1497 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1498 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001499 "com.android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001500
1501 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001502 * Activity Action: Show settings for managing network data usage of a
1503 * specific application. Applications should define an activity that offers
1504 * options to control data usage.
1505 */
1506 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1507 public static final String ACTION_MANAGE_NETWORK_USAGE =
1508 "android.intent.action.MANAGE_NETWORK_USAGE";
1509
1510 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001511 * Activity Action: Launch application installer.
1512 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001513 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001514 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1515 * you can also use "package:<package-name>" to install an application for the
1516 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001517 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1518 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1519 * <p>
1520 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1521 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001522 * <p>
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001523 * <strong>Note:</strong>If your app is targeting API level higher than 25 you
Svet Ganov86877e42015-05-28 08:19:48 -07001524 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1525 * in order to launch the application installer.
1526 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001527 *
1528 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1529 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1530 * @see #EXTRA_RETURN_RESULT
1531 */
1532 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1533 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1534
1535 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001536 * @hide
1537 * @deprecated Do not use. This will go away.
1538 * Replace with {@link #ACTION_INSTALL_INSTANT_APP_PACKAGE}.
1539 */
1540 @SystemApi
1541 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1542 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1543 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1544 /**
1545 * Activity Action: Launch instant application installer.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001546 * <p class="note">
1547 * This is a protected intent that can only be sent by the system.
1548 * </p>
1549 *
1550 * @hide
1551 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001552 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001553 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001554 public static final String ACTION_INSTALL_INSTANT_APP_PACKAGE
1555 = "android.intent.action.INSTALL_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001556
1557 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001558 * @hide
1559 * @deprecated Do not use. This will go away.
1560 * Replace with {@link #ACTION_RESOLVE_INSTANT_APP_PACKAGE}.
1561 */
1562 @SystemApi
1563 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1564 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1565 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1566 /**
1567 * Service Action: Resolve instant application.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001568 * <p>
1569 * The system will have a persistent connection to this service.
1570 * This is a protected intent that can only be sent by the system.
1571 * </p>
1572 *
1573 * @hide
1574 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001575 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001576 @SdkConstant(SdkConstantType.SERVICE_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001577 public static final String ACTION_RESOLVE_INSTANT_APP_PACKAGE
1578 = "android.intent.action.RESOLVE_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001579
1580 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001581 * @hide
1582 * @deprecated Do not use. This will go away.
1583 * Replace with {@link #ACTION_INSTANT_APP_RESOLVER_SETTINGS}.
1584 */
1585 @SystemApi
1586 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1587 public static final String ACTION_EPHEMERAL_RESOLVER_SETTINGS
1588 = "android.intent.action.EPHEMERAL_RESOLVER_SETTINGS";
1589 /**
1590 * Activity Action: Launch instant app settings.
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001591 *
1592 * <p class="note">
1593 * This is a protected intent that can only be sent by the system.
1594 * </p>
1595 *
1596 * @hide
1597 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001598 @SystemApi
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001599 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001600 public static final String ACTION_INSTANT_APP_RESOLVER_SETTINGS
1601 = "android.intent.action.INSTANT_APP_RESOLVER_SETTINGS";
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001602
1603 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001604 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1605 * package. Specifies the installer package name; this package will receive the
1606 * {@link #ACTION_APP_ERROR} intent.
1607 */
1608 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1609 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1610
1611 /**
1612 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1613 * package. Specifies that the application being installed should not be
1614 * treated as coming from an unknown source, but as coming from the app
1615 * invoking the Intent. For this to work you must start the installer with
1616 * startActivityForResult().
1617 */
1618 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1619 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1620
1621 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001622 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1623 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001624 * data field originated from.
1625 */
rich cannings706e8ba2012-08-20 13:20:14 -07001626 public static final String EXTRA_ORIGINATING_URI
1627 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001628
1629 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001630 * This extra can be used with any Intent used to launch an activity, supplying information
1631 * about who is launching that activity. This field contains a {@link android.net.Uri}
1632 * object, typically an http: or https: URI of the web site that the referral came from;
1633 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1634 * a native application that it came from.
1635 *
1636 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1637 * instead of directly retrieving the extra. It is also valid for applications to
1638 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1639 * a string, not a Uri; the field here, if supplied, will always take precedence,
1640 * however.</p>
1641 *
1642 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001643 */
1644 public static final String EXTRA_REFERRER
1645 = "android.intent.extra.REFERRER";
1646
1647 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001648 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1649 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1650 * not be created, in particular when Intent extras are supplied through the
1651 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1652 * schemes.
1653 *
1654 * @see #EXTRA_REFERRER
1655 */
1656 public static final String EXTRA_REFERRER_NAME
1657 = "android.intent.extra.REFERRER_NAME";
1658
1659 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001660 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001661 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001662 * Currently only a system app that hosts the provider authority "downloads" or holds the
1663 * permission {@link android.Manifest.permission.MANAGE_DOCUMENTS} can use this.
Ben Gruver37d83a32012-09-27 13:02:06 -07001664 * @hide
1665 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001666 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001667 public static final String EXTRA_ORIGINATING_UID
1668 = "android.intent.extra.ORIGINATING_UID";
1669
1670 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001671 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1672 * package. Tells the installer UI to skip the confirmation with the user
1673 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001674 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1675 * will no longer show an interstitial message about updating existing
1676 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001677 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001678 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001679 public static final String EXTRA_ALLOW_REPLACE
1680 = "android.intent.extra.ALLOW_REPLACE";
1681
1682 /**
1683 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1684 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1685 * return to the application the result code of the install/uninstall. The returned result
1686 * code will be {@link android.app.Activity#RESULT_OK} on success or
1687 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1688 */
1689 public static final String EXTRA_RETURN_RESULT
1690 = "android.intent.extra.RETURN_RESULT";
1691
1692 /**
1693 * Package manager install result code. @hide because result codes are not
1694 * yet ready to be exposed.
1695 */
1696 public static final String EXTRA_INSTALL_RESULT
1697 = "android.intent.extra.INSTALL_RESULT";
1698
1699 /**
1700 * Activity Action: Launch application uninstaller.
1701 * <p>
1702 * Input: The data must be a package: URI whose scheme specific part is
1703 * the package name of the current installed package to be uninstalled.
1704 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1705 * <p>
1706 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1707 * succeeded.
1708 */
1709 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1710 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1711
1712 /**
msnider3c191b82017-01-23 14:23:16 -08001713 * Activity Action: Launch application uninstaller.
1714 * <p>
1715 * Input: The data must be a package: URI whose scheme specific part is
1716 * the package name of the current installed package to be uninstalled.
1717 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1718 * <p>
1719 * Output: Nothing.
1720 * </p>
1721 */
1722 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1723 public static final String ACTION_CLEAR_PACKAGE = "android.intent.action.CLEAR_PACKAGE";
1724
1725 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001726 * Specify whether the package should be uninstalled for all users.
1727 * @hide because these should not be part of normal application flow.
1728 */
1729 public static final String EXTRA_UNINSTALL_ALL_USERS
1730 = "android.intent.extra.UNINSTALL_ALL_USERS";
1731
1732 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001733 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1734 * describing the last run version of the platform that was setup.
1735 * @hide
1736 */
1737 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1738
Svet Ganov3695b8a2015-03-24 16:30:25 -07001739 /**
1740 * Activity action: Launch UI to manage the permissions of an app.
1741 * <p>
1742 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1743 * will be managed by the launched UI.
1744 * </p>
1745 * <p>
1746 * Output: Nothing.
1747 * </p>
1748 *
1749 * @see #EXTRA_PACKAGE_NAME
1750 *
1751 * @hide
1752 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001753 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001754 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1755 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1756 "android.intent.action.MANAGE_APP_PERMISSIONS";
1757
1758 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001759 * Activity action: Launch UI to manage permissions.
1760 * <p>
1761 * Input: Nothing.
1762 * </p>
1763 * <p>
1764 * Output: Nothing.
1765 * </p>
1766 *
1767 * @hide
1768 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001769 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001770 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1771 public static final String ACTION_MANAGE_PERMISSIONS =
1772 "android.intent.action.MANAGE_PERMISSIONS";
1773
1774 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001775 * Activity action: Launch UI to review permissions for an app.
1776 * The system uses this intent if permission review for apps not
1777 * supporting the new runtime permissions model is enabled. In
1778 * this mode a permission review is required before any of the
1779 * app components can run.
1780 * <p>
1781 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1782 * permissions will be reviewed (mandatory).
1783 * </p>
1784 * <p>
1785 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1786 * be fired after the permission review (optional).
1787 * </p>
1788 * <p>
1789 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1790 * be invoked after the permission review (optional).
1791 * </p>
1792 * <p>
1793 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1794 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1795 * </p>
1796 * <p>
1797 * Output: Nothing.
1798 * </p>
1799 *
1800 * @see #EXTRA_PACKAGE_NAME
1801 * @see #EXTRA_INTENT
1802 * @see #EXTRA_REMOTE_CALLBACK
1803 * @see #EXTRA_RESULT_NEEDED
1804 *
1805 * @hide
1806 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001807 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001808 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1809 public static final String ACTION_REVIEW_PERMISSIONS =
1810 "android.intent.action.REVIEW_PERMISSIONS";
1811
1812 /**
1813 * Intent extra: A callback for reporting remote result as a bundle.
1814 * <p>
1815 * Type: IRemoteCallback
1816 * </p>
1817 *
1818 * @hide
1819 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001820 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001821 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1822
1823 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001824 * Intent extra: An app package name.
1825 * <p>
1826 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001827 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001828 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001829 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001830 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1831
1832 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001833 * Intent extra: An app split name.
1834 * <p>
1835 * Type: String
1836 * </p>
1837 * @hide
1838 */
1839 @SystemApi
1840 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1841
1842 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001843 * Intent extra: An extra for specifying whether a result is needed.
1844 * <p>
1845 * Type: boolean
1846 * </p>
1847 *
1848 * @hide
1849 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001850 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001851 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1852
1853 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001854 * Activity action: Launch UI to manage which apps have a given permission.
1855 * <p>
1856 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1857 * to which will be managed by the launched UI.
1858 * </p>
1859 * <p>
1860 * Output: Nothing.
1861 * </p>
1862 *
1863 * @see #EXTRA_PERMISSION_NAME
1864 *
1865 * @hide
1866 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001867 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001868 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1869 public static final String ACTION_MANAGE_PERMISSION_APPS =
1870 "android.intent.action.MANAGE_PERMISSION_APPS";
1871
1872 /**
1873 * Intent extra: The name of a permission.
1874 * <p>
1875 * Type: String
1876 * </p>
1877 *
1878 * @hide
1879 */
1880 @SystemApi
1881 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1882
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001883 // ---------------------------------------------------------------------
1884 // ---------------------------------------------------------------------
1885 // Standard intent broadcast actions (see action variable).
1886
1887 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001888 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1889 * <p>
1890 * For historical reasons, the name of this broadcast action refers to the power
1891 * state of the screen but it is actually sent in response to changes in the
1892 * overall interactive state of the device.
1893 * </p><p>
1894 * This broadcast is sent when the device becomes non-interactive which may have
1895 * nothing to do with the screen turning off. To determine the
1896 * actual state of the screen, use {@link android.view.Display#getState}.
1897 * </p><p>
1898 * See {@link android.os.PowerManager#isInteractive} for details.
1899 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001900 * You <em>cannot</em> receive this through components declared in
1901 * manifests, only by explicitly registering for it with
1902 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1903 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001904 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001905 * <p class="note">This is a protected intent that can only be sent
1906 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001907 */
1908 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1909 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001910
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001911 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001912 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1913 * <p>
1914 * For historical reasons, the name of this broadcast action refers to the power
1915 * state of the screen but it is actually sent in response to changes in the
1916 * overall interactive state of the device.
1917 * </p><p>
1918 * This broadcast is sent when the device becomes interactive which may have
1919 * nothing to do with the screen turning on. To determine the
1920 * actual state of the screen, use {@link android.view.Display#getState}.
1921 * </p><p>
1922 * See {@link android.os.PowerManager#isInteractive} for details.
1923 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001924 * You <em>cannot</em> receive this through components declared in
1925 * manifests, only by explicitly registering for it with
1926 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1927 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001928 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001929 * <p class="note">This is a protected intent that can only be sent
1930 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001931 */
1932 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1933 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001934
1935 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001936 * Broadcast Action: Sent after the system stops dreaming.
1937 *
1938 * <p class="note">This is a protected intent that can only be sent by the system.
1939 * It is only sent to registered receivers.</p>
1940 */
1941 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1942 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1943
1944 /**
1945 * Broadcast Action: Sent after the system starts dreaming.
1946 *
1947 * <p class="note">This is a protected intent that can only be sent by the system.
1948 * It is only sent to registered receivers.</p>
1949 */
1950 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1951 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1952
1953 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001954 * 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 -07001955 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001956 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001957 * <p class="note">This is a protected intent that can only be sent
1958 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001959 */
1960 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001961 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001962
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001963 /**
1964 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001965 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001966 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001967 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1968 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001969 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001970 * <p class="note">This is a protected intent that can only be sent
1971 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001972 */
1973 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1974 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1975 /**
1976 * Broadcast Action: The time was set.
1977 */
1978 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1979 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1980 /**
1981 * Broadcast Action: The date has changed.
1982 */
1983 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1984 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1985 /**
1986 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1987 * <ul>
1988 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1989 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001990 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001991 * <p class="note">This is a protected intent that can only be sent
1992 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001993 */
1994 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1995 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1996 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001997 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1998 * DNS entries should be tossed.
1999 * @hide
2000 */
2001 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2002 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
2003 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002004 * Alarm Changed Action: This is broadcast when the AlarmClock
2005 * application's alarm is set or unset. It is used by the
2006 * AlarmClock application and the StatusBar service.
2007 * @hide
2008 */
2009 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2010 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002011
2012 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002013 * Broadcast Action: This is broadcast once, after the user has finished
2014 * booting, but while still in the "locked" state. It can be used to perform
2015 * application-specific initialization, such as installing alarms. You must
2016 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
2017 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002018 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002019 * This broadcast is sent immediately at boot by all devices (regardless of
2020 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
2021 * higher. Upon receipt of this broadcast, the user is still locked and only
2022 * device-protected storage can be accessed safely. If you want to access
2023 * credential-protected storage, you need to wait for the user to be
2024 * unlocked (typically by entering their lock pattern or PIN for the first
2025 * time), after which the {@link #ACTION_USER_UNLOCKED} and
2026 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
2027 * <p>
2028 * To receive this broadcast, your receiver component must be marked as
2029 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002030 * <p class="note">
2031 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002032 *
2033 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002034 */
2035 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2036 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2037
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002038 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002039 * Broadcast Action: This is broadcast once, after the user has finished
2040 * booting. It can be used to perform application-specific initialization,
2041 * such as installing alarms. You must hold the
2042 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2043 * order to receive this broadcast.
2044 * <p>
2045 * This broadcast is sent at boot by all devices (both with and without
2046 * direct boot support). Upon receipt of this broadcast, the user is
2047 * unlocked and both device-protected and credential-protected storage can
2048 * accessed safely.
2049 * <p>
2050 * If you need to run while the user is still locked (before they've entered
2051 * their lock pattern or PIN for the first time), you can listen for the
2052 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2053 * <p class="note">
2054 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002055 */
2056 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002057 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002058 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002059
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002060 /**
2061 * Broadcast Action: This is broadcast when a user action should request a
2062 * temporary system dialog to dismiss. Some examples of temporary system
2063 * dialogs are the notification window-shade and the recent tasks dialog.
2064 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002065 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002066 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2067 /**
2068 * Broadcast Action: Trigger the download and eventual installation
2069 * of a package.
2070 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002071 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002072 * <p class="note">This is a protected intent that can only be sent
2073 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002074 *
2075 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002076 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002077 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002078 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2079 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2080 /**
Christopher Tate94b91db2017-04-19 15:49:17 -07002081 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002082 * device. The data contains the name of the package. Note that the
2083 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002084 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002085 * <ul>
Christopher Tate94b91db2017-04-19 15:49:17 -07002086 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2087 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002088 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2089 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002090 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002091 * <p class="note">This is a protected intent that can only be sent
2092 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002093 */
2094 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2095 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2096 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002097 * Broadcast Action: A new version of an application package has been
2098 * installed, replacing an existing version that was previously installed.
2099 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002100 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002101 * <ul>
2102 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2103 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002104 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002105 * <p class="note">This is a protected intent that can only be sent
2106 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002107 */
2108 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2109 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2110 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002111 * Broadcast Action: A new version of your application has been installed
2112 * over an existing one. This is only sent to the application that was
2113 * replaced. It does not contain any additional data; to receive it, just
2114 * use an intent filter for this action.
2115 *
2116 * <p class="note">This is a protected intent that can only be sent
2117 * by the system.
2118 */
2119 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2120 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2121 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002122 * Broadcast Action: An existing application package has been removed from
2123 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002124 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002125 * <ul>
2126 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2127 * to the package.
2128 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2129 * application -- data and code -- is being removed.
2130 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2131 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2132 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002133 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002134 * <p class="note">This is a protected intent that can only be sent
2135 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002136 */
2137 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2138 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2139 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002140 * Broadcast Action: An existing application package has been completely
2141 * removed from the device. The data contains the name of the package.
2142 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2143 * {@link #EXTRA_DATA_REMOVED} is true and
2144 * {@link #EXTRA_REPLACING} is false of that broadcast.
2145 *
2146 * <ul>
2147 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2148 * to the package.
2149 * </ul>
2150 *
2151 * <p class="note">This is a protected intent that can only be sent
2152 * by the system.
2153 */
2154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2155 public static final String ACTION_PACKAGE_FULLY_REMOVED
2156 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2157 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002158 * Broadcast Action: An existing application package has been changed (for
2159 * example, a component has been enabled or disabled). The data contains
2160 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002161 * <ul>
2162 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002163 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002164 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002165 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2166 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002167 * </ul>
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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002171 */
2172 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2173 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2174 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002175 * @hide
2176 * Broadcast Action: Ask system services if there is any reason to
2177 * restart the given package. The data contains the name of the
2178 * package.
2179 * <ul>
2180 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2181 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2182 * </ul>
2183 *
2184 * <p class="note">This is a protected intent that can only be sent
2185 * by the system.
2186 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002187 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002188 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2189 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2190 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002191 * Broadcast Action: The user has restarted a package, and all of its
2192 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002193 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002194 * be removed. Note that the restarted package does <em>not</em>
2195 * receive this broadcast.
2196 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002197 * <ul>
2198 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2199 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002200 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002201 * <p class="note">This is a protected intent that can only be sent
2202 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002203 */
2204 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2205 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2206 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002207 * Broadcast Action: The user has cleared the data of a package. This should
2208 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002209 * its persistent data is erased and this broadcast sent.
2210 * Note that the cleared package does <em>not</em>
2211 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002212 * <ul>
2213 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2214 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002215 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002216 * <p class="note">This is a protected intent that can only be sent
2217 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002218 */
2219 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2220 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2221 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002222 * Broadcast Action: Packages have been suspended.
2223 * <p>Includes the following extras:
2224 * <ul>
2225 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2226 * </ul>
2227 *
2228 * <p class="note">This is a protected intent that can only be sent
2229 * by the system. It is only sent to registered receivers.
2230 */
2231 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2232 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2233 /**
2234 * Broadcast Action: Packages have been unsuspended.
2235 * <p>Includes the following extras:
2236 * <ul>
2237 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2238 * </ul>
2239 *
2240 * <p class="note">This is a protected intent that can only be sent
2241 * by the system. It is only sent to registered receivers.
2242 */
2243 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2244 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2245 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002246 * Broadcast Action: A user ID has been removed from the system. The user
2247 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002248 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002249 * <p class="note">This is a protected intent that can only be sent
2250 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002251 */
2252 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2253 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002254
2255 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002256 * Broadcast Action: Sent to the installer package of an application when
2257 * that application is first launched (that is the first time it is moved
2258 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002259 *
2260 * <p class="note">This is a protected intent that can only be sent
2261 * by the system.
2262 */
2263 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2264 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2265
2266 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002267 * Broadcast Action: Sent to the system package verifier when a package
2268 * needs to be verified. The data contains the package URI.
2269 * <p class="note">
2270 * This is a protected intent that can only be sent by the system.
2271 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002272 */
2273 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2274 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2275
2276 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002277 * Broadcast Action: Sent to the system package verifier when a package is
2278 * verified. The data contains the package URI.
2279 * <p class="note">
2280 * This is a protected intent that can only be sent by the system.
2281 */
2282 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2283 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2284
2285 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002286 * Broadcast Action: Sent to the system intent filter verifier when an
2287 * intent filter needs to be verified. The data contains the filter data
2288 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002289 * <p class="note">
2290 * This is a protected intent that can only be sent by the system.
2291 * </p>
2292 *
2293 * @hide
2294 */
2295 @SystemApi
2296 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2297 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2298
2299 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002300 * Broadcast Action: Resources for a set of packages (which were
2301 * previously unavailable) are currently
2302 * available since the media on which they exist is available.
2303 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2304 * list of packages whose availability changed.
2305 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2306 * list of uids of packages whose availability changed.
2307 * Note that the
2308 * packages in this list do <em>not</em> receive this broadcast.
2309 * The specified set of packages are now available on the system.
2310 * <p>Includes the following extras:
2311 * <ul>
2312 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2313 * whose resources(were previously unavailable) are currently available.
2314 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2315 * packages whose resources(were previously unavailable)
2316 * are currently available.
2317 * </ul>
2318 *
2319 * <p class="note">This is a protected intent that can only be sent
2320 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002321 */
2322 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002323 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2324 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002325
2326 /**
2327 * Broadcast Action: Resources for a set of packages are currently
2328 * unavailable since the media on which they exist is unavailable.
2329 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2330 * list of packages whose availability changed.
2331 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2332 * list of uids of packages whose availability changed.
2333 * The specified set of packages can no longer be
2334 * launched and are practically unavailable on the system.
2335 * <p>Inclues the following extras:
2336 * <ul>
2337 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2338 * whose resources are no longer available.
2339 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2340 * whose resources are no longer available.
2341 * </ul>
2342 *
2343 * <p class="note">This is a protected intent that can only be sent
2344 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002345 */
2346 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002347 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002348 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002349
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002350 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002351 * Broadcast Action: preferred activities have changed *explicitly*.
2352 *
2353 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2354 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2355 * be sent.
2356 *
2357 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2358 *
2359 * @hide
2360 */
2361 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2362 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2363 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2364
2365
2366 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002367 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002368 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002369 * This should <em>only</em> be used to determine when the wallpaper
2370 * has changed to show the new wallpaper to the user. You should certainly
2371 * never, in response to this, change the wallpaper or other attributes of
2372 * it such as the suggested size. That would be crazy, right? You'd cause
2373 * all kinds of loops, especially if other apps are doing similar things,
2374 * right? Of course. So please don't do this.
2375 *
2376 * @deprecated Modern applications should use
2377 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2378 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2379 * shown behind their UI, rather than watching for this broadcast and
2380 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002381 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002382 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002383 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2384 /**
2385 * Broadcast Action: The current device {@link android.content.res.Configuration}
2386 * (orientation, locale, etc) has changed. When such a change happens, the
2387 * UIs (view hierarchy) will need to be rebuilt based on this new
2388 * information; for the most part, applications don't need to worry about
2389 * this, because the system will take care of stopping and restarting the
2390 * application to make sure it sees the new changes. Some system code that
2391 * can not be restarted will need to watch for this action and handle it
2392 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002393 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002394 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002395 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002396 * in manifests, only by explicitly registering for it with
2397 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2398 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002399 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002400 * <p class="note">This is a protected intent that can only be sent
2401 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002402 *
2403 * @see android.content.res.Configuration
2404 */
2405 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2406 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2407 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002408 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002409 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002410 * <p class="note">This is a protected intent that can only be sent
2411 * by the system.
2412 */
2413 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2414 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2415 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002416 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2417 * charging state, level, and other information about the battery.
2418 * See {@link android.os.BatteryManager} for documentation on the
2419 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002420 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002421 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002422 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002423 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002424 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002425 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2426 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2427 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2428 * broadcasts that are sent and can be received through manifest
2429 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002430 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002431 * <p class="note">This is a protected intent that can only be sent
2432 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002433 */
2434 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2435 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2436 /**
2437 * Broadcast Action: Indicates low battery condition on the device.
2438 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002439 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002440 * <p class="note">This is a protected intent that can only be sent
2441 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002442 */
2443 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2444 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2445 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002446 * Broadcast Action: Indicates the battery is now okay after being low.
2447 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2448 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002449 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002450 * <p class="note">This is a protected intent that can only be sent
2451 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002452 */
2453 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2454 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2455 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002456 * Broadcast Action: External power has been connected to the device.
2457 * This is intended for applications that wish to register specifically to this notification.
2458 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2459 * stay active to receive this notification. This action can be used to implement actions
2460 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002461 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002462 * <p class="note">This is a protected intent that can only be sent
2463 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002464 */
2465 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002466 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002467 /**
2468 * Broadcast Action: External power has been removed from the device.
2469 * This is intended for applications that wish to register specifically to this notification.
2470 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2471 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002472 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002473 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002474 * <p class="note">This is a protected intent that can only be sent
2475 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002476 */
2477 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002478 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002479 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002480 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002481 * Broadcast Action: Device is shutting down.
2482 * This is broadcast when the device is being shut down (completely turned
2483 * off, not sleeping). Once the broadcast is complete, the final shutdown
2484 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002485 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002486 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002487 * <p class="note">This is a protected intent that can only be sent
2488 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002489 * <p>May include the following extras:
2490 * <ul>
2491 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2492 * shutdown is only for userspace processes. If not set, assumed to be false.
2493 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002494 */
2495 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002496 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002497 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002498 * Activity Action: Start this activity to request system shutdown.
2499 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002500 * to request confirmation from the user before shutting down. The optional boolean
2501 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2502 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002503 *
2504 * <p class="note">This is a protected intent that can only be sent
2505 * by the system.
2506 *
2507 * {@hide}
2508 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002509 public static final String ACTION_REQUEST_SHUTDOWN
2510 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002511 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002512 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002513 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002514 * <p class="note">
2515 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002516 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002517 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2518 * or above, this broadcast will no longer be delivered to any
2519 * {@link BroadcastReceiver} defined in your manifest. Instead,
2520 * apps are strongly encouraged to use the improved
2521 * {@link Context#getCacheDir()} behavior so the system can
2522 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002523 */
2524 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002525 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002526 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2527 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002528 * Broadcast Action: Indicates low storage space condition on the device no
2529 * longer exists
2530 * <p class="note">
2531 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002532 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002533 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2534 * or above, this broadcast will no longer be delivered to any
2535 * {@link BroadcastReceiver} defined in your manifest. Instead,
2536 * apps are strongly encouraged to use the improved
2537 * {@link Context#getCacheDir()} behavior so the system can
2538 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002539 */
2540 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002541 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002542 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2543 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002544 * Broadcast Action: A sticky broadcast that indicates a storage space full
2545 * condition on the device. This is intended for activities that want to be
2546 * able to fill the data partition completely, leaving only enough free
2547 * space to prevent system-wide SQLite failures.
2548 * <p class="note">
2549 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002550 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002551 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2552 * or above, this broadcast will no longer be delivered to any
2553 * {@link BroadcastReceiver} defined in your manifest. Instead,
2554 * apps are strongly encouraged to use the improved
2555 * {@link Context#getCacheDir()} behavior so the system can
2556 * automatically free up storage when needed.
2557 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002558 */
2559 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002560 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002561 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2562 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002563 * Broadcast Action: Indicates storage space full condition on the device no
2564 * longer exists.
2565 * <p class="note">
2566 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002567 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002568 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2569 * or above, this broadcast will no longer be delivered to any
2570 * {@link BroadcastReceiver} defined in your manifest. Instead,
2571 * apps are strongly encouraged to use the improved
2572 * {@link Context#getCacheDir()} behavior so the system can
2573 * automatically free up storage when needed.
2574 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002575 */
2576 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002577 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002578 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2579 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002580 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2581 * and package management should be started.
2582 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2583 * notification.
2584 */
2585 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2586 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2587 /**
2588 * Broadcast Action: The device has entered USB Mass Storage mode.
2589 * This is used mainly for the USB Settings panel.
2590 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2591 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002592 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002593 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002594 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002595 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002596 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2597
2598 /**
2599 * Broadcast Action: The device has exited USB Mass Storage mode.
2600 * This is used mainly for the USB Settings panel.
2601 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2602 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002603 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002604 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002605 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002606 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002607 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2608
2609 /**
2610 * Broadcast Action: External media has been removed.
2611 * The path to the mount point for the removed media is contained in the Intent.mData field.
2612 */
2613 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2614 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2615
2616 /**
2617 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002618 * 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 -07002619 */
2620 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2621 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2622
2623 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002624 * Broadcast Action: External media is present, and being disk-checked
2625 * 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 -08002626 */
2627 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2628 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2629
2630 /**
2631 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2632 * 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 -08002633 */
2634 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2635 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2636
2637 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002638 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002639 * 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 -07002640 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2641 * media was mounted read only.
2642 */
2643 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2644 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2645
2646 /**
2647 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002648 * 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 -07002649 */
2650 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2651 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2652
2653 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002654 * Broadcast Action: External media is no longer being shared via USB mass storage.
2655 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2656 *
2657 * @hide
2658 */
2659 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2660
2661 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002662 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2663 * The path to the mount point for the removed media is contained in the Intent.mData field.
2664 */
2665 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2666 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2667
2668 /**
2669 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002670 * 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 -07002671 */
2672 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2673 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2674
2675 /**
2676 * Broadcast Action: User has expressed the desire to remove the external storage media.
2677 * Applications should close all files they have open within the mount point when they receive this intent.
2678 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2679 */
2680 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2681 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2682
2683 /**
2684 * Broadcast Action: The media scanner has started scanning a directory.
2685 * The path to the directory being scanned is contained in the Intent.mData field.
2686 */
2687 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2688 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2689
2690 /**
2691 * Broadcast Action: The media scanner has finished scanning a directory.
2692 * The path to the scanned directory is contained in the Intent.mData field.
2693 */
2694 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2695 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2696
2697 /**
2698 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2699 * The path to the file is contained in the Intent.mData field.
2700 */
2701 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2702 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2703
2704 /**
2705 * Broadcast Action: The "Media Button" was pressed. Includes a single
2706 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2707 * caused the broadcast.
2708 */
2709 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2710 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2711
2712 /**
2713 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2714 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2715 * caused the broadcast.
2716 */
2717 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2718 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2719
2720 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2721 // location; they are not general-purpose actions.
2722
2723 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002724 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002725 */
2726 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2727 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2728 "android.intent.action.GTALK_CONNECTED";
2729
2730 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002731 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002732 */
2733 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2734 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2735 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002736
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002737 /**
2738 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002739 */
2740 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2741 public static final String ACTION_INPUT_METHOD_CHANGED =
2742 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002743
2744 /**
2745 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2746 * more radios have been turned off or on. The intent will have the following extra value:</p>
2747 * <ul>
2748 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2749 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2750 * turned off</li>
2751 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002752 *
Peng Xua35b5532016-01-20 00:05:45 -08002753 * <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 -07002754 */
2755 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2756 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2757
2758 /**
2759 * Broadcast Action: Some content providers have parts of their namespace
2760 * where they publish new events or items that the user may be especially
2761 * interested in. For these things, they may broadcast this action when the
2762 * set of interesting items change.
2763 *
2764 * For example, GmailProvider sends this notification when the set of unread
2765 * mail in the inbox changes.
2766 *
2767 * <p>The data of the intent identifies which part of which provider
2768 * changed. When queried through the content resolver, the data URI will
2769 * return the data set in question.
2770 *
2771 * <p>The intent will have the following extra values:
2772 * <ul>
2773 * <li><em>count</em> - The number of items in the data set. This is the
2774 * same as the number of items in the cursor returned by querying the
2775 * data URI. </li>
2776 * </ul>
2777 *
2778 * This intent will be sent at boot (if the count is non-zero) and when the
2779 * data set changes. It is possible for the data set to change without the
2780 * count changing (for example, if a new unread message arrives in the same
2781 * sync operation in which a message is archived). The phone should still
2782 * ring/vibrate/etc as normal in this case.
2783 */
2784 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2785 public static final String ACTION_PROVIDER_CHANGED =
2786 "android.intent.action.PROVIDER_CHANGED";
2787
2788 /**
2789 * Broadcast Action: Wired Headset plugged in or unplugged.
2790 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002791 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2792 * and documentation.
2793 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002794 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002795 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002796 */
2797 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002798 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002799
2800 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002801 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2802 * <ul>
2803 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2804 * </ul>
2805 *
2806 * <p class="note">This is a protected intent that can only be sent
2807 * by the system.
2808 *
2809 * @hide
2810 */
2811 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2812 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2813 = "android.intent.action.ADVANCED_SETTINGS";
2814
2815 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002816 * Broadcast Action: Sent after application restrictions are changed.
2817 *
2818 * <p class="note">This is a protected intent that can only be sent
2819 * by the system.</p>
2820 */
2821 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2822 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2823 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2824
2825 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002826 * Broadcast Action: An outgoing call is about to be placed.
2827 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002828 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002829 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002830 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002831 * the phone number originally intended to be dialed.</li>
2832 * </ul>
2833 * <p>Once the broadcast is finished, the resultData is used as the actual
2834 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002835 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002836 * outgoing call in turn: for example, a parental control application
2837 * might verify that the user is authorized to place the call at that
2838 * time, then a number-rewriting application might add an area code if
2839 * one was not specified.</p>
2840 * <p>For consistency, any receiver whose purpose is to prohibit phone
2841 * calls should have a priority of 0, to ensure it will see the final
2842 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002843 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002844 * should have a positive priority.
2845 * Negative priorities are reserved for the system for this broadcast;
2846 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002847 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2848 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002849 * <p>Emergency calls cannot be intercepted using this mechanism, and
2850 * other calls cannot be modified to call emergency numbers using this
2851 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002852 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2853 * call to use their own service instead. Those apps should first prevent
2854 * the call from being placed by setting resultData to <code>null</code>
2855 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002856 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002857 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2858 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002859 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002860 * <p class="note">This is a protected intent that can only be sent
2861 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002862 */
2863 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2864 public static final String ACTION_NEW_OUTGOING_CALL =
2865 "android.intent.action.NEW_OUTGOING_CALL";
2866
2867 /**
2868 * Broadcast Action: Have the device reboot. This is only for use by
2869 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002870 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002871 * <p class="note">This is a protected intent that can only be sent
2872 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002873 */
2874 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2875 public static final String ACTION_REBOOT =
2876 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002877
Wei Huang97ecc9c2009-05-11 17:44:20 -07002878 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002879 * Broadcast Action: A sticky broadcast for changes in the physical
2880 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002881 *
2882 * <p>The intent will have the following extra values:
2883 * <ul>
2884 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002885 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002886 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002887 * <p>This is intended for monitoring the current physical dock state.
2888 * See {@link android.app.UiModeManager} for the normal API dealing with
2889 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002890 */
2891 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2892 public static final String ACTION_DOCK_EVENT =
2893 "android.intent.action.DOCK_EVENT";
2894
2895 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002896 * Broadcast Action: A broadcast when idle maintenance can be started.
2897 * This means that the user is not interacting with the device and is
2898 * not expected to do so soon. Typical use of the idle maintenance is
2899 * to perform somehow expensive tasks that can be postponed at a moment
2900 * when they will not degrade user experience.
2901 * <p>
2902 * <p class="note">In order to keep the device responsive in case of an
2903 * unexpected user interaction, implementations of a maintenance task
2904 * should be interruptible. In such a scenario a broadcast with action
2905 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2906 * should not do the maintenance work in
2907 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2908 * maintenance service by {@link Context#startService(Intent)}. Also
2909 * you should hold a wake lock while your maintenance service is running
2910 * to prevent the device going to sleep.
2911 * </p>
2912 * <p>
2913 * <p class="note">This is a protected intent that can only be sent by
2914 * the system.
2915 * </p>
2916 *
2917 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002918 *
2919 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002920 */
2921 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2922 public static final String ACTION_IDLE_MAINTENANCE_START =
2923 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2924
2925 /**
2926 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2927 * This means that the user was not interacting with the device as a result
2928 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2929 * was sent and now the user started interacting with the device. Typical
2930 * use of the idle maintenance is to perform somehow expensive tasks that
2931 * can be postponed at a moment when they will not degrade user experience.
2932 * <p>
2933 * <p class="note">In order to keep the device responsive in case of an
2934 * unexpected user interaction, implementations of a maintenance task
2935 * should be interruptible. Hence, on receiving a broadcast with this
2936 * action, the maintenance task should be interrupted as soon as possible.
2937 * In other words, you should not do the maintenance work in
2938 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2939 * maintenance service that was started on receiving of
2940 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2941 * lock you acquired when your maintenance service started.
2942 * </p>
2943 * <p class="note">This is a protected intent that can only be sent
2944 * by the system.
2945 *
2946 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002947 *
2948 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002949 */
2950 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2951 public static final String ACTION_IDLE_MAINTENANCE_END =
2952 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2953
2954 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002955 * Broadcast Action: a remote intent is to be broadcasted.
2956 *
2957 * A remote intent is used for remote RPC between devices. The remote intent
2958 * is serialized and sent from one device to another device. The receiving
2959 * device parses the remote intent and broadcasts it. Note that anyone can
2960 * broadcast a remote intent. However, if the intent receiver of the remote intent
2961 * does not trust intent broadcasts from arbitrary intent senders, it should require
2962 * the sender to hold certain permissions so only trusted sender's broadcast will be
2963 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002964 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002965 */
2966 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002967 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002968
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002969 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002970 * Broadcast Action: This is broadcast once when the user is booting after a
2971 * system update. It can be used to perform cleanup or upgrades after a
2972 * system update.
2973 * <p>
2974 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2975 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2976 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2977 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002978 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002979 * @hide
2980 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08002981 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002982 public static final String ACTION_PRE_BOOT_COMPLETED =
2983 "android.intent.action.PRE_BOOT_COMPLETED";
2984
Amith Yamasani13593602012-03-22 16:16:17 -07002985 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002986 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002987 * on restricted users. The broadcast intent contains an extra
2988 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2989 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2990 * String[] depending on the restriction type.<p/>
2991 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002992 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2993 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2994 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002995 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2996 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002997 * @see RestrictionEntry
2998 */
2999 public static final String ACTION_GET_RESTRICTION_ENTRIES =
3000 "android.intent.action.GET_RESTRICTION_ENTRIES";
3001
3002 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003003 * Sent the first time a user is starting, to allow system apps to
3004 * perform one time initialization. (This will not be seen by third
3005 * party applications because a newly initialized user does not have any
3006 * third party applications installed for it.) This is sent early in
3007 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003008 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3009 * broadcast, since it is part of a visible user interaction; be as quick
3010 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003011 */
3012 public static final String ACTION_USER_INITIALIZE =
3013 "android.intent.action.USER_INITIALIZE";
3014
3015 /**
3016 * Sent when a user switch is happening, causing the process's user to be
3017 * brought to the foreground. This is only sent to receivers registered
3018 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3019 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003020 * foreground. This is sent as a foreground
3021 * broadcast, since it is part of a visible user interaction; be as quick
3022 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003023 */
3024 public static final String ACTION_USER_FOREGROUND =
3025 "android.intent.action.USER_FOREGROUND";
3026
3027 /**
3028 * Sent when a user switch is happening, causing the process's user to be
3029 * sent to the background. This is only sent to receivers registered
3030 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3031 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003032 * background. This is sent as a foreground
3033 * broadcast, since it is part of a visible user interaction; be as quick
3034 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003035 */
3036 public static final String ACTION_USER_BACKGROUND =
3037 "android.intent.action.USER_BACKGROUND";
3038
3039 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003040 * Broadcast sent to the system when a user is added. Carries an extra
3041 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3042 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003043 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003044 * @hide
3045 */
3046 public static final String ACTION_USER_ADDED =
3047 "android.intent.action.USER_ADDED";
3048
3049 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003050 * Broadcast sent by the system when a user is started. Carries an extra
3051 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003052 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003053 * that has been started. This is sent as a foreground
3054 * broadcast, since it is part of a visible user interaction; be as quick
3055 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003056 * @hide
3057 */
3058 public static final String ACTION_USER_STARTED =
3059 "android.intent.action.USER_STARTED";
3060
3061 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003062 * Broadcast sent when a user is in the process of starting. Carries an extra
3063 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3064 * sent to registered receivers, not manifest receivers. It is sent to all
3065 * users (including the one that is being started). You must hold
3066 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3067 * this broadcast. This is sent as a background broadcast, since
3068 * its result is not part of the primary UX flow; to safely keep track of
3069 * started/stopped state of a user you can use this in conjunction with
3070 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3071 * other user state broadcasts since those are foreground broadcasts so can
3072 * execute in a different order.
3073 * @hide
3074 */
3075 public static final String ACTION_USER_STARTING =
3076 "android.intent.action.USER_STARTING";
3077
3078 /**
3079 * Broadcast sent when a user is going to be stopped. Carries an extra
3080 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3081 * sent to registered receivers, not manifest receivers. It is sent to all
3082 * users (including the one that is being stopped). You must hold
3083 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3084 * this broadcast. The user will not stop until all receivers have
3085 * handled the broadcast. This is sent as a background broadcast, since
3086 * its result is not part of the primary UX flow; to safely keep track of
3087 * started/stopped state of a user you can use this in conjunction with
3088 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3089 * other user state broadcasts since those are foreground broadcasts so can
3090 * execute in a different order.
3091 * @hide
3092 */
3093 public static final String ACTION_USER_STOPPING =
3094 "android.intent.action.USER_STOPPING";
3095
3096 /**
3097 * Broadcast sent to the system when a user is stopped. Carries an extra
3098 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3099 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3100 * specific package. This is only sent to registered receivers, not manifest
3101 * receivers. It is sent to all running users <em>except</em> the one that
3102 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003103 * @hide
3104 */
3105 public static final String ACTION_USER_STOPPED =
3106 "android.intent.action.USER_STOPPED";
3107
3108 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003109 * 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 -07003110 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003111 * one that has been removed. The user will not be completely removed until all receivers have
3112 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003113 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003114 * @hide
3115 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003116 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003117 public static final String ACTION_USER_REMOVED =
3118 "android.intent.action.USER_REMOVED";
3119
3120 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003121 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003122 * the userHandle of the user to become the current one. This is only sent to
3123 * registered receivers, not manifest receivers. It is sent to all running users.
3124 * You must hold
3125 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003126 * @hide
3127 */
3128 public static final String ACTION_USER_SWITCHED =
3129 "android.intent.action.USER_SWITCHED";
3130
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003131 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003132 * Broadcast Action: Sent when the credential-encrypted private storage has
3133 * become unlocked for the target user. This is only sent to registered
3134 * receivers, not manifest receivers.
3135 */
3136 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3137 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3138
3139 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003140 * Broadcast sent to the system when a user's information changes. Carries an extra
3141 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003142 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003143 * @hide
3144 */
3145 public static final String ACTION_USER_INFO_CHANGED =
3146 "android.intent.action.USER_INFO_CHANGED";
3147
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003148 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003149 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3150 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003151 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3152 * that need to display merged content across both primary and managed profiles need to
3153 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003154 * not manifest receivers.
3155 */
3156 public static final String ACTION_MANAGED_PROFILE_ADDED =
3157 "android.intent.action.MANAGED_PROFILE_ADDED";
3158
3159 /**
3160 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003161 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3162 * Only applications (for example Launchers) that need to display merged content across both
3163 * primary and managed profiles need to worry about this broadcast. This is only sent to
3164 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003165 */
3166 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3167 "android.intent.action.MANAGED_PROFILE_REMOVED";
3168
3169 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003170 * Broadcast sent to the primary user when the credential-encrypted private storage for
3171 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3172 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3173 * Launchers) that need to display merged content across both primary and managed profiles
3174 * need to worry about this broadcast. This is only sent to registered receivers,
3175 * not manifest receivers.
3176 */
3177 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3178 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3179
3180 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003181 * Broadcast sent to the primary user when an associated managed profile has become available.
3182 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003183 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3184 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3185 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003186 */
Rubin Xue95057a2016-04-01 16:49:25 +01003187 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3188 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3189
3190 /**
3191 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3192 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3193 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3194 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3195 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3196 */
3197 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3198 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003199
3200 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003201 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3202 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3203 * the device was locked or unlocked.
3204 *
3205 * This is only sent to registered receivers.
3206 *
3207 * @hide
3208 */
3209 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3210 "android.intent.action.DEVICE_LOCKED_CHANGED";
3211
3212 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003213 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3214 */
3215 public static final String ACTION_QUICK_CLOCK =
3216 "android.intent.action.QUICK_CLOCK";
3217
Michael Wright0087a142013-02-05 16:29:39 -08003218 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003219 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003220 * @hide
3221 */
3222 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003223 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003224
Justin Kohd378ad72013-04-01 12:18:26 -07003225 /**
3226 * Broadcast Action: A global button was pressed. Includes a single
3227 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3228 * caused the broadcast.
3229 * @hide
3230 */
3231 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3232
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003233 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003234 * Broadcast Action: Sent when media resource is granted.
3235 * <p>
3236 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3237 * granted.
3238 * </p>
3239 * <p class="note">
3240 * This is a protected intent that can only be sent by the system.
3241 * </p>
3242 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003243 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003244 * </p>
3245 *
3246 * @hide
3247 */
3248 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3249 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3250
3251 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003252 * Broadcast Action: An overlay package has changed. The data contains the
3253 * name of the overlay package which has changed. This is broadcast on all
3254 * changes to the OverlayInfo returned by {@link
3255 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3256 * most common change is a state change that will change whether the
3257 * overlay is enabled or not.
3258 * @hide
3259 */
3260 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3261
3262 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003263 * Activity Action: Allow the user to select and return one or more existing
3264 * documents. When invoked, the system will display the various
3265 * {@link DocumentsProvider} instances installed on the device, letting the
3266 * user interactively navigate through them. These documents include local
3267 * media, such as photos and video, and documents provided by installed
3268 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003269 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003270 * Each document is represented as a {@code content://} URI backed by a
3271 * {@link DocumentsProvider}, which can be opened as a stream with
3272 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3273 * {@link android.provider.DocumentsContract.Document} metadata.
3274 * <p>
3275 * All selected documents are returned to the calling application with
3276 * persistable read and write permission grants. If you want to maintain
3277 * access to the documents across device reboots, you need to explicitly
3278 * take the persistable permissions using
3279 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3280 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003281 * Callers must indicate the acceptable document MIME types through
3282 * {@link #setType(String)}. For example, to select photos, use
3283 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3284 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3285 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003286 * <p>
3287 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003288 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3289 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003290 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003291 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3292 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003293 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003294 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003295 * Callers can set a document URI through
3296 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3297 * location of documents navigator. System will do its best to launch the
3298 * navigator in the specified document if it's a folder, or the folder that
3299 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003300 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003301 * Output: The URI of the item that was picked, returned in
3302 * {@link #getData()}. This must be a {@code content://} URI so that any
3303 * receiver can access it. If multiple documents were selected, they are
3304 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003305 *
3306 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003307 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003308 * @see #ACTION_CREATE_DOCUMENT
3309 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003310 */
3311 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3312 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3313
3314 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003315 * Activity Action: Allow the user to create a new document. When invoked,
3316 * the system will display the various {@link DocumentsProvider} instances
3317 * installed on the device, letting the user navigate through them. The
3318 * returned document may be a newly created document with no content, or it
3319 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003320 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003321 * Each document is represented as a {@code content://} URI backed by a
3322 * {@link DocumentsProvider}, which can be opened as a stream with
3323 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3324 * {@link android.provider.DocumentsContract.Document} metadata.
3325 * <p>
3326 * Callers must indicate the concrete MIME type of the document being
3327 * created by setting {@link #setType(String)}. This MIME type cannot be
3328 * changed after the document is created.
3329 * <p>
3330 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3331 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003332 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003333 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3334 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003335 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003336 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003337 * Callers can set a document URI through
3338 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3339 * location of documents navigator. System will do its best to launch the
3340 * navigator in the specified document if it's a folder, or the folder that
3341 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003342 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003343 * Output: The URI of the item that was created. This must be a
3344 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003345 *
3346 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003347 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003348 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003349 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003350 */
3351 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3352 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3353
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003354 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003355 * Activity Action: Allow the user to pick a directory subtree. When
3356 * invoked, the system will display the various {@link DocumentsProvider}
3357 * instances installed on the device, letting the user navigate through
3358 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003359 * <p>
3360 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003361 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3362 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3363 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003364 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003365 * Callers can set a document URI through
3366 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3367 * location of documents navigator. System will do its best to launch the
3368 * navigator in the specified document if it's a folder, or the folder that
3369 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003370 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003371 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003372 *
3373 * @see DocumentsContract
3374 */
3375 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003376 public static final String
3377 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003378
Felipe Lemec7b1f892016-01-15 15:02:31 -08003379 /**
Peng Xua35b5532016-01-20 00:05:45 -08003380 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3381 * exisiting sensor being disconnected.
3382 *
3383 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3384 *
3385 * {@hide}
3386 */
3387 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3388 public static final String
3389 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3390
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003391 /**
Sanket Padawe2c1a49f2017-03-31 12:39:50 -07003392 * Broadcast Action: The default subscription has changed. This has the following
3393 * extra values:</p>
3394 * The {@link #EXTRA_SUBSCRIPTION_INDEX} extra indicates the current default subscription index
3395 */
3396 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3397 public static final String ACTION_DEFAULT_SUBSCRIPTION_CHANGED
3398 = "android.intent.action.ACTION_DEFAULT_SUBSCRIPTION_CHANGED";
3399
3400 /**
3401 * Broadcast Action: The default sms subscription has changed. This has the following
3402 * extra values:</p>
3403 * {@link #EXTRA_SUBSCRIPTION_INDEX} extra indicates the current default sms
3404 * subscription index
3405 */
3406 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3407 public static final String ACTION_DEFAULT_SMS_SUBSCRIPTION_CHANGED
3408 = "android.intent.action.ACTION_DEFAULT_SMS_SUBSCRIPTION_CHANGED";
3409
3410 /**
3411 * Integer extra used with {@link #ACTION_DEFAULT_SUBSCRIPTION_CHANGED} and
3412 * {@link #ACTION_DEFAULT_SMS_SUBSCRIPTION_CHANGED} to indicate the subscription
3413 * which has changed.
3414 */
3415 public static final String EXTRA_SUBSCRIPTION_INDEX = "android.intent.extra.SUBSCRIPTION_INDEX";
3416
3417 /**
Sam Line707f832017-04-13 17:00:55 -07003418 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003419 * @hide
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003420 */
3421 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003422 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003423 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3424
Christopher Tate6597e342015-02-17 12:15:25 -08003425 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003426 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3427 * is about to be performed.
3428 * @hide
3429 */
3430 @SystemApi
3431 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3432 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3433 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3434
3435 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003436 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3437 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3438 *
3439 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3440 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003441 * @hide
3442 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003443 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003444 public static final String EXTRA_FORCE_MASTER_CLEAR =
3445 "android.intent.extra.FORCE_MASTER_CLEAR";
3446
3447 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003448 * A broadcast action to trigger a factory reset.
3449 *
3450 * <p> The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission.
3451 *
3452 * <p>Not for use by third-party applications.
3453 *
3454 * @see #EXTRA_FORCE_MASTER_CLEAR
3455 *
3456 * {@hide}
3457 */
3458 @SystemApi
3459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3460 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3461
3462 /**
3463 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3464 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3465 *
3466 * <p>Not for use by third-party applications.
3467 *
3468 * @hide
3469 */
3470 @SystemApi
3471 public static final String EXTRA_FORCE_FACTORY_RESET =
3472 "android.intent.extra.FORCE_FACTORY_RESET";
3473
3474 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003475 * Broadcast action: report that a settings element is being restored from backup. The intent
3476 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3477 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3478 * is the value of that settings entry prior to the restore operation. All of these values are
3479 * represented as strings.
3480 *
3481 * <p>This broadcast is sent only for settings provider entries known to require special handling
3482 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3483 * the provider's backup agent implementation.
3484 *
3485 * @see #EXTRA_SETTING_NAME
3486 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3487 * @see #EXTRA_SETTING_NEW_VALUE
3488 * {@hide}
3489 */
3490 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3491
3492 /** {@hide} */
3493 public static final String EXTRA_SETTING_NAME = "setting_name";
3494 /** {@hide} */
3495 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3496 /** {@hide} */
3497 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3498
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003499 /**
3500 * Activity Action: Process a piece of text.
3501 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3502 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3503 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3504 */
3505 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3506 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003507
3508 /**
3509 * Broadcast Action: The sim card state has changed.
3510 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3511 * because TelephonyIntents is an internal class.
3512 * @hide
3513 */
3514 @SystemApi
3515 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3516 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3517
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003518 /**
fionaxu90fee272017-03-31 12:45:12 -07003519 * Broadcast Action: indicate that the phone service state has changed.
3520 * The intent will have the following extra values:</p>
3521 * <p>
3522 * @see #EXTRA_VOICE_REG_STATE
3523 * @see #EXTRA_DATA_REG_STATE
3524 * @see #EXTRA_VOICE_ROAMING_TYPE
3525 * @see #EXTRA_DATA_ROAMING_TYPE
3526 * @see #EXTRA_OPERATOR_ALPHA_LONG
3527 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3528 * @see #EXTRA_OPERATOR_NUMERIC
3529 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3530 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3531 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3532 * @see #EXTRA_MANUAL
3533 * @see #EXTRA_VOICE_RADIO_TECH
3534 * @see #EXTRA_DATA_RADIO_TECH
3535 * @see #EXTRA_CSS_INDICATOR
3536 * @see #EXTRA_NETWORK_ID
3537 * @see #EXTRA_SYSTEM_ID
3538 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3539 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3540 * @see #EXTRA_EMERGENCY_ONLY
3541 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3542 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3543 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3544 *
3545 * <p class="note">
3546 * Requires the READ_PHONE_STATE permission.
3547 *
3548 * <p class="note">This is a protected intent that can only be sent by the system.
3549 * @hide
3550 */
3551 @Deprecated
3552 @SystemApi
3553 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3554 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3555
3556 /**
3557 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3558 * state.
3559 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3560 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3561 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3562 * @see android.telephony.ServiceState#STATE_POWER_OFF
3563 * @hide
3564 */
3565 @Deprecated
3566 @SystemApi
3567 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3568
3569 /**
3570 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3571 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3572 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3573 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3574 * @see android.telephony.ServiceState#STATE_POWER_OFF
3575 * @hide
3576 */
3577 @Deprecated
3578 @SystemApi
3579 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3580
3581 /**
3582 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3583 * type.
3584 * @hide
3585 */
3586 @Deprecated
3587 @SystemApi
3588 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3589
3590 /**
3591 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3592 * type.
3593 * @hide
3594 */
3595 @Deprecated
3596 @SystemApi
3597 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3598
3599 /**
3600 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3601 * registered voice operator name in long alphanumeric format.
3602 * {@code null} if the operator name is not known or unregistered.
3603 * @hide
3604 */
3605 @Deprecated
3606 @SystemApi
3607 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3608
3609 /**
3610 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3611 * registered voice operator name in short alphanumeric format.
3612 * {@code null} if the operator name is not known or unregistered.
3613 * @hide
3614 */
3615 @Deprecated
3616 @SystemApi
3617 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3618
3619 /**
3620 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3621 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3622 * network.
3623 * @hide
3624 */
3625 @Deprecated
3626 @SystemApi
3627 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3628
3629 /**
3630 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3631 * registered data operator name in long alphanumeric format.
3632 * {@code null} if the operator name is not known or unregistered.
3633 * @hide
3634 */
3635 @Deprecated
3636 @SystemApi
3637 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3638
3639 /**
3640 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3641 * registered data operator name in short alphanumeric format.
3642 * {@code null} if the operator name is not known or unregistered.
3643 * @hide
3644 */
3645 @Deprecated
3646 @SystemApi
3647 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3648
3649 /**
3650 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3651 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3652 * data operator.
3653 * @hide
3654 */
3655 @Deprecated
3656 @SystemApi
3657 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3658
3659 /**
3660 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3661 * network selection mode is manual.
3662 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3663 * @hide
3664 */
3665 @Deprecated
3666 @SystemApi
3667 public static final String EXTRA_MANUAL = "manual";
3668
3669 /**
3670 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3671 * radio technology.
3672 * @hide
3673 */
3674 @Deprecated
3675 @SystemApi
3676 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3677
3678 /**
3679 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3680 * radio technology.
3681 * @hide
3682 */
3683 @Deprecated
3684 @SystemApi
3685 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3686
3687 /**
3688 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3689 * support on CDMA network.
3690 * Will be {@code true} if support, {@code false} otherwise.
3691 * @hide
3692 */
3693 @Deprecated
3694 @SystemApi
3695 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3696
3697 /**
3698 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3699 * id. {@code Integer.MAX_VALUE} if unknown.
3700 * @hide
3701 */
3702 @Deprecated
3703 @SystemApi
3704 public static final String EXTRA_NETWORK_ID = "networkId";
3705
3706 /**
3707 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3708 * {@code Integer.MAX_VALUE} if unknown.
3709 * @hide
3710 */
3711 @Deprecated
3712 @SystemApi
3713 public static final String EXTRA_SYSTEM_ID = "systemId";
3714
3715 /**
3716 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3717 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3718 * @hide
3719 */
3720 @Deprecated
3721 @SystemApi
3722 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3723
3724 /**
3725 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3726 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3727 * @hide
3728 */
3729 @Deprecated
3730 @SystemApi
3731 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3732
3733 /**
3734 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3735 * only mode.
3736 * {@code true} if in emergency only mode, {@code false} otherwise.
3737 * @hide
3738 */
3739 @Deprecated
3740 @SystemApi
3741 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3742
3743 /**
3744 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3745 * registration state is roaming.
3746 * {@code true} if registration indicates roaming, {@code false} otherwise
3747 * @hide
3748 */
3749 @Deprecated
3750 @SystemApi
3751 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
3752 "isDataRoamingFromRegistration";
3753
3754 /**
3755 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
3756 * aggregation is in use.
3757 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
3758 * @hide
3759 */
3760 @Deprecated
3761 @SystemApi
3762 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
3763
3764 /**
3765 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
3766 * is reduced from the rsrp threshold while calculating signal strength level.
3767 * @hide
3768 */
3769 @Deprecated
3770 @SystemApi
3771 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
3772
3773 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003774 * The name of the extra used to define the text to be processed, as a
3775 * CharSequence. Note that this may be a styled CharSequence, so you must use
3776 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003777 */
3778 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3779 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003780 * 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 +00003781 */
3782 public static final String EXTRA_PROCESS_TEXT_READONLY =
3783 "android.intent.extra.PROCESS_TEXT_READONLY";
3784
Bryce Leebc58f592015-09-25 16:43:01 -07003785 /**
3786 * Broadcast action: reports when a new thermal event has been reached. When the device
3787 * is reaching its maximum temperatue, the thermal level reported
3788 * {@hide}
3789 */
3790 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3791 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3792
3793 /** {@hide} */
3794 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3795
3796 /**
3797 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003798 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003799 * {@hide}
3800 */
3801 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3802
3803 /**
3804 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003805 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003806 * {@hide}
3807 */
3808 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3809
3810 /**
3811 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003812 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003813 * {@hide}
3814 */
3815 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3816
3817
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003818 // ---------------------------------------------------------------------
3819 // ---------------------------------------------------------------------
3820 // Standard intent categories (see addCategory()).
3821
3822 /**
3823 * Set if the activity should be an option for the default action
3824 * (center press) to perform on a piece of data. Setting this will
3825 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003826 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003827 * Intent when initiating an action -- it is for use in intent filters
3828 * specified in packages.
3829 */
3830 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3831 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3832 /**
3833 * Activities that can be safely invoked from a browser must support this
3834 * category. For example, if the user is viewing a web page or an e-mail
3835 * and clicks on a link in the text, the Intent generated execute that
3836 * link will require the BROWSABLE category, so that only activities
3837 * supporting this category will be considered as possible actions. By
3838 * supporting this category, you are promising that there is nothing
3839 * damaging (without user intervention) that can happen by invoking any
3840 * matching Intent.
3841 */
3842 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3843 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3844 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003845 * Categories for activities that can participate in voice interaction.
3846 * An activity that supports this category must be prepared to run with
3847 * no UI shown at all (though in some case it may have a UI shown), and
3848 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3849 */
3850 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3851 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3852 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003853 * Set if the activity should be considered as an alternative action to
3854 * the data the user is currently viewing. See also
3855 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3856 * applies to the selection in a list of items.
3857 *
3858 * <p>Supporting this category means that you would like your activity to be
3859 * displayed in the set of alternative things the user can do, usually as
3860 * part of the current activity's options menu. You will usually want to
3861 * include a specific label in the &lt;intent-filter&gt; of this action
3862 * describing to the user what it does.
3863 *
3864 * <p>The action of IntentFilter with this category is important in that it
3865 * describes the specific action the target will perform. This generally
3866 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3867 * a specific name such as "com.android.camera.action.CROP. Only one
3868 * alternative of any particular action will be shown to the user, so using
3869 * a specific action like this makes sure that your alternative will be
3870 * displayed while also allowing other applications to provide their own
3871 * overrides of that particular action.
3872 */
3873 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3874 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3875 /**
3876 * Set if the activity should be considered as an alternative selection
3877 * action to the data the user has currently selected. This is like
3878 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3879 * of items from which the user can select, giving them alternatives to the
3880 * default action that will be performed on it.
3881 */
3882 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3883 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3884 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003885 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003886 */
3887 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3888 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3889 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003890 * Should be displayed in the top-level launcher.
3891 */
3892 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3893 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3894 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003895 * Indicates an activity optimized for Leanback mode, and that should
3896 * be displayed in the Leanback launcher.
3897 */
3898 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3899 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3900 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003901 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3902 * @hide
3903 */
3904 @SystemApi
3905 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3906 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003907 * Provides information about the package it is in; typically used if
3908 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3909 * a front-door to the user without having to be shown in the all apps list.
3910 */
3911 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3912 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3913 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003914 * This is the home activity, that is the first activity that is displayed
3915 * when the device boots.
3916 */
3917 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3918 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3919 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003920 * This is the home activity that is displayed when the device is finished setting up and ready
3921 * for use.
3922 * @hide
3923 */
3924 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3925 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3926 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003927 * This is the setup wizard activity, that is the first activity that is displayed
3928 * when the user sets up the device for the first time.
3929 * @hide
3930 */
3931 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3932 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3933 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003934 * This activity is a preference panel.
3935 */
3936 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3937 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3938 /**
3939 * This activity is a development preference panel.
3940 */
3941 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3942 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3943 /**
3944 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003945 */
3946 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3947 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3948 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003949 * This activity allows the user to browse and download new applications.
3950 */
3951 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3952 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3953 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003954 * This activity may be exercised by the monkey or other automated test tools.
3955 */
3956 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3957 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3958 /**
3959 * To be used as a test (not part of the normal user experience).
3960 */
3961 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3962 /**
3963 * To be used as a unit test (run through the Test Harness).
3964 */
3965 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3966 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003967 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003968 * experience).
3969 */
3970 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003971
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003972 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003973 * Used to indicate that an intent only wants URIs that can be opened with
3974 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3975 * must support at least the columns defined in {@link OpenableColumns} when
3976 * queried.
3977 *
3978 * @see #ACTION_GET_CONTENT
3979 * @see #ACTION_OPEN_DOCUMENT
3980 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003981 */
3982 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3983 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3984
3985 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09003986 * Used to indicate that an intent filter can accept files which are not necessarily
3987 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
3988 * at least streamable via
3989 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
3990 * using one of the stream types exposed via
3991 * {@link ContentResolver#getStreamTypes(Uri, String)}.
3992 *
3993 * @see #ACTION_SEND
3994 * @see #ACTION_SEND_MULTIPLE
3995 */
3996 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3997 public static final String CATEGORY_TYPED_OPENABLE =
3998 "android.intent.category.TYPED_OPENABLE";
3999
4000 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004001 * To be used as code under test for framework instrumentation tests.
4002 */
4003 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
4004 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04004005 /**
4006 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004007 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4008 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004009 */
4010 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4011 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
4012 /**
4013 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004014 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4015 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004016 */
4017 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4018 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004019 /**
4020 * An activity to run when device is inserted into a analog (low end) dock.
4021 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4022 * information, see {@link android.app.UiModeManager}.
4023 */
4024 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4025 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
4026
4027 /**
4028 * An activity to run when device is inserted into a digital (high end) dock.
4029 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4030 * information, see {@link android.app.UiModeManager}.
4031 */
4032 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4033 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004034
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004035 /**
4036 * Used to indicate that the activity can be used in a car environment.
4037 */
4038 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4039 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4040
Zak Cohendb6ca492017-01-26 14:09:00 -08004041 /**
4042 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4043 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4044 * information, see {@link android.app.UiModeManager}.
4045 */
4046 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4047 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004048 // ---------------------------------------------------------------------
4049 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004050 // Application launch intent categories (see addCategory()).
4051
4052 /**
4053 * Used with {@link #ACTION_MAIN} to launch the browser application.
4054 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004055 * <p>NOTE: This should not be used as the primary key of an Intent,
4056 * since it will not result in the app launching with the correct
4057 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004058 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004059 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004060 */
4061 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4062 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4063
4064 /**
4065 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4066 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004067 * <p>NOTE: This should not be used as the primary key of an Intent,
4068 * since it will not result in the app launching with the correct
4069 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004070 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004071 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004072 */
4073 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4074 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4075
4076 /**
4077 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4078 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004079 * <p>NOTE: This should not be used as the primary key of an Intent,
4080 * since it will not result in the app launching with the correct
4081 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004082 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004083 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004084 */
4085 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4086 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4087
4088 /**
4089 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4090 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004091 * <p>NOTE: This should not be used as the primary key of an Intent,
4092 * since it will not result in the app launching with the correct
4093 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004094 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004095 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004096 */
4097 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4098 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4099
4100 /**
4101 * Used with {@link #ACTION_MAIN} to launch the email application.
4102 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004103 * <p>NOTE: This should not be used as the primary key of an Intent,
4104 * since it will not result in the app launching with the correct
4105 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004106 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004107 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004108 */
4109 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4110 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4111
4112 /**
4113 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4114 * The activity should be able to view and manipulate image and video files
4115 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004116 * <p>NOTE: This should not be used as the primary key of an Intent,
4117 * since it will not result in the app launching with the correct
4118 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004119 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004120 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004121 */
4122 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4123 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4124
4125 /**
4126 * Used with {@link #ACTION_MAIN} to launch the maps application.
4127 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004128 * <p>NOTE: This should not be used as the primary key of an Intent,
4129 * since it will not result in the app launching with the correct
4130 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004131 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004132 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004133 */
4134 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4135 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4136
4137 /**
4138 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4139 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004140 * <p>NOTE: This should not be used as the primary key of an Intent,
4141 * since it will not result in the app launching with the correct
4142 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004143 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004144 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004145 */
4146 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4147 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4148
4149 /**
4150 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004151 * The activity should be able to play, browse, or manipulate music files
4152 * stored on the device.
4153 * <p>NOTE: This should not be used as the primary key of an Intent,
4154 * since it will not result in the app launching with the correct
4155 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004156 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004157 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004158 */
4159 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4160 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4161
4162 // ---------------------------------------------------------------------
4163 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004164 // Standard extra data keys.
4165
4166 /**
4167 * The initial data to place in a newly created record. Use with
4168 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4169 * fields as would be given to the underlying ContentProvider.insert()
4170 * call.
4171 */
4172 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4173
4174 /**
4175 * A constant CharSequence that is associated with the Intent, used with
4176 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4177 * this may be a styled CharSequence, so you must use
4178 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4179 * retrieve it.
4180 */
4181 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4182
4183 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004184 * A constant String that is associated with the Intent, used with
4185 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4186 * as HTML formatted text. Note that you <em>must</em> also supply
4187 * {@link #EXTRA_TEXT}.
4188 */
4189 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4190
4191 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004192 * A content: URI holding a stream of data associated with the Intent,
4193 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004194 */
4195 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4196
4197 /**
4198 * A String[] holding e-mail addresses that should be delivered to.
4199 */
4200 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4201
4202 /**
4203 * A String[] holding e-mail addresses that should be carbon copied.
4204 */
4205 public static final String EXTRA_CC = "android.intent.extra.CC";
4206
4207 /**
4208 * A String[] holding e-mail addresses that should be blind carbon copied.
4209 */
4210 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4211
4212 /**
4213 * A constant string holding the desired subject line of a message.
4214 */
4215 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4216
4217 /**
4218 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004219 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004220 */
4221 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4222
4223 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004224 * An int representing the user id to be used.
4225 *
4226 * @hide
4227 */
4228 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4229
4230 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004231 * An int representing the task id to be retrieved. This is used when a launch from recents is
4232 * intercepted by another action such as credentials confirmation to remember which task should
4233 * be resumed when complete.
4234 *
4235 * @hide
4236 */
4237 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4238
4239 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004240 * An Intent[] describing additional, alternate choices you would like shown with
4241 * {@link #ACTION_CHOOSER}.
4242 *
4243 * <p>An app may be capable of providing several different payload types to complete a
4244 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4245 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4246 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4247 * photo data or a hosted link where the photos can be viewed.</p>
4248 *
4249 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4250 * first/primary/preferred intent in the set. Additional intents specified in
4251 * this extra are ordered; by default intents that appear earlier in the array will be
4252 * preferred over intents that appear later in the array as matches for the same
4253 * target component. To alter this preference, a calling app may also supply
4254 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4255 */
4256 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4257
4258 /**
Adam Powell52c39212016-04-07 15:14:18 -07004259 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4260 * and omitted from a list of components presented to the user.
4261 *
4262 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4263 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4264 * from your own package or other apps from your organization if the idea of sending to those
4265 * targets would be redundant with other app functionality. Filtered components will not
4266 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4267 */
4268 public static final String EXTRA_EXCLUDE_COMPONENTS
4269 = "android.intent.extra.EXCLUDE_COMPONENTS";
4270
4271 /**
4272 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4273 * describing additional high-priority deep-link targets for the chooser to present to the user.
4274 *
4275 * <p>Targets provided in this way will be presented inline with all other targets provided
4276 * by services from other apps. They will be prioritized before other service targets, but
4277 * after those targets provided by sources that the user has manually pinned to the front.</p>
4278 *
4279 * @see #ACTION_CHOOSER
4280 */
4281 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4282
4283 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004284 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4285 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4286 *
4287 * <p>An app preparing an action for another app to complete may wish to allow the user to
4288 * disambiguate between several options for completing the action based on the chosen target
4289 * or otherwise refine the action before it is invoked.
4290 * </p>
4291 *
4292 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4293 * <ul>
4294 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4295 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4296 * chosen target beyond the first</li>
4297 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4298 * should fill in and send once the disambiguation is complete</li>
4299 * </ul>
4300 */
4301 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4302 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4303
4304 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004305 * An {@code ArrayList} of {@code String} annotations describing content for
4306 * {@link #ACTION_CHOOSER}.
4307 *
4308 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4309 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4310 *
4311 * <p>Annotations should describe the major components or topics of the content. It is up to
4312 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4313 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004314 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4315 * character. Performance on customized annotations can suffer, if they are rarely used for
4316 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4317 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004318 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004319 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004320 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004321 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004322 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004323 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004324 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004325 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004326 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004327 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4328 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4329 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4330 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4331 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004332 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004333 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4334 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004335 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004336 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004337 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004338 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004339 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004340 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004341 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004342 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004343 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004344 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004345 * Christmas and Thanksgiving.</li>
4346 * </ul>
4347 */
4348 public static final String EXTRA_CONTENT_ANNOTATIONS
4349 = "android.intent.extra.CONTENT_ANNOTATIONS";
4350
4351 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004352 * A {@link ResultReceiver} used to return data back to the sender.
4353 *
4354 * <p>Used to complete an app-specific
4355 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4356 *
4357 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4358 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4359 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4360 * when the user selects a target component from the chooser. It is up to the recipient
4361 * to send a result to this ResultReceiver to signal that disambiguation is complete
4362 * and that the chooser should invoke the user's choice.</p>
4363 *
4364 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4365 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4366 * to match and fill in the final Intent or ChooserTarget before starting it.
4367 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4368 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4369 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4370 *
4371 * <p>The result code passed to the ResultReceiver should be
4372 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4373 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4374 * the chooser should finish without starting a target.</p>
4375 */
4376 public static final String EXTRA_RESULT_RECEIVER
4377 = "android.intent.extra.RESULT_RECEIVER";
4378
4379 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004380 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004381 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004382 */
4383 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4384
4385 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004386 * A Parcelable[] of {@link Intent} or
4387 * {@link android.content.pm.LabeledIntent} objects as set with
4388 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4389 * a the front of the list of choices, when shown to the user with a
4390 * {@link #ACTION_CHOOSER}.
4391 */
4392 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4393
4394 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004395 * A {@link IntentSender} to start after ephemeral installation success.
4396 * @hide
4397 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004398 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4399
4400 /**
4401 * A {@link IntentSender} to start after ephemeral installation failure.
4402 * @hide
4403 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004404 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4405
4406 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004407 * The host name that triggered an ephemeral resolution.
4408 * @hide
4409 */
4410 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4411
4412 /**
4413 * An opaque token to track ephemeral resolution.
4414 * @hide
4415 */
4416 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4417
4418 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004419 * The version code of the app to install components from.
4420 * @hide
4421 */
4422 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4423
4424 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004425 * A Bundle forming a mapping of potential target package names to different extras Bundles
4426 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4427 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4428 * be currently installed on the device.
4429 *
4430 * <p>An application may choose to provide alternate extras for the case where a user
4431 * selects an activity from a predetermined set of target packages. If the activity
4432 * the user selects from the chooser belongs to a package with its package name as
4433 * a key in this bundle, the corresponding extras for that package will be merged with
4434 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4435 * extra has the same key as an extra already present in the intent it will overwrite
4436 * the extra from the intent.</p>
4437 *
4438 * <p><em>Examples:</em>
4439 * <ul>
4440 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4441 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4442 * parameters for that target.</li>
4443 * <li>An application may offer additional metadata for known targets of a given intent
4444 * to pass along information only relevant to that target such as account or content
4445 * identifiers already known to that application.</li>
4446 * </ul></p>
4447 */
4448 public static final String EXTRA_REPLACEMENT_EXTRAS =
4449 "android.intent.extra.REPLACEMENT_EXTRAS";
4450
4451 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004452 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4453 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4454 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4455 * {@link ComponentName} of the chosen component.
4456 *
4457 * <p>In some situations this callback may never come, for example if the user abandons
4458 * the chooser, switches to another task or any number of other reasons. Apps should not
4459 * be written assuming that this callback will always occur.</p>
4460 */
4461 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4462 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4463
4464 /**
4465 * The {@link ComponentName} chosen by the user to complete an action.
4466 *
4467 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4468 */
4469 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4470
4471 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004472 * A {@link android.view.KeyEvent} object containing the event that
4473 * triggered the creation of the Intent it is in.
4474 */
4475 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4476
4477 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004478 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4479 * before shutting down.
4480 *
4481 * {@hide}
4482 */
4483 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4484
4485 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004486 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4487 * requested by the user.
4488 *
4489 * {@hide}
4490 */
4491 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4492 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4493
4494 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004495 * 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 -07004496 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4497 * of restarting the application.
4498 */
4499 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4500
4501 /**
4502 * A String holding the phone number originally entered in
4503 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4504 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4505 */
4506 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004507
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004508 /**
4509 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4510 * intents to supply the uid the package had been assigned. Also an optional
4511 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4512 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4513 * purpose.
4514 */
4515 public static final String EXTRA_UID = "android.intent.extra.UID";
4516
4517 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004518 * @hide String array of package names.
4519 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004520 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004521 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4522
4523 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004524 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4525 * intents to indicate whether this represents a full uninstall (removing
4526 * both the code and its data) or a partial uninstall (leaving its data,
4527 * implying that this is an update).
4528 */
4529 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004530
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004531 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004532 * @hide
4533 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4534 * intents to indicate that at this point the package has been removed for
4535 * all users on the device.
4536 */
4537 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4538 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4539
4540 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004541 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4542 * intents to indicate that this is a replacement of the package, so this
4543 * broadcast will immediately be followed by an add broadcast for a
4544 * different version of the same package.
4545 */
4546 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004547
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004548 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004549 * Used as an int extra field in {@link android.app.AlarmManager} intents
4550 * to tell the application being invoked how many pending alarms are being
4551 * delievered with the intent. For one-shot alarms this will always be 1.
4552 * For recurring alarms, this might be greater than 1 if the device was
4553 * asleep or powered off at the time an earlier alarm would have been
4554 * delivered.
4555 */
4556 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004557
Jacek Surazski86b6c532009-05-13 14:38:28 +02004558 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004559 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4560 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004561 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4562 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004563 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4564 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4565 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004566 */
4567 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4568
4569 /**
4570 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4571 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004572 */
4573 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4574
4575 /**
4576 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4577 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004578 */
4579 public static final int EXTRA_DOCK_STATE_DESK = 1;
4580
4581 /**
4582 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4583 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004584 */
4585 public static final int EXTRA_DOCK_STATE_CAR = 2;
4586
4587 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004588 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4589 * to represent that the phone is in a analog (low end) dock.
4590 */
4591 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4592
4593 /**
4594 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4595 * to represent that the phone is in a digital (high end) dock.
4596 */
4597 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4598
4599 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004600 * Boolean that can be supplied as meta-data with a dock activity, to
4601 * indicate that the dock should take over the home key when it is active.
4602 */
4603 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004604
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004605 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004606 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4607 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004608 */
4609 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4610
4611 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004612 * Used in the extra field in the remote intent. It's astring token passed with the
4613 * remote intent.
4614 */
4615 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4616 "android.intent.extra.remote_intent_token";
4617
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004618 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004619 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004620 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004621 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004622 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004623 "android.intent.extra.changed_component_name";
4624
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004625 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004626 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004627 * and contains a string array of all of the components that have changed. If
4628 * the state of the overall package has changed, then it will contain an entry
4629 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004630 */
4631 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4632 "android.intent.extra.changed_component_name_list";
4633
4634 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004635 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004636 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004637 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4638 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4639 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004640 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004641 */
4642 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4643 "android.intent.extra.changed_package_list";
4644
4645 /**
4646 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004647 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4648 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004649 * and contains an integer array of uids of all of the components
4650 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004651 */
4652 public static final String EXTRA_CHANGED_UID_LIST =
4653 "android.intent.extra.changed_uid_list";
4654
4655 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004656 * @hide
4657 * Magic extra system code can use when binding, to give a label for
4658 * who it is that has bound to a service. This is an integer giving
4659 * a framework string resource that can be displayed to the user.
4660 */
4661 public static final String EXTRA_CLIENT_LABEL =
4662 "android.intent.extra.client_label";
4663
4664 /**
4665 * @hide
4666 * Magic extra system code can use when binding, to give a PendingIntent object
4667 * that can be launched for the user to disable the system's use of this
4668 * service.
4669 */
4670 public static final String EXTRA_CLIENT_INTENT =
4671 "android.intent.extra.client_intent";
4672
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004673 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004674 * Extra used to indicate that an intent should only return data that is on
4675 * the local device. This is a boolean extra; the default is false. If true,
4676 * an implementation should only allow the user to select data that is
4677 * already on the device, not requiring it be downloaded from a remote
4678 * service when opened.
4679 *
4680 * @see #ACTION_GET_CONTENT
4681 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004682 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004683 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004684 */
4685 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004686 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004687
Amith Yamasani13593602012-03-22 16:16:17 -07004688 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004689 * Extra used to indicate that an intent can allow the user to select and
4690 * return multiple items. This is a boolean extra; the default is false. If
4691 * true, an implementation is allowed to present the user with a UI where
4692 * they can pick multiple items that are all returned to the caller. When
4693 * this happens, they should be returned as the {@link #getClipData()} part
4694 * of the result Intent.
4695 *
4696 * @see #ACTION_GET_CONTENT
4697 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004698 */
4699 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004700 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004701
4702 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004703 * The integer userHandle carried with broadcast intents related to addition, removal and
4704 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4705 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4706 *
Amith Yamasani13593602012-03-22 16:16:17 -07004707 * @hide
4708 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004709 public static final String EXTRA_USER_HANDLE =
4710 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004711
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004712 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004713 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4714 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4715 */
4716 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004717 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004718
4719 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004720 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004721 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4722 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004723 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004724 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4725
4726 /**
4727 * Extra sent in the intent to the BroadcastReceiver that handles
4728 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4729 * the restrictions as key/value pairs.
4730 */
4731 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4732 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004733
Amith Yamasani86118ba2013-03-28 14:33:16 -07004734 /**
4735 * Extra used in the response from a BroadcastReceiver that handles
4736 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4737 */
4738 public static final String EXTRA_RESTRICTIONS_INTENT =
4739 "android.intent.extra.restrictions_intent";
4740
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004741 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004742 * Extra used to communicate a set of acceptable MIME types. The type of the
4743 * extra is {@code String[]}. Values may be a combination of concrete MIME
4744 * types (such as "image/png") and/or partial MIME types (such as
4745 * "audio/*").
4746 *
4747 * @see #ACTION_GET_CONTENT
4748 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004749 */
4750 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4751
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004752 /**
4753 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4754 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004755 * When this is true, hardware devices can use this information to determine that
4756 * they shouldn't do a complete shutdown of their device since this is not a
4757 * complete shutdown down to the kernel, but only user space restarting.
4758 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004759 */
4760 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4761 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4762
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004763 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004764 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4765 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4766 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4767 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004768 *
4769 * @hide for internal use only.
4770 */
4771 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4772 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004773 /** @hide */
4774 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4775 /** @hide */
4776 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4777 /** @hide */
4778 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004779
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004780 /** {@hide} */
4781 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4782
Rubin Xue8490f12015-06-25 12:17:48 +01004783 /** {@hide} */
4784 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4785
Santos Cordon15a13782015-03-31 18:32:31 -07004786 /**
4787 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4788 * activation request.
4789 * TODO: Add information about the structure and response data used with the pending intent.
4790 * @hide
4791 */
4792 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4793 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4794
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004795 /**
4796 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004797 *
4798 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07004799 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004800 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004801 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4802
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004803 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004804 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
4805 * such as opening in other apps, sharing, opening, editing, printing, deleting,
4806 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004807 *
4808 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07004809 * @see #ACTION_QUICK_VIEW
4810 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004811 */
Garfield Tance1d0e92017-03-23 10:52:48 -07004812 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004813 public static final String EXTRA_QUICK_VIEW_ADVANCED =
4814 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004815
4816 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07004817 * An optional extra of {@code String[]} indicating which quick view features should be made
4818 * available to the user in the quick view UI while handing a
4819 * {@link Intent#ACTION_QUICK_VIEW} intent.
4820 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
4821 * Quick viewer can implement features not listed below.
4822 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
4823 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DOWNLOAD},
4824 * {@link QuickViewConstants#FEATURE_SEND}, {@link QuickViewConstants#FEATURE_PRINT}.
4825 * <p>
4826 * Requirements:
4827 * <li>Quick viewer shouldn't show a feature if the feature is absent in
4828 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
4829 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
4830 * internal policies.
4831 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
4832 * requirement that the feature be shown. Quick viewer may, according to its own policies,
4833 * disable or hide features.
4834 *
4835 * @see #ACTION_QUICK_VIEW
4836 */
4837 public static final String EXTRA_QUICK_VIEW_FEATURES =
4838 "android.intent.extra.QUICK_VIEW_FEATURES";
4839
4840 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004841 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004842 * When a profile goes into quiet mode, all apps in the profile are killed and the
4843 * profile user is stopped. Widgets originating from the profile are masked, and app
4844 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004845 */
4846 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004847
4848 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004849 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004850 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004851 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4852 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004853 *
4854 * @hide
4855 */
4856 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4857 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4858
4859 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004860 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4861 * whether to show the chooser or not when there is only one application available
4862 * to choose from.
4863 *
4864 * @hide
4865 */
4866 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4867 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4868
4869 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004870 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004871 * to represent that a video codec is allowed to use.
4872 *
4873 * @hide
4874 */
4875 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4876
4877 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004878 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004879 * to represent that a audio codec is allowed to use.
4880 *
4881 * @hide
4882 */
4883 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4884
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004885 // ---------------------------------------------------------------------
4886 // ---------------------------------------------------------------------
4887 // Intent flags (see mFlags variable).
4888
Tor Norbyed9273d62013-05-30 15:59:53 -07004889 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06004890 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07004891 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4892 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004893 @Retention(RetentionPolicy.SOURCE)
4894 public @interface GrantUriMode {}
4895
Jeff Sharkey846318a2014-04-04 12:12:41 -07004896 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06004897 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07004898 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4899 @Retention(RetentionPolicy.SOURCE)
4900 public @interface AccessUriMode {}
4901
4902 /**
4903 * Test if given mode flags specify an access mode, which must be at least
4904 * read and/or write.
4905 *
4906 * @hide
4907 */
4908 public static boolean isAccessUriMode(int modeFlags) {
4909 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4910 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4911 }
4912
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06004913 /** @hide */
4914 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
4915 FLAG_GRANT_READ_URI_PERMISSION,
4916 FLAG_GRANT_WRITE_URI_PERMISSION,
4917 FLAG_FROM_BACKGROUND,
4918 FLAG_DEBUG_LOG_RESOLUTION,
4919 FLAG_EXCLUDE_STOPPED_PACKAGES,
4920 FLAG_INCLUDE_STOPPED_PACKAGES,
4921 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
4922 FLAG_GRANT_PREFIX_URI_PERMISSION,
4923 FLAG_DEBUG_TRIAGED_MISSING,
4924 FLAG_IGNORE_EPHEMERAL,
4925 FLAG_ACTIVITY_NO_HISTORY,
4926 FLAG_ACTIVITY_SINGLE_TOP,
4927 FLAG_ACTIVITY_NEW_TASK,
4928 FLAG_ACTIVITY_MULTIPLE_TASK,
4929 FLAG_ACTIVITY_CLEAR_TOP,
4930 FLAG_ACTIVITY_FORWARD_RESULT,
4931 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
4932 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
4933 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
4934 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
4935 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
4936 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
4937 FLAG_ACTIVITY_NEW_DOCUMENT,
4938 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
4939 FLAG_ACTIVITY_NO_USER_ACTION,
4940 FLAG_ACTIVITY_REORDER_TO_FRONT,
4941 FLAG_ACTIVITY_NO_ANIMATION,
4942 FLAG_ACTIVITY_CLEAR_TASK,
4943 FLAG_ACTIVITY_TASK_ON_HOME,
4944 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
4945 FLAG_ACTIVITY_LAUNCH_ADJACENT,
4946 FLAG_RECEIVER_REGISTERED_ONLY,
4947 FLAG_RECEIVER_REPLACE_PENDING,
4948 FLAG_RECEIVER_FOREGROUND,
4949 FLAG_RECEIVER_NO_ABORT,
4950 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
4951 FLAG_RECEIVER_BOOT_UPGRADE,
4952 FLAG_RECEIVER_INCLUDE_BACKGROUND,
4953 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
4954 FLAG_RECEIVER_FROM_SHELL,
4955 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
4956 })
4957 @Retention(RetentionPolicy.SOURCE)
4958 public @interface Flags {}
4959
4960 /** @hide */
4961 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
4962 FLAG_FROM_BACKGROUND,
4963 FLAG_DEBUG_LOG_RESOLUTION,
4964 FLAG_EXCLUDE_STOPPED_PACKAGES,
4965 FLAG_INCLUDE_STOPPED_PACKAGES,
4966 FLAG_DEBUG_TRIAGED_MISSING,
4967 FLAG_IGNORE_EPHEMERAL,
4968 FLAG_ACTIVITY_NO_HISTORY,
4969 FLAG_ACTIVITY_SINGLE_TOP,
4970 FLAG_ACTIVITY_NEW_TASK,
4971 FLAG_ACTIVITY_MULTIPLE_TASK,
4972 FLAG_ACTIVITY_CLEAR_TOP,
4973 FLAG_ACTIVITY_FORWARD_RESULT,
4974 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
4975 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
4976 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
4977 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
4978 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
4979 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
4980 FLAG_ACTIVITY_NEW_DOCUMENT,
4981 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
4982 FLAG_ACTIVITY_NO_USER_ACTION,
4983 FLAG_ACTIVITY_REORDER_TO_FRONT,
4984 FLAG_ACTIVITY_NO_ANIMATION,
4985 FLAG_ACTIVITY_CLEAR_TASK,
4986 FLAG_ACTIVITY_TASK_ON_HOME,
4987 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
4988 FLAG_ACTIVITY_LAUNCH_ADJACENT,
4989 FLAG_RECEIVER_REGISTERED_ONLY,
4990 FLAG_RECEIVER_REPLACE_PENDING,
4991 FLAG_RECEIVER_FOREGROUND,
4992 FLAG_RECEIVER_NO_ABORT,
4993 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
4994 FLAG_RECEIVER_BOOT_UPGRADE,
4995 FLAG_RECEIVER_INCLUDE_BACKGROUND,
4996 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
4997 FLAG_RECEIVER_FROM_SHELL,
4998 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
4999 })
5000 @Retention(RetentionPolicy.SOURCE)
5001 public @interface MutableFlags {}
5002
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005003 /**
5004 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005005 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005006 * specified in its ClipData. When applying to an Intent's ClipData,
5007 * all URIs as well as recursive traversals through data or other ClipData
5008 * in Intent items will be granted; only the grant flags of the top-level
5009 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005010 */
5011 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5012 /**
5013 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005014 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005015 * specified in its ClipData. When applying to an Intent's ClipData,
5016 * all URIs as well as recursive traversals through data or other ClipData
5017 * in Intent items will be granted; only the grant flags of the top-level
5018 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005019 */
5020 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5021 /**
5022 * Can be set by the caller to indicate that this Intent is coming from
5023 * a background operation, not from direct user interaction.
5024 */
5025 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5026 /**
5027 * A flag you can enable for debugging: when set, log messages will be
5028 * printed during the resolution of this intent to show you what has
5029 * been found to create the final resolved list.
5030 */
5031 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005032 /**
5033 * If set, this intent will not match any components in packages that
5034 * are currently stopped. If this is not set, then the default behavior
5035 * is to include such applications in the result.
5036 */
5037 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5038 /**
5039 * If set, this intent will always match any components in packages that
5040 * are currently stopped. This is the default behavior when
5041 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5042 * flags are set, this one wins (it allows overriding of exclude for
5043 * places where the framework may automatically set the exclude flag).
5044 */
5045 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005046
5047 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005048 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005049 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005050 * persisted across device reboots until explicitly revoked with
5051 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5052 * grant for possible persisting; the receiving application must call
5053 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5054 * actually persist.
5055 *
5056 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5057 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5058 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005059 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005060 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005061 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005062
5063 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005064 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5065 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5066 * applies to any URI that is a prefix match against the original granted
5067 * URI. (Without this flag, the URI must match exactly for access to be
5068 * granted.) Another URI is considered a prefix match only when scheme,
5069 * authority, and all path segments defined by the prefix are an exact
5070 * match.
5071 */
5072 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5073
5074 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005075 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005076 * homework and verified that they correctly handle packages and components
5077 * that come and go over time. In particular:
5078 * <ul>
5079 * <li>Apps installed on external storage, which will appear to be
5080 * uninstalled while the the device is ejected.
5081 * <li>Apps with encryption unaware components, which will appear to not
5082 * exist while the device is locked.
5083 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005084 *
5085 * @hide
5086 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005087 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005088
5089 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005090 * Internal flag used to indicate ephemeral applications should not be
5091 * considered when resolving the intent.
5092 *
5093 * @hide
5094 */
5095 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5096
5097 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005098 * If set, the new activity is not kept in the history stack. As soon as
5099 * the user navigates away from it, the activity is finished. This may also
5100 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5101 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005102 *
5103 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5104 * is never invoked when the current activity starts a new activity which
5105 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005106 */
5107 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5108 /**
5109 * If set, the activity will not be launched if it is already running
5110 * at the top of the history stack.
5111 */
5112 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5113 /**
5114 * If set, this activity will become the start of a new task on this
5115 * history stack. A task (from the activity that started it to the
5116 * next task activity) defines an atomic group of activities that the
5117 * user can move to. Tasks can be moved to the foreground and background;
5118 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005119 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005120 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5121 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005122 *
5123 * <p>This flag is generally used by activities that want
5124 * to present a "launcher" style behavior: they give the user a list of
5125 * separate things that can be done, which otherwise run completely
5126 * independently of the activity launching them.
5127 *
5128 * <p>When using this flag, if a task is already running for the activity
5129 * you are now starting, then a new activity will not be started; instead,
5130 * the current task will simply be brought to the front of the screen with
5131 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5132 * to disable this behavior.
5133 *
5134 * <p>This flag can not be used when the caller is requesting a result from
5135 * the activity being launched.
5136 */
5137 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5138 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005139 * This flag is used to create a new task and launch an activity into it.
5140 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5141 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5142 * search through existing tasks for ones matching this Intent. Only if no such
5143 * task is found would a new task be created. When paired with
5144 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5145 * the search for a matching task and unconditionally start a new task.
5146 *
5147 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5148 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005149 * top-level application launcher.</strong> Used in conjunction with
5150 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5151 * behavior of bringing an existing task to the foreground. When set,
5152 * a new task is <em>always</em> started to host the Activity for the
5153 * Intent, regardless of whether there is already an existing task running
5154 * the same thing.
5155 *
5156 * <p><strong>Because the default system does not include graphical task management,
5157 * you should not use this flag unless you provide some way for a user to
5158 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005159 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005160 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5161 * creating new document tasks.
5162 *
5163 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005164 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005165 *
Scott Main7aee61f2011-02-08 11:25:01 -08005166 * <p>See
5167 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5168 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005169 *
5170 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5171 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005172 */
5173 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5174 /**
5175 * If set, and the activity being launched is already running in the
5176 * current task, then instead of launching a new instance of that activity,
5177 * all of the other activities on top of it will be closed and this Intent
5178 * will be delivered to the (now on top) old activity as a new Intent.
5179 *
5180 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5181 * If D calls startActivity() with an Intent that resolves to the component
5182 * of activity B, then C and D will be finished and B receive the given
5183 * Intent, resulting in the stack now being: A, B.
5184 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005185 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005186 * either receive the new intent you are starting here in its
5187 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005188 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005189 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5190 * the same intent, then it will be finished and re-created; for all other
5191 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5192 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005193 *
5194 * <p>This launch mode can also be used to good effect in conjunction with
5195 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5196 * of a task, it will bring any currently running instance of that task
5197 * to the foreground, and then clear it to its root state. This is
5198 * especially useful, for example, when launching an activity from the
5199 * notification manager.
5200 *
Scott Main7aee61f2011-02-08 11:25:01 -08005201 * <p>See
5202 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5203 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005204 */
5205 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5206 /**
5207 * If set and this intent is being used to launch a new activity from an
5208 * existing one, then the reply target of the existing activity will be
5209 * transfered to the new activity. This way the new activity can call
5210 * {@link android.app.Activity#setResult} and have that result sent back to
5211 * the reply target of the original activity.
5212 */
5213 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5214 /**
5215 * If set and this intent is being used to launch a new activity from an
5216 * existing one, the current activity will not be counted as the top
5217 * activity for deciding whether the new intent should be delivered to
5218 * the top instead of starting a new one. The previous activity will
5219 * be used as the top, with the assumption being that the current activity
5220 * will finish itself immediately.
5221 */
5222 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5223 /**
5224 * If set, the new activity is not kept in the list of recently launched
5225 * activities.
5226 */
5227 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5228 /**
5229 * This flag is not normally set by application code, but set for you by
5230 * the system as described in the
5231 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5232 * launchMode} documentation for the singleTask mode.
5233 */
5234 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5235 /**
5236 * If set, and this activity is either being started in a new task or
5237 * bringing to the top an existing task, then it will be launched as
5238 * the front door of the task. This will result in the application of
5239 * any affinities needed to have that task in the proper state (either
5240 * moving activities to or from it), or simply resetting that task to
5241 * its initial state if needed.
5242 */
5243 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5244 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005245 * This flag is not normally set by application code, but set for you by
5246 * the system if this activity is being launched from history
5247 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005248 */
5249 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005250 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005251 * @deprecated As of API 21 this performs identically to
5252 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005253 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005254 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005255 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005256 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005257 * This flag is used to open a document into a new task rooted at the activity launched
5258 * by this Intent. Through the use of this flag, or its equivalent attribute,
5259 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005260 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005261 *
Craig Mautner026596b2014-05-21 15:35:44 -07005262 * <p>The use of the activity attribute form of this,
5263 * {@link android.R.attr#documentLaunchMode}, is
5264 * preferred over the Intent flag described here. The attribute form allows the
5265 * Activity to specify multiple document behavior for all launchers of the Activity
5266 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005267 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005268 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5269 * it is kept after the activity is finished is different than the use of
5270 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5271 * this flag is being used to create a new recents entry, then by default that entry
5272 * will be removed once the activity is finished. You can modify this behavior with
5273 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5274 *
Craig Mautner026596b2014-05-21 15:35:44 -07005275 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5276 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5277 * equivalent of the Activity manifest specifying {@link
5278 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5279 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5280 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005281 *
Craig Mautner026596b2014-05-21 15:35:44 -07005282 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005283 *
Craig Mautner026596b2014-05-21 15:35:44 -07005284 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005285 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5286 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005287 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005288 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005289 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005290 * callback from occurring on the current frontmost activity before it is
5291 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005292 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005293 * <p>Typically, an activity can rely on that callback to indicate that an
5294 * explicit user action has caused their activity to be moved out of the
5295 * foreground. The callback marks an appropriate point in the activity's
5296 * lifecycle for it to dismiss any notifications that it intends to display
5297 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005298 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005299 * <p>If an activity is ever started via any non-user-driven events such as
5300 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5301 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005302 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005303 */
5304 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005305 /**
5306 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5307 * this flag will cause the launched activity to be brought to the front of its
5308 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005309 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005310 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5311 * If D calls startActivity() with an Intent that resolves to the component
5312 * of activity B, then B will be brought to the front of the history stack,
5313 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005314 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005315 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005316 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005317 */
5318 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005319 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005320 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5321 * this flag will prevent the system from applying an activity transition
5322 * animation to go to the next activity state. This doesn't mean an
5323 * animation will never run -- if another activity change happens that doesn't
5324 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005325 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005326 * when you are going to do a series of activity operations but the
5327 * animation seen by the user shouldn't be driven by the first activity
5328 * change but rather a later one.
5329 */
5330 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5331 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005332 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5333 * this flag will cause any existing task that would be associated with the
5334 * activity to be cleared before the activity is started. That is, the activity
5335 * becomes the new root of an otherwise empty task, and any old activities
5336 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5337 */
5338 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5339 /**
5340 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5341 * this flag will cause a newly launching task to be placed on top of the current
5342 * home activity task (if there is one). That is, pressing back from the task
5343 * will always return the user to home even if that was not the last activity they
5344 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5345 */
5346 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5347 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005348 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5349 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005350 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005351 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005352 * this flag. When set and the task's activity is finished, the recents
5353 * entry will remain in the interface for the user to re-launch it, like a
5354 * recents entry for a top-level application.
5355 * <p>
5356 * The receiving activity can override this request with
5357 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5358 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005359 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005360 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005361 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005362
5363 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005364 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5365 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005366 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5367 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005368 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005369 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005370
5371 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005372 * If set, when sending a broadcast only registered receivers will be
5373 * called -- no BroadcastReceiver components will be launched.
5374 */
5375 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005376 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005377 * If set, when sending a broadcast the new broadcast will replace
5378 * any existing pending broadcast that matches it. Matching is defined
5379 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5380 * true for the intents of the two broadcasts. When a match is found,
5381 * the new broadcast (and receivers associated with it) will replace the
5382 * existing one in the pending broadcast list, remaining at the same
5383 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005384 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005385 * <p>This flag is most typically used with sticky broadcasts, which
5386 * only care about delivering the most recent values of the broadcast
5387 * to their receivers.
5388 */
5389 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5390 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005391 * If set, when sending a broadcast the recipient is allowed to run at
5392 * foreground priority, with a shorter timeout interval. During normal
5393 * broadcasts the receivers are not automatically hoisted out of the
5394 * background priority class.
5395 */
5396 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5397 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005398 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5399 * They can still propagate results through to later receivers, but they can not prevent
5400 * later receivers from seeing the broadcast.
5401 */
5402 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5403 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005404 * If set, when sending a broadcast <i>before boot has completed</i> only
5405 * registered receivers will be called -- no BroadcastReceiver components
5406 * will be launched. Sticky intent state will be recorded properly even
5407 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5408 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005409 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005410 * <p>This flag is only for use by system sevices as a convenience to
5411 * avoid having to implement a more complex mechanism around detection
5412 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005413 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005414 * @hide
5415 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005416 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005417 /**
5418 * Set when this broadcast is for a boot upgrade, a special mode that
5419 * allows the broadcast to be sent before the system is ready and launches
5420 * the app process with no providers running in it.
5421 * @hide
5422 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005423 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005424 /**
5425 * If set, the broadcast will always go to manifest receivers in background (cached
5426 * or not running) apps, regardless of whether that would be done by default. By
5427 * default they will only receive broadcasts if the broadcast has specified an
5428 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005429 *
5430 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5431 * the broadcast code there must also be changed to match.
5432 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005433 * @hide
5434 */
5435 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5436 /**
5437 * If set, the broadcast will never go to manifest receivers in background (cached
5438 * or not running) apps, regardless of whether that would be done by default. By
5439 * default they will receive broadcasts if the broadcast has specified an
5440 * explicit component or package name.
5441 * @hide
5442 */
5443 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005444 /**
5445 * If set, this broadcast is being sent from the shell.
5446 * @hide
5447 */
5448 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005449
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005450 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005451 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5452 * will not receive broadcasts.
5453 *
5454 * <em>This flag has no effect when used by an Instant App.</em>
5455 */
5456 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5457
5458 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005459 * @hide Flags that can't be changed with PendingIntent.
5460 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005461 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5462 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5463 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005464
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005465 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005466 // ---------------------------------------------------------------------
5467 // toUri() and parseUri() options.
5468
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005469 /** @hide */
5470 @IntDef(flag = true, prefix = { "URI_" }, value = {
5471 URI_ALLOW_UNSAFE,
5472 URI_ANDROID_APP_SCHEME,
5473 URI_INTENT_SCHEME,
5474 })
5475 @Retention(RetentionPolicy.SOURCE)
5476 public @interface UriFlags {}
5477
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005478 /**
5479 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5480 * always has the "intent:" scheme. This syntax can be used when you want
5481 * to later disambiguate between URIs that are intended to describe an
5482 * Intent vs. all others that should be treated as raw URIs. When used
5483 * with {@link #parseUri}, any other scheme will result in a generic
5484 * VIEW action for that raw URI.
5485 */
5486 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005487
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005488 /**
5489 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5490 * always has the "android-app:" scheme. This is a variation of
5491 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5492 * http/https URI being delivered to a specific package name. The format
5493 * is:
5494 *
5495 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005496 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005497 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005498 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5499 * you must also include a scheme; including a path also requires both a host and a scheme.
5500 * The final #Intent; fragment can be used without a scheme, host, or path.
5501 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005502 * used with intents that have a {@link #setSelector}, since the base intent
5503 * will always have an explicit package name.</p>
5504 *
5505 * <p>Some examples of how this scheme maps to Intent objects:</p>
5506 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5507 * <colgroup align="left" />
5508 * <colgroup align="left" />
5509 * <thead>
5510 * <tr><th>URI</th> <th>Intent</th></tr>
5511 * </thead>
5512 *
5513 * <tbody>
5514 * <tr><td><code>android-app://com.example.app</code></td>
5515 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5516 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5517 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5518 * </table></td>
5519 * </tr>
5520 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5521 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5522 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5523 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5524 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5525 * </table></td>
5526 * </tr>
5527 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5528 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5529 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5530 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5531 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5532 * </table></td>
5533 * </tr>
5534 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5535 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5536 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5537 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5538 * </table></td>
5539 * </tr>
5540 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5541 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5542 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5543 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5544 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5545 * </table></td>
5546 * </tr>
5547 * <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>
5548 * <td><table border="" style="margin:0" >
5549 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5550 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5551 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5552 * </table></td>
5553 * </tr>
5554 * </tbody>
5555 * </table>
5556 */
5557 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5558
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005559 /**
5560 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5561 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5562 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5563 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5564 * generated Intent can not cause unexpected data access to happen.
5565 *
5566 * <p>If you do not trust the source of the URI being parsed, you should still do further
5567 * processing to protect yourself from it. In particular, when using it to start an
5568 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5569 * that can handle it.</p>
5570 */
5571 public static final int URI_ALLOW_UNSAFE = 1<<2;
5572
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005573 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005574
5575 private String mAction;
5576 private Uri mData;
5577 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005578 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005579 private ComponentName mComponent;
5580 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005581 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005582 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005583 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005584 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005585 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005586 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005587 /** Token to track instant app launches. Local only; do not copy cross-process. */
5588 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005589
5590 // ---------------------------------------------------------------------
5591
5592 /**
5593 * Create an empty intent.
5594 */
5595 public Intent() {
5596 }
5597
5598 /**
5599 * Copy constructor.
5600 */
5601 public Intent(Intent o) {
5602 this.mAction = o.mAction;
5603 this.mData = o.mData;
5604 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005605 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005606 this.mComponent = o.mComponent;
5607 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005608 this.mContentUserHint = o.mContentUserHint;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005609 this.mLaunchToken = o.mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005610 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005611 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005612 }
5613 if (o.mExtras != null) {
5614 this.mExtras = new Bundle(o.mExtras);
5615 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005616 if (o.mSourceBounds != null) {
5617 this.mSourceBounds = new Rect(o.mSourceBounds);
5618 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005619 if (o.mSelector != null) {
5620 this.mSelector = new Intent(o.mSelector);
5621 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005622 if (o.mClipData != null) {
5623 this.mClipData = new ClipData(o.mClipData);
5624 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005625 }
5626
5627 @Override
5628 public Object clone() {
5629 return new Intent(this);
5630 }
5631
5632 private Intent(Intent o, boolean all) {
5633 this.mAction = o.mAction;
5634 this.mData = o.mData;
5635 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005636 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005637 this.mComponent = o.mComponent;
5638 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005639 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005640 }
5641 }
5642
5643 /**
5644 * Make a clone of only the parts of the Intent that are relevant for
5645 * filter matching: the action, data, type, component, and categories.
5646 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005647 public @NonNull Intent cloneFilter() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005648 return new Intent(this, false);
5649 }
5650
5651 /**
5652 * Create an intent with a given action. All other fields (data, type,
5653 * class) are null. Note that the action <em>must</em> be in a
5654 * namespace because Intents are used globally in the system -- for
5655 * example the system VIEW action is android.intent.action.VIEW; an
5656 * application's custom action would be something like
5657 * com.google.app.myapp.CUSTOM_ACTION.
5658 *
5659 * @param action The Intent action, such as ACTION_VIEW.
5660 */
5661 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005662 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005663 }
5664
5665 /**
5666 * Create an intent with a given action and for a given data url. Note
5667 * that the action <em>must</em> be in a namespace because Intents are
5668 * used globally in the system -- for example the system VIEW action is
5669 * android.intent.action.VIEW; an application's custom action would be
5670 * something like com.google.app.myapp.CUSTOM_ACTION.
5671 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005672 * <p><em>Note: scheme and host name matching in the Android framework is
5673 * case-sensitive, unlike the formal RFC. As a result,
5674 * you should always ensure that you write your Uri with these elements
5675 * using lower case letters, and normalize any Uris you receive from
5676 * outside of Android to ensure the scheme and host is lower case.</em></p>
5677 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005678 * @param action The Intent action, such as ACTION_VIEW.
5679 * @param uri The Intent data URI.
5680 */
5681 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005682 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005683 mData = uri;
5684 }
5685
5686 /**
5687 * Create an intent for a specific component. All other fields (action, data,
5688 * type, class) are null, though they can be modified later with explicit
5689 * calls. This provides a convenient way to create an intent that is
5690 * intended to execute a hard-coded class name, rather than relying on the
5691 * system to find an appropriate class for you; see {@link #setComponent}
5692 * for more information on the repercussions of this.
5693 *
5694 * @param packageContext A Context of the application package implementing
5695 * this class.
5696 * @param cls The component class that is to be used for the intent.
5697 *
5698 * @see #setClass
5699 * @see #setComponent
5700 * @see #Intent(String, android.net.Uri , Context, Class)
5701 */
5702 public Intent(Context packageContext, Class<?> cls) {
5703 mComponent = new ComponentName(packageContext, cls);
5704 }
5705
5706 /**
5707 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005708 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005709 * construct the Intent and then calling {@link #setClass} to set its
5710 * class.
5711 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005712 * <p><em>Note: scheme and host name matching in the Android framework is
5713 * case-sensitive, unlike the formal RFC. As a result,
5714 * you should always ensure that you write your Uri with these elements
5715 * using lower case letters, and normalize any Uris you receive from
5716 * outside of Android to ensure the scheme and host is lower case.</em></p>
5717 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005718 * @param action The Intent action, such as ACTION_VIEW.
5719 * @param uri The Intent data URI.
5720 * @param packageContext A Context of the application package implementing
5721 * this class.
5722 * @param cls The component class that is to be used for the intent.
5723 *
5724 * @see #Intent(String, android.net.Uri)
5725 * @see #Intent(Context, Class)
5726 * @see #setClass
5727 * @see #setComponent
5728 */
5729 public Intent(String action, Uri uri,
5730 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005731 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005732 mData = uri;
5733 mComponent = new ComponentName(packageContext, cls);
5734 }
5735
5736 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005737 * Create an intent to launch the main (root) activity of a task. This
5738 * is the Intent that is started when the application's is launched from
5739 * Home. For anything else that wants to launch an application in the
5740 * same way, it is important that they use an Intent structured the same
5741 * way, and can use this function to ensure this is the case.
5742 *
5743 * <p>The returned Intent has the given Activity component as its explicit
5744 * component, {@link #ACTION_MAIN} as its action, and includes the
5745 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5746 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5747 * to do that through {@link #addFlags(int)} on the returned Intent.
5748 *
5749 * @param mainActivity The main activity component that this Intent will
5750 * launch.
5751 * @return Returns a newly created Intent that can be used to launch the
5752 * activity as a main application entry.
5753 *
5754 * @see #setClass
5755 * @see #setComponent
5756 */
5757 public static Intent makeMainActivity(ComponentName mainActivity) {
5758 Intent intent = new Intent(ACTION_MAIN);
5759 intent.setComponent(mainActivity);
5760 intent.addCategory(CATEGORY_LAUNCHER);
5761 return intent;
5762 }
5763
5764 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005765 * Make an Intent for the main activity of an application, without
5766 * specifying a specific activity to run but giving a selector to find
5767 * the activity. This results in a final Intent that is structured
5768 * the same as when the application is launched from
5769 * Home. For anything else that wants to launch an application in the
5770 * same way, it is important that they use an Intent structured the same
5771 * way, and can use this function to ensure this is the case.
5772 *
5773 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5774 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5775 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5776 * to do that through {@link #addFlags(int)} on the returned Intent.
5777 *
5778 * @param selectorAction The action name of the Intent's selector.
5779 * @param selectorCategory The name of a category to add to the Intent's
5780 * selector.
5781 * @return Returns a newly created Intent that can be used to launch the
5782 * activity as a main application entry.
5783 *
5784 * @see #setSelector(Intent)
5785 */
5786 public static Intent makeMainSelectorActivity(String selectorAction,
5787 String selectorCategory) {
5788 Intent intent = new Intent(ACTION_MAIN);
5789 intent.addCategory(CATEGORY_LAUNCHER);
5790 Intent selector = new Intent();
5791 selector.setAction(selectorAction);
5792 selector.addCategory(selectorCategory);
5793 intent.setSelector(selector);
5794 return intent;
5795 }
5796
5797 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005798 * Make an Intent that can be used to re-launch an application's task
5799 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5800 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5801 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5802 *
5803 * @param mainActivity The activity component that is the root of the
5804 * task; this is the activity that has been published in the application's
5805 * manifest as the main launcher icon.
5806 *
5807 * @return Returns a newly created Intent that can be used to relaunch the
5808 * activity's task in its root state.
5809 */
5810 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5811 Intent intent = makeMainActivity(mainActivity);
5812 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5813 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5814 return intent;
5815 }
5816
5817 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005818 * Call {@link #parseUri} with 0 flags.
5819 * @deprecated Use {@link #parseUri} instead.
5820 */
5821 @Deprecated
5822 public static Intent getIntent(String uri) throws URISyntaxException {
5823 return parseUri(uri, 0);
5824 }
Tom Taylord4a47292009-12-21 13:59:18 -08005825
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005826 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005827 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005828 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005829 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005830 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005831 *
5832 * <p>The URI given here must not be relative -- that is, it must include
5833 * the scheme and full path.
5834 *
5835 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005836 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005837 *
5838 * @return Intent The newly created Intent object.
5839 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005840 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5841 * it bad (as parsed by the Uri class) or the Intent data within the
5842 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005843 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005844 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005845 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005846 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005847 int i = 0;
5848 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005849 final boolean androidApp = uri.startsWith("android-app:");
5850
5851 // Validate intent scheme if requested.
5852 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5853 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005854 Intent intent = new Intent(ACTION_VIEW);
5855 try {
5856 intent.setData(Uri.parse(uri));
5857 } catch (IllegalArgumentException e) {
5858 throw new URISyntaxException(uri, e.getMessage());
5859 }
5860 return intent;
5861 }
5862 }
Tom Taylord4a47292009-12-21 13:59:18 -08005863
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005864 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005865 // simple case
5866 if (i == -1) {
5867 if (!androidApp) {
5868 return new Intent(ACTION_VIEW, Uri.parse(uri));
5869 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005870
5871 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005872 } else if (!uri.startsWith("#Intent;", i)) {
5873 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005874 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005875 } else {
5876 i = -1;
5877 }
5878 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005879
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005880 // new format
5881 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005882 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005883 boolean explicitAction = false;
5884 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005885
5886 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005887 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005888 String data;
5889 if (i >= 0) {
5890 data = uri.substring(0, i);
5891 i += 8; // length of "#Intent;"
5892 } else {
5893 data = uri;
5894 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005895
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005896 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005897 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005898 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005899 if (eq < 0) eq = i-1;
5900 int semi = uri.indexOf(';', i);
5901 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005902
5903 // action
5904 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005905 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005906 if (!inSelector) {
5907 explicitAction = true;
5908 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005909 }
5910
5911 // categories
5912 else if (uri.startsWith("category=", i)) {
5913 intent.addCategory(value);
5914 }
5915
5916 // type
5917 else if (uri.startsWith("type=", i)) {
5918 intent.mType = value;
5919 }
5920
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005921 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005922 else if (uri.startsWith("launchFlags=", i)) {
5923 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005924 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5925 intent.mFlags &= ~IMMUTABLE_FLAGS;
5926 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005927 }
5928
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005929 // package
5930 else if (uri.startsWith("package=", i)) {
5931 intent.mPackage = value;
5932 }
5933
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005934 // component
5935 else if (uri.startsWith("component=", i)) {
5936 intent.mComponent = ComponentName.unflattenFromString(value);
5937 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005938
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005939 // scheme
5940 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005941 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005942 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005943 } else {
5944 scheme = value;
5945 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005946 }
5947
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005948 // source bounds
5949 else if (uri.startsWith("sourceBounds=", i)) {
5950 intent.mSourceBounds = Rect.unflattenFromString(value);
5951 }
5952
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005953 // selector
5954 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5955 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005956 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005957 }
5958
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005959 // extra
5960 else {
5961 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005962 // create Bundle if it doesn't already exist
5963 if (intent.mExtras == null) intent.mExtras = new Bundle();
5964 Bundle b = intent.mExtras;
5965 // add EXTRA
5966 if (uri.startsWith("S.", i)) b.putString(key, value);
5967 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5968 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5969 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5970 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5971 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5972 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5973 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5974 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5975 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5976 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005977
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005978 // move to the next item
5979 i = semi + 1;
5980 }
5981
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005982 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005983 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005984 if (baseIntent.mPackage == null) {
5985 baseIntent.setSelector(intent);
5986 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005987 intent = baseIntent;
5988 }
5989
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005990 if (data != null) {
5991 if (data.startsWith("intent:")) {
5992 data = data.substring(7);
5993 if (scheme != null) {
5994 data = scheme + ':' + data;
5995 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005996 } else if (data.startsWith("android-app:")) {
5997 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5998 // Correctly formed android-app, first part is package name.
5999 int end = data.indexOf('/', 14);
6000 if (end < 0) {
6001 // All we have is a package name.
6002 intent.mPackage = data.substring(14);
6003 if (!explicitAction) {
6004 intent.setAction(ACTION_MAIN);
6005 }
6006 data = "";
6007 } else {
6008 // Target the Intent at the given package name always.
6009 String authority = null;
6010 intent.mPackage = data.substring(14, end);
6011 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006012 if ((end+1) < data.length()) {
6013 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6014 // Found a scheme, remember it.
6015 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006016 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006017 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6018 // Found a authority, remember it.
6019 authority = data.substring(end+1, newEnd);
6020 end = newEnd;
6021 }
6022 } else {
6023 // All we have is a scheme.
6024 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006025 }
6026 }
6027 if (scheme == null) {
6028 // If there was no scheme, then this just targets the package.
6029 if (!explicitAction) {
6030 intent.setAction(ACTION_MAIN);
6031 }
6032 data = "";
6033 } else if (authority == null) {
6034 data = scheme + ":";
6035 } else {
6036 data = scheme + "://" + authority + data.substring(end);
6037 }
6038 }
6039 } else {
6040 data = "";
6041 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006042 }
Tom Taylord4a47292009-12-21 13:59:18 -08006043
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006044 if (data.length() > 0) {
6045 try {
6046 intent.mData = Uri.parse(data);
6047 } catch (IllegalArgumentException e) {
6048 throw new URISyntaxException(uri, e.getMessage());
6049 }
6050 }
6051 }
Tom Taylord4a47292009-12-21 13:59:18 -08006052
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006053 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006054
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006055 } catch (IndexOutOfBoundsException e) {
6056 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6057 }
6058 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006059
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006060 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006061 return getIntentOld(uri, 0);
6062 }
6063
6064 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006065 Intent intent;
6066
6067 int i = uri.lastIndexOf('#');
6068 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006069 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006070 final int intentFragmentStart = i;
6071 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006072
6073 i++;
6074
6075 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006076 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006077 i += 7;
6078 int j = uri.indexOf(')', i);
6079 action = uri.substring(i, j);
6080 i = j + 1;
6081 }
6082
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006083 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006084
6085 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006086 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006087 i += 11;
6088 int j = uri.indexOf(')', i);
6089 while (i < j) {
6090 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006091 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006092 if (i < sep) {
6093 intent.addCategory(uri.substring(i, sep));
6094 }
6095 i = sep + 1;
6096 }
6097 i = j + 1;
6098 }
6099
6100 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006101 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006102 i += 5;
6103 int j = uri.indexOf(')', i);
6104 intent.mType = uri.substring(i, j);
6105 i = j + 1;
6106 }
6107
6108 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006109 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006110 i += 12;
6111 int j = uri.indexOf(')', i);
6112 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006113 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6114 intent.mFlags &= ~IMMUTABLE_FLAGS;
6115 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006116 i = j + 1;
6117 }
6118
6119 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006120 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006121 i += 10;
6122 int j = uri.indexOf(')', i);
6123 int sep = uri.indexOf('!', i);
6124 if (sep >= 0 && sep < j) {
6125 String pkg = uri.substring(i, sep);
6126 String cls = uri.substring(sep + 1, j);
6127 intent.mComponent = new ComponentName(pkg, cls);
6128 }
6129 i = j + 1;
6130 }
6131
6132 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006133 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006134 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006135
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006136 final int closeParen = uri.indexOf(')', i);
6137 if (closeParen == -1) throw new URISyntaxException(uri,
6138 "EXTRA missing trailing ')'", i);
6139
6140 while (i < closeParen) {
6141 // fetch the key value
6142 int j = uri.indexOf('=', i);
6143 if (j <= i + 1 || i >= closeParen) {
6144 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6145 }
6146 char type = uri.charAt(i);
6147 i++;
6148 String key = uri.substring(i, j);
6149 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006150
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006151 // get type-value
6152 j = uri.indexOf('!', i);
6153 if (j == -1 || j >= closeParen) j = closeParen;
6154 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6155 String value = uri.substring(i, j);
6156 i = j;
6157
6158 // create Bundle if it doesn't already exist
6159 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006160
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006161 // add item to bundle
6162 try {
6163 switch (type) {
6164 case 'S':
6165 intent.mExtras.putString(key, Uri.decode(value));
6166 break;
6167 case 'B':
6168 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6169 break;
6170 case 'b':
6171 intent.mExtras.putByte(key, Byte.parseByte(value));
6172 break;
6173 case 'c':
6174 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6175 break;
6176 case 'd':
6177 intent.mExtras.putDouble(key, Double.parseDouble(value));
6178 break;
6179 case 'f':
6180 intent.mExtras.putFloat(key, Float.parseFloat(value));
6181 break;
6182 case 'i':
6183 intent.mExtras.putInt(key, Integer.parseInt(value));
6184 break;
6185 case 'l':
6186 intent.mExtras.putLong(key, Long.parseLong(value));
6187 break;
6188 case 's':
6189 intent.mExtras.putShort(key, Short.parseShort(value));
6190 break;
6191 default:
6192 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6193 }
6194 } catch (NumberFormatException e) {
6195 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6196 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006197
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006198 char ch = uri.charAt(i);
6199 if (ch == ')') break;
6200 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6201 i++;
6202 }
6203 }
6204
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006205 if (isIntentFragment) {
6206 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6207 } else {
6208 intent.mData = Uri.parse(uri);
6209 }
Tom Taylord4a47292009-12-21 13:59:18 -08006210
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006211 if (intent.mAction == null) {
6212 // By default, if no action is specified, then use VIEW.
6213 intent.mAction = ACTION_VIEW;
6214 }
6215
6216 } else {
6217 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6218 }
6219
6220 return intent;
6221 }
6222
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006223 /** @hide */
6224 public interface CommandOptionHandler {
6225 boolean handleOption(String opt, ShellCommand cmd);
6226 }
6227
6228 /** @hide */
6229 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6230 throws URISyntaxException {
6231 Intent intent = new Intent();
6232 Intent baseIntent = intent;
6233 boolean hasIntentInfo = false;
6234
6235 Uri data = null;
6236 String type = null;
6237
6238 String opt;
6239 while ((opt=cmd.getNextOption()) != null) {
6240 switch (opt) {
6241 case "-a":
6242 intent.setAction(cmd.getNextArgRequired());
6243 if (intent == baseIntent) {
6244 hasIntentInfo = true;
6245 }
6246 break;
6247 case "-d":
6248 data = Uri.parse(cmd.getNextArgRequired());
6249 if (intent == baseIntent) {
6250 hasIntentInfo = true;
6251 }
6252 break;
6253 case "-t":
6254 type = cmd.getNextArgRequired();
6255 if (intent == baseIntent) {
6256 hasIntentInfo = true;
6257 }
6258 break;
6259 case "-c":
6260 intent.addCategory(cmd.getNextArgRequired());
6261 if (intent == baseIntent) {
6262 hasIntentInfo = true;
6263 }
6264 break;
6265 case "-e":
6266 case "--es": {
6267 String key = cmd.getNextArgRequired();
6268 String value = cmd.getNextArgRequired();
6269 intent.putExtra(key, value);
6270 }
6271 break;
6272 case "--esn": {
6273 String key = cmd.getNextArgRequired();
6274 intent.putExtra(key, (String) null);
6275 }
6276 break;
6277 case "--ei": {
6278 String key = cmd.getNextArgRequired();
6279 String value = cmd.getNextArgRequired();
6280 intent.putExtra(key, Integer.decode(value));
6281 }
6282 break;
6283 case "--eu": {
6284 String key = cmd.getNextArgRequired();
6285 String value = cmd.getNextArgRequired();
6286 intent.putExtra(key, Uri.parse(value));
6287 }
6288 break;
6289 case "--ecn": {
6290 String key = cmd.getNextArgRequired();
6291 String value = cmd.getNextArgRequired();
6292 ComponentName cn = ComponentName.unflattenFromString(value);
6293 if (cn == null)
6294 throw new IllegalArgumentException("Bad component name: " + value);
6295 intent.putExtra(key, cn);
6296 }
6297 break;
6298 case "--eia": {
6299 String key = cmd.getNextArgRequired();
6300 String value = cmd.getNextArgRequired();
6301 String[] strings = value.split(",");
6302 int[] list = new int[strings.length];
6303 for (int i = 0; i < strings.length; i++) {
6304 list[i] = Integer.decode(strings[i]);
6305 }
6306 intent.putExtra(key, list);
6307 }
6308 break;
6309 case "--eial": {
6310 String key = cmd.getNextArgRequired();
6311 String value = cmd.getNextArgRequired();
6312 String[] strings = value.split(",");
6313 ArrayList<Integer> list = new ArrayList<>(strings.length);
6314 for (int i = 0; i < strings.length; i++) {
6315 list.add(Integer.decode(strings[i]));
6316 }
6317 intent.putExtra(key, list);
6318 }
6319 break;
6320 case "--el": {
6321 String key = cmd.getNextArgRequired();
6322 String value = cmd.getNextArgRequired();
6323 intent.putExtra(key, Long.valueOf(value));
6324 }
6325 break;
6326 case "--ela": {
6327 String key = cmd.getNextArgRequired();
6328 String value = cmd.getNextArgRequired();
6329 String[] strings = value.split(",");
6330 long[] list = new long[strings.length];
6331 for (int i = 0; i < strings.length; i++) {
6332 list[i] = Long.valueOf(strings[i]);
6333 }
6334 intent.putExtra(key, list);
6335 hasIntentInfo = true;
6336 }
6337 break;
6338 case "--elal": {
6339 String key = cmd.getNextArgRequired();
6340 String value = cmd.getNextArgRequired();
6341 String[] strings = value.split(",");
6342 ArrayList<Long> list = new ArrayList<>(strings.length);
6343 for (int i = 0; i < strings.length; i++) {
6344 list.add(Long.valueOf(strings[i]));
6345 }
6346 intent.putExtra(key, list);
6347 hasIntentInfo = true;
6348 }
6349 break;
6350 case "--ef": {
6351 String key = cmd.getNextArgRequired();
6352 String value = cmd.getNextArgRequired();
6353 intent.putExtra(key, Float.valueOf(value));
6354 hasIntentInfo = true;
6355 }
6356 break;
6357 case "--efa": {
6358 String key = cmd.getNextArgRequired();
6359 String value = cmd.getNextArgRequired();
6360 String[] strings = value.split(",");
6361 float[] list = new float[strings.length];
6362 for (int i = 0; i < strings.length; i++) {
6363 list[i] = Float.valueOf(strings[i]);
6364 }
6365 intent.putExtra(key, list);
6366 hasIntentInfo = true;
6367 }
6368 break;
6369 case "--efal": {
6370 String key = cmd.getNextArgRequired();
6371 String value = cmd.getNextArgRequired();
6372 String[] strings = value.split(",");
6373 ArrayList<Float> list = new ArrayList<>(strings.length);
6374 for (int i = 0; i < strings.length; i++) {
6375 list.add(Float.valueOf(strings[i]));
6376 }
6377 intent.putExtra(key, list);
6378 hasIntentInfo = true;
6379 }
6380 break;
6381 case "--esa": {
6382 String key = cmd.getNextArgRequired();
6383 String value = cmd.getNextArgRequired();
6384 // Split on commas unless they are preceeded by an escape.
6385 // The escape character must be escaped for the string and
6386 // again for the regex, thus four escape characters become one.
6387 String[] strings = value.split("(?<!\\\\),");
6388 intent.putExtra(key, strings);
6389 hasIntentInfo = true;
6390 }
6391 break;
6392 case "--esal": {
6393 String key = cmd.getNextArgRequired();
6394 String value = cmd.getNextArgRequired();
6395 // Split on commas unless they are preceeded by an escape.
6396 // The escape character must be escaped for the string and
6397 // again for the regex, thus four escape characters become one.
6398 String[] strings = value.split("(?<!\\\\),");
6399 ArrayList<String> list = new ArrayList<>(strings.length);
6400 for (int i = 0; i < strings.length; i++) {
6401 list.add(strings[i]);
6402 }
6403 intent.putExtra(key, list);
6404 hasIntentInfo = true;
6405 }
6406 break;
6407 case "--ez": {
6408 String key = cmd.getNextArgRequired();
6409 String value = cmd.getNextArgRequired().toLowerCase();
6410 // Boolean.valueOf() results in false for anything that is not "true", which is
6411 // error-prone in shell commands
6412 boolean arg;
6413 if ("true".equals(value) || "t".equals(value)) {
6414 arg = true;
6415 } else if ("false".equals(value) || "f".equals(value)) {
6416 arg = false;
6417 } else {
6418 try {
6419 arg = Integer.decode(value) != 0;
6420 } catch (NumberFormatException ex) {
6421 throw new IllegalArgumentException("Invalid boolean value: " + value);
6422 }
6423 }
6424
6425 intent.putExtra(key, arg);
6426 }
6427 break;
6428 case "-n": {
6429 String str = cmd.getNextArgRequired();
6430 ComponentName cn = ComponentName.unflattenFromString(str);
6431 if (cn == null)
6432 throw new IllegalArgumentException("Bad component name: " + str);
6433 intent.setComponent(cn);
6434 if (intent == baseIntent) {
6435 hasIntentInfo = true;
6436 }
6437 }
6438 break;
6439 case "-p": {
6440 String str = cmd.getNextArgRequired();
6441 intent.setPackage(str);
6442 if (intent == baseIntent) {
6443 hasIntentInfo = true;
6444 }
6445 }
6446 break;
6447 case "-f":
6448 String str = cmd.getNextArgRequired();
6449 intent.setFlags(Integer.decode(str).intValue());
6450 break;
6451 case "--grant-read-uri-permission":
6452 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6453 break;
6454 case "--grant-write-uri-permission":
6455 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6456 break;
6457 case "--grant-persistable-uri-permission":
6458 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6459 break;
6460 case "--grant-prefix-uri-permission":
6461 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6462 break;
6463 case "--exclude-stopped-packages":
6464 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6465 break;
6466 case "--include-stopped-packages":
6467 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6468 break;
6469 case "--debug-log-resolution":
6470 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6471 break;
6472 case "--activity-brought-to-front":
6473 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6474 break;
6475 case "--activity-clear-top":
6476 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6477 break;
6478 case "--activity-clear-when-task-reset":
6479 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6480 break;
6481 case "--activity-exclude-from-recents":
6482 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6483 break;
6484 case "--activity-launched-from-history":
6485 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6486 break;
6487 case "--activity-multiple-task":
6488 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6489 break;
6490 case "--activity-no-animation":
6491 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6492 break;
6493 case "--activity-no-history":
6494 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6495 break;
6496 case "--activity-no-user-action":
6497 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6498 break;
6499 case "--activity-previous-is-top":
6500 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6501 break;
6502 case "--activity-reorder-to-front":
6503 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6504 break;
6505 case "--activity-reset-task-if-needed":
6506 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6507 break;
6508 case "--activity-single-top":
6509 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6510 break;
6511 case "--activity-clear-task":
6512 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6513 break;
6514 case "--activity-task-on-home":
6515 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6516 break;
6517 case "--receiver-registered-only":
6518 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6519 break;
6520 case "--receiver-replace-pending":
6521 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6522 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006523 case "--receiver-foreground":
6524 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6525 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006526 case "--receiver-no-abort":
6527 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6528 break;
6529 case "--receiver-include-background":
6530 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6531 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006532 case "--selector":
6533 intent.setDataAndType(data, type);
6534 intent = new Intent();
6535 break;
6536 default:
6537 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6538 // Okay, caller handled this option.
6539 } else {
6540 throw new IllegalArgumentException("Unknown option: " + opt);
6541 }
6542 break;
6543 }
6544 }
6545 intent.setDataAndType(data, type);
6546
6547 final boolean hasSelector = intent != baseIntent;
6548 if (hasSelector) {
6549 // A selector was specified; fix up.
6550 baseIntent.setSelector(intent);
6551 intent = baseIntent;
6552 }
6553
6554 String arg = cmd.getNextArg();
6555 baseIntent = null;
6556 if (arg == null) {
6557 if (hasSelector) {
6558 // If a selector has been specified, and no arguments
6559 // have been supplied for the main Intent, then we can
6560 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6561 // need to have a component name specified yet, the
6562 // selector will take care of that.
6563 baseIntent = new Intent(Intent.ACTION_MAIN);
6564 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6565 }
6566 } else if (arg.indexOf(':') >= 0) {
6567 // The argument is a URI. Fully parse it, and use that result
6568 // to fill in any data not specified so far.
6569 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6570 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6571 } else if (arg.indexOf('/') >= 0) {
6572 // The argument is a component name. Build an Intent to launch
6573 // it.
6574 baseIntent = new Intent(Intent.ACTION_MAIN);
6575 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6576 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6577 } else {
6578 // Assume the argument is a package name.
6579 baseIntent = new Intent(Intent.ACTION_MAIN);
6580 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6581 baseIntent.setPackage(arg);
6582 }
6583 if (baseIntent != null) {
6584 Bundle extras = intent.getExtras();
6585 intent.replaceExtras((Bundle)null);
6586 Bundle uriExtras = baseIntent.getExtras();
6587 baseIntent.replaceExtras((Bundle)null);
6588 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6589 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6590 for (String c : cats) {
6591 baseIntent.removeCategory(c);
6592 }
6593 }
6594 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6595 if (extras == null) {
6596 extras = uriExtras;
6597 } else if (uriExtras != null) {
6598 uriExtras.putAll(extras);
6599 extras = uriExtras;
6600 }
6601 intent.replaceExtras(extras);
6602 hasIntentInfo = true;
6603 }
6604
6605 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6606 return intent;
6607 }
6608
6609 /** @hide */
6610 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6611 final String[] lines = new String[] {
6612 "<INTENT> specifications include these flags and arguments:",
6613 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6614 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6615 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6616 " [--esn <EXTRA_KEY> ...]",
6617 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6618 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6619 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6620 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6621 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6622 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6623 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6624 " (mutiple extras passed as Integer[])",
6625 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6626 " (mutiple extras passed as List<Integer>)",
6627 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6628 " (mutiple extras passed as Long[])",
6629 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6630 " (mutiple extras passed as List<Long>)",
6631 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6632 " (mutiple extras passed as Float[])",
6633 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6634 " (mutiple extras passed as List<Float>)",
6635 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6636 " (mutiple extras passed as String[]; to embed a comma into a string,",
6637 " escape it using \"\\,\")",
6638 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6639 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6640 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006641 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006642 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6643 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6644 " [--debug-log-resolution] [--exclude-stopped-packages]",
6645 " [--include-stopped-packages]",
6646 " [--activity-brought-to-front] [--activity-clear-top]",
6647 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6648 " [--activity-launched-from-history] [--activity-multiple-task]",
6649 " [--activity-no-animation] [--activity-no-history]",
6650 " [--activity-no-user-action] [--activity-previous-is-top]",
6651 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6652 " [--activity-single-top] [--activity-clear-task]",
6653 " [--activity-task-on-home]",
6654 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08006655 " [--receiver-foreground] [--receiver-no-abort]",
6656 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006657 " [--selector]",
6658 " [<URI> | <PACKAGE> | <COMPONENT>]"
6659 };
6660 for (String line : lines) {
6661 pw.print(prefix);
6662 pw.println(line);
6663 }
6664 }
6665
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006666 /**
6667 * Retrieve the general action to be performed, such as
6668 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6669 * the information in the intent should be interpreted -- most importantly,
6670 * what to do with the data returned by {@link #getData}.
6671 *
6672 * @return The action of this intent or null if none is specified.
6673 *
6674 * @see #setAction
6675 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006676 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006677 return mAction;
6678 }
6679
6680 /**
6681 * Retrieve data this intent is operating on. This URI specifies the name
6682 * of the data; often it uses the content: scheme, specifying data in a
6683 * content provider. Other schemes may be handled by specific activities,
6684 * such as http: by the web browser.
6685 *
6686 * @return The URI of the data this intent is targeting or null.
6687 *
6688 * @see #getScheme
6689 * @see #setData
6690 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006691 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006692 return mData;
6693 }
6694
6695 /**
6696 * The same as {@link #getData()}, but returns the URI as an encoded
6697 * String.
6698 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006699 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006700 return mData != null ? mData.toString() : null;
6701 }
6702
6703 /**
6704 * Return the scheme portion of the intent's data. If the data is null or
6705 * does not include a scheme, null is returned. Otherwise, the scheme
6706 * prefix without the final ':' is returned, i.e. "http".
6707 *
6708 * <p>This is the same as calling getData().getScheme() (and checking for
6709 * null data).
6710 *
6711 * @return The scheme of this intent.
6712 *
6713 * @see #getData
6714 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006715 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006716 return mData != null ? mData.getScheme() : null;
6717 }
6718
6719 /**
6720 * Retrieve any explicit MIME type included in the intent. This is usually
6721 * null, as the type is determined by the intent data.
6722 *
6723 * @return If a type was manually set, it is returned; else null is
6724 * returned.
6725 *
6726 * @see #resolveType(ContentResolver)
6727 * @see #setType
6728 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006729 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006730 return mType;
6731 }
6732
6733 /**
6734 * Return the MIME data type of this intent. If the type field is
6735 * explicitly set, that is simply returned. Otherwise, if the data is set,
6736 * the type of that data is returned. If neither fields are set, a null is
6737 * returned.
6738 *
6739 * @return The MIME type of this intent.
6740 *
6741 * @see #getType
6742 * @see #resolveType(ContentResolver)
6743 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006744 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006745 return resolveType(context.getContentResolver());
6746 }
6747
6748 /**
6749 * Return the MIME data type of this intent. If the type field is
6750 * explicitly set, that is simply returned. Otherwise, if the data is set,
6751 * the type of that data is returned. If neither fields are set, a null is
6752 * returned.
6753 *
6754 * @param resolver A ContentResolver that can be used to determine the MIME
6755 * type of the intent's data.
6756 *
6757 * @return The MIME type of this intent.
6758 *
6759 * @see #getType
6760 * @see #resolveType(Context)
6761 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006762 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006763 if (mType != null) {
6764 return mType;
6765 }
6766 if (mData != null) {
6767 if ("content".equals(mData.getScheme())) {
6768 return resolver.getType(mData);
6769 }
6770 }
6771 return null;
6772 }
6773
6774 /**
6775 * Return the MIME data type of this intent, only if it will be needed for
6776 * intent resolution. This is not generally useful for application code;
6777 * it is used by the frameworks for communicating with back-end system
6778 * services.
6779 *
6780 * @param resolver A ContentResolver that can be used to determine the MIME
6781 * type of the intent's data.
6782 *
6783 * @return The MIME type of this intent, or null if it is unknown or not
6784 * needed.
6785 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006786 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006787 if (mComponent != null) {
6788 return mType;
6789 }
6790 return resolveType(resolver);
6791 }
6792
6793 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006794 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006795 *
6796 * @param category The category to check.
6797 *
6798 * @return boolean True if the intent contains the category, else false.
6799 *
6800 * @see #getCategories
6801 * @see #addCategory
6802 */
6803 public boolean hasCategory(String category) {
6804 return mCategories != null && mCategories.contains(category);
6805 }
6806
6807 /**
6808 * Return the set of all categories in the intent. If there are no categories,
6809 * returns NULL.
6810 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006811 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006812 *
6813 * @see #hasCategory
6814 * @see #addCategory
6815 */
6816 public Set<String> getCategories() {
6817 return mCategories;
6818 }
6819
6820 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006821 * Return the specific selector associated with this Intent. If there is
6822 * none, returns null. See {@link #setSelector} for more information.
6823 *
6824 * @see #setSelector
6825 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006826 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006827 return mSelector;
6828 }
6829
6830 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006831 * Return the {@link ClipData} associated with this Intent. If there is
6832 * none, returns null. See {@link #setClipData} for more information.
6833 *
John Spurlock125d1332013-11-25 11:58:37 -05006834 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006835 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006836 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006837 return mClipData;
6838 }
6839
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006840 /** @hide */
6841 public int getContentUserHint() {
6842 return mContentUserHint;
6843 }
6844
Todd Kennedyb3b431302017-03-20 16:05:48 -07006845 /** @hide */
6846 public String getLaunchToken() {
6847 return mLaunchToken;
6848 }
6849
6850 /** @hide */
6851 public void setLaunchToken(String launchToken) {
6852 mLaunchToken = launchToken;
6853 }
6854
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006855 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006856 * Sets the ClassLoader that will be used when unmarshalling
6857 * any Parcelable values from the extras of this Intent.
6858 *
6859 * @param loader a ClassLoader, or null to use the default loader
6860 * at the time of unmarshalling.
6861 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006862 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006863 if (mExtras != null) {
6864 mExtras.setClassLoader(loader);
6865 }
6866 }
6867
6868 /**
6869 * Returns true if an extra value is associated with the given name.
6870 * @param name the extra's name
6871 * @return true if the given extra is present.
6872 */
6873 public boolean hasExtra(String name) {
6874 return mExtras != null && mExtras.containsKey(name);
6875 }
6876
6877 /**
6878 * Returns true if the Intent's extras contain a parcelled file descriptor.
6879 * @return true if the Intent contains a parcelled file descriptor.
6880 */
6881 public boolean hasFileDescriptors() {
6882 return mExtras != null && mExtras.hasFileDescriptors();
6883 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006884
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006885 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006886 public void setAllowFds(boolean allowFds) {
6887 if (mExtras != null) {
6888 mExtras.setAllowFds(allowFds);
6889 }
6890 }
6891
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006892 /** {@hide} */
6893 public void setDefusable(boolean defusable) {
6894 if (mExtras != null) {
6895 mExtras.setDefusable(defusable);
6896 }
6897 }
6898
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006899 /**
6900 * Retrieve extended data from the intent.
6901 *
6902 * @param name The name of the desired item.
6903 *
6904 * @return the value of an item that previously added with putExtra()
6905 * or null if none was found.
6906 *
6907 * @deprecated
6908 * @hide
6909 */
6910 @Deprecated
6911 public Object getExtra(String name) {
6912 return getExtra(name, null);
6913 }
6914
6915 /**
6916 * Retrieve extended data from the intent.
6917 *
6918 * @param name The name of the desired item.
6919 * @param defaultValue the value to be returned if no value of the desired
6920 * type is stored with the given name.
6921 *
6922 * @return the value of an item that previously added with putExtra()
6923 * or the default value if none was found.
6924 *
6925 * @see #putExtra(String, boolean)
6926 */
6927 public boolean getBooleanExtra(String name, boolean defaultValue) {
6928 return mExtras == null ? defaultValue :
6929 mExtras.getBoolean(name, defaultValue);
6930 }
6931
6932 /**
6933 * Retrieve extended data from the intent.
6934 *
6935 * @param name The name of the desired item.
6936 * @param defaultValue the value to be returned if no value of the desired
6937 * type is stored with the given name.
6938 *
6939 * @return the value of an item that previously added with putExtra()
6940 * or the default value if none was found.
6941 *
6942 * @see #putExtra(String, byte)
6943 */
6944 public byte getByteExtra(String name, byte defaultValue) {
6945 return mExtras == null ? defaultValue :
6946 mExtras.getByte(name, defaultValue);
6947 }
6948
6949 /**
6950 * Retrieve extended data from the intent.
6951 *
6952 * @param name The name of the desired item.
6953 * @param defaultValue the value to be returned if no value of the desired
6954 * type is stored with the given name.
6955 *
6956 * @return the value of an item that previously added with putExtra()
6957 * or the default value if none was found.
6958 *
6959 * @see #putExtra(String, short)
6960 */
6961 public short getShortExtra(String name, short defaultValue) {
6962 return mExtras == null ? defaultValue :
6963 mExtras.getShort(name, defaultValue);
6964 }
6965
6966 /**
6967 * Retrieve extended data from the intent.
6968 *
6969 * @param name The name of the desired item.
6970 * @param defaultValue the value to be returned if no value of the desired
6971 * type is stored with the given name.
6972 *
6973 * @return the value of an item that previously added with putExtra()
6974 * or the default value if none was found.
6975 *
6976 * @see #putExtra(String, char)
6977 */
6978 public char getCharExtra(String name, char defaultValue) {
6979 return mExtras == null ? defaultValue :
6980 mExtras.getChar(name, defaultValue);
6981 }
6982
6983 /**
6984 * Retrieve extended data from the intent.
6985 *
6986 * @param name The name of the desired item.
6987 * @param defaultValue the value to be returned if no value of the desired
6988 * type is stored with the given name.
6989 *
6990 * @return the value of an item that previously added with putExtra()
6991 * or the default value if none was found.
6992 *
6993 * @see #putExtra(String, int)
6994 */
6995 public int getIntExtra(String name, int defaultValue) {
6996 return mExtras == null ? defaultValue :
6997 mExtras.getInt(name, defaultValue);
6998 }
6999
7000 /**
7001 * Retrieve extended data from the intent.
7002 *
7003 * @param name The name of the desired item.
7004 * @param defaultValue the value to be returned if no value of the desired
7005 * type is stored with the given name.
7006 *
7007 * @return the value of an item that previously added with putExtra()
7008 * or the default value if none was found.
7009 *
7010 * @see #putExtra(String, long)
7011 */
7012 public long getLongExtra(String name, long defaultValue) {
7013 return mExtras == null ? defaultValue :
7014 mExtras.getLong(name, defaultValue);
7015 }
7016
7017 /**
7018 * Retrieve extended data from the intent.
7019 *
7020 * @param name The name of the desired item.
7021 * @param defaultValue the value to be returned if no value of the desired
7022 * type is stored with the given name.
7023 *
7024 * @return the value of an item that previously added with putExtra(),
7025 * or the default value if no such item is present
7026 *
7027 * @see #putExtra(String, float)
7028 */
7029 public float getFloatExtra(String name, float defaultValue) {
7030 return mExtras == null ? defaultValue :
7031 mExtras.getFloat(name, defaultValue);
7032 }
7033
7034 /**
7035 * Retrieve extended data from the intent.
7036 *
7037 * @param name The name of the desired item.
7038 * @param defaultValue the value to be returned if no value of the desired
7039 * type is stored with the given name.
7040 *
7041 * @return the value of an item that previously added with putExtra()
7042 * or the default value if none was found.
7043 *
7044 * @see #putExtra(String, double)
7045 */
7046 public double getDoubleExtra(String name, double defaultValue) {
7047 return mExtras == null ? defaultValue :
7048 mExtras.getDouble(name, defaultValue);
7049 }
7050
7051 /**
7052 * Retrieve extended data from the intent.
7053 *
7054 * @param name The name of the desired item.
7055 *
7056 * @return the value of an item that previously added with putExtra()
7057 * or null if no String value was found.
7058 *
7059 * @see #putExtra(String, String)
7060 */
7061 public String getStringExtra(String name) {
7062 return mExtras == null ? null : mExtras.getString(name);
7063 }
7064
7065 /**
7066 * Retrieve extended data from the intent.
7067 *
7068 * @param name The name of the desired item.
7069 *
7070 * @return the value of an item that previously added with putExtra()
7071 * or null if no CharSequence value was found.
7072 *
7073 * @see #putExtra(String, CharSequence)
7074 */
7075 public CharSequence getCharSequenceExtra(String name) {
7076 return mExtras == null ? null : mExtras.getCharSequence(name);
7077 }
7078
7079 /**
7080 * Retrieve extended data from the intent.
7081 *
7082 * @param name The name of the desired item.
7083 *
7084 * @return the value of an item that previously added with putExtra()
7085 * or null if no Parcelable value was found.
7086 *
7087 * @see #putExtra(String, Parcelable)
7088 */
7089 public <T extends Parcelable> T getParcelableExtra(String name) {
7090 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7091 }
7092
7093 /**
7094 * Retrieve extended data from the intent.
7095 *
7096 * @param name The name of the desired item.
7097 *
7098 * @return the value of an item that previously added with putExtra()
7099 * or null if no Parcelable[] value was found.
7100 *
7101 * @see #putExtra(String, Parcelable[])
7102 */
7103 public Parcelable[] getParcelableArrayExtra(String name) {
7104 return mExtras == null ? null : mExtras.getParcelableArray(name);
7105 }
7106
7107 /**
7108 * Retrieve extended data from the intent.
7109 *
7110 * @param name The name of the desired item.
7111 *
7112 * @return the value of an item that previously added with putExtra()
7113 * or null if no ArrayList<Parcelable> value was found.
7114 *
7115 * @see #putParcelableArrayListExtra(String, ArrayList)
7116 */
7117 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
7118 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7119 }
7120
7121 /**
7122 * Retrieve extended data from the intent.
7123 *
7124 * @param name The name of the desired item.
7125 *
7126 * @return the value of an item that previously added with putExtra()
7127 * or null if no Serializable value was found.
7128 *
7129 * @see #putExtra(String, Serializable)
7130 */
7131 public Serializable getSerializableExtra(String name) {
7132 return mExtras == null ? null : mExtras.getSerializable(name);
7133 }
7134
7135 /**
7136 * Retrieve extended data from the intent.
7137 *
7138 * @param name The name of the desired item.
7139 *
7140 * @return the value of an item that previously added with putExtra()
7141 * or null if no ArrayList<Integer> value was found.
7142 *
7143 * @see #putIntegerArrayListExtra(String, ArrayList)
7144 */
7145 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
7146 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7147 }
7148
7149 /**
7150 * Retrieve extended data from the intent.
7151 *
7152 * @param name The name of the desired item.
7153 *
7154 * @return the value of an item that previously added with putExtra()
7155 * or null if no ArrayList<String> value was found.
7156 *
7157 * @see #putStringArrayListExtra(String, ArrayList)
7158 */
7159 public ArrayList<String> getStringArrayListExtra(String name) {
7160 return mExtras == null ? null : mExtras.getStringArrayList(name);
7161 }
7162
7163 /**
7164 * Retrieve extended data from the intent.
7165 *
7166 * @param name The name of the desired item.
7167 *
7168 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007169 * or null if no ArrayList<CharSequence> value was found.
7170 *
7171 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7172 */
7173 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
7174 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7175 }
7176
7177 /**
7178 * Retrieve extended data from the intent.
7179 *
7180 * @param name The name of the desired item.
7181 *
7182 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007183 * or null if no boolean array value was found.
7184 *
7185 * @see #putExtra(String, boolean[])
7186 */
7187 public boolean[] getBooleanArrayExtra(String name) {
7188 return mExtras == null ? null : mExtras.getBooleanArray(name);
7189 }
7190
7191 /**
7192 * Retrieve extended data from the intent.
7193 *
7194 * @param name The name of the desired item.
7195 *
7196 * @return the value of an item that previously added with putExtra()
7197 * or null if no byte array value was found.
7198 *
7199 * @see #putExtra(String, byte[])
7200 */
7201 public byte[] getByteArrayExtra(String name) {
7202 return mExtras == null ? null : mExtras.getByteArray(name);
7203 }
7204
7205 /**
7206 * Retrieve extended data from the intent.
7207 *
7208 * @param name The name of the desired item.
7209 *
7210 * @return the value of an item that previously added with putExtra()
7211 * or null if no short array value was found.
7212 *
7213 * @see #putExtra(String, short[])
7214 */
7215 public short[] getShortArrayExtra(String name) {
7216 return mExtras == null ? null : mExtras.getShortArray(name);
7217 }
7218
7219 /**
7220 * Retrieve extended data from the intent.
7221 *
7222 * @param name The name of the desired item.
7223 *
7224 * @return the value of an item that previously added with putExtra()
7225 * or null if no char array value was found.
7226 *
7227 * @see #putExtra(String, char[])
7228 */
7229 public char[] getCharArrayExtra(String name) {
7230 return mExtras == null ? null : mExtras.getCharArray(name);
7231 }
7232
7233 /**
7234 * Retrieve extended data from the intent.
7235 *
7236 * @param name The name of the desired item.
7237 *
7238 * @return the value of an item that previously added with putExtra()
7239 * or null if no int array value was found.
7240 *
7241 * @see #putExtra(String, int[])
7242 */
7243 public int[] getIntArrayExtra(String name) {
7244 return mExtras == null ? null : mExtras.getIntArray(name);
7245 }
7246
7247 /**
7248 * Retrieve extended data from the intent.
7249 *
7250 * @param name The name of the desired item.
7251 *
7252 * @return the value of an item that previously added with putExtra()
7253 * or null if no long array value was found.
7254 *
7255 * @see #putExtra(String, long[])
7256 */
7257 public long[] getLongArrayExtra(String name) {
7258 return mExtras == null ? null : mExtras.getLongArray(name);
7259 }
7260
7261 /**
7262 * Retrieve extended data from the intent.
7263 *
7264 * @param name The name of the desired item.
7265 *
7266 * @return the value of an item that previously added with putExtra()
7267 * or null if no float array value was found.
7268 *
7269 * @see #putExtra(String, float[])
7270 */
7271 public float[] getFloatArrayExtra(String name) {
7272 return mExtras == null ? null : mExtras.getFloatArray(name);
7273 }
7274
7275 /**
7276 * Retrieve extended data from the intent.
7277 *
7278 * @param name The name of the desired item.
7279 *
7280 * @return the value of an item that previously added with putExtra()
7281 * or null if no double array value was found.
7282 *
7283 * @see #putExtra(String, double[])
7284 */
7285 public double[] getDoubleArrayExtra(String name) {
7286 return mExtras == null ? null : mExtras.getDoubleArray(name);
7287 }
7288
7289 /**
7290 * Retrieve extended data from the intent.
7291 *
7292 * @param name The name of the desired item.
7293 *
7294 * @return the value of an item that previously added with putExtra()
7295 * or null if no String array value was found.
7296 *
7297 * @see #putExtra(String, String[])
7298 */
7299 public String[] getStringArrayExtra(String name) {
7300 return mExtras == null ? null : mExtras.getStringArray(name);
7301 }
7302
7303 /**
7304 * Retrieve extended data from the intent.
7305 *
7306 * @param name The name of the desired item.
7307 *
7308 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007309 * or null if no CharSequence array value was found.
7310 *
7311 * @see #putExtra(String, CharSequence[])
7312 */
7313 public CharSequence[] getCharSequenceArrayExtra(String name) {
7314 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7315 }
7316
7317 /**
7318 * Retrieve extended data from the intent.
7319 *
7320 * @param name The name of the desired item.
7321 *
7322 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007323 * or null if no Bundle value was found.
7324 *
7325 * @see #putExtra(String, Bundle)
7326 */
7327 public Bundle getBundleExtra(String name) {
7328 return mExtras == null ? null : mExtras.getBundle(name);
7329 }
7330
7331 /**
7332 * Retrieve extended data from the intent.
7333 *
7334 * @param name The name of the desired item.
7335 *
7336 * @return the value of an item that previously added with putExtra()
7337 * or null if no IBinder value was found.
7338 *
7339 * @see #putExtra(String, IBinder)
7340 *
7341 * @deprecated
7342 * @hide
7343 */
7344 @Deprecated
7345 public IBinder getIBinderExtra(String name) {
7346 return mExtras == null ? null : mExtras.getIBinder(name);
7347 }
7348
7349 /**
7350 * Retrieve extended data from the intent.
7351 *
7352 * @param name The name of the desired item.
7353 * @param defaultValue The default value to return in case no item is
7354 * associated with the key 'name'
7355 *
7356 * @return the value of an item that previously added with putExtra()
7357 * or defaultValue if none was found.
7358 *
7359 * @see #putExtra
7360 *
7361 * @deprecated
7362 * @hide
7363 */
7364 @Deprecated
7365 public Object getExtra(String name, Object defaultValue) {
7366 Object result = defaultValue;
7367 if (mExtras != null) {
7368 Object result2 = mExtras.get(name);
7369 if (result2 != null) {
7370 result = result2;
7371 }
7372 }
7373
7374 return result;
7375 }
7376
7377 /**
7378 * Retrieves a map of extended data from the intent.
7379 *
7380 * @return the map of all extras previously added with putExtra(),
7381 * or null if none have been added.
7382 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007383 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007384 return (mExtras != null)
7385 ? new Bundle(mExtras)
7386 : null;
7387 }
7388
7389 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007390 * Filter extras to only basic types.
7391 * @hide
7392 */
7393 public void removeUnsafeExtras() {
7394 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007395 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007396 }
7397 }
7398
7399 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007400 * Retrieve any special flags associated with this intent. You will
7401 * normally just set them with {@link #setFlags} and let the system
7402 * take the appropriate action with them.
7403 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007404 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007405 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007406 * @see #addFlags
7407 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007408 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007409 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007410 return mFlags;
7411 }
7412
Dianne Hackborne7f97212011-02-24 14:40:20 -08007413 /** @hide */
7414 public boolean isExcludingStopped() {
7415 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7416 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7417 }
7418
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007419 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007420 * Retrieve the application package name this Intent is limited to. When
7421 * resolving an Intent, if non-null this limits the resolution to only
7422 * components in the given application package.
7423 *
7424 * @return The name of the application package for the Intent.
7425 *
7426 * @see #resolveActivity
7427 * @see #setPackage
7428 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007429 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007430 return mPackage;
7431 }
7432
7433 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007434 * Retrieve the concrete component associated with the intent. When receiving
7435 * an intent, this is the component that was found to best handle it (that is,
7436 * yourself) and will always be non-null; in all other cases it will be
7437 * null unless explicitly set.
7438 *
7439 * @return The name of the application component to handle the intent.
7440 *
7441 * @see #resolveActivity
7442 * @see #setComponent
7443 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007444 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007445 return mComponent;
7446 }
7447
7448 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007449 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7450 * used as a hint to the receiver for animations and the like. Null means that there
7451 * is no source bounds.
7452 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007453 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007454 return mSourceBounds;
7455 }
7456
7457 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007458 * Return the Activity component that should be used to handle this intent.
7459 * The appropriate component is determined based on the information in the
7460 * intent, evaluated as follows:
7461 *
7462 * <p>If {@link #getComponent} returns an explicit class, that is returned
7463 * without any further consideration.
7464 *
7465 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7466 * category to be considered.
7467 *
7468 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7469 * action.
7470 *
7471 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7472 * this type.
7473 *
7474 * <p>If {@link #addCategory} has added any categories, the activity must
7475 * handle ALL of the categories specified.
7476 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007477 * <p>If {@link #getPackage} is non-NULL, only activity components in
7478 * that application package will be considered.
7479 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007480 * <p>If there are no activities that satisfy all of these conditions, a
7481 * null string is returned.
7482 *
7483 * <p>If multiple activities are found to satisfy the intent, the one with
7484 * the highest priority will be used. If there are multiple activities
7485 * with the same priority, the system will either pick the best activity
7486 * based on user preference, or resolve to a system class that will allow
7487 * the user to pick an activity and forward from there.
7488 *
7489 * <p>This method is implemented simply by calling
7490 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7491 * true.</p>
7492 * <p> This API is called for you as part of starting an activity from an
7493 * intent. You do not normally need to call it yourself.</p>
7494 *
7495 * @param pm The package manager with which to resolve the Intent.
7496 *
7497 * @return Name of the component implementing an activity that can
7498 * display the intent.
7499 *
7500 * @see #setComponent
7501 * @see #getComponent
7502 * @see #resolveActivityInfo
7503 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007504 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007505 if (mComponent != null) {
7506 return mComponent;
7507 }
7508
7509 ResolveInfo info = pm.resolveActivity(
7510 this, PackageManager.MATCH_DEFAULT_ONLY);
7511 if (info != null) {
7512 return new ComponentName(
7513 info.activityInfo.applicationInfo.packageName,
7514 info.activityInfo.name);
7515 }
7516
7517 return null;
7518 }
7519
7520 /**
7521 * Resolve the Intent into an {@link ActivityInfo}
7522 * describing the activity that should execute the intent. Resolution
7523 * follows the same rules as described for {@link #resolveActivity}, but
7524 * you get back the completely information about the resolved activity
7525 * instead of just its class name.
7526 *
7527 * @param pm The package manager with which to resolve the Intent.
7528 * @param flags Addition information to retrieve as per
7529 * {@link PackageManager#getActivityInfo(ComponentName, int)
7530 * PackageManager.getActivityInfo()}.
7531 *
7532 * @return PackageManager.ActivityInfo
7533 *
7534 * @see #resolveActivity
7535 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007536 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
7537 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007538 ActivityInfo ai = null;
7539 if (mComponent != null) {
7540 try {
7541 ai = pm.getActivityInfo(mComponent, flags);
7542 } catch (PackageManager.NameNotFoundException e) {
7543 // ignore
7544 }
7545 } else {
7546 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007547 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007548 if (info != null) {
7549 ai = info.activityInfo;
7550 }
7551 }
7552
7553 return ai;
7554 }
7555
7556 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007557 * Special function for use by the system to resolve service
7558 * intents to system apps. Throws an exception if there are
7559 * multiple potential matches to the Intent. Returns null if
7560 * there are no matches.
7561 * @hide
7562 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007563 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
7564 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07007565 if (mComponent != null) {
7566 return mComponent;
7567 }
7568
7569 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7570 if (results == null) {
7571 return null;
7572 }
7573 ComponentName comp = null;
7574 for (int i=0; i<results.size(); i++) {
7575 ResolveInfo ri = results.get(i);
7576 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7577 continue;
7578 }
7579 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7580 ri.serviceInfo.name);
7581 if (comp != null) {
7582 throw new IllegalStateException("Multiple system services handle " + this
7583 + ": " + comp + ", " + foundComp);
7584 }
7585 comp = foundComp;
7586 }
7587 return comp;
7588 }
7589
7590 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007591 * Set the general action to be performed.
7592 *
7593 * @param action An action name, such as ACTION_VIEW. Application-specific
7594 * actions should be prefixed with the vendor's package name.
7595 *
7596 * @return Returns the same Intent object, for chaining multiple calls
7597 * into a single statement.
7598 *
7599 * @see #getAction
7600 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007601 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007602 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007603 return this;
7604 }
7605
7606 /**
7607 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007608 * clears any type that was previously set by {@link #setType} or
7609 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007610 *
Nick Pellyccae4122012-01-09 14:12:58 -08007611 * <p><em>Note: scheme matching in the Android framework is
7612 * case-sensitive, unlike the formal RFC. As a result,
7613 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007614 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007615 * {@link #setDataAndNormalize}
7616 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007617 *
Nick Pellyccae4122012-01-09 14:12:58 -08007618 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007619 *
7620 * @return Returns the same Intent object, for chaining multiple calls
7621 * into a single statement.
7622 *
7623 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007624 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007625 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007626 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007627 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007628 mData = data;
7629 mType = null;
7630 return this;
7631 }
7632
7633 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007634 * Normalize and set the data this intent is operating on.
7635 *
7636 * <p>This method automatically clears any type that was
7637 * previously set (for example, by {@link #setType}).
7638 *
7639 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007640 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007641 * so really this is just a convenience method for
7642 * <pre>
7643 * setData(data.normalize())
7644 * </pre>
7645 *
7646 * @param data The Uri of the data this intent is now targeting.
7647 *
7648 * @return Returns the same Intent object, for chaining multiple calls
7649 * into a single statement.
7650 *
7651 * @see #getData
7652 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007653 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007654 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007655 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007656 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007657 }
7658
7659 /**
7660 * Set an explicit MIME data type.
7661 *
7662 * <p>This is used to create intents that only specify a type and not data,
7663 * for example to indicate the type of data to return.
7664 *
7665 * <p>This method automatically clears any data that was
7666 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007667 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007668 * <p><em>Note: MIME type matching in the Android framework is
7669 * case-sensitive, unlike formal RFC MIME types. As a result,
7670 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007671 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7672 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007673 *
7674 * @param type The MIME type of the data being handled by this intent.
7675 *
7676 * @return Returns the same Intent object, for chaining multiple calls
7677 * into a single statement.
7678 *
7679 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007680 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007681 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007682 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007683 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007684 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007685 mData = null;
7686 mType = type;
7687 return this;
7688 }
7689
7690 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007691 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007692 *
Nick Pellyccae4122012-01-09 14:12:58 -08007693 * <p>This is used to create intents that only specify a type and not data,
7694 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007695 *
Nick Pellyccae4122012-01-09 14:12:58 -08007696 * <p>This method automatically clears any data that was
7697 * previously set (for example by {@link #setData}).
7698 *
7699 * <p>The MIME type is normalized using
7700 * {@link #normalizeMimeType} before it is set,
7701 * so really this is just a convenience method for
7702 * <pre>
7703 * setType(Intent.normalizeMimeType(type))
7704 * </pre>
7705 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007706 * @param type The MIME type of the data being handled by this intent.
7707 *
7708 * @return Returns the same Intent object, for chaining multiple calls
7709 * into a single statement.
7710 *
Nick Pellyccae4122012-01-09 14:12:58 -08007711 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007712 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007713 * @see #normalizeMimeType
7714 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007715 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08007716 return setType(normalizeMimeType(type));
7717 }
7718
7719 /**
7720 * (Usually optional) Set the data for the intent along with an explicit
7721 * MIME data type. This method should very rarely be used -- it allows you
7722 * to override the MIME type that would ordinarily be inferred from the
7723 * data with your own type given here.
7724 *
7725 * <p><em>Note: MIME type and Uri scheme matching in the
7726 * Android framework is case-sensitive, unlike the formal RFC definitions.
7727 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007728 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007729 * {@link #setDataAndTypeAndNormalize}
7730 * to ensure that they are converted to lower case.</em>
7731 *
7732 * @param data The Uri of the data this intent is now targeting.
7733 * @param type The MIME type of the data being handled by this intent.
7734 *
7735 * @return Returns the same Intent object, for chaining multiple calls
7736 * into a single statement.
7737 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007738 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007739 * @see #setData
7740 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007741 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007742 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007743 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007744 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007745 mData = data;
7746 mType = type;
7747 return this;
7748 }
7749
7750 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007751 * (Usually optional) Normalize and set both the data Uri and an explicit
7752 * MIME data type. This method should very rarely be used -- it allows you
7753 * to override the MIME type that would ordinarily be inferred from the
7754 * data with your own type given here.
7755 *
7756 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007757 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007758 * before they are set, so really this is just a convenience method for
7759 * <pre>
7760 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7761 * </pre>
7762 *
7763 * @param data The Uri of the data this intent is now targeting.
7764 * @param type The MIME type of the data being handled by this intent.
7765 *
7766 * @return Returns the same Intent object, for chaining multiple calls
7767 * into a single statement.
7768 *
7769 * @see #setType
7770 * @see #setData
7771 * @see #setDataAndType
7772 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007773 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007774 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007775 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007776 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007777 }
7778
7779 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007780 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007781 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007782 * activities that provide <em>all</em> of the requested categories will be
7783 * used.
7784 *
7785 * @param category The desired category. This can be either one of the
7786 * predefined Intent categories, or a custom category in your own
7787 * namespace.
7788 *
7789 * @return Returns the same Intent object, for chaining multiple calls
7790 * into a single statement.
7791 *
7792 * @see #hasCategory
7793 * @see #removeCategory
7794 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007795 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007796 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007797 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007798 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007799 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007800 return this;
7801 }
7802
7803 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007804 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007805 *
7806 * @param category The category to remove.
7807 *
7808 * @see #addCategory
7809 */
7810 public void removeCategory(String category) {
7811 if (mCategories != null) {
7812 mCategories.remove(category);
7813 if (mCategories.size() == 0) {
7814 mCategories = null;
7815 }
7816 }
7817 }
7818
7819 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007820 * Set a selector for this Intent. This is a modification to the kinds of
7821 * things the Intent will match. If the selector is set, it will be used
7822 * when trying to find entities that can handle the Intent, instead of the
7823 * main contents of the Intent. This allows you build an Intent containing
7824 * a generic protocol while targeting it more specifically.
7825 *
7826 * <p>An example of where this may be used is with things like
7827 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7828 * Intent that will launch the Browser application. However, the correct
7829 * main entry point of an application is actually {@link #ACTION_MAIN}
7830 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7831 * used to specify the actual Activity to launch. If you launch the browser
7832 * with something different, undesired behavior may happen if the user has
7833 * previously or later launches it the normal way, since they do not match.
7834 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7835 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7836 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7837 *
7838 * <p>Setting a selector does not impact the behavior of
7839 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7840 * desired behavior of a selector -- it does not impact the base meaning
7841 * of the Intent, just what kinds of things will be matched against it
7842 * when determining who can handle it.</p>
7843 *
7844 * <p>You can not use both a selector and {@link #setPackage(String)} on
7845 * the same base Intent.</p>
7846 *
7847 * @param selector The desired selector Intent; set to null to not use
7848 * a special selector.
7849 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007850 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007851 if (selector == this) {
7852 throw new IllegalArgumentException(
7853 "Intent being set as a selector of itself");
7854 }
7855 if (selector != null && mPackage != null) {
7856 throw new IllegalArgumentException(
7857 "Can't set selector when package name is already set");
7858 }
7859 mSelector = selector;
7860 }
7861
7862 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007863 * Set a {@link ClipData} associated with this Intent. This replaces any
7864 * previously set ClipData.
7865 *
7866 * <p>The ClipData in an intent is not used for Intent matching or other
7867 * such operations. Semantically it is like extras, used to transmit
7868 * additional data with the Intent. The main feature of using this over
7869 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7870 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7871 * items included in the clip data. This is useful, in particular, if
7872 * you want to transmit an Intent containing multiple <code>content:</code>
7873 * URIs for which the recipient may not have global permission to access the
7874 * content provider.
7875 *
7876 * <p>If the ClipData contains items that are themselves Intents, any
7877 * grant flags in those Intents will be ignored. Only the top-level flags
7878 * of the main Intent are respected, and will be applied to all Uri or
7879 * Intent items in the clip (or sub-items of the clip).
7880 *
7881 * <p>The MIME type, label, and icon in the ClipData object are not
7882 * directly used by Intent. Applications should generally rely on the
7883 * MIME type of the Intent itself, not what it may find in the ClipData.
7884 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007885 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007886 *
7887 * @param clip The new clip to set. May be null to clear the current clip.
7888 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007889 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007890 mClipData = clip;
7891 }
7892
7893 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007894 * This is NOT a secure mechanism to identify the user who sent the intent.
7895 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7896 * who sent the intent.
7897 * @hide
7898 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007899 public void prepareToLeaveUser(int userId) {
7900 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7901 // We want mContentUserHint to refer to the original user, so don't do anything.
7902 if (mContentUserHint == UserHandle.USER_CURRENT) {
7903 mContentUserHint = userId;
7904 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007905 }
7906
7907 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007908 * Add extended data to the intent. The name must include a package
7909 * prefix, for example the app com.android.contacts would use names
7910 * like "com.android.contacts.ShowAll".
7911 *
7912 * @param name The name of the extra data, with package prefix.
7913 * @param value The boolean data value.
7914 *
7915 * @return Returns the same Intent object, for chaining multiple calls
7916 * into a single statement.
7917 *
7918 * @see #putExtras
7919 * @see #removeExtra
7920 * @see #getBooleanExtra(String, boolean)
7921 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007922 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007923 if (mExtras == null) {
7924 mExtras = new Bundle();
7925 }
7926 mExtras.putBoolean(name, value);
7927 return this;
7928 }
7929
7930 /**
7931 * Add extended data to the intent. The name must include a package
7932 * prefix, for example the app com.android.contacts would use names
7933 * like "com.android.contacts.ShowAll".
7934 *
7935 * @param name The name of the extra data, with package prefix.
7936 * @param value The byte data value.
7937 *
7938 * @return Returns the same Intent object, for chaining multiple calls
7939 * into a single statement.
7940 *
7941 * @see #putExtras
7942 * @see #removeExtra
7943 * @see #getByteExtra(String, byte)
7944 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007945 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007946 if (mExtras == null) {
7947 mExtras = new Bundle();
7948 }
7949 mExtras.putByte(name, value);
7950 return this;
7951 }
7952
7953 /**
7954 * Add extended data to the intent. The name must include a package
7955 * prefix, for example the app com.android.contacts would use names
7956 * like "com.android.contacts.ShowAll".
7957 *
7958 * @param name The name of the extra data, with package prefix.
7959 * @param value The char data value.
7960 *
7961 * @return Returns the same Intent object, for chaining multiple calls
7962 * into a single statement.
7963 *
7964 * @see #putExtras
7965 * @see #removeExtra
7966 * @see #getCharExtra(String, char)
7967 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007968 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007969 if (mExtras == null) {
7970 mExtras = new Bundle();
7971 }
7972 mExtras.putChar(name, value);
7973 return this;
7974 }
7975
7976 /**
7977 * Add extended data to the intent. The name must include a package
7978 * prefix, for example the app com.android.contacts would use names
7979 * like "com.android.contacts.ShowAll".
7980 *
7981 * @param name The name of the extra data, with package prefix.
7982 * @param value The short data value.
7983 *
7984 * @return Returns the same Intent object, for chaining multiple calls
7985 * into a single statement.
7986 *
7987 * @see #putExtras
7988 * @see #removeExtra
7989 * @see #getShortExtra(String, short)
7990 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007991 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007992 if (mExtras == null) {
7993 mExtras = new Bundle();
7994 }
7995 mExtras.putShort(name, value);
7996 return this;
7997 }
7998
7999 /**
8000 * Add extended data to the intent. The name must include a package
8001 * prefix, for example the app com.android.contacts would use names
8002 * like "com.android.contacts.ShowAll".
8003 *
8004 * @param name The name of the extra data, with package prefix.
8005 * @param value The integer data value.
8006 *
8007 * @return Returns the same Intent object, for chaining multiple calls
8008 * into a single statement.
8009 *
8010 * @see #putExtras
8011 * @see #removeExtra
8012 * @see #getIntExtra(String, int)
8013 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008014 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008015 if (mExtras == null) {
8016 mExtras = new Bundle();
8017 }
8018 mExtras.putInt(name, value);
8019 return this;
8020 }
8021
8022 /**
8023 * Add extended data to the intent. The name must include a package
8024 * prefix, for example the app com.android.contacts would use names
8025 * like "com.android.contacts.ShowAll".
8026 *
8027 * @param name The name of the extra data, with package prefix.
8028 * @param value The long data value.
8029 *
8030 * @return Returns the same Intent object, for chaining multiple calls
8031 * into a single statement.
8032 *
8033 * @see #putExtras
8034 * @see #removeExtra
8035 * @see #getLongExtra(String, long)
8036 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008037 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008038 if (mExtras == null) {
8039 mExtras = new Bundle();
8040 }
8041 mExtras.putLong(name, value);
8042 return this;
8043 }
8044
8045 /**
8046 * Add extended data to the intent. The name must include a package
8047 * prefix, for example the app com.android.contacts would use names
8048 * like "com.android.contacts.ShowAll".
8049 *
8050 * @param name The name of the extra data, with package prefix.
8051 * @param value The float data value.
8052 *
8053 * @return Returns the same Intent object, for chaining multiple calls
8054 * into a single statement.
8055 *
8056 * @see #putExtras
8057 * @see #removeExtra
8058 * @see #getFloatExtra(String, float)
8059 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008060 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008061 if (mExtras == null) {
8062 mExtras = new Bundle();
8063 }
8064 mExtras.putFloat(name, value);
8065 return this;
8066 }
8067
8068 /**
8069 * Add extended data to the intent. The name must include a package
8070 * prefix, for example the app com.android.contacts would use names
8071 * like "com.android.contacts.ShowAll".
8072 *
8073 * @param name The name of the extra data, with package prefix.
8074 * @param value The double data value.
8075 *
8076 * @return Returns the same Intent object, for chaining multiple calls
8077 * into a single statement.
8078 *
8079 * @see #putExtras
8080 * @see #removeExtra
8081 * @see #getDoubleExtra(String, double)
8082 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008083 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008084 if (mExtras == null) {
8085 mExtras = new Bundle();
8086 }
8087 mExtras.putDouble(name, value);
8088 return this;
8089 }
8090
8091 /**
8092 * Add extended data to the intent. The name must include a package
8093 * prefix, for example the app com.android.contacts would use names
8094 * like "com.android.contacts.ShowAll".
8095 *
8096 * @param name The name of the extra data, with package prefix.
8097 * @param value The String data value.
8098 *
8099 * @return Returns the same Intent object, for chaining multiple calls
8100 * into a single statement.
8101 *
8102 * @see #putExtras
8103 * @see #removeExtra
8104 * @see #getStringExtra(String)
8105 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008106 public @NonNull Intent putExtra(String name, String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008107 if (mExtras == null) {
8108 mExtras = new Bundle();
8109 }
8110 mExtras.putString(name, value);
8111 return this;
8112 }
8113
8114 /**
8115 * Add extended data to the intent. The name must include a package
8116 * prefix, for example the app com.android.contacts would use names
8117 * like "com.android.contacts.ShowAll".
8118 *
8119 * @param name The name of the extra data, with package prefix.
8120 * @param value The CharSequence data value.
8121 *
8122 * @return Returns the same Intent object, for chaining multiple calls
8123 * into a single statement.
8124 *
8125 * @see #putExtras
8126 * @see #removeExtra
8127 * @see #getCharSequenceExtra(String)
8128 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008129 public @NonNull Intent putExtra(String name, CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008130 if (mExtras == null) {
8131 mExtras = new Bundle();
8132 }
8133 mExtras.putCharSequence(name, value);
8134 return this;
8135 }
8136
8137 /**
8138 * Add extended data to the intent. The name must include a package
8139 * prefix, for example the app com.android.contacts would use names
8140 * like "com.android.contacts.ShowAll".
8141 *
8142 * @param name The name of the extra data, with package prefix.
8143 * @param value The Parcelable data value.
8144 *
8145 * @return Returns the same Intent object, for chaining multiple calls
8146 * into a single statement.
8147 *
8148 * @see #putExtras
8149 * @see #removeExtra
8150 * @see #getParcelableExtra(String)
8151 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008152 public @NonNull Intent putExtra(String name, Parcelable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008153 if (mExtras == null) {
8154 mExtras = new Bundle();
8155 }
8156 mExtras.putParcelable(name, value);
8157 return this;
8158 }
8159
8160 /**
8161 * Add extended data to the intent. The name must include a package
8162 * prefix, for example the app com.android.contacts would use names
8163 * like "com.android.contacts.ShowAll".
8164 *
8165 * @param name The name of the extra data, with package prefix.
8166 * @param value The Parcelable[] data value.
8167 *
8168 * @return Returns the same Intent object, for chaining multiple calls
8169 * into a single statement.
8170 *
8171 * @see #putExtras
8172 * @see #removeExtra
8173 * @see #getParcelableArrayExtra(String)
8174 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008175 public @NonNull Intent putExtra(String name, Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008176 if (mExtras == null) {
8177 mExtras = new Bundle();
8178 }
8179 mExtras.putParcelableArray(name, value);
8180 return this;
8181 }
8182
8183 /**
8184 * Add extended data to the intent. The name must include a package
8185 * prefix, for example the app com.android.contacts would use names
8186 * like "com.android.contacts.ShowAll".
8187 *
8188 * @param name The name of the extra data, with package prefix.
8189 * @param value The ArrayList<Parcelable> data value.
8190 *
8191 * @return Returns the same Intent object, for chaining multiple calls
8192 * into a single statement.
8193 *
8194 * @see #putExtras
8195 * @see #removeExtra
8196 * @see #getParcelableArrayListExtra(String)
8197 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008198 public @NonNull Intent putParcelableArrayListExtra(String name,
8199 ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008200 if (mExtras == null) {
8201 mExtras = new Bundle();
8202 }
8203 mExtras.putParcelableArrayList(name, value);
8204 return this;
8205 }
8206
8207 /**
8208 * Add extended data to the intent. The name must include a package
8209 * prefix, for example the app com.android.contacts would use names
8210 * like "com.android.contacts.ShowAll".
8211 *
8212 * @param name The name of the extra data, with package prefix.
8213 * @param value The ArrayList<Integer> data value.
8214 *
8215 * @return Returns the same Intent object, for chaining multiple calls
8216 * into a single statement.
8217 *
8218 * @see #putExtras
8219 * @see #removeExtra
8220 * @see #getIntegerArrayListExtra(String)
8221 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008222 public @NonNull Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008223 if (mExtras == null) {
8224 mExtras = new Bundle();
8225 }
8226 mExtras.putIntegerArrayList(name, value);
8227 return this;
8228 }
8229
8230 /**
8231 * Add extended data to the intent. The name must include a package
8232 * prefix, for example the app com.android.contacts would use names
8233 * like "com.android.contacts.ShowAll".
8234 *
8235 * @param name The name of the extra data, with package prefix.
8236 * @param value The ArrayList<String> data value.
8237 *
8238 * @return Returns the same Intent object, for chaining multiple calls
8239 * into a single statement.
8240 *
8241 * @see #putExtras
8242 * @see #removeExtra
8243 * @see #getStringArrayListExtra(String)
8244 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008245 public @NonNull Intent putStringArrayListExtra(String name, ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008246 if (mExtras == null) {
8247 mExtras = new Bundle();
8248 }
8249 mExtras.putStringArrayList(name, value);
8250 return this;
8251 }
8252
8253 /**
8254 * Add extended data to the intent. The name must include a package
8255 * prefix, for example the app com.android.contacts would use names
8256 * like "com.android.contacts.ShowAll".
8257 *
8258 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008259 * @param value The ArrayList<CharSequence> data value.
8260 *
8261 * @return Returns the same Intent object, for chaining multiple calls
8262 * into a single statement.
8263 *
8264 * @see #putExtras
8265 * @see #removeExtra
8266 * @see #getCharSequenceArrayListExtra(String)
8267 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008268 public @NonNull Intent putCharSequenceArrayListExtra(String name,
8269 ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008270 if (mExtras == null) {
8271 mExtras = new Bundle();
8272 }
8273 mExtras.putCharSequenceArrayList(name, value);
8274 return this;
8275 }
8276
8277 /**
8278 * Add extended data to the intent. The name must include a package
8279 * prefix, for example the app com.android.contacts would use names
8280 * like "com.android.contacts.ShowAll".
8281 *
8282 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008283 * @param value The Serializable data value.
8284 *
8285 * @return Returns the same Intent object, for chaining multiple calls
8286 * into a single statement.
8287 *
8288 * @see #putExtras
8289 * @see #removeExtra
8290 * @see #getSerializableExtra(String)
8291 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008292 public @NonNull Intent putExtra(String name, Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008293 if (mExtras == null) {
8294 mExtras = new Bundle();
8295 }
8296 mExtras.putSerializable(name, value);
8297 return this;
8298 }
8299
8300 /**
8301 * Add extended data to the intent. The name must include a package
8302 * prefix, for example the app com.android.contacts would use names
8303 * like "com.android.contacts.ShowAll".
8304 *
8305 * @param name The name of the extra data, with package prefix.
8306 * @param value The boolean array data value.
8307 *
8308 * @return Returns the same Intent object, for chaining multiple calls
8309 * into a single statement.
8310 *
8311 * @see #putExtras
8312 * @see #removeExtra
8313 * @see #getBooleanArrayExtra(String)
8314 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008315 public @NonNull Intent putExtra(String name, boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008316 if (mExtras == null) {
8317 mExtras = new Bundle();
8318 }
8319 mExtras.putBooleanArray(name, value);
8320 return this;
8321 }
8322
8323 /**
8324 * Add extended data to the intent. The name must include a package
8325 * prefix, for example the app com.android.contacts would use names
8326 * like "com.android.contacts.ShowAll".
8327 *
8328 * @param name The name of the extra data, with package prefix.
8329 * @param value The byte array data value.
8330 *
8331 * @return Returns the same Intent object, for chaining multiple calls
8332 * into a single statement.
8333 *
8334 * @see #putExtras
8335 * @see #removeExtra
8336 * @see #getByteArrayExtra(String)
8337 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008338 public @NonNull Intent putExtra(String name, byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008339 if (mExtras == null) {
8340 mExtras = new Bundle();
8341 }
8342 mExtras.putByteArray(name, value);
8343 return this;
8344 }
8345
8346 /**
8347 * Add extended data to the intent. The name must include a package
8348 * prefix, for example the app com.android.contacts would use names
8349 * like "com.android.contacts.ShowAll".
8350 *
8351 * @param name The name of the extra data, with package prefix.
8352 * @param value The short array data value.
8353 *
8354 * @return Returns the same Intent object, for chaining multiple calls
8355 * into a single statement.
8356 *
8357 * @see #putExtras
8358 * @see #removeExtra
8359 * @see #getShortArrayExtra(String)
8360 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008361 public @NonNull Intent putExtra(String name, short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008362 if (mExtras == null) {
8363 mExtras = new Bundle();
8364 }
8365 mExtras.putShortArray(name, value);
8366 return this;
8367 }
8368
8369 /**
8370 * Add extended data to the intent. The name must include a package
8371 * prefix, for example the app com.android.contacts would use names
8372 * like "com.android.contacts.ShowAll".
8373 *
8374 * @param name The name of the extra data, with package prefix.
8375 * @param value The char array data value.
8376 *
8377 * @return Returns the same Intent object, for chaining multiple calls
8378 * into a single statement.
8379 *
8380 * @see #putExtras
8381 * @see #removeExtra
8382 * @see #getCharArrayExtra(String)
8383 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008384 public @NonNull Intent putExtra(String name, char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008385 if (mExtras == null) {
8386 mExtras = new Bundle();
8387 }
8388 mExtras.putCharArray(name, value);
8389 return this;
8390 }
8391
8392 /**
8393 * Add extended data to the intent. The name must include a package
8394 * prefix, for example the app com.android.contacts would use names
8395 * like "com.android.contacts.ShowAll".
8396 *
8397 * @param name The name of the extra data, with package prefix.
8398 * @param value The int array data value.
8399 *
8400 * @return Returns the same Intent object, for chaining multiple calls
8401 * into a single statement.
8402 *
8403 * @see #putExtras
8404 * @see #removeExtra
8405 * @see #getIntArrayExtra(String)
8406 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008407 public @NonNull Intent putExtra(String name, int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008408 if (mExtras == null) {
8409 mExtras = new Bundle();
8410 }
8411 mExtras.putIntArray(name, value);
8412 return this;
8413 }
8414
8415 /**
8416 * Add extended data to the intent. The name must include a package
8417 * prefix, for example the app com.android.contacts would use names
8418 * like "com.android.contacts.ShowAll".
8419 *
8420 * @param name The name of the extra data, with package prefix.
8421 * @param value The byte array data value.
8422 *
8423 * @return Returns the same Intent object, for chaining multiple calls
8424 * into a single statement.
8425 *
8426 * @see #putExtras
8427 * @see #removeExtra
8428 * @see #getLongArrayExtra(String)
8429 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008430 public @NonNull Intent putExtra(String name, long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008431 if (mExtras == null) {
8432 mExtras = new Bundle();
8433 }
8434 mExtras.putLongArray(name, value);
8435 return this;
8436 }
8437
8438 /**
8439 * Add extended data to the intent. The name must include a package
8440 * prefix, for example the app com.android.contacts would use names
8441 * like "com.android.contacts.ShowAll".
8442 *
8443 * @param name The name of the extra data, with package prefix.
8444 * @param value The float array data value.
8445 *
8446 * @return Returns the same Intent object, for chaining multiple calls
8447 * into a single statement.
8448 *
8449 * @see #putExtras
8450 * @see #removeExtra
8451 * @see #getFloatArrayExtra(String)
8452 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008453 public @NonNull Intent putExtra(String name, float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008454 if (mExtras == null) {
8455 mExtras = new Bundle();
8456 }
8457 mExtras.putFloatArray(name, value);
8458 return this;
8459 }
8460
8461 /**
8462 * Add extended data to the intent. The name must include a package
8463 * prefix, for example the app com.android.contacts would use names
8464 * like "com.android.contacts.ShowAll".
8465 *
8466 * @param name The name of the extra data, with package prefix.
8467 * @param value The double array data value.
8468 *
8469 * @return Returns the same Intent object, for chaining multiple calls
8470 * into a single statement.
8471 *
8472 * @see #putExtras
8473 * @see #removeExtra
8474 * @see #getDoubleArrayExtra(String)
8475 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008476 public @NonNull Intent putExtra(String name, double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008477 if (mExtras == null) {
8478 mExtras = new Bundle();
8479 }
8480 mExtras.putDoubleArray(name, value);
8481 return this;
8482 }
8483
8484 /**
8485 * Add extended data to the intent. The name must include a package
8486 * prefix, for example the app com.android.contacts would use names
8487 * like "com.android.contacts.ShowAll".
8488 *
8489 * @param name The name of the extra data, with package prefix.
8490 * @param value The String array data value.
8491 *
8492 * @return Returns the same Intent object, for chaining multiple calls
8493 * into a single statement.
8494 *
8495 * @see #putExtras
8496 * @see #removeExtra
8497 * @see #getStringArrayExtra(String)
8498 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008499 public @NonNull Intent putExtra(String name, String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008500 if (mExtras == null) {
8501 mExtras = new Bundle();
8502 }
8503 mExtras.putStringArray(name, value);
8504 return this;
8505 }
8506
8507 /**
8508 * Add extended data to the intent. The name must include a package
8509 * prefix, for example the app com.android.contacts would use names
8510 * like "com.android.contacts.ShowAll".
8511 *
8512 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008513 * @param value The CharSequence array data value.
8514 *
8515 * @return Returns the same Intent object, for chaining multiple calls
8516 * into a single statement.
8517 *
8518 * @see #putExtras
8519 * @see #removeExtra
8520 * @see #getCharSequenceArrayExtra(String)
8521 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008522 public @NonNull Intent putExtra(String name, CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008523 if (mExtras == null) {
8524 mExtras = new Bundle();
8525 }
8526 mExtras.putCharSequenceArray(name, value);
8527 return this;
8528 }
8529
8530 /**
8531 * Add extended data to the intent. The name must include a package
8532 * prefix, for example the app com.android.contacts would use names
8533 * like "com.android.contacts.ShowAll".
8534 *
8535 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008536 * @param value The Bundle data value.
8537 *
8538 * @return Returns the same Intent object, for chaining multiple calls
8539 * into a single statement.
8540 *
8541 * @see #putExtras
8542 * @see #removeExtra
8543 * @see #getBundleExtra(String)
8544 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008545 public @NonNull Intent putExtra(String name, Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008546 if (mExtras == null) {
8547 mExtras = new Bundle();
8548 }
8549 mExtras.putBundle(name, value);
8550 return this;
8551 }
8552
8553 /**
8554 * Add extended data to the intent. The name must include a package
8555 * prefix, for example the app com.android.contacts would use names
8556 * like "com.android.contacts.ShowAll".
8557 *
8558 * @param name The name of the extra data, with package prefix.
8559 * @param value The IBinder data value.
8560 *
8561 * @return Returns the same Intent object, for chaining multiple calls
8562 * into a single statement.
8563 *
8564 * @see #putExtras
8565 * @see #removeExtra
8566 * @see #getIBinderExtra(String)
8567 *
8568 * @deprecated
8569 * @hide
8570 */
8571 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008572 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008573 if (mExtras == null) {
8574 mExtras = new Bundle();
8575 }
8576 mExtras.putIBinder(name, value);
8577 return this;
8578 }
8579
8580 /**
8581 * Copy all extras in 'src' in to this intent.
8582 *
8583 * @param src Contains the extras to copy.
8584 *
8585 * @see #putExtra
8586 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008587 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008588 if (src.mExtras != null) {
8589 if (mExtras == null) {
8590 mExtras = new Bundle(src.mExtras);
8591 } else {
8592 mExtras.putAll(src.mExtras);
8593 }
8594 }
8595 return this;
8596 }
8597
8598 /**
8599 * Add a set of extended data to the intent. The keys must include a package
8600 * prefix, for example the app com.android.contacts would use names
8601 * like "com.android.contacts.ShowAll".
8602 *
8603 * @param extras The Bundle of extras to add to this intent.
8604 *
8605 * @see #putExtra
8606 * @see #removeExtra
8607 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008608 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008609 if (mExtras == null) {
8610 mExtras = new Bundle();
8611 }
8612 mExtras.putAll(extras);
8613 return this;
8614 }
8615
8616 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008617 * Completely replace the extras in the Intent with the extras in the
8618 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008619 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008620 * @param src The exact extras contained in this Intent are copied
8621 * into the target intent, replacing any that were previously there.
8622 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008623 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008624 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8625 return this;
8626 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008627
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008628 /**
8629 * Completely replace the extras in the Intent with the given Bundle of
8630 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008631 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008632 * @param extras The new set of extras in the Intent, or null to erase
8633 * all extras.
8634 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008635 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008636 mExtras = extras != null ? new Bundle(extras) : null;
8637 return this;
8638 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008639
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008640 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008641 * Remove extended data from the intent.
8642 *
8643 * @see #putExtra
8644 */
8645 public void removeExtra(String name) {
8646 if (mExtras != null) {
8647 mExtras.remove(name);
8648 if (mExtras.size() == 0) {
8649 mExtras = null;
8650 }
8651 }
8652 }
8653
8654 /**
8655 * Set special flags controlling how this intent is handled. Most values
8656 * here depend on the type of component being executed by the Intent,
8657 * specifically the FLAG_ACTIVITY_* flags are all for use with
8658 * {@link Context#startActivity Context.startActivity()} and the
8659 * FLAG_RECEIVER_* flags are all for use with
8660 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8661 *
Scott Main7aee61f2011-02-08 11:25:01 -08008662 * <p>See the
8663 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8664 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008665 * the behavior of your application.
8666 *
8667 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008668 * @return Returns the same Intent object, for chaining multiple calls
8669 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008670 * @see #getFlags
8671 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008672 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008673 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008674 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008675 mFlags = flags;
8676 return this;
8677 }
8678
8679 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008680 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008681 *
8682 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008683 * @return Returns the same Intent object, for chaining multiple calls into
8684 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008685 * @see #setFlags
8686 * @see #getFlags
8687 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008688 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008689 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008690 mFlags |= flags;
8691 return this;
8692 }
8693
8694 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008695 * Remove these flags from the intent.
8696 *
8697 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008698 * @see #setFlags
8699 * @see #getFlags
8700 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008701 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008702 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008703 mFlags &= ~flags;
8704 }
8705
8706 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008707 * (Usually optional) Set an explicit application package name that limits
8708 * the components this Intent will resolve to. If left to the default
8709 * value of null, all components in all applications will considered.
8710 * If non-null, the Intent can only match the components in the given
8711 * application package.
8712 *
8713 * @param packageName The name of the application package to handle the
8714 * intent, or null to allow any application package.
8715 *
8716 * @return Returns the same Intent object, for chaining multiple calls
8717 * into a single statement.
8718 *
8719 * @see #getPackage
8720 * @see #resolveActivity
8721 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008722 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008723 if (packageName != null && mSelector != null) {
8724 throw new IllegalArgumentException(
8725 "Can't set package name when selector is already set");
8726 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008727 mPackage = packageName;
8728 return this;
8729 }
8730
8731 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008732 * (Usually optional) Explicitly set the component to handle the intent.
8733 * If left with the default value of null, the system will determine the
8734 * appropriate class to use based on the other fields (action, data,
8735 * type, categories) in the Intent. If this class is defined, the
8736 * specified class will always be used regardless of the other fields. You
8737 * should only set this value when you know you absolutely want a specific
8738 * class to be used; otherwise it is better to let the system find the
8739 * appropriate class so that you will respect the installed applications
8740 * and user preferences.
8741 *
8742 * @param component The name of the application component to handle the
8743 * intent, or null to let the system find one for you.
8744 *
8745 * @return Returns the same Intent object, for chaining multiple calls
8746 * into a single statement.
8747 *
8748 * @see #setClass
8749 * @see #setClassName(Context, String)
8750 * @see #setClassName(String, String)
8751 * @see #getComponent
8752 * @see #resolveActivity
8753 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008754 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008755 mComponent = component;
8756 return this;
8757 }
8758
8759 /**
8760 * Convenience for calling {@link #setComponent} with an
8761 * explicit class name.
8762 *
8763 * @param packageContext A Context of the application package implementing
8764 * this class.
8765 * @param className The name of a class inside of the application package
8766 * that will be used as the component for this Intent.
8767 *
8768 * @return Returns the same Intent object, for chaining multiple calls
8769 * into a single statement.
8770 *
8771 * @see #setComponent
8772 * @see #setClass
8773 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008774 public @NonNull Intent setClassName(@NonNull Context packageContext,
8775 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008776 mComponent = new ComponentName(packageContext, className);
8777 return this;
8778 }
8779
8780 /**
8781 * Convenience for calling {@link #setComponent} with an
8782 * explicit application package name and class name.
8783 *
8784 * @param packageName The name of the package implementing the desired
8785 * component.
8786 * @param className The name of a class inside of the application package
8787 * that will be used as the component for this Intent.
8788 *
8789 * @return Returns the same Intent object, for chaining multiple calls
8790 * into a single statement.
8791 *
8792 * @see #setComponent
8793 * @see #setClass
8794 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008795 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008796 mComponent = new ComponentName(packageName, className);
8797 return this;
8798 }
8799
8800 /**
8801 * Convenience for calling {@link #setComponent(ComponentName)} with the
8802 * name returned by a {@link Class} object.
8803 *
8804 * @param packageContext A Context of the application package implementing
8805 * this class.
8806 * @param cls The class name to set, equivalent to
8807 * <code>setClassName(context, cls.getName())</code>.
8808 *
8809 * @return Returns the same Intent object, for chaining multiple calls
8810 * into a single statement.
8811 *
8812 * @see #setComponent
8813 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008814 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008815 mComponent = new ComponentName(packageContext, cls);
8816 return this;
8817 }
8818
8819 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008820 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8821 * used as a hint to the receiver for animations and the like. Null means that there
8822 * is no source bounds.
8823 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008824 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008825 if (r != null) {
8826 mSourceBounds = new Rect(r);
8827 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008828 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008829 }
8830 }
8831
Tor Norbyed9273d62013-05-30 15:59:53 -07008832 /** @hide */
8833 @IntDef(flag = true,
8834 value = {
8835 FILL_IN_ACTION,
8836 FILL_IN_DATA,
8837 FILL_IN_CATEGORIES,
8838 FILL_IN_COMPONENT,
8839 FILL_IN_PACKAGE,
8840 FILL_IN_SOURCE_BOUNDS,
8841 FILL_IN_SELECTOR,
8842 FILL_IN_CLIP_DATA
8843 })
8844 @Retention(RetentionPolicy.SOURCE)
8845 public @interface FillInFlags {}
8846
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008847 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008848 * Use with {@link #fillIn} to allow the current action value to be
8849 * overwritten, even if it is already set.
8850 */
8851 public static final int FILL_IN_ACTION = 1<<0;
8852
8853 /**
8854 * Use with {@link #fillIn} to allow the current data or type value
8855 * overwritten, even if it is already set.
8856 */
8857 public static final int FILL_IN_DATA = 1<<1;
8858
8859 /**
8860 * Use with {@link #fillIn} to allow the current categories to be
8861 * overwritten, even if they are already set.
8862 */
8863 public static final int FILL_IN_CATEGORIES = 1<<2;
8864
8865 /**
8866 * Use with {@link #fillIn} to allow the current component value to be
8867 * overwritten, even if it is already set.
8868 */
8869 public static final int FILL_IN_COMPONENT = 1<<3;
8870
8871 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008872 * Use with {@link #fillIn} to allow the current package value to be
8873 * overwritten, even if it is already set.
8874 */
8875 public static final int FILL_IN_PACKAGE = 1<<4;
8876
8877 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008878 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008879 * overwritten, even if it is already set.
8880 */
8881 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8882
8883 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008884 * Use with {@link #fillIn} to allow the current selector to be
8885 * overwritten, even if it is already set.
8886 */
8887 public static final int FILL_IN_SELECTOR = 1<<6;
8888
8889 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008890 * Use with {@link #fillIn} to allow the current ClipData to be
8891 * overwritten, even if it is already set.
8892 */
8893 public static final int FILL_IN_CLIP_DATA = 1<<7;
8894
8895 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008896 * Copy the contents of <var>other</var> in to this object, but only
8897 * where fields are not defined by this object. For purposes of a field
8898 * being defined, the following pieces of data in the Intent are
8899 * considered to be separate fields:
8900 *
8901 * <ul>
8902 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008903 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008904 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8905 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008906 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008907 * <li> component, as set by {@link #setComponent(ComponentName)} or
8908 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008909 * <li> source bounds, as set by {@link #setSourceBounds}.
8910 * <li> selector, as set by {@link #setSelector(Intent)}.
8911 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008912 * <li> each top-level name in the associated extras.
8913 * </ul>
8914 *
8915 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008916 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008917 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8918 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8919 * the restriction where the corresponding field will not be replaced if
8920 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008921 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008922 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8923 * is explicitly specified. The selector will only be copied if
8924 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008925 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008926 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8927 * and Intent B with {action="gotit", data-type="some/thing",
8928 * categories="one","two"}.
8929 *
8930 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8931 * containing: {action="gotit", data-type="some/thing",
8932 * categories="bar"}.
8933 *
8934 * @param other Another Intent whose values are to be used to fill in
8935 * the current one.
8936 * @param flags Options to control which fields can be filled in.
8937 *
8938 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008939 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008940 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08008941 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07008942 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008943 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008944 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008945 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008946 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008947 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008948 if (other.mAction != null
8949 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008950 mAction = other.mAction;
8951 changes |= FILL_IN_ACTION;
8952 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008953 if ((other.mData != null || other.mType != null)
8954 && ((mData == null && mType == null)
8955 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008956 mData = other.mData;
8957 mType = other.mType;
8958 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008959 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008960 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008961 if (other.mCategories != null
8962 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008963 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008964 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008965 }
8966 changes |= FILL_IN_CATEGORIES;
8967 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008968 if (other.mPackage != null
8969 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008970 // Only do this if mSelector is not set.
8971 if (mSelector == null) {
8972 mPackage = other.mPackage;
8973 changes |= FILL_IN_PACKAGE;
8974 }
8975 }
8976 // Selector is special: it can only be set if explicitly allowed,
8977 // for the same reason as the component name.
8978 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8979 if (mPackage == null) {
8980 mSelector = new Intent(other.mSelector);
8981 mPackage = null;
8982 changes |= FILL_IN_SELECTOR;
8983 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008984 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008985 if (other.mClipData != null
8986 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8987 mClipData = other.mClipData;
8988 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008989 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008990 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008991 // Component is special: it can -only- be set if explicitly allowed,
8992 // since otherwise the sender could force the intent somewhere the
8993 // originator didn't intend.
8994 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008995 mComponent = other.mComponent;
8996 changes |= FILL_IN_COMPONENT;
8997 }
8998 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008999 if (other.mSourceBounds != null
9000 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
9001 mSourceBounds = new Rect(other.mSourceBounds);
9002 changes |= FILL_IN_SOURCE_BOUNDS;
9003 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009004 if (mExtras == null) {
9005 if (other.mExtras != null) {
9006 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009007 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009008 }
9009 } else if (other.mExtras != null) {
9010 try {
9011 Bundle newb = new Bundle(other.mExtras);
9012 newb.putAll(mExtras);
9013 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009014 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009015 } catch (RuntimeException e) {
9016 // Modifying the extras can cause us to unparcel the contents
9017 // of the bundle, and if we do this in the system process that
9018 // may fail. We really should handle this (i.e., the Bundle
9019 // impl shouldn't be on top of a plain map), but for now just
9020 // ignore it and keep the original contents. :(
9021 Log.w("Intent", "Failure filling in extras", e);
9022 }
9023 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009024 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9025 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9026 mContentUserHint = other.mContentUserHint;
9027 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009028 return changes;
9029 }
9030
9031 /**
9032 * Wrapper class holding an Intent and implementing comparisons on it for
9033 * the purpose of filtering. The class implements its
9034 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9035 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9036 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9037 * on the wrapped Intent.
9038 */
9039 public static final class FilterComparison {
9040 private final Intent mIntent;
9041 private final int mHashCode;
9042
9043 public FilterComparison(Intent intent) {
9044 mIntent = intent;
9045 mHashCode = intent.filterHashCode();
9046 }
9047
9048 /**
9049 * Return the Intent that this FilterComparison represents.
9050 * @return Returns the Intent held by the FilterComparison. Do
9051 * not modify!
9052 */
9053 public Intent getIntent() {
9054 return mIntent;
9055 }
9056
9057 @Override
9058 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009059 if (obj instanceof FilterComparison) {
9060 Intent other = ((FilterComparison)obj).mIntent;
9061 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009062 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009063 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009064 }
9065
9066 @Override
9067 public int hashCode() {
9068 return mHashCode;
9069 }
9070 }
9071
9072 /**
9073 * Determine if two intents are the same for the purposes of intent
9074 * resolution (filtering). That is, if their action, data, type,
9075 * class, and categories are the same. This does <em>not</em> compare
9076 * any extra data included in the intents.
9077 *
9078 * @param other The other Intent to compare against.
9079 *
9080 * @return Returns true if action, data, type, class, and categories
9081 * are the same.
9082 */
9083 public boolean filterEquals(Intent other) {
9084 if (other == null) {
9085 return false;
9086 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009087 if (!Objects.equals(this.mAction, other.mAction)) return false;
9088 if (!Objects.equals(this.mData, other.mData)) return false;
9089 if (!Objects.equals(this.mType, other.mType)) return false;
9090 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9091 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9092 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009093
9094 return true;
9095 }
9096
9097 /**
9098 * Generate hash code that matches semantics of filterEquals().
9099 *
9100 * @return Returns the hash value of the action, data, type, class, and
9101 * categories.
9102 *
9103 * @see #filterEquals
9104 */
9105 public int filterHashCode() {
9106 int code = 0;
9107 if (mAction != null) {
9108 code += mAction.hashCode();
9109 }
9110 if (mData != null) {
9111 code += mData.hashCode();
9112 }
9113 if (mType != null) {
9114 code += mType.hashCode();
9115 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009116 if (mPackage != null) {
9117 code += mPackage.hashCode();
9118 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009119 if (mComponent != null) {
9120 code += mComponent.hashCode();
9121 }
9122 if (mCategories != null) {
9123 code += mCategories.hashCode();
9124 }
9125 return code;
9126 }
9127
9128 @Override
9129 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009130 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009131
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009132 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009133 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009134 b.append(" }");
9135
9136 return b.toString();
9137 }
9138
9139 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009140 public String toInsecureString() {
9141 StringBuilder b = new StringBuilder(128);
9142
9143 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009144 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009145 b.append(" }");
9146
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009147 return b.toString();
9148 }
Romain Guy4969af72009-06-17 10:53:19 -07009149
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009150 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009151 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009152 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009153
9154 b.append("Intent { ");
9155 toShortString(b, false, true, true, true);
9156 b.append(" }");
9157
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009158 return b.toString();
9159 }
9160
9161 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009162 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9163 StringBuilder b = new StringBuilder(128);
9164 toShortString(b, secure, comp, extras, clip);
9165 return b.toString();
9166 }
9167
9168 /** @hide */
9169 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9170 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009171 boolean first = true;
9172 if (mAction != null) {
9173 b.append("act=").append(mAction);
9174 first = false;
9175 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009176 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009177 if (!first) {
9178 b.append(' ');
9179 }
9180 first = false;
9181 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009182 for (int i=0; i<mCategories.size(); i++) {
9183 if (i > 0) b.append(',');
9184 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009185 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009186 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009187 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009188 if (mData != null) {
9189 if (!first) {
9190 b.append(' ');
9191 }
9192 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009193 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009194 if (secure) {
9195 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009196 } else {
9197 b.append(mData);
9198 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009199 }
9200 if (mType != null) {
9201 if (!first) {
9202 b.append(' ');
9203 }
9204 first = false;
9205 b.append("typ=").append(mType);
9206 }
9207 if (mFlags != 0) {
9208 if (!first) {
9209 b.append(' ');
9210 }
9211 first = false;
9212 b.append("flg=0x").append(Integer.toHexString(mFlags));
9213 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009214 if (mPackage != null) {
9215 if (!first) {
9216 b.append(' ');
9217 }
9218 first = false;
9219 b.append("pkg=").append(mPackage);
9220 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009221 if (comp && mComponent != null) {
9222 if (!first) {
9223 b.append(' ');
9224 }
9225 first = false;
9226 b.append("cmp=").append(mComponent.flattenToShortString());
9227 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009228 if (mSourceBounds != null) {
9229 if (!first) {
9230 b.append(' ');
9231 }
9232 first = false;
9233 b.append("bnds=").append(mSourceBounds.toShortString());
9234 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009235 if (mClipData != null) {
9236 if (!first) {
9237 b.append(' ');
9238 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009239 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009240 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009241 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009242 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009243 if (mClipData.getDescription() != null) {
9244 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9245 } else {
9246 first = true;
9247 }
9248 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009249 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009250 first = false;
9251 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009252 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009253 if (extras && mExtras != null) {
9254 if (!first) {
9255 b.append(' ');
9256 }
9257 first = false;
9258 b.append("(has extras)");
9259 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009260 if (mContentUserHint != UserHandle.USER_CURRENT) {
9261 if (!first) {
9262 b.append(' ');
9263 }
9264 first = false;
9265 b.append("u=").append(mContentUserHint);
9266 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009267 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009268 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009269 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009270 b.append("}");
9271 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009272 }
9273
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009274 /**
9275 * Call {@link #toUri} with 0 flags.
9276 * @deprecated Use {@link #toUri} instead.
9277 */
9278 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009279 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009280 return toUri(0);
9281 }
9282
9283 /**
9284 * Convert this Intent into a String holding a URI representation of it.
9285 * The returned URI string has been properly URI encoded, so it can be
9286 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9287 * Intent's data as the base URI, with an additional fragment describing
9288 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009289 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009290 * <p>You can convert the returned string back to an Intent with
9291 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009292 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009293 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009294 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009295 * @return Returns a URI encoding URI string describing the entire contents
9296 * of the Intent.
9297 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009298 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009299 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009300 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9301 if (mPackage == null) {
9302 throw new IllegalArgumentException(
9303 "Intent must include an explicit package name to build an android-app: "
9304 + this);
9305 }
9306 uri.append("android-app://");
9307 uri.append(mPackage);
9308 String scheme = null;
9309 if (mData != null) {
9310 scheme = mData.getScheme();
9311 if (scheme != null) {
9312 uri.append('/');
9313 uri.append(scheme);
9314 String authority = mData.getEncodedAuthority();
9315 if (authority != null) {
9316 uri.append('/');
9317 uri.append(authority);
9318 String path = mData.getEncodedPath();
9319 if (path != null) {
9320 uri.append(path);
9321 }
9322 String queryParams = mData.getEncodedQuery();
9323 if (queryParams != null) {
9324 uri.append('?');
9325 uri.append(queryParams);
9326 }
9327 String fragment = mData.getEncodedFragment();
9328 if (fragment != null) {
9329 uri.append('#');
9330 uri.append(fragment);
9331 }
9332 }
9333 }
9334 }
9335 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9336 mPackage, flags);
9337 return uri.toString();
9338 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009339 String scheme = null;
9340 if (mData != null) {
9341 String data = mData.toString();
9342 if ((flags&URI_INTENT_SCHEME) != 0) {
9343 final int N = data.length();
9344 for (int i=0; i<N; i++) {
9345 char c = data.charAt(i);
9346 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
9347 || c == '.' || c == '-') {
9348 continue;
9349 }
9350 if (c == ':' && i > 0) {
9351 // Valid scheme.
9352 scheme = data.substring(0, i);
9353 uri.append("intent:");
9354 data = data.substring(i+1);
9355 break;
9356 }
Tom Taylord4a47292009-12-21 13:59:18 -08009357
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009358 // No scheme.
9359 break;
9360 }
9361 }
9362 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009363
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009364 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9365 uri.append("intent:");
9366 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009367
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009368 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009369
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009370 return uri.toString();
9371 }
9372
9373 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9374 String defPackage, int flags) {
9375 StringBuilder frag = new StringBuilder(128);
9376
9377 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009378 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009379 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009380 // Note that for now we are not going to try to handle the
9381 // data part; not clear how to represent this as a URI, and
9382 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009383 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9384 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009385 }
9386
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009387 if (frag.length() > 0) {
9388 uri.append("#Intent;");
9389 uri.append(frag);
9390 uri.append("end");
9391 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009392 }
9393
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009394 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9395 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009396 if (scheme != null) {
9397 uri.append("scheme=").append(scheme).append(';');
9398 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009399 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009400 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009401 }
9402 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009403 for (int i=0; i<mCategories.size(); i++) {
9404 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009405 }
9406 }
9407 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009408 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009409 }
9410 if (mFlags != 0) {
9411 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9412 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009413 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009414 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9415 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009416 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009417 uri.append("component=").append(Uri.encode(
9418 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009419 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009420 if (mSourceBounds != null) {
9421 uri.append("sourceBounds=")
9422 .append(Uri.encode(mSourceBounds.flattenToString()))
9423 .append(';');
9424 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009425 if (mExtras != null) {
9426 for (String key : mExtras.keySet()) {
9427 final Object value = mExtras.get(key);
9428 char entryType =
9429 value instanceof String ? 'S' :
9430 value instanceof Boolean ? 'B' :
9431 value instanceof Byte ? 'b' :
9432 value instanceof Character ? 'c' :
9433 value instanceof Double ? 'd' :
9434 value instanceof Float ? 'f' :
9435 value instanceof Integer ? 'i' :
9436 value instanceof Long ? 'l' :
9437 value instanceof Short ? 's' :
9438 '\0';
9439
9440 if (entryType != '\0') {
9441 uri.append(entryType);
9442 uri.append('.');
9443 uri.append(Uri.encode(key));
9444 uri.append('=');
9445 uri.append(Uri.encode(value.toString()));
9446 uri.append(';');
9447 }
9448 }
9449 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009450 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009451
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009452 public int describeContents() {
9453 return (mExtras != null) ? mExtras.describeContents() : 0;
9454 }
9455
9456 public void writeToParcel(Parcel out, int flags) {
9457 out.writeString(mAction);
9458 Uri.writeToParcel(out, mData);
9459 out.writeString(mType);
9460 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009461 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009462 ComponentName.writeToParcel(mComponent, out);
9463
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009464 if (mSourceBounds != null) {
9465 out.writeInt(1);
9466 mSourceBounds.writeToParcel(out, flags);
9467 } else {
9468 out.writeInt(0);
9469 }
9470
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009471 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009472 final int N = mCategories.size();
9473 out.writeInt(N);
9474 for (int i=0; i<N; i++) {
9475 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009476 }
9477 } else {
9478 out.writeInt(0);
9479 }
9480
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009481 if (mSelector != null) {
9482 out.writeInt(1);
9483 mSelector.writeToParcel(out, flags);
9484 } else {
9485 out.writeInt(0);
9486 }
9487
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009488 if (mClipData != null) {
9489 out.writeInt(1);
9490 mClipData.writeToParcel(out, flags);
9491 } else {
9492 out.writeInt(0);
9493 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009494 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009495 out.writeBundle(mExtras);
9496 }
9497
9498 public static final Parcelable.Creator<Intent> CREATOR
9499 = new Parcelable.Creator<Intent>() {
9500 public Intent createFromParcel(Parcel in) {
9501 return new Intent(in);
9502 }
9503 public Intent[] newArray(int size) {
9504 return new Intent[size];
9505 }
9506 };
9507
Dianne Hackborneb034652009-09-07 00:49:58 -07009508 /** @hide */
9509 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009510 readFromParcel(in);
9511 }
9512
9513 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009514 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009515 mData = Uri.CREATOR.createFromParcel(in);
9516 mType = in.readString();
9517 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009518 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009519 mComponent = ComponentName.readFromParcel(in);
9520
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009521 if (in.readInt() != 0) {
9522 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9523 }
9524
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009525 int N = in.readInt();
9526 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009527 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009528 int i;
9529 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009530 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009531 }
9532 } else {
9533 mCategories = null;
9534 }
9535
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009536 if (in.readInt() != 0) {
9537 mSelector = new Intent(in);
9538 }
9539
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009540 if (in.readInt() != 0) {
9541 mClipData = new ClipData(in);
9542 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009543 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009544 mExtras = in.readBundle();
9545 }
9546
9547 /**
9548 * Parses the "intent" element (and its children) from XML and instantiates
9549 * an Intent object. The given XML parser should be located at the tag
9550 * where parsing should start (often named "intent"), from which the
9551 * basic action, data, type, and package and class name will be
9552 * retrieved. The function will then parse in to any child elements,
9553 * looking for <category android:name="xxx"> tags to add categories and
9554 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9555 * to the intent.
9556 *
9557 * @param resources The Resources to use when inflating resources.
9558 * @param parser The XML parser pointing at an "intent" tag.
9559 * @param attrs The AttributeSet interface for retrieving extended
9560 * attribute data at the current <var>parser</var> location.
9561 * @return An Intent object matching the XML data.
9562 * @throws XmlPullParserException If there was an XML parsing error.
9563 * @throws IOException If there was an I/O error.
9564 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009565 public static @NonNull Intent parseIntent(@NonNull Resources resources,
9566 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009567 throws XmlPullParserException, IOException {
9568 Intent intent = new Intent();
9569
9570 TypedArray sa = resources.obtainAttributes(attrs,
9571 com.android.internal.R.styleable.Intent);
9572
9573 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9574
9575 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9576 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9577 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9578
9579 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9580 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9581 if (packageName != null && className != null) {
9582 intent.setComponent(new ComponentName(packageName, className));
9583 }
9584
9585 sa.recycle();
9586
9587 int outerDepth = parser.getDepth();
9588 int type;
9589 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9590 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9591 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9592 continue;
9593 }
9594
9595 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009596 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009597 sa = resources.obtainAttributes(attrs,
9598 com.android.internal.R.styleable.IntentCategory);
9599 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9600 sa.recycle();
9601
9602 if (cat != null) {
9603 intent.addCategory(cat);
9604 }
9605 XmlUtils.skipCurrentTag(parser);
9606
Craig Mautner21d24a22014-04-23 11:45:37 -07009607 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009608 if (intent.mExtras == null) {
9609 intent.mExtras = new Bundle();
9610 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009611 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009612 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009613
9614 } else {
9615 XmlUtils.skipCurrentTag(parser);
9616 }
9617 }
9618
9619 return intent;
9620 }
Nick Pellyccae4122012-01-09 14:12:58 -08009621
Craig Mautner21d24a22014-04-23 11:45:37 -07009622 /** @hide */
9623 public void saveToXml(XmlSerializer out) throws IOException {
9624 if (mAction != null) {
9625 out.attribute(null, ATTR_ACTION, mAction);
9626 }
9627 if (mData != null) {
9628 out.attribute(null, ATTR_DATA, mData.toString());
9629 }
9630 if (mType != null) {
9631 out.attribute(null, ATTR_TYPE, mType);
9632 }
9633 if (mComponent != null) {
9634 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9635 }
9636 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9637
9638 if (mCategories != null) {
9639 out.startTag(null, TAG_CATEGORIES);
9640 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9641 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9642 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009643 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009644 }
9645 }
9646
9647 /** @hide */
9648 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9649 XmlPullParserException {
9650 Intent intent = new Intent();
9651 final int outerDepth = in.getDepth();
9652
9653 int attrCount = in.getAttributeCount();
9654 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9655 final String attrName = in.getAttributeName(attrNdx);
9656 final String attrValue = in.getAttributeValue(attrNdx);
9657 if (ATTR_ACTION.equals(attrName)) {
9658 intent.setAction(attrValue);
9659 } else if (ATTR_DATA.equals(attrName)) {
9660 intent.setData(Uri.parse(attrValue));
9661 } else if (ATTR_TYPE.equals(attrName)) {
9662 intent.setType(attrValue);
9663 } else if (ATTR_COMPONENT.equals(attrName)) {
9664 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9665 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009666 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009667 } else {
9668 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9669 }
9670 }
9671
9672 int event;
9673 String name;
9674 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9675 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9676 if (event == XmlPullParser.START_TAG) {
9677 name = in.getName();
9678 if (TAG_CATEGORIES.equals(name)) {
9679 attrCount = in.getAttributeCount();
9680 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9681 intent.addCategory(in.getAttributeValue(attrNdx));
9682 }
9683 } else {
9684 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9685 XmlUtils.skipCurrentTag(in);
9686 }
9687 }
9688 }
9689
9690 return intent;
9691 }
9692
Nick Pellyccae4122012-01-09 14:12:58 -08009693 /**
9694 * Normalize a MIME data type.
9695 *
9696 * <p>A normalized MIME type has white-space trimmed,
9697 * content-type parameters removed, and is lower-case.
9698 * This aligns the type with Android best practices for
9699 * intent filtering.
9700 *
9701 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9702 * "text/x-vCard" becomes "text/x-vcard".
9703 *
9704 * <p>All MIME types received from outside Android (such as user input,
9705 * or external sources like Bluetooth, NFC, or the Internet) should
9706 * be normalized before they are used to create an Intent.
9707 *
9708 * @param type MIME data type to normalize
9709 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009710 * @see #setType
9711 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009712 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009713 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08009714 if (type == null) {
9715 return null;
9716 }
9717
Elliott Hughescb64d432013-08-02 10:00:44 -07009718 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009719
9720 final int semicolonIndex = type.indexOf(';');
9721 if (semicolonIndex != -1) {
9722 type = type.substring(0, semicolonIndex);
9723 }
9724 return type;
9725 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009726
9727 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009728 * Prepare this {@link Intent} to leave an app process.
9729 *
9730 * @hide
9731 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009732 public void prepareToLeaveProcess(Context context) {
9733 final boolean leavingPackage = (mComponent == null)
9734 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9735 prepareToLeaveProcess(leavingPackage);
9736 }
9737
9738 /**
9739 * Prepare this {@link Intent} to leave an app process.
9740 *
9741 * @hide
9742 */
9743 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009744 setAllowFds(false);
9745
9746 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009747 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009748 }
9749 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009750 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009751 }
9752
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -07009753 if (mExtras != null && !mExtras.isParcelled()) {
9754 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
9755 if (intent instanceof Intent) {
9756 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
9757 }
9758 }
9759
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009760 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9761 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009762 switch (mAction) {
9763 case ACTION_MEDIA_REMOVED:
9764 case ACTION_MEDIA_UNMOUNTED:
9765 case ACTION_MEDIA_CHECKING:
9766 case ACTION_MEDIA_NOFS:
9767 case ACTION_MEDIA_MOUNTED:
9768 case ACTION_MEDIA_SHARED:
9769 case ACTION_MEDIA_UNSHARED:
9770 case ACTION_MEDIA_BAD_REMOVAL:
9771 case ACTION_MEDIA_UNMOUNTABLE:
9772 case ACTION_MEDIA_EJECT:
9773 case ACTION_MEDIA_SCANNER_STARTED:
9774 case ACTION_MEDIA_SCANNER_FINISHED:
9775 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009776 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9777 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009778 // Ignore legacy actions
9779 break;
9780 default:
9781 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009782 }
9783 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009784
9785 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
9786 && leavingPackage) {
9787 switch (mAction) {
9788 case ACTION_PROVIDER_CHANGED:
9789 // Ignore actions that don't need to grant
9790 break;
9791 default:
9792 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
9793 }
9794 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009795 }
9796
9797 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009798 * @hide
9799 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009800 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009801 // We just entered destination process, so we should be able to read all
9802 // parcelables inside.
9803 setDefusable(true);
9804
9805 if (mSelector != null) {
9806 mSelector.prepareToEnterProcess();
9807 }
9808 if (mClipData != null) {
9809 mClipData.prepareToEnterProcess();
9810 }
9811
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009812 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009813 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9814 fixUris(mContentUserHint);
9815 mContentUserHint = UserHandle.USER_CURRENT;
9816 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009817 }
9818 }
9819
9820 /**
9821 * @hide
9822 */
9823 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009824 Uri data = getData();
9825 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009826 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009827 }
9828 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009829 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009830 }
9831 String action = getAction();
9832 if (ACTION_SEND.equals(action)) {
9833 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9834 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009835 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009836 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009837 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009838 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9839 if (streams != null) {
9840 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9841 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009842 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009843 }
9844 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9845 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009846 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9847 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9848 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9849 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9850 if (output != null) {
9851 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9852 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009853 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009854 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009855
9856 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009857 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009858 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9859 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009860 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009861 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009862 * @hide
9863 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009864 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009865 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009866 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009867
9868 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009869 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009870
9871 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009872 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009873 // Inspect contained intents to see if we need to migrate extras. We
9874 // don't promote ClipData to the parent, since ChooserActivity will
9875 // already start the picked item as the caller, and we can't combine
9876 // the flags in a safe way.
9877
9878 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009879 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009880 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9881 if (intent != null) {
9882 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009883 }
9884 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009885 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009886 try {
9887 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9888 if (intents != null) {
9889 for (int i = 0; i < intents.length; i++) {
9890 final Intent intent = (Intent) intents[i];
9891 if (intent != null) {
9892 migrated |= intent.migrateExtraStreamToClipData();
9893 }
9894 }
9895 }
9896 } catch (ClassCastException e) {
9897 }
9898 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009899
9900 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009901 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009902 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9903 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9904 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9905 if (stream != null || text != null || htmlText != null) {
9906 final ClipData clipData = new ClipData(
9907 null, new String[] { getType() },
9908 new ClipData.Item(text, htmlText, null, stream));
9909 setClipData(clipData);
9910 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009911 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009912 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009913 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009914 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009915
9916 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009917 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009918 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9919 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9920 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9921 int num = -1;
9922 if (streams != null) {
9923 num = streams.size();
9924 }
9925 if (texts != null) {
9926 if (num >= 0 && num != texts.size()) {
9927 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009928 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009929 }
9930 num = texts.size();
9931 }
9932 if (htmlTexts != null) {
9933 if (num >= 0 && num != htmlTexts.size()) {
9934 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009935 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009936 }
9937 num = htmlTexts.size();
9938 }
9939 if (num > 0) {
9940 final ClipData clipData = new ClipData(
9941 null, new String[] { getType() },
9942 makeClipItem(streams, texts, htmlTexts, 0));
9943
9944 for (int i = 1; i < num; i++) {
9945 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9946 }
9947
9948 setClipData(clipData);
9949 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009950 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009951 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009952 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009953 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009954 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9955 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9956 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9957 final Uri output;
9958 try {
9959 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9960 } catch (ClassCastException e) {
9961 return false;
9962 }
9963 if (output != null) {
9964 setClipData(ClipData.newRawUri("", output));
9965 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9966 return true;
9967 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009968 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009969
9970 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009971 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009972
9973 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9974 ArrayList<String> htmlTexts, int which) {
9975 Uri uri = streams != null ? streams.get(which) : null;
9976 CharSequence text = texts != null ? texts.get(which) : null;
9977 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9978 return new ClipData.Item(text, htmlText, null, uri);
9979 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009980
9981 /** @hide */
9982 public boolean isDocument() {
9983 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9984 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009985}