blob: 81081f838f74c9265ada70060732585da60c74a5 [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;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070022import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050024import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070025import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050026import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060027import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070028import android.content.pm.PackageManager;
29import android.content.pm.ResolveInfo;
30import android.content.res.Resources;
31import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080032import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070033import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060034import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070035import android.os.Bundle;
36import android.os.IBinder;
37import android.os.Parcel;
38import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000039import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050040import android.os.ResultReceiver;
41import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070042import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010043import android.os.UserHandle;
Jeff Sharkey81aebe72017-04-03 20:14:10 +000044import android.os.storage.StorageManager;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070045import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070046import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050047import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070048import android.provider.OpenableColumns;
Jason Monk2f68e8a2016-02-23 17:57:28 -050049import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070050import android.util.AttributeSet;
51import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080052import com.android.internal.util.XmlUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050053import org.xmlpull.v1.XmlPullParser;
54import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070055import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070056
57import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080058import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070059import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070060import java.lang.annotation.Retention;
61import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070062import java.net.URISyntaxException;
63import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080064import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070065import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080066import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070067import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070068import java.util.Set;
69
Jeff Sharkey81aebe72017-04-03 20:14:10 +000070import static android.content.ContentProvider.maybeAddUserId;
71
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070072/**
73 * An intent is an abstract description of an operation to be performed. It
74 * can be used with {@link Context#startActivity(Intent) startActivity} to
75 * launch an {@link android.app.Activity},
76 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
77 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
78 * and {@link android.content.Context#startService} or
79 * {@link android.content.Context#bindService} to communicate with a
80 * background {@link android.app.Service}.
81 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070082 * <p>An Intent provides a facility for performing late runtime binding between the code in
83 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070084 * can be thought of as the glue between activities. It is basically a passive data structure
85 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070086 *
87 * <div class="special reference">
88 * <h3>Developer Guides</h3>
89 * <p>For information about how to create and resolve intents, read the
90 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
91 * developer guide.</p>
92 * </div>
93 *
94 * <a name="IntentStructure"></a>
95 * <h3>Intent Structure</h3>
96 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070097 *
98 * <ul>
99 * <li> <p><b>action</b> -- The general action to be performed, such as
100 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
101 * etc.</p>
102 * </li>
103 * <li> <p><b>data</b> -- The data to operate on, such as a person record
104 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
105 * </li>
106 * </ul>
107 *
108 *
109 * <p>Some examples of action/data pairs are:</p>
110 *
111 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700112 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700113 * information about the person whose identifier is "1".</p>
114 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700115 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700116 * the phone dialer with the person filled in.</p>
117 * </li>
118 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
119 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700120 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700121 * a particular URI.</p>
122 * </li>
123 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
124 * the phone dialer with the given number filled in.</p>
125 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700126 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700127 * information about the person whose identifier is "1".</p>
128 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700129 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700130 * a list of people, which the user can browse through. This example is a
131 * typical top-level entry into the Contacts application, showing you the
132 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700133 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700134 * being used to start an activity to display that person.</p>
135 * </li>
136 * </ul>
137 *
138 * <p>In addition to these primary attributes, there are a number of secondary
139 * attributes that you can also include with an intent:</p>
140 *
141 * <ul>
142 * <li> <p><b>category</b> -- Gives additional information about the action
143 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
144 * appear in the Launcher as a top-level application, while
145 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
146 * of alternative actions the user can perform on a piece of data.</p>
147 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
148 * intent data. Normally the type is inferred from the data itself.
149 * By setting this attribute, you disable that evaluation and force
150 * an explicit type.</p>
151 * <li> <p><b>component</b> -- Specifies an explicit name of a component
152 * class to use for the intent. Normally this is determined by looking
153 * at the other information in the intent (the action, data/type, and
154 * categories) and matching that with a component that can handle it.
155 * If this attribute is set then none of the evaluation is performed,
156 * and this component is used exactly as is. By specifying this attribute,
157 * all of the other Intent attributes become optional.</p>
158 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
159 * This can be used to provide extended information to the component.
160 * For example, if we have a action to send an e-mail message, we could
161 * also include extra pieces of data here to supply a subject, body,
162 * etc.</p>
163 * </ul>
164 *
165 * <p>Here are some examples of other operations you can specify as intents
166 * using these additional parameters:</p>
167 *
168 * <ul>
169 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
170 * Launch the home screen.</p>
171 * </li>
172 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
173 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
174 * vnd.android.cursor.item/phone}</i></b>
175 * -- Display the list of people's phone numbers, allowing the user to
176 * browse through them and pick one and return it to the parent activity.</p>
177 * </li>
178 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
179 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
180 * -- Display all pickers for data that can be opened with
181 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
182 * allowing the user to pick one of them and then some data inside of it
183 * and returning the resulting URI to the caller. This can be used,
184 * for example, in an e-mail application to allow the user to pick some
185 * data to include as an attachment.</p>
186 * </li>
187 * </ul>
188 *
189 * <p>There are a variety of standard Intent action and category constants
190 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700191 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700192 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700193 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700194 *
195 * <p>Put together, the set of actions, data types, categories, and extra data
196 * defines a language for the system allowing for the expression of phrases
197 * such as "call john smith's cell". As applications are added to the system,
198 * they can extend this language by adding new actions, types, and categories, or
199 * they can modify the behavior of existing phrases by supplying their own
200 * activities that handle them.</p>
201 *
202 * <a name="IntentResolution"></a>
203 * <h3>Intent Resolution</h3>
204 *
205 * <p>There are two primary forms of intents you will use.
206 *
207 * <ul>
208 * <li> <p><b>Explicit Intents</b> have specified a component (via
209 * {@link #setComponent} or {@link #setClass}), which provides the exact
210 * class to be run. Often these will not include any other information,
211 * simply being a way for an application to launch various internal
212 * activities it has as the user interacts with the application.
213 *
214 * <li> <p><b>Implicit Intents</b> have not specified a component;
215 * instead, they must include enough information for the system to
216 * determine which of the available components is best to run for that
217 * intent.
218 * </ul>
219 *
220 * <p>When using implicit intents, given such an arbitrary intent we need to
221 * know what to do with it. This is handled by the process of <em>Intent
222 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
223 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
224 * more activities/receivers) that can handle it.</p>
225 *
226 * <p>The intent resolution mechanism basically revolves around matching an
227 * Intent against all of the &lt;intent-filter&gt; descriptions in the
228 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
229 * objects explicitly registered with {@link Context#registerReceiver}.) More
230 * details on this can be found in the documentation on the {@link
231 * IntentFilter} class.</p>
232 *
233 * <p>There are three pieces of information in the Intent that are used for
234 * resolution: the action, type, and category. Using this information, a query
235 * is done on the {@link PackageManager} for a component that can handle the
236 * intent. The appropriate component is determined based on the intent
237 * information supplied in the <code>AndroidManifest.xml</code> file as
238 * follows:</p>
239 *
240 * <ul>
241 * <li> <p>The <b>action</b>, if given, must be listed by the component as
242 * one it handles.</p>
243 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
244 * already supplied in the Intent. Like the action, if a type is
245 * included in the intent (either explicitly or implicitly in its
246 * data), then this must be listed by the component as one it handles.</p>
247 * <li> For data that is not a <code>content:</code> URI and where no explicit
248 * type is included in the Intent, instead the <b>scheme</b> of the
249 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
250 * considered. Again like the action, if we are matching a scheme it
251 * must be listed by the component as one it can handle.
252 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
253 * by the activity as categories it handles. That is, if you include
254 * the categories {@link #CATEGORY_LAUNCHER} and
255 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
256 * with an intent that lists <em>both</em> of those categories.
257 * Activities will very often need to support the
258 * {@link #CATEGORY_DEFAULT} so that they can be found by
259 * {@link Context#startActivity Context.startActivity()}.</p>
260 * </ul>
261 *
262 * <p>For example, consider the Note Pad sample application that
263 * allows user to browse through a list of notes data and view details about
264 * individual items. Text in italics indicate places were you would replace a
265 * name with one specific to your own package.</p>
266 *
267 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
268 * package="<i>com.android.notepad</i>"&gt;
269 * &lt;application android:icon="@drawable/app_notes"
270 * android:label="@string/app_name"&gt;
271 *
272 * &lt;provider class=".NotePadProvider"
273 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
274 *
275 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
276 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700277 * &lt;action android:name="android.intent.action.MAIN" /&gt;
278 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700279 * &lt;/intent-filter&gt;
280 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700281 * &lt;action android:name="android.intent.action.VIEW" /&gt;
282 * &lt;action android:name="android.intent.action.EDIT" /&gt;
283 * &lt;action android:name="android.intent.action.PICK" /&gt;
284 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
285 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700286 * &lt;/intent-filter&gt;
287 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700288 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
289 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
290 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700291 * &lt;/intent-filter&gt;
292 * &lt;/activity&gt;
293 *
294 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
295 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700296 * &lt;action android:name="android.intent.action.VIEW" /&gt;
297 * &lt;action android:name="android.intent.action.EDIT" /&gt;
298 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
299 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700300 * &lt;/intent-filter&gt;
301 *
302 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700303 * &lt;action android:name="android.intent.action.INSERT" /&gt;
304 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
305 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700306 * &lt;/intent-filter&gt;
307 *
308 * &lt;/activity&gt;
309 *
310 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
311 * android:theme="@android:style/Theme.Dialog"&gt;
312 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700313 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
314 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
315 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
316 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
317 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700318 * &lt;/intent-filter&gt;
319 * &lt;/activity&gt;
320 *
321 * &lt;/application&gt;
322 * &lt;/manifest&gt;</pre>
323 *
324 * <p>The first activity,
325 * <code>com.android.notepad.NotesList</code>, serves as our main
326 * entry into the app. It can do three things as described by its three intent
327 * templates:
328 * <ol>
329 * <li><pre>
330 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700331 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
332 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700333 * &lt;/intent-filter&gt;</pre>
334 * <p>This provides a top-level entry into the NotePad application: the standard
335 * MAIN action is a main entry point (not requiring any other information in
336 * the Intent), and the LAUNCHER category says that this entry point should be
337 * listed in the application launcher.</p>
338 * <li><pre>
339 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700340 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
341 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
342 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
343 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700344 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700345 * &lt;/intent-filter&gt;</pre>
346 * <p>This declares the things that the activity can do on a directory of
347 * notes. The type being supported is given with the &lt;type&gt; tag, where
348 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
349 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
350 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
351 * The activity allows the user to view or edit the directory of data (via
352 * the VIEW and EDIT actions), or to pick a particular note and return it
353 * to the caller (via the PICK action). Note also the DEFAULT category
354 * supplied here: this is <em>required</em> for the
355 * {@link Context#startActivity Context.startActivity} method to resolve your
356 * activity when its component name is not explicitly specified.</p>
357 * <li><pre>
358 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700359 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
360 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
361 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700363 * <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 -0700364 * the user without needing to know where it came from. The data type
365 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
366 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
367 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
368 * The GET_CONTENT action is similar to the PICK action, where the activity
369 * will return to its caller a piece of data selected by the user. Here,
370 * however, the caller specifies the type of data they desire instead of
371 * the type of data the user will be picking from.</p>
372 * </ol>
373 *
374 * <p>Given these capabilities, the following intents will resolve to the
375 * NotesList activity:</p>
376 *
377 * <ul>
378 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
379 * activities that can be used as top-level entry points into an
380 * application.</p>
381 * <li> <p><b>{ action=android.app.action.MAIN,
382 * category=android.app.category.LAUNCHER }</b> is the actual intent
383 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700384 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700385 * data=content://com.google.provider.NotePad/notes }</b>
386 * displays a list of all the notes under
387 * "content://com.google.provider.NotePad/notes", which
388 * the user can browse through and see the details on.</p>
389 * <li> <p><b>{ action=android.app.action.PICK
390 * data=content://com.google.provider.NotePad/notes }</b>
391 * provides a list of the notes under
392 * "content://com.google.provider.NotePad/notes", from which
393 * the user can pick a note whose data URL is returned back to the caller.</p>
394 * <li> <p><b>{ action=android.app.action.GET_CONTENT
395 * type=vnd.android.cursor.item/vnd.google.note }</b>
396 * is similar to the pick action, but allows the caller to specify the
397 * kind of data they want back so that the system can find the appropriate
398 * activity to pick something of that data type.</p>
399 * </ul>
400 *
401 * <p>The second activity,
402 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
403 * note entry and allows them to edit it. It can do two things as described
404 * by its two intent templates:
405 * <ol>
406 * <li><pre>
407 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700408 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
409 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
410 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
411 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700412 * &lt;/intent-filter&gt;</pre>
413 * <p>The first, primary, purpose of this activity is to let the user interact
414 * with a single note, as decribed by the MIME type
415 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
416 * either VIEW a note or allow the user to EDIT it. Again we support the
417 * DEFAULT category to allow the activity to be launched without explicitly
418 * specifying its component.</p>
419 * <li><pre>
420 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700421 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
422 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
423 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700424 * &lt;/intent-filter&gt;</pre>
425 * <p>The secondary use of this activity is to insert a new note entry into
426 * an existing directory of notes. This is used when the user creates a new
427 * note: the INSERT action is executed on the directory of notes, causing
428 * this activity to run and have the user create the new note data which
429 * it then adds to the content provider.</p>
430 * </ol>
431 *
432 * <p>Given these capabilities, the following intents will resolve to the
433 * NoteEditor activity:</p>
434 *
435 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700436 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700437 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
438 * shows the user the content of note <var>{ID}</var>.</p>
439 * <li> <p><b>{ action=android.app.action.EDIT
440 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
441 * allows the user to edit the content of note <var>{ID}</var>.</p>
442 * <li> <p><b>{ action=android.app.action.INSERT
443 * data=content://com.google.provider.NotePad/notes }</b>
444 * creates a new, empty note in the notes list at
445 * "content://com.google.provider.NotePad/notes"
446 * and allows the user to edit it. If they keep their changes, the URI
447 * of the newly created note is returned to the caller.</p>
448 * </ul>
449 *
450 * <p>The last activity,
451 * <code>com.android.notepad.TitleEditor</code>, allows the user to
452 * edit the title of a note. This could be implemented as a class that the
453 * application directly invokes (by explicitly setting its component in
454 * the Intent), but here we show a way you can publish alternative
455 * operations on existing data:</p>
456 *
457 * <pre>
458 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700459 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
460 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
461 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
462 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
463 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700464 * &lt;/intent-filter&gt;</pre>
465 *
466 * <p>In the single intent template here, we
467 * have created our own private action called
468 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
469 * edit the title of a note. It must be invoked on a specific note
470 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
471 * view and edit actions, but here displays and edits the title contained
472 * in the note data.
473 *
474 * <p>In addition to supporting the default category as usual, our title editor
475 * also supports two other standard categories: ALTERNATIVE and
476 * SELECTED_ALTERNATIVE. Implementing
477 * these categories allows others to find the special action it provides
478 * without directly knowing about it, through the
479 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
480 * more often to build dynamic menu items with
481 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
482 * template here was also supply an explicit name for the template
483 * (via <code>android:label="@string/resolve_title"</code>) to better control
484 * what the user sees when presented with this activity as an alternative
485 * action to the data they are viewing.
486 *
487 * <p>Given these capabilities, the following intent will resolve to the
488 * TitleEditor activity:</p>
489 *
490 * <ul>
491 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
492 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
493 * displays and allows the user to edit the title associated
494 * with note <var>{ID}</var>.</p>
495 * </ul>
496 *
497 * <h3>Standard Activity Actions</h3>
498 *
499 * <p>These are the current standard actions that Intent defines for launching
500 * activities (usually through {@link Context#startActivity}. The most
501 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
502 * {@link #ACTION_EDIT}.
503 *
504 * <ul>
505 * <li> {@link #ACTION_MAIN}
506 * <li> {@link #ACTION_VIEW}
507 * <li> {@link #ACTION_ATTACH_DATA}
508 * <li> {@link #ACTION_EDIT}
509 * <li> {@link #ACTION_PICK}
510 * <li> {@link #ACTION_CHOOSER}
511 * <li> {@link #ACTION_GET_CONTENT}
512 * <li> {@link #ACTION_DIAL}
513 * <li> {@link #ACTION_CALL}
514 * <li> {@link #ACTION_SEND}
515 * <li> {@link #ACTION_SENDTO}
516 * <li> {@link #ACTION_ANSWER}
517 * <li> {@link #ACTION_INSERT}
518 * <li> {@link #ACTION_DELETE}
519 * <li> {@link #ACTION_RUN}
520 * <li> {@link #ACTION_SYNC}
521 * <li> {@link #ACTION_PICK_ACTIVITY}
522 * <li> {@link #ACTION_SEARCH}
523 * <li> {@link #ACTION_WEB_SEARCH}
524 * <li> {@link #ACTION_FACTORY_TEST}
525 * </ul>
526 *
527 * <h3>Standard Broadcast Actions</h3>
528 *
529 * <p>These are the current standard actions that Intent defines for receiving
530 * broadcasts (usually through {@link Context#registerReceiver} or a
531 * &lt;receiver&gt; tag in a manifest).
532 *
533 * <ul>
534 * <li> {@link #ACTION_TIME_TICK}
535 * <li> {@link #ACTION_TIME_CHANGED}
536 * <li> {@link #ACTION_TIMEZONE_CHANGED}
537 * <li> {@link #ACTION_BOOT_COMPLETED}
538 * <li> {@link #ACTION_PACKAGE_ADDED}
539 * <li> {@link #ACTION_PACKAGE_CHANGED}
540 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800541 * <li> {@link #ACTION_PACKAGE_RESTARTED}
542 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000543 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
544 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700545 * <li> {@link #ACTION_UID_REMOVED}
546 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700547 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700548 * <li> {@link #ACTION_POWER_DISCONNECTED}
549 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700550 * </ul>
551 *
552 * <h3>Standard Categories</h3>
553 *
554 * <p>These are the current standard categories that can be used to further
555 * clarify an Intent via {@link #addCategory}.
556 *
557 * <ul>
558 * <li> {@link #CATEGORY_DEFAULT}
559 * <li> {@link #CATEGORY_BROWSABLE}
560 * <li> {@link #CATEGORY_TAB}
561 * <li> {@link #CATEGORY_ALTERNATIVE}
562 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
563 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800564 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700565 * <li> {@link #CATEGORY_HOME}
566 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700567 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400568 * <li> {@link #CATEGORY_CAR_DOCK}
569 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500570 * <li> {@link #CATEGORY_LE_DESK_DOCK}
571 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200572 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700573 * <li> {@link #CATEGORY_APP_MARKET}
Zak Cohendb6ca492017-01-26 14:09:00 -0800574 * <li> {@link #CATEGORY_VR_HOME}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700575 * </ul>
576 *
577 * <h3>Standard Extra Data</h3>
578 *
579 * <p>These are the current standard fields that can be used as extra data via
580 * {@link #putExtra}.
581 *
582 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800583 * <li> {@link #EXTRA_ALARM_COUNT}
584 * <li> {@link #EXTRA_BCC}
585 * <li> {@link #EXTRA_CC}
586 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
587 * <li> {@link #EXTRA_DATA_REMOVED}
588 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500589 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
590 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800591 * <li> {@link #EXTRA_DOCK_STATE_CAR}
592 * <li> {@link #EXTRA_DOCK_STATE_DESK}
593 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
594 * <li> {@link #EXTRA_DONT_KILL_APP}
595 * <li> {@link #EXTRA_EMAIL}
596 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700597 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800598 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700599 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800600 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700601 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800602 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
603 * <li> {@link #EXTRA_REPLACING}
604 * <li> {@link #EXTRA_SHORTCUT_ICON}
605 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
606 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700607 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800608 * <li> {@link #EXTRA_SHORTCUT_NAME}
609 * <li> {@link #EXTRA_SUBJECT}
610 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700611 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800612 * <li> {@link #EXTRA_TITLE}
613 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700614 * </ul>
615 *
616 * <h3>Flags</h3>
617 *
618 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800619 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
620 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700621 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800622public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700623 private static final String ATTR_ACTION = "action";
624 private static final String TAG_CATEGORIES = "categories";
625 private static final String ATTR_CATEGORY = "category";
626 private static final String TAG_EXTRA = "extra";
627 private static final String ATTR_TYPE = "type";
628 private static final String ATTR_COMPONENT = "component";
629 private static final String ATTR_DATA = "data";
630 private static final String ATTR_FLAGS = "flags";
631
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700632 // ---------------------------------------------------------------------
633 // ---------------------------------------------------------------------
634 // Standard intent activity actions (see action variable).
635
636 /**
637 * Activity Action: Start as a main entry point, does not expect to
638 * receive data.
639 * <p>Input: nothing
640 * <p>Output: nothing
641 */
642 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
643 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800644
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700645 /**
646 * Activity Action: Display the data to the user. This is the most common
647 * action performed on data -- it is the generic action you can use on
648 * a piece of data to get the most reasonable thing to occur. For example,
649 * when used on a contacts entry it will view the entry; when used on a
650 * mailto: URI it will bring up a compose window filled with the information
651 * supplied by the URI; when used with a tel: URI it will invoke the
652 * dialer.
653 * <p>Input: {@link #getData} is URI from which to retrieve data.
654 * <p>Output: nothing.
655 */
656 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
657 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800658
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700659 /**
660 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
661 * performed on a piece of data.
662 */
663 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800664
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700665 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900666 * Activity Action: Quick view the data. Launches a quick viewer for
667 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900668 * <p>Activities handling this intent action should handle the vast majority of
669 * MIME types rather than only specific ones.
Garfield Tance1d0e92017-03-23 10:52:48 -0700670 * <p>Quick viewers must render the quick view image locally, and must not send
671 * file content outside current device.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900672 * <p>Input: {@link #getData} is a mandatory content URI of the item to
673 * preview. {@link #getClipData} contains an optional list of content URIs
674 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
675 * optional index of the URI in the clip data to show first.
Garfield Tance1d0e92017-03-23 10:52:48 -0700676 * {@link #EXTRA_QUICK_VIEW_FEATURES} is an optional extra indicating the features
677 * that can be shown in the quick view UI.
Steve McKayc78bcb82015-07-31 14:35:22 -0700678 * <p>Output: nothing.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900679 * @see #EXTRA_INDEX
Garfield Tance1d0e92017-03-23 10:52:48 -0700680 * @see #EXTRA_QUICK_VIEW_FEATURES
Steve McKayc78bcb82015-07-31 14:35:22 -0700681 */
682 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
683 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
684
685 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700686 * Used to indicate that some piece of data should be attached to some other
687 * place. For example, image data could be attached to a contact. It is up
688 * to the recipient to decide where the data should be attached; the intent
689 * does not specify the ultimate destination.
690 * <p>Input: {@link #getData} is URI of data to be attached.
691 * <p>Output: nothing.
692 */
693 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
694 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800695
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700696 /**
697 * Activity Action: Provide explicit editable access to the given data.
698 * <p>Input: {@link #getData} is URI of data to be edited.
699 * <p>Output: nothing.
700 */
701 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
702 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800703
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700704 /**
705 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
706 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
707 * The extras can contain type specific data to pass through to the editing/creating
708 * activity.
709 * <p>Output: The URI of the item that was picked. This must be a content:
710 * URI so that any receiver can access it.
711 */
712 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
713 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 /**
716 * Activity Action: Pick an item from the data, returning what was selected.
717 * <p>Input: {@link #getData} is URI containing a directory of data
718 * (vnd.android.cursor.dir/*) from which to pick an item.
719 * <p>Output: The URI of the item that was picked.
720 */
721 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
722 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800723
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700724 /**
725 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800726 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800727 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
728 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700729 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
730 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800731 * (value: ShortcutIconResource).</p>
732 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800733 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700734 * @see #EXTRA_SHORTCUT_INTENT
735 * @see #EXTRA_SHORTCUT_NAME
736 * @see #EXTRA_SHORTCUT_ICON
737 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
738 * @see android.content.Intent.ShortcutIconResource
739 */
740 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
741 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
742
743 /**
744 * The name of the extra used to define the Intent of a shortcut.
745 *
746 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800747 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700748 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800749 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700750 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
751 /**
752 * The name of the extra used to define the name of a shortcut.
753 *
754 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800755 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700756 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800757 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700758 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
759 /**
760 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
761 *
762 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800763 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700764 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800765 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700766 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
767 /**
768 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
769 *
770 * @see #ACTION_CREATE_SHORTCUT
771 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800772 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700773 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800774 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700775 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
776 "android.intent.extra.shortcut.ICON_RESOURCE";
777
778 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500779 * An activity that provides a user interface for adjusting application preferences.
780 * Optional but recommended settings for all applications which have settings.
781 */
782 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
783 public static final String ACTION_APPLICATION_PREFERENCES
784 = "android.intent.action.APPLICATION_PREFERENCES";
785
786 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700787 * Activity Action: Launch an activity showing the app information.
788 * For applications which install other applications (such as app stores), it is recommended
789 * to handle this action for providing the app information to the user.
790 *
791 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
792 * to be displayed.
793 * <p>Output: Nothing.
794 */
795 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
796 public static final String ACTION_SHOW_APP_INFO
797 = "android.intent.action.SHOW_APP_INFO";
798
799 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800800 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700801 *
802 * @see Intent#ACTION_CREATE_SHORTCUT
803 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800804 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
805 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700806 */
807 public static class ShortcutIconResource implements Parcelable {
808 /**
809 * The package name of the application containing the icon.
810 */
811 public String packageName;
812
813 /**
814 * The resource name of the icon, including package, name and type.
815 */
816 public String resourceName;
817
818 /**
819 * Creates a new ShortcutIconResource for the specified context and resource
820 * identifier.
821 *
822 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700823 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700824 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700825 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700826 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700827 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700828 ShortcutIconResource icon = new ShortcutIconResource();
829 icon.packageName = context.getPackageName();
830 icon.resourceName = context.getResources().getResourceName(resourceId);
831 return icon;
832 }
833
834 /**
835 * Used to read a ShortcutIconResource from a Parcel.
836 */
837 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
838 new Parcelable.Creator<ShortcutIconResource>() {
839
840 public ShortcutIconResource createFromParcel(Parcel source) {
841 ShortcutIconResource icon = new ShortcutIconResource();
842 icon.packageName = source.readString();
843 icon.resourceName = source.readString();
844 return icon;
845 }
846
847 public ShortcutIconResource[] newArray(int size) {
848 return new ShortcutIconResource[size];
849 }
850 };
851
852 /**
853 * No special parcel contents.
854 */
855 public int describeContents() {
856 return 0;
857 }
858
859 public void writeToParcel(Parcel dest, int flags) {
860 dest.writeString(packageName);
861 dest.writeString(resourceName);
862 }
863
864 @Override
865 public String toString() {
866 return resourceName;
867 }
868 }
869
870 /**
871 * Activity Action: Display an activity chooser, allowing the user to pick
872 * what they want to before proceeding. This can be used as an alternative
873 * to the standard activity picker that is displayed by the system when
874 * you try to start an activity with multiple possible matches, with these
875 * differences in behavior:
876 * <ul>
877 * <li>You can specify the title that will appear in the activity chooser.
878 * <li>The user does not have the option to make one of the matching
879 * activities a preferred activity, and all possible activities will
880 * always be shown even if one of them is currently marked as the
881 * preferred activity.
882 * </ul>
883 * <p>
884 * This action should be used when the user will naturally expect to
885 * select an activity in order to proceed. An example if when not to use
886 * it is when the user clicks on a "mailto:" link. They would naturally
887 * expect to go directly to their mail app, so startActivity() should be
888 * called directly: it will
889 * either launch the current preferred app, or put up a dialog allowing the
890 * user to pick an app to use and optionally marking that as preferred.
891 * <p>
892 * In contrast, if the user is selecting a menu item to send a picture
893 * they are viewing to someone else, there are many different things they
894 * may want to do at this point: send it through e-mail, upload it to a
895 * web service, etc. In this case the CHOOSER action should be used, to
896 * always present to the user a list of the things they can do, with a
897 * nice title given by the caller such as "Send this photo with:".
898 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700899 * If you need to grant URI permissions through a chooser, you must specify
900 * the permissions to be granted on the ACTION_CHOOSER Intent
901 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
902 * {@link #setClipData} to specify the URIs to be granted as well as
903 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
904 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
905 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700906 * As a convenience, an Intent of this form can be created with the
907 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700908 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700909 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700910 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
911 * and can optionally have a {@link #EXTRA_TITLE} field containing the
912 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700913 * <p>
914 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700915 */
916 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
917 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
918
919 /**
920 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
921 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700922 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
923 * target intent, also optionally supplying a title. If the target
924 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
925 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
926 * set in the returned chooser intent, with its ClipData set appropriately:
927 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500928 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700929 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700930 * @param target The Intent that the user will be selecting an activity
931 * to perform.
932 * @param title Optional title that will be displayed in the chooser.
933 * @return Return a new Intent object that you can hand to
934 * {@link Context#startActivity(Intent) Context.startActivity()} and
935 * related methods.
936 */
937 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700938 return createChooser(target, title, null);
939 }
940
941 /**
942 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
943 *
944 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
945 * target intent, also optionally supplying a title. If the target
946 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
947 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
948 * set in the returned chooser intent, with its ClipData set appropriately:
949 * either a direct reflection of {@link #getClipData()} if that is non-null,
950 * or a new ClipData built from {@link #getData()}.</p>
951 *
952 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
953 * when the user makes a choice. This can be useful if the calling application wants
954 * to remember the last chosen target and surface it as a more prominent or one-touch
955 * affordance elsewhere in the UI for next time.</p>
956 *
957 * @param target The Intent that the user will be selecting an activity
958 * to perform.
959 * @param title Optional title that will be displayed in the chooser.
960 * @param sender Optional IntentSender to be called when a choice is made.
961 * @return Return a new Intent object that you can hand to
962 * {@link Context#startActivity(Intent) Context.startActivity()} and
963 * related methods.
964 */
965 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700966 Intent intent = new Intent(ACTION_CHOOSER);
967 intent.putExtra(EXTRA_INTENT, target);
968 if (title != null) {
969 intent.putExtra(EXTRA_TITLE, title);
970 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700971
Adam Powell0b3c1122014-10-09 12:50:14 -0700972 if (sender != null) {
973 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
974 }
975
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700976 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700977 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
978 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
979 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700980 if (permFlags != 0) {
981 ClipData targetClipData = target.getClipData();
982 if (targetClipData == null && target.getData() != null) {
983 ClipData.Item item = new ClipData.Item(target.getData());
984 String[] mimeTypes;
985 if (target.getType() != null) {
986 mimeTypes = new String[] { target.getType() };
987 } else {
988 mimeTypes = new String[] { };
989 }
990 targetClipData = new ClipData(null, mimeTypes, item);
991 }
992 if (targetClipData != null) {
993 intent.setClipData(targetClipData);
994 intent.addFlags(permFlags);
995 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700996 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700997
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700998 return intent;
999 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001000
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001001 /**
1002 * Activity Action: Allow the user to select a particular kind of data and
1003 * return it. This is different than {@link #ACTION_PICK} in that here we
1004 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001005 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001006 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001007 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001008 * etc.
1009 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001010 * 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 -07001011 * of data, such as a person contact, you set the MIME type to the kind of
1012 * data you want and launch it with {@link Context#startActivity(Intent)}.
1013 * The system will then launch the best application to select that kind
1014 * of data for you.
1015 * <p>
1016 * You may also be interested in any of a set of types of content the user
1017 * can pick. For example, an e-mail application that wants to allow the
1018 * user to add an attachment to an e-mail message can use this action to
1019 * bring up a list of all of the types of content the user can attach.
1020 * <p>
1021 * In this case, you should wrap the GET_CONTENT intent with a chooser
1022 * (through {@link #createChooser}), which will give the proper interface
1023 * for the user to pick how to send your data and allow you to specify
1024 * a prompt indicating what they are doing. You will usually specify a
1025 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1026 * broad range of content types the user can select from.
1027 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001028 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001029 * only pick from data that can be represented as a stream. This is
1030 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1031 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001032 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001033 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001034 * is locally available on the device. For example, if this extra is set
1035 * to true then an image picker should not show any pictures that are available
1036 * from a remote server but not already on the local device (thus requiring
1037 * they be downloaded when opened).
1038 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001039 * If the caller can handle multiple returned items (the user performing
1040 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1041 * to indicate this.
1042 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001043 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1044 * that no URI is supplied in the intent, as there are no constraints on
1045 * where the returned data originally comes from. You may also include the
1046 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001047 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001048 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1049 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001050 * <p>
1051 * Output: The URI of the item that was picked. This must be a content:
1052 * URI so that any receiver can access it.
1053 */
1054 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1055 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1056 /**
1057 * Activity Action: Dial a number as specified by the data. This shows a
1058 * UI with the number being dialed, allowing the user to explicitly
1059 * initiate the call.
1060 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1061 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1062 * number.
1063 * <p>Output: nothing.
1064 */
1065 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1066 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1067 /**
1068 * Activity Action: Perform a call to someone specified by the data.
1069 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1070 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1071 * number.
1072 * <p>Output: nothing.
1073 *
1074 * <p>Note: there will be restrictions on which applications can initiate a
1075 * call; most applications should use the {@link #ACTION_DIAL}.
1076 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1077 * numbers. Applications can <strong>dial</strong> emergency numbers using
1078 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001079 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001080 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001081 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001082 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001083 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001084 */
1085 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1086 public static final String ACTION_CALL = "android.intent.action.CALL";
1087 /**
1088 * Activity Action: Perform a call to an emergency number specified by the
1089 * data.
1090 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1091 * tel: URI of an explicit phone number.
1092 * <p>Output: nothing.
1093 * @hide
1094 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001095 @SystemApi
1096 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001097 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1098 /**
1099 * Activity action: Perform a call to any number (emergency or not)
1100 * specified by the data.
1101 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1102 * tel: URI of an explicit phone number.
1103 * <p>Output: nothing.
1104 * @hide
1105 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001106 @SystemApi
1107 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001108 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
fionaxu77a744c2017-03-17 14:35:39 -07001109
Santos Cordon15a13782015-03-31 18:32:31 -07001110 /**
fionaxuadfe7002017-02-17 17:20:46 -08001111 * Activity Action: Main entry point for carrier setup apps.
1112 * <p>Carrier apps that provide an implementation for this action may be invoked to configure
1113 * carrier service and typically require
1114 * {@link android.telephony.TelephonyManager#hasCarrierPrivileges() carrier privileges} to
1115 * fulfill their duties.
1116 */
1117 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1118 public static final String ACTION_CARRIER_SETUP = "android.intent.action.CARRIER_SETUP";
1119 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001120 * Activity Action: Send a message to someone specified by the data.
1121 * <p>Input: {@link #getData} is URI describing the target.
1122 * <p>Output: nothing.
1123 */
1124 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1125 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1126 /**
1127 * Activity Action: Deliver some data to someone else. Who the data is
1128 * being delivered to is not specified; it is up to the receiver of this
1129 * action to ask the user where the data should be sent.
1130 * <p>
1131 * When launching a SEND intent, you should usually wrap it in a chooser
1132 * (through {@link #createChooser}), which will give the proper interface
1133 * for the user to pick how to send your data and allow you to specify
1134 * a prompt indicating what they are doing.
1135 * <p>
1136 * Input: {@link #getType} is the MIME type of the data being sent.
1137 * get*Extra can have either a {@link #EXTRA_TEXT}
1138 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1139 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1140 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1141 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001142 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1143 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1144 * your text with HTML formatting.
1145 * <p>
1146 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1147 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1148 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1149 * content: URIs and other advanced features of {@link ClipData}. If
1150 * using this approach, you still must supply the same data through the
1151 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1152 * for compatibility with old applications. If you don't set a ClipData,
1153 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001154 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001155 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1156 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1157 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1158 * be openable only as asset typed files using
1159 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1160 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001161 * Optional standard extras, which may be interpreted by some recipients as
1162 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1163 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1164 * <p>
1165 * Output: nothing.
1166 */
1167 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1168 public static final String ACTION_SEND = "android.intent.action.SEND";
1169 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001170 * Activity Action: Deliver multiple data to someone else.
1171 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001172 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001173 * <p>
1174 * Input: {@link #getType} is the MIME type of the data being sent.
1175 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001176 * #EXTRA_STREAM} field, containing the data to be sent. If using
1177 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1178 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001179 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001180 * Multiple types are supported, and receivers should handle mixed types
1181 * whenever possible. The right way for the receiver to check them is to
1182 * use the content resolver on each URI. The intent sender should try to
1183 * put the most concrete mime type in the intent type, but it can fall
1184 * back to {@literal <type>/*} or {@literal *}/* as needed.
1185 * <p>
1186 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1187 * be image/jpg, but if you are sending image/jpg and image/png, then the
1188 * intent's type should be image/*.
1189 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001190 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1191 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1192 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1193 * content: URIs and other advanced features of {@link ClipData}. If
1194 * using this approach, you still must supply the same data through the
1195 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1196 * for compatibility with old applications. If you don't set a ClipData,
1197 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1198 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001199 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1200 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1201 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1202 * be openable only as asset typed files using
1203 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1204 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001205 * Optional standard extras, which may be interpreted by some recipients as
1206 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1207 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1208 * <p>
1209 * Output: nothing.
1210 */
1211 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1212 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1213 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001214 * Activity Action: Handle an incoming phone call.
1215 * <p>Input: nothing.
1216 * <p>Output: nothing.
1217 */
1218 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1219 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1220 /**
1221 * Activity Action: Insert an empty item into the given container.
1222 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1223 * in which to place the data.
1224 * <p>Output: URI of the new data that was created.
1225 */
1226 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1227 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1228 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001229 * Activity Action: Create a new item in the given container, initializing it
1230 * from the current contents of the clipboard.
1231 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1232 * in which to place the data.
1233 * <p>Output: URI of the new data that was created.
1234 */
1235 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1236 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1237 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001238 * Activity Action: Delete the given data from its container.
1239 * <p>Input: {@link #getData} is URI of data to be deleted.
1240 * <p>Output: nothing.
1241 */
1242 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1243 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1244 /**
1245 * Activity Action: Run the data, whatever that means.
1246 * <p>Input: ? (Note: this is currently specific to the test harness.)
1247 * <p>Output: nothing.
1248 */
1249 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1250 public static final String ACTION_RUN = "android.intent.action.RUN";
1251 /**
1252 * Activity Action: Perform a data synchronization.
1253 * <p>Input: ?
1254 * <p>Output: ?
1255 */
1256 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1257 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1258 /**
1259 * Activity Action: Pick an activity given an intent, returning the class
1260 * selected.
1261 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1262 * used with {@link PackageManager#queryIntentActivities} to determine the
1263 * set of activities from which to pick.
1264 * <p>Output: Class name of the activity that was selected.
1265 */
1266 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1267 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1268 /**
1269 * Activity Action: Perform a search.
1270 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1271 * is the text to search for. If empty, simply
1272 * enter your search results Activity with the search UI activated.
1273 * <p>Output: nothing.
1274 */
1275 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1276 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1277 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001278 * Activity Action: Start the platform-defined tutorial
1279 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1280 * is the text to search for. If empty, simply
1281 * enter your search results Activity with the search UI activated.
1282 * <p>Output: nothing.
1283 */
1284 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1285 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1286 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001287 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001288 * <p>
1289 * Input: {@link android.app.SearchManager#QUERY
1290 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1291 * a url starts with http or https, the site will be opened. If it is plain
1292 * text, Google search will be applied.
1293 * <p>
1294 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001295 */
1296 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1297 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001298
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001299 /**
Jim Miller07994402012-05-02 14:22:27 -07001300 * Activity Action: Perform assist action.
1301 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001302 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1303 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001304 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1305 * information.
Jim Miller07994402012-05-02 14:22:27 -07001306 * Output: nothing.
1307 */
1308 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1309 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001310
1311 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001312 * Activity Action: Perform voice 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
Adam Skorydfc7fd72013-08-05 19:23:41 -07001316 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001317 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001318 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001319 */
Amith Yamasani16452032017-03-03 10:15:57 -08001320 @SystemApi
Bjorn Bringertbc086862013-03-01 12:59:24 +00001321 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1322 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1323
1324 /**
Adam Skory7140a252013-09-11 12:04:58 +01001325 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1326 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001327 */
1328 public static final String EXTRA_ASSIST_PACKAGE
1329 = "android.intent.extra.ASSIST_PACKAGE";
1330
1331 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001332 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1333 * application package at the time the assist was invoked.
1334 */
1335 public static final String EXTRA_ASSIST_UID
1336 = "android.intent.extra.ASSIST_UID";
1337
1338 /**
Adam Skory7140a252013-09-11 12:04:58 +01001339 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1340 * information supplied by the current foreground app at the time of the assist request.
1341 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001342 */
1343 public static final String EXTRA_ASSIST_CONTEXT
1344 = "android.intent.extra.ASSIST_CONTEXT";
1345
Jim Miller07994402012-05-02 14:22:27 -07001346 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001347 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1348 * keyboard as the primary input device for assistance.
1349 */
1350 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1351 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1352
1353 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001354 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1355 * that was used to invoke the assist.
1356 */
1357 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1358 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1359
1360 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001361 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001362 * <p>Input: Nothing.
1363 * <p>Output: nothing.
1364 */
1365 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1366 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1367 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001368 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001369 * <p>Input: Nothing.
1370 * <p>Output: Nothing.
1371 */
1372 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1373 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1374
1375 /**
1376 * Activity Action: Show activity for reporting a bug.
1377 * <p>Input: Nothing.
1378 * <p>Output: Nothing.
1379 */
1380 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1381 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1382
1383 /**
1384 * Activity Action: Main entry point for factory tests. Only used when
1385 * the device is booting in factory test node. The implementing package
1386 * must be installed in the system image.
1387 * <p>Input: nothing
1388 * <p>Output: nothing
1389 */
1390 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1391
1392 /**
1393 * Activity Action: The user pressed the "call" button to go to the dialer
1394 * or other appropriate UI for placing a call.
1395 * <p>Input: Nothing.
1396 * <p>Output: Nothing.
1397 */
1398 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1399 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1400
1401 /**
1402 * Activity Action: Start Voice Command.
1403 * <p>Input: Nothing.
1404 * <p>Output: Nothing.
1405 */
1406 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1407 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001408
1409 /**
1410 * Activity Action: Start action associated with long pressing on the
1411 * search key.
1412 * <p>Input: Nothing.
1413 * <p>Output: Nothing.
1414 */
1415 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1416 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001417
Jacek Surazski86b6c532009-05-13 14:38:28 +02001418 /**
1419 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1420 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001421 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001422 * <p>Input: No data is specified. The bug report is passed in using
1423 * an {@link #EXTRA_BUG_REPORT} field.
1424 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001425 *
1426 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001427 */
1428 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1429 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001430
1431 /**
1432 * Activity Action: Show power usage information to the user.
1433 * <p>Input: Nothing.
1434 * <p>Output: Nothing.
1435 */
1436 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1437 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001438
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001439 /**
1440 * Activity Action: Setup wizard to launch after a platform update. This
1441 * activity should have a string meta-data field associated with it,
1442 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1443 * the platform for setup. The activity will be launched only if
1444 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1445 * same value.
1446 * <p>Input: Nothing.
1447 * <p>Output: Nothing.
1448 * @hide
1449 */
1450 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1451 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001452
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001453 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001454 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1455 * <p>Input: Nothing.
1456 * <p>Output: Nothing.
1457 * @hide
1458 */
1459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1460 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001461 "com.android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001462
1463 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001464 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1465 * <p>Input: Nothing.
1466 * <p>Output: Nothing.
1467 * @hide
1468 */
1469 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1470 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001471 "com.android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001472
1473 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001474 * Activity Action: Show settings for managing network data usage of a
1475 * specific application. Applications should define an activity that offers
1476 * options to control data usage.
1477 */
1478 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1479 public static final String ACTION_MANAGE_NETWORK_USAGE =
1480 "android.intent.action.MANAGE_NETWORK_USAGE";
1481
1482 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001483 * Activity Action: Launch application installer.
1484 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001485 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001486 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1487 * you can also use "package:<package-name>" to install an application for the
1488 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001489 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1490 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1491 * <p>
1492 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1493 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001494 * <p>
1495 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1496 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1497 * in order to launch the application installer.
1498 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001499 *
1500 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1501 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1502 * @see #EXTRA_RETURN_RESULT
1503 */
1504 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1505 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1506
1507 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001508 * @hide
1509 * @deprecated Do not use. This will go away.
1510 * Replace with {@link #ACTION_INSTALL_INSTANT_APP_PACKAGE}.
1511 */
1512 @SystemApi
1513 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1514 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1515 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1516 /**
1517 * Activity Action: Launch instant application installer.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001518 * <p class="note">
1519 * This is a protected intent that can only be sent by the system.
1520 * </p>
1521 *
1522 * @hide
1523 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001524 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001525 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001526 public static final String ACTION_INSTALL_INSTANT_APP_PACKAGE
1527 = "android.intent.action.INSTALL_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001528
1529 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001530 * @hide
1531 * @deprecated Do not use. This will go away.
1532 * Replace with {@link #ACTION_RESOLVE_INSTANT_APP_PACKAGE}.
1533 */
1534 @SystemApi
1535 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1536 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1537 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1538 /**
1539 * Service Action: Resolve instant application.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001540 * <p>
1541 * The system will have a persistent connection to this service.
1542 * This is a protected intent that can only be sent by the system.
1543 * </p>
1544 *
1545 * @hide
1546 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001547 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001548 @SdkConstant(SdkConstantType.SERVICE_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001549 public static final String ACTION_RESOLVE_INSTANT_APP_PACKAGE
1550 = "android.intent.action.RESOLVE_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001551
1552 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001553 * @hide
1554 * @deprecated Do not use. This will go away.
1555 * Replace with {@link #ACTION_INSTANT_APP_RESOLVER_SETTINGS}.
1556 */
1557 @SystemApi
1558 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1559 public static final String ACTION_EPHEMERAL_RESOLVER_SETTINGS
1560 = "android.intent.action.EPHEMERAL_RESOLVER_SETTINGS";
1561 /**
1562 * Activity Action: Launch instant app settings.
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001563 *
1564 * <p class="note">
1565 * This is a protected intent that can only be sent by the system.
1566 * </p>
1567 *
1568 * @hide
1569 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001570 @SystemApi
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001571 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001572 public static final String ACTION_INSTANT_APP_RESOLVER_SETTINGS
1573 = "android.intent.action.INSTANT_APP_RESOLVER_SETTINGS";
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001574
1575 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001576 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1577 * package. Specifies the installer package name; this package will receive the
1578 * {@link #ACTION_APP_ERROR} intent.
1579 */
1580 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1581 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1582
1583 /**
1584 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1585 * package. Specifies that the application being installed should not be
1586 * treated as coming from an unknown source, but as coming from the app
1587 * invoking the Intent. For this to work you must start the installer with
1588 * startActivityForResult().
1589 */
1590 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1591 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1592
1593 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001594 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1595 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001596 * data field originated from.
1597 */
rich cannings706e8ba2012-08-20 13:20:14 -07001598 public static final String EXTRA_ORIGINATING_URI
1599 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001600
1601 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001602 * This extra can be used with any Intent used to launch an activity, supplying information
1603 * about who is launching that activity. This field contains a {@link android.net.Uri}
1604 * object, typically an http: or https: URI of the web site that the referral came from;
1605 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1606 * a native application that it came from.
1607 *
1608 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1609 * instead of directly retrieving the extra. It is also valid for applications to
1610 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1611 * a string, not a Uri; the field here, if supplied, will always take precedence,
1612 * however.</p>
1613 *
1614 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001615 */
1616 public static final String EXTRA_REFERRER
1617 = "android.intent.extra.REFERRER";
1618
1619 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001620 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1621 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1622 * not be created, in particular when Intent extras are supplied through the
1623 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1624 * schemes.
1625 *
1626 * @see #EXTRA_REFERRER
1627 */
1628 public static final String EXTRA_REFERRER_NAME
1629 = "android.intent.extra.REFERRER_NAME";
1630
1631 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001632 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001633 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Ben Gruver37d83a32012-09-27 13:02:06 -07001634 * @hide
1635 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001636 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001637 public static final String EXTRA_ORIGINATING_UID
1638 = "android.intent.extra.ORIGINATING_UID";
1639
1640 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001641 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1642 * package. Tells the installer UI to skip the confirmation with the user
1643 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001644 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1645 * will no longer show an interstitial message about updating existing
1646 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001647 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001648 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001649 public static final String EXTRA_ALLOW_REPLACE
1650 = "android.intent.extra.ALLOW_REPLACE";
1651
1652 /**
1653 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1654 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1655 * return to the application the result code of the install/uninstall. The returned result
1656 * code will be {@link android.app.Activity#RESULT_OK} on success or
1657 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1658 */
1659 public static final String EXTRA_RETURN_RESULT
1660 = "android.intent.extra.RETURN_RESULT";
1661
1662 /**
1663 * Package manager install result code. @hide because result codes are not
1664 * yet ready to be exposed.
1665 */
1666 public static final String EXTRA_INSTALL_RESULT
1667 = "android.intent.extra.INSTALL_RESULT";
1668
1669 /**
1670 * Activity Action: Launch application uninstaller.
1671 * <p>
1672 * Input: The data must be a package: URI whose scheme specific part is
1673 * the package name of the current installed package to be uninstalled.
1674 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1675 * <p>
1676 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1677 * succeeded.
1678 */
1679 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1680 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1681
1682 /**
msnider3c191b82017-01-23 14:23:16 -08001683 * Activity Action: Launch application uninstaller.
1684 * <p>
1685 * Input: The data must be a package: URI whose scheme specific part is
1686 * the package name of the current installed package to be uninstalled.
1687 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1688 * <p>
1689 * Output: Nothing.
1690 * </p>
1691 */
1692 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1693 public static final String ACTION_CLEAR_PACKAGE = "android.intent.action.CLEAR_PACKAGE";
1694
1695 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001696 * Specify whether the package should be uninstalled for all users.
1697 * @hide because these should not be part of normal application flow.
1698 */
1699 public static final String EXTRA_UNINSTALL_ALL_USERS
1700 = "android.intent.extra.UNINSTALL_ALL_USERS";
1701
1702 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001703 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1704 * describing the last run version of the platform that was setup.
1705 * @hide
1706 */
1707 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1708
Svet Ganov3695b8a2015-03-24 16:30:25 -07001709 /**
1710 * Activity action: Launch UI to manage the permissions of an app.
1711 * <p>
1712 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1713 * will be managed by the launched UI.
1714 * </p>
1715 * <p>
1716 * Output: Nothing.
1717 * </p>
1718 *
1719 * @see #EXTRA_PACKAGE_NAME
1720 *
1721 * @hide
1722 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001723 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001724 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1725 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1726 "android.intent.action.MANAGE_APP_PERMISSIONS";
1727
1728 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001729 * Activity action: Launch UI to manage permissions.
1730 * <p>
1731 * Input: Nothing.
1732 * </p>
1733 * <p>
1734 * Output: Nothing.
1735 * </p>
1736 *
1737 * @hide
1738 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001739 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001740 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1741 public static final String ACTION_MANAGE_PERMISSIONS =
1742 "android.intent.action.MANAGE_PERMISSIONS";
1743
1744 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001745 * Activity action: Launch UI to review permissions for an app.
1746 * The system uses this intent if permission review for apps not
1747 * supporting the new runtime permissions model is enabled. In
1748 * this mode a permission review is required before any of the
1749 * app components can run.
1750 * <p>
1751 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1752 * permissions will be reviewed (mandatory).
1753 * </p>
1754 * <p>
1755 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1756 * be fired after the permission review (optional).
1757 * </p>
1758 * <p>
1759 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1760 * be invoked after the permission review (optional).
1761 * </p>
1762 * <p>
1763 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1764 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1765 * </p>
1766 * <p>
1767 * Output: Nothing.
1768 * </p>
1769 *
1770 * @see #EXTRA_PACKAGE_NAME
1771 * @see #EXTRA_INTENT
1772 * @see #EXTRA_REMOTE_CALLBACK
1773 * @see #EXTRA_RESULT_NEEDED
1774 *
1775 * @hide
1776 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001777 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001778 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1779 public static final String ACTION_REVIEW_PERMISSIONS =
1780 "android.intent.action.REVIEW_PERMISSIONS";
1781
1782 /**
1783 * Intent extra: A callback for reporting remote result as a bundle.
1784 * <p>
1785 * Type: IRemoteCallback
1786 * </p>
1787 *
1788 * @hide
1789 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001790 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001791 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1792
1793 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001794 * Intent extra: An app package name.
1795 * <p>
1796 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001797 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001798 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001799 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001800 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1801
1802 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001803 * Intent extra: An app split name.
1804 * <p>
1805 * Type: String
1806 * </p>
1807 * @hide
1808 */
1809 @SystemApi
1810 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1811
1812 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001813 * Intent extra: An extra for specifying whether a result is needed.
1814 * <p>
1815 * Type: boolean
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_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1822
1823 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001824 * Activity action: Launch UI to manage which apps have a given permission.
1825 * <p>
1826 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1827 * to which will be managed by the launched UI.
1828 * </p>
1829 * <p>
1830 * Output: Nothing.
1831 * </p>
1832 *
1833 * @see #EXTRA_PERMISSION_NAME
1834 *
1835 * @hide
1836 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001837 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001838 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1839 public static final String ACTION_MANAGE_PERMISSION_APPS =
1840 "android.intent.action.MANAGE_PERMISSION_APPS";
1841
1842 /**
1843 * Intent extra: The name of a permission.
1844 * <p>
1845 * Type: String
1846 * </p>
1847 *
1848 * @hide
1849 */
1850 @SystemApi
1851 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1852
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001853 // ---------------------------------------------------------------------
1854 // ---------------------------------------------------------------------
1855 // Standard intent broadcast actions (see action variable).
1856
1857 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001858 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1859 * <p>
1860 * For historical reasons, the name of this broadcast action refers to the power
1861 * state of the screen but it is actually sent in response to changes in the
1862 * overall interactive state of the device.
1863 * </p><p>
1864 * This broadcast is sent when the device becomes non-interactive which may have
1865 * nothing to do with the screen turning off. To determine the
1866 * actual state of the screen, use {@link android.view.Display#getState}.
1867 * </p><p>
1868 * See {@link android.os.PowerManager#isInteractive} for details.
1869 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001870 * You <em>cannot</em> receive this through components declared in
1871 * manifests, only by explicitly registering for it with
1872 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1873 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001874 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001875 * <p class="note">This is a protected intent that can only be sent
1876 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001877 */
1878 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1879 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001880
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001881 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001882 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1883 * <p>
1884 * For historical reasons, the name of this broadcast action refers to the power
1885 * state of the screen but it is actually sent in response to changes in the
1886 * overall interactive state of the device.
1887 * </p><p>
1888 * This broadcast is sent when the device becomes interactive which may have
1889 * nothing to do with the screen turning on. To determine the
1890 * actual state of the screen, use {@link android.view.Display#getState}.
1891 * </p><p>
1892 * See {@link android.os.PowerManager#isInteractive} for details.
1893 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001894 * You <em>cannot</em> receive this through components declared in
1895 * manifests, only by explicitly registering for it with
1896 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1897 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001898 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001899 * <p class="note">This is a protected intent that can only be sent
1900 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001901 */
1902 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1903 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001904
1905 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001906 * Broadcast Action: Sent after the system stops dreaming.
1907 *
1908 * <p class="note">This is a protected intent that can only be sent by the system.
1909 * It is only sent to registered receivers.</p>
1910 */
1911 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1912 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1913
1914 /**
1915 * Broadcast Action: Sent after the system starts dreaming.
1916 *
1917 * <p class="note">This is a protected intent that can only be sent by the system.
1918 * It is only sent to registered receivers.</p>
1919 */
1920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1921 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1922
1923 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001924 * 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 -07001925 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001926 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001927 * <p class="note">This is a protected intent that can only be sent
1928 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001929 */
1930 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001931 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001932
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001933 /**
1934 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001935 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001936 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001937 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1938 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001939 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001940 * <p class="note">This is a protected intent that can only be sent
1941 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001942 */
1943 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1944 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1945 /**
1946 * Broadcast Action: The time was set.
1947 */
1948 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1949 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1950 /**
1951 * Broadcast Action: The date has changed.
1952 */
1953 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1954 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1955 /**
1956 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1957 * <ul>
1958 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1959 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001960 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001961 * <p class="note">This is a protected intent that can only be sent
1962 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001963 */
1964 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1965 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1966 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001967 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1968 * DNS entries should be tossed.
1969 * @hide
1970 */
1971 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1972 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1973 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001974 * Alarm Changed Action: This is broadcast when the AlarmClock
1975 * application's alarm is set or unset. It is used by the
1976 * AlarmClock application and the StatusBar service.
1977 * @hide
1978 */
1979 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1980 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001981
1982 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001983 * Broadcast Action: This is broadcast once, after the user has finished
1984 * booting, but while still in the "locked" state. It can be used to perform
1985 * application-specific initialization, such as installing alarms. You must
1986 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1987 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001988 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001989 * This broadcast is sent immediately at boot by all devices (regardless of
1990 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1991 * higher. Upon receipt of this broadcast, the user is still locked and only
1992 * device-protected storage can be accessed safely. If you want to access
1993 * credential-protected storage, you need to wait for the user to be
1994 * unlocked (typically by entering their lock pattern or PIN for the first
1995 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1996 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1997 * <p>
1998 * To receive this broadcast, your receiver component must be marked as
1999 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002000 * <p class="note">
2001 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002002 *
2003 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002004 */
2005 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2006 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2007
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002008 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002009 * Broadcast Action: This is broadcast once, after the user has finished
2010 * booting. It can be used to perform application-specific initialization,
2011 * such as installing alarms. You must hold the
2012 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2013 * order to receive this broadcast.
2014 * <p>
2015 * This broadcast is sent at boot by all devices (both with and without
2016 * direct boot support). Upon receipt of this broadcast, the user is
2017 * unlocked and both device-protected and credential-protected storage can
2018 * accessed safely.
2019 * <p>
2020 * If you need to run while the user is still locked (before they've entered
2021 * their lock pattern or PIN for the first time), you can listen for the
2022 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2023 * <p class="note">
2024 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002025 */
2026 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002027 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002028 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002029
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002030 /**
2031 * Broadcast Action: This is broadcast when a user action should request a
2032 * temporary system dialog to dismiss. Some examples of temporary system
2033 * dialogs are the notification window-shade and the recent tasks dialog.
2034 */
2035 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2036 /**
2037 * Broadcast Action: Trigger the download and eventual installation
2038 * of a package.
2039 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002040 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002041 * <p class="note">This is a protected intent that can only be sent
2042 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002043 *
2044 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002045 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002046 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002047 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2048 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2049 /**
2050 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002051 * device. The data contains the name of the package. Note that the
2052 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002053 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002054 * <ul>
2055 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2056 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
2057 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2058 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002059 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002060 * <p class="note">This is a protected intent that can only be sent
2061 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002062 */
2063 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2064 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2065 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002066 * Broadcast Action: A new version of an application package has been
2067 * installed, replacing an existing version that was previously installed.
2068 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002069 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002070 * <ul>
2071 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2072 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002073 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002074 * <p class="note">This is a protected intent that can only be sent
2075 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002076 */
2077 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2078 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2079 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002080 * Broadcast Action: A new version of your application has been installed
2081 * over an existing one. This is only sent to the application that was
2082 * replaced. It does not contain any additional data; to receive it, just
2083 * use an intent filter for this action.
2084 *
2085 * <p class="note">This is a protected intent that can only be sent
2086 * by the system.
2087 */
2088 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2089 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2090 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002091 * Broadcast Action: An existing application package has been removed from
2092 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002093 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002094 * <ul>
2095 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2096 * to the package.
2097 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2098 * application -- data and code -- is being removed.
2099 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2100 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2101 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002102 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002103 * <p class="note">This is a protected intent that can only be sent
2104 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002105 */
2106 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2107 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2108 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002109 * Broadcast Action: An existing application package has been completely
2110 * removed from the device. The data contains the name of the package.
2111 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2112 * {@link #EXTRA_DATA_REMOVED} is true and
2113 * {@link #EXTRA_REPLACING} is false of that broadcast.
2114 *
2115 * <ul>
2116 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2117 * to the package.
2118 * </ul>
2119 *
2120 * <p class="note">This is a protected intent that can only be sent
2121 * by the system.
2122 */
2123 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2124 public static final String ACTION_PACKAGE_FULLY_REMOVED
2125 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2126 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002127 * Broadcast Action: An existing application package has been changed (for
2128 * example, a component has been enabled or disabled). The data contains
2129 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002130 * <ul>
2131 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002132 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002133 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002134 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2135 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002136 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002137 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002138 * <p class="note">This is a protected intent that can only be sent
2139 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002140 */
2141 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2142 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2143 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002144 * @hide
2145 * Broadcast Action: Ask system services if there is any reason to
2146 * restart the given package. The data contains the name of the
2147 * package.
2148 * <ul>
2149 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2150 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2151 * </ul>
2152 *
2153 * <p class="note">This is a protected intent that can only be sent
2154 * by the system.
2155 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002156 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002157 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2158 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2159 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002160 * Broadcast Action: The user has restarted a package, and all of its
2161 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002162 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002163 * be removed. Note that the restarted package does <em>not</em>
2164 * receive this broadcast.
2165 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002166 * <ul>
2167 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2168 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002169 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002170 * <p class="note">This is a protected intent that can only be sent
2171 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002172 */
2173 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2174 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2175 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002176 * Broadcast Action: The user has cleared the data of a package. This should
2177 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002178 * its persistent data is erased and this broadcast sent.
2179 * Note that the cleared package does <em>not</em>
2180 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002181 * <ul>
2182 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2183 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002184 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002185 * <p class="note">This is a protected intent that can only be sent
2186 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002187 */
2188 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2189 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2190 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002191 * Broadcast Action: Packages have been suspended.
2192 * <p>Includes the following extras:
2193 * <ul>
2194 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2195 * </ul>
2196 *
2197 * <p class="note">This is a protected intent that can only be sent
2198 * by the system. It is only sent to registered receivers.
2199 */
2200 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2201 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2202 /**
2203 * Broadcast Action: Packages have been unsuspended.
2204 * <p>Includes the following extras:
2205 * <ul>
2206 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2207 * </ul>
2208 *
2209 * <p class="note">This is a protected intent that can only be sent
2210 * by the system. It is only sent to registered receivers.
2211 */
2212 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2213 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2214 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002215 * Broadcast Action: A user ID has been removed from the system. The user
2216 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002217 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002218 * <p class="note">This is a protected intent that can only be sent
2219 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002220 */
2221 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2222 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002223
2224 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002225 * Broadcast Action: Sent to the installer package of an application when
2226 * that application is first launched (that is the first time it is moved
2227 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002228 *
2229 * <p class="note">This is a protected intent that can only be sent
2230 * by the system.
2231 */
2232 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2233 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2234
2235 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002236 * Broadcast Action: Sent to the system package verifier when a package
2237 * needs to be verified. The data contains the package URI.
2238 * <p class="note">
2239 * This is a protected intent that can only be sent by the system.
2240 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002241 */
2242 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2243 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2244
2245 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002246 * Broadcast Action: Sent to the system package verifier when a package is
2247 * verified. The data contains the package URI.
2248 * <p class="note">
2249 * This is a protected intent that can only be sent by the system.
2250 */
2251 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2252 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2253
2254 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002255 * Broadcast Action: Sent to the system intent filter verifier when an
2256 * intent filter needs to be verified. The data contains the filter data
2257 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002258 * <p class="note">
2259 * This is a protected intent that can only be sent by the system.
2260 * </p>
2261 *
2262 * @hide
2263 */
2264 @SystemApi
2265 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2266 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2267
2268 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002269 * Broadcast Action: Resources for a set of packages (which were
2270 * previously unavailable) are currently
2271 * available since the media on which they exist is available.
2272 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2273 * list of packages whose availability changed.
2274 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2275 * list of uids of packages whose availability changed.
2276 * Note that the
2277 * packages in this list do <em>not</em> receive this broadcast.
2278 * The specified set of packages are now available on the system.
2279 * <p>Includes the following extras:
2280 * <ul>
2281 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2282 * whose resources(were previously unavailable) are currently available.
2283 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2284 * packages whose resources(were previously unavailable)
2285 * are currently available.
2286 * </ul>
2287 *
2288 * <p class="note">This is a protected intent that can only be sent
2289 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002290 */
2291 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002292 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2293 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002294
2295 /**
2296 * Broadcast Action: Resources for a set of packages are currently
2297 * unavailable since the media on which they exist is unavailable.
2298 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2299 * list of packages whose availability changed.
2300 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2301 * list of uids of packages whose availability changed.
2302 * The specified set of packages can no longer be
2303 * launched and are practically unavailable on the system.
2304 * <p>Inclues the following extras:
2305 * <ul>
2306 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2307 * whose resources are no longer available.
2308 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2309 * whose resources are no longer available.
2310 * </ul>
2311 *
2312 * <p class="note">This is a protected intent that can only be sent
2313 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002314 */
2315 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002316 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002317 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002318
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002319 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002320 * Broadcast Action: preferred activities have changed *explicitly*.
2321 *
2322 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2323 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2324 * be sent.
2325 *
2326 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2327 *
2328 * @hide
2329 */
2330 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2331 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2332 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2333
2334
2335 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002336 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002337 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002338 * This should <em>only</em> be used to determine when the wallpaper
2339 * has changed to show the new wallpaper to the user. You should certainly
2340 * never, in response to this, change the wallpaper or other attributes of
2341 * it such as the suggested size. That would be crazy, right? You'd cause
2342 * all kinds of loops, especially if other apps are doing similar things,
2343 * right? Of course. So please don't do this.
2344 *
2345 * @deprecated Modern applications should use
2346 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2347 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2348 * shown behind their UI, rather than watching for this broadcast and
2349 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002350 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002351 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002352 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2353 /**
2354 * Broadcast Action: The current device {@link android.content.res.Configuration}
2355 * (orientation, locale, etc) has changed. When such a change happens, the
2356 * UIs (view hierarchy) will need to be rebuilt based on this new
2357 * information; for the most part, applications don't need to worry about
2358 * this, because the system will take care of stopping and restarting the
2359 * application to make sure it sees the new changes. Some system code that
2360 * can not be restarted will need to watch for this action and handle it
2361 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002362 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002363 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002364 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002365 * in manifests, only by explicitly registering for it with
2366 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2367 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002368 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002369 * <p class="note">This is a protected intent that can only be sent
2370 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002371 *
2372 * @see android.content.res.Configuration
2373 */
2374 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2375 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2376 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002377 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002378 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002379 * <p class="note">This is a protected intent that can only be sent
2380 * by the system.
2381 */
2382 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2383 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2384 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002385 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2386 * charging state, level, and other information about the battery.
2387 * See {@link android.os.BatteryManager} for documentation on the
2388 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002389 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002390 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002391 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002392 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002393 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002394 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2395 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2396 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2397 * broadcasts that are sent and can be received through manifest
2398 * receivers.
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 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2404 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2405 /**
2406 * Broadcast Action: Indicates low battery condition on the device.
2407 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002408 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002409 * <p class="note">This is a protected intent that can only be sent
2410 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002411 */
2412 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2413 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2414 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002415 * Broadcast Action: Indicates the battery is now okay after being low.
2416 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2417 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002418 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002419 * <p class="note">This is a protected intent that can only be sent
2420 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002421 */
2422 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2423 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2424 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002425 * Broadcast Action: External power has been connected to the device.
2426 * This is intended for applications that wish to register specifically to this notification.
2427 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2428 * stay active to receive this notification. This action can be used to implement actions
2429 * that wait until power is available to trigger.
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.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002433 */
2434 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002435 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002436 /**
2437 * Broadcast Action: External power has been removed from the device.
2438 * This is intended for applications that wish to register specifically to this notification.
2439 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2440 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002441 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002442 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002443 * <p class="note">This is a protected intent that can only be sent
2444 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002445 */
2446 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002447 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002448 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002449 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002450 * Broadcast Action: Device is shutting down.
2451 * This is broadcast when the device is being shut down (completely turned
2452 * off, not sleeping). Once the broadcast is complete, the final shutdown
2453 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002454 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002455 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002456 * <p class="note">This is a protected intent that can only be sent
2457 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002458 * <p>May include the following extras:
2459 * <ul>
2460 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2461 * shutdown is only for userspace processes. If not set, assumed to be false.
2462 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002463 */
2464 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002465 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002466 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002467 * Activity Action: Start this activity to request system shutdown.
2468 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002469 * to request confirmation from the user before shutting down. The optional boolean
2470 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2471 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002472 *
2473 * <p class="note">This is a protected intent that can only be sent
2474 * by the system.
2475 *
2476 * {@hide}
2477 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002478 public static final String ACTION_REQUEST_SHUTDOWN
2479 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002480 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002481 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002482 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002483 * <p class="note">
2484 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002485 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002486 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2487 * or above, this broadcast will no longer be delivered to any
2488 * {@link BroadcastReceiver} defined in your manifest. Instead,
2489 * apps are strongly encouraged to use the improved
2490 * {@link Context#getCacheDir()} behavior so the system can
2491 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002492 */
2493 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002494 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002495 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2496 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002497 * Broadcast Action: Indicates low storage space condition on the device no
2498 * longer exists
2499 * <p class="note">
2500 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002501 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002502 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2503 * or above, this broadcast will no longer be delivered to any
2504 * {@link BroadcastReceiver} defined in your manifest. Instead,
2505 * apps are strongly encouraged to use the improved
2506 * {@link Context#getCacheDir()} behavior so the system can
2507 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002508 */
2509 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002510 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002511 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2512 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002513 * Broadcast Action: A sticky broadcast that indicates a storage space full
2514 * condition on the device. This is intended for activities that want to be
2515 * able to fill the data partition completely, leaving only enough free
2516 * space to prevent system-wide SQLite failures.
2517 * <p class="note">
2518 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002519 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002520 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2521 * or above, this broadcast will no longer be delivered to any
2522 * {@link BroadcastReceiver} defined in your manifest. Instead,
2523 * apps are strongly encouraged to use the improved
2524 * {@link Context#getCacheDir()} behavior so the system can
2525 * automatically free up storage when needed.
2526 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002527 */
2528 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002529 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002530 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2531 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002532 * Broadcast Action: Indicates storage space full condition on the device no
2533 * longer exists.
2534 * <p class="note">
2535 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002536 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002537 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2538 * or above, this broadcast will no longer be delivered to any
2539 * {@link BroadcastReceiver} defined in your manifest. Instead,
2540 * apps are strongly encouraged to use the improved
2541 * {@link Context#getCacheDir()} behavior so the system can
2542 * automatically free up storage when needed.
2543 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002544 */
2545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002546 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002547 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2548 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002549 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2550 * and package management should be started.
2551 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2552 * notification.
2553 */
2554 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2555 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2556 /**
2557 * Broadcast Action: The device has entered USB Mass Storage mode.
2558 * This is used mainly for the USB Settings panel.
2559 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2560 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002561 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002562 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002563 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002564 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2565
2566 /**
2567 * Broadcast Action: The device has exited USB Mass Storage mode.
2568 * This is used mainly for the USB Settings panel.
2569 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2570 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002571 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002572 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002573 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002574 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2575
2576 /**
2577 * Broadcast Action: External media has been removed.
2578 * The path to the mount point for the removed media is contained in the Intent.mData field.
2579 */
2580 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2581 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2582
2583 /**
2584 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002585 * 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 -07002586 */
2587 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2588 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2589
2590 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002591 * Broadcast Action: External media is present, and being disk-checked
2592 * 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 -08002593 */
2594 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2595 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2596
2597 /**
2598 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2599 * 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 -08002600 */
2601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2602 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2603
2604 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002605 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002606 * 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 -07002607 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2608 * media was mounted read only.
2609 */
2610 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2611 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2612
2613 /**
2614 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002615 * 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 -07002616 */
2617 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2618 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2619
2620 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002621 * Broadcast Action: External media is no longer being shared via USB mass storage.
2622 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2623 *
2624 * @hide
2625 */
2626 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2627
2628 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002629 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2630 * The path to the mount point for the removed media is contained in the Intent.mData field.
2631 */
2632 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2633 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2634
2635 /**
2636 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002637 * 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 -07002638 */
2639 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2640 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2641
2642 /**
2643 * Broadcast Action: User has expressed the desire to remove the external storage media.
2644 * Applications should close all files they have open within the mount point when they receive this intent.
2645 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2646 */
2647 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2648 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2649
2650 /**
2651 * Broadcast Action: The media scanner has started scanning a directory.
2652 * The path to the directory being scanned is contained in the Intent.mData field.
2653 */
2654 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2655 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2656
2657 /**
2658 * Broadcast Action: The media scanner has finished scanning a directory.
2659 * The path to the scanned directory is contained in the Intent.mData field.
2660 */
2661 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2662 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2663
2664 /**
2665 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2666 * The path to the file is contained in the Intent.mData field.
2667 */
2668 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2669 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2670
2671 /**
2672 * Broadcast Action: The "Media Button" was pressed. Includes a single
2673 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2674 * caused the broadcast.
2675 */
2676 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2677 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2678
2679 /**
2680 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2681 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2682 * caused the broadcast.
2683 */
2684 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2685 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2686
2687 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2688 // location; they are not general-purpose actions.
2689
2690 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002691 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002692 */
2693 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2694 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2695 "android.intent.action.GTALK_CONNECTED";
2696
2697 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002698 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002699 */
2700 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2701 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2702 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002703
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002704 /**
2705 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002706 */
2707 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2708 public static final String ACTION_INPUT_METHOD_CHANGED =
2709 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002710
2711 /**
2712 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2713 * more radios have been turned off or on. The intent will have the following extra value:</p>
2714 * <ul>
2715 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2716 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2717 * turned off</li>
2718 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002719 *
Peng Xua35b5532016-01-20 00:05:45 -08002720 * <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 -07002721 */
2722 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2723 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2724
2725 /**
2726 * Broadcast Action: Some content providers have parts of their namespace
2727 * where they publish new events or items that the user may be especially
2728 * interested in. For these things, they may broadcast this action when the
2729 * set of interesting items change.
2730 *
2731 * For example, GmailProvider sends this notification when the set of unread
2732 * mail in the inbox changes.
2733 *
2734 * <p>The data of the intent identifies which part of which provider
2735 * changed. When queried through the content resolver, the data URI will
2736 * return the data set in question.
2737 *
2738 * <p>The intent will have the following extra values:
2739 * <ul>
2740 * <li><em>count</em> - The number of items in the data set. This is the
2741 * same as the number of items in the cursor returned by querying the
2742 * data URI. </li>
2743 * </ul>
2744 *
2745 * This intent will be sent at boot (if the count is non-zero) and when the
2746 * data set changes. It is possible for the data set to change without the
2747 * count changing (for example, if a new unread message arrives in the same
2748 * sync operation in which a message is archived). The phone should still
2749 * ring/vibrate/etc as normal in this case.
2750 */
2751 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2752 public static final String ACTION_PROVIDER_CHANGED =
2753 "android.intent.action.PROVIDER_CHANGED";
2754
2755 /**
2756 * Broadcast Action: Wired Headset plugged in or unplugged.
2757 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002758 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2759 * and documentation.
2760 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002761 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002762 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002763 */
2764 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002765 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002766
2767 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002768 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2769 * <ul>
2770 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2771 * </ul>
2772 *
2773 * <p class="note">This is a protected intent that can only be sent
2774 * by the system.
2775 *
2776 * @hide
2777 */
2778 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2779 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2780 = "android.intent.action.ADVANCED_SETTINGS";
2781
2782 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002783 * Broadcast Action: Sent after application restrictions are changed.
2784 *
2785 * <p class="note">This is a protected intent that can only be sent
2786 * by the system.</p>
2787 */
2788 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2789 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2790 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2791
2792 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002793 * Broadcast Action: An outgoing call is about to be placed.
2794 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002795 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002796 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002797 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002798 * the phone number originally intended to be dialed.</li>
2799 * </ul>
2800 * <p>Once the broadcast is finished, the resultData is used as the actual
2801 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002802 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002803 * outgoing call in turn: for example, a parental control application
2804 * might verify that the user is authorized to place the call at that
2805 * time, then a number-rewriting application might add an area code if
2806 * one was not specified.</p>
2807 * <p>For consistency, any receiver whose purpose is to prohibit phone
2808 * calls should have a priority of 0, to ensure it will see the final
2809 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002810 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002811 * should have a positive priority.
2812 * Negative priorities are reserved for the system for this broadcast;
2813 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002814 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2815 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002816 * <p>Emergency calls cannot be intercepted using this mechanism, and
2817 * other calls cannot be modified to call emergency numbers using this
2818 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002819 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2820 * call to use their own service instead. Those apps should first prevent
2821 * the call from being placed by setting resultData to <code>null</code>
2822 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002823 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002824 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2825 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002826 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002827 * <p class="note">This is a protected intent that can only be sent
2828 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002829 */
2830 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2831 public static final String ACTION_NEW_OUTGOING_CALL =
2832 "android.intent.action.NEW_OUTGOING_CALL";
2833
2834 /**
2835 * Broadcast Action: Have the device reboot. This is only for use by
2836 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002837 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002838 * <p class="note">This is a protected intent that can only be sent
2839 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002840 */
2841 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2842 public static final String ACTION_REBOOT =
2843 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002844
Wei Huang97ecc9c2009-05-11 17:44:20 -07002845 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002846 * Broadcast Action: A sticky broadcast for changes in the physical
2847 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002848 *
2849 * <p>The intent will have the following extra values:
2850 * <ul>
2851 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002852 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002853 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002854 * <p>This is intended for monitoring the current physical dock state.
2855 * See {@link android.app.UiModeManager} for the normal API dealing with
2856 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002857 */
2858 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2859 public static final String ACTION_DOCK_EVENT =
2860 "android.intent.action.DOCK_EVENT";
2861
2862 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002863 * Broadcast Action: A broadcast when idle maintenance can be started.
2864 * This means that the user is not interacting with the device and is
2865 * not expected to do so soon. Typical use of the idle maintenance is
2866 * to perform somehow expensive tasks that can be postponed at a moment
2867 * when they will not degrade user experience.
2868 * <p>
2869 * <p class="note">In order to keep the device responsive in case of an
2870 * unexpected user interaction, implementations of a maintenance task
2871 * should be interruptible. In such a scenario a broadcast with action
2872 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2873 * should not do the maintenance work in
2874 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2875 * maintenance service by {@link Context#startService(Intent)}. Also
2876 * you should hold a wake lock while your maintenance service is running
2877 * to prevent the device going to sleep.
2878 * </p>
2879 * <p>
2880 * <p class="note">This is a protected intent that can only be sent by
2881 * the system.
2882 * </p>
2883 *
2884 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002885 *
2886 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002887 */
2888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2889 public static final String ACTION_IDLE_MAINTENANCE_START =
2890 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2891
2892 /**
2893 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2894 * This means that the user was not interacting with the device as a result
2895 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2896 * was sent and now the user started interacting with the device. Typical
2897 * use of the idle maintenance is to perform somehow expensive tasks that
2898 * can be postponed at a moment when they will not degrade user experience.
2899 * <p>
2900 * <p class="note">In order to keep the device responsive in case of an
2901 * unexpected user interaction, implementations of a maintenance task
2902 * should be interruptible. Hence, on receiving a broadcast with this
2903 * action, the maintenance task should be interrupted as soon as possible.
2904 * In other words, you should not do the maintenance work in
2905 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2906 * maintenance service that was started on receiving of
2907 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2908 * lock you acquired when your maintenance service started.
2909 * </p>
2910 * <p class="note">This is a protected intent that can only be sent
2911 * by the system.
2912 *
2913 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002914 *
2915 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002916 */
2917 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2918 public static final String ACTION_IDLE_MAINTENANCE_END =
2919 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2920
2921 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002922 * Broadcast Action: a remote intent is to be broadcasted.
2923 *
2924 * A remote intent is used for remote RPC between devices. The remote intent
2925 * is serialized and sent from one device to another device. The receiving
2926 * device parses the remote intent and broadcasts it. Note that anyone can
2927 * broadcast a remote intent. However, if the intent receiver of the remote intent
2928 * does not trust intent broadcasts from arbitrary intent senders, it should require
2929 * the sender to hold certain permissions so only trusted sender's broadcast will be
2930 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002931 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002932 */
2933 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002934 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002935
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002936 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002937 * Broadcast Action: This is broadcast once when the user is booting after a
2938 * system update. It can be used to perform cleanup or upgrades after a
2939 * system update.
2940 * <p>
2941 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2942 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2943 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2944 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002945 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002946 * @hide
2947 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08002948 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002949 public static final String ACTION_PRE_BOOT_COMPLETED =
2950 "android.intent.action.PRE_BOOT_COMPLETED";
2951
Amith Yamasani13593602012-03-22 16:16:17 -07002952 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002953 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002954 * on restricted users. The broadcast intent contains an extra
2955 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2956 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2957 * String[] depending on the restriction type.<p/>
2958 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002959 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2960 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2961 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002962 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2963 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002964 * @see RestrictionEntry
2965 */
2966 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2967 "android.intent.action.GET_RESTRICTION_ENTRIES";
2968
2969 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002970 * Sent the first time a user is starting, to allow system apps to
2971 * perform one time initialization. (This will not be seen by third
2972 * party applications because a newly initialized user does not have any
2973 * third party applications installed for it.) This is sent early in
2974 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002975 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2976 * broadcast, since it is part of a visible user interaction; be as quick
2977 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002978 */
2979 public static final String ACTION_USER_INITIALIZE =
2980 "android.intent.action.USER_INITIALIZE";
2981
2982 /**
2983 * Sent when a user switch is happening, causing the process's user to be
2984 * brought to the foreground. This is only sent to receivers registered
2985 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2986 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002987 * foreground. This is sent as a foreground
2988 * broadcast, since it is part of a visible user interaction; be as quick
2989 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002990 */
2991 public static final String ACTION_USER_FOREGROUND =
2992 "android.intent.action.USER_FOREGROUND";
2993
2994 /**
2995 * Sent when a user switch is happening, causing the process's user to be
2996 * sent to the background. This is only sent to receivers registered
2997 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2998 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002999 * background. This is sent as a foreground
3000 * broadcast, since it is part of a visible user interaction; be as quick
3001 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003002 */
3003 public static final String ACTION_USER_BACKGROUND =
3004 "android.intent.action.USER_BACKGROUND";
3005
3006 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003007 * Broadcast sent to the system when a user is added. Carries an extra
3008 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3009 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003010 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003011 * @hide
3012 */
3013 public static final String ACTION_USER_ADDED =
3014 "android.intent.action.USER_ADDED";
3015
3016 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003017 * Broadcast sent by the system when a user is started. Carries an extra
3018 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003019 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003020 * that has been started. 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 * @hide
3024 */
3025 public static final String ACTION_USER_STARTED =
3026 "android.intent.action.USER_STARTED";
3027
3028 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003029 * Broadcast sent when a user is in the process of starting. Carries an extra
3030 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3031 * sent to registered receivers, not manifest receivers. It is sent to all
3032 * users (including the one that is being started). You must hold
3033 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3034 * this broadcast. This is sent as a background broadcast, since
3035 * its result is not part of the primary UX flow; to safely keep track of
3036 * started/stopped state of a user you can use this in conjunction with
3037 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3038 * other user state broadcasts since those are foreground broadcasts so can
3039 * execute in a different order.
3040 * @hide
3041 */
3042 public static final String ACTION_USER_STARTING =
3043 "android.intent.action.USER_STARTING";
3044
3045 /**
3046 * Broadcast sent when a user is going to be stopped. Carries an extra
3047 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3048 * sent to registered receivers, not manifest receivers. It is sent to all
3049 * users (including the one that is being stopped). You must hold
3050 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3051 * this broadcast. The user will not stop until all receivers have
3052 * handled the broadcast. This is sent as a background broadcast, since
3053 * its result is not part of the primary UX flow; to safely keep track of
3054 * started/stopped state of a user you can use this in conjunction with
3055 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3056 * other user state broadcasts since those are foreground broadcasts so can
3057 * execute in a different order.
3058 * @hide
3059 */
3060 public static final String ACTION_USER_STOPPING =
3061 "android.intent.action.USER_STOPPING";
3062
3063 /**
3064 * Broadcast sent to the system when a user is stopped. Carries an extra
3065 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3066 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3067 * specific package. This is only sent to registered receivers, not manifest
3068 * receivers. It is sent to all running users <em>except</em> the one that
3069 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003070 * @hide
3071 */
3072 public static final String ACTION_USER_STOPPED =
3073 "android.intent.action.USER_STOPPED";
3074
3075 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003076 * 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 -07003077 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003078 * one that has been removed. The user will not be completely removed until all receivers have
3079 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003080 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003081 * @hide
3082 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003083 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003084 public static final String ACTION_USER_REMOVED =
3085 "android.intent.action.USER_REMOVED";
3086
3087 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003088 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003089 * the userHandle of the user to become the current one. This is only sent to
3090 * registered receivers, not manifest receivers. It is sent to all running users.
3091 * You must hold
3092 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003093 * @hide
3094 */
3095 public static final String ACTION_USER_SWITCHED =
3096 "android.intent.action.USER_SWITCHED";
3097
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003098 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003099 * Broadcast Action: Sent when the credential-encrypted private storage has
3100 * become unlocked for the target user. This is only sent to registered
3101 * receivers, not manifest receivers.
3102 */
3103 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3104 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3105
3106 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003107 * Broadcast sent to the system when a user's information changes. Carries an extra
3108 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003109 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003110 * @hide
3111 */
3112 public static final String ACTION_USER_INFO_CHANGED =
3113 "android.intent.action.USER_INFO_CHANGED";
3114
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003115 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003116 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3117 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003118 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3119 * that need to display merged content across both primary and managed profiles need to
3120 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003121 * not manifest receivers.
3122 */
3123 public static final String ACTION_MANAGED_PROFILE_ADDED =
3124 "android.intent.action.MANAGED_PROFILE_ADDED";
3125
3126 /**
3127 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003128 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3129 * Only applications (for example Launchers) that need to display merged content across both
3130 * primary and managed profiles need to worry about this broadcast. This is only sent to
3131 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003132 */
3133 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3134 "android.intent.action.MANAGED_PROFILE_REMOVED";
3135
3136 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003137 * Broadcast sent to the primary user when the credential-encrypted private storage for
3138 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3139 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3140 * Launchers) that need to display merged content across both primary and managed profiles
3141 * need to worry about this broadcast. This is only sent to registered receivers,
3142 * not manifest receivers.
3143 */
3144 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3145 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3146
3147 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003148 * Broadcast sent to the primary user when an associated managed profile has become available.
3149 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003150 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3151 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3152 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003153 */
Rubin Xue95057a2016-04-01 16:49:25 +01003154 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3155 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3156
3157 /**
3158 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3159 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3160 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3161 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3162 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3163 */
3164 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3165 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003166
3167 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003168 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3169 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3170 * the device was locked or unlocked.
3171 *
3172 * This is only sent to registered receivers.
3173 *
3174 * @hide
3175 */
3176 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3177 "android.intent.action.DEVICE_LOCKED_CHANGED";
3178
3179 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003180 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3181 */
3182 public static final String ACTION_QUICK_CLOCK =
3183 "android.intent.action.QUICK_CLOCK";
3184
Michael Wright0087a142013-02-05 16:29:39 -08003185 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003186 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003187 * @hide
3188 */
3189 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003190 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003191
Justin Kohd378ad72013-04-01 12:18:26 -07003192 /**
3193 * Broadcast Action: A global button was pressed. Includes a single
3194 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3195 * caused the broadcast.
3196 * @hide
3197 */
3198 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3199
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003200 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003201 * Broadcast Action: Sent when media resource is granted.
3202 * <p>
3203 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3204 * granted.
3205 * </p>
3206 * <p class="note">
3207 * This is a protected intent that can only be sent by the system.
3208 * </p>
3209 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003210 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003211 * </p>
3212 *
3213 * @hide
3214 */
3215 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3216 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3217
3218 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003219 * Broadcast Action: An overlay package has been installed. The data
3220 * contains the name of the added overlay package.
3221 * @hide
3222 */
3223 public static final String ACTION_OVERLAY_ADDED = "android.intent.action.OVERLAY_ADDED";
3224
3225 /**
3226 * Broadcast Action: An overlay package has changed. The data contains the
3227 * name of the overlay package which has changed. This is broadcast on all
3228 * changes to the OverlayInfo returned by {@link
3229 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3230 * most common change is a state change that will change whether the
3231 * overlay is enabled or not.
3232 * @hide
3233 */
3234 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3235
3236 /**
3237 * Broadcast Action: An overlay package has been removed. The data contains
3238 * the name of the overlay package which has been removed.
3239 * @hide
3240 */
3241 public static final String ACTION_OVERLAY_REMOVED = "android.intent.action.OVERLAY_REMOVED";
3242
3243 /**
3244 * Broadcast Action: The order of a package's list of overlay packages has
3245 * changed. The data contains the package name of the overlay package that
3246 * had its position in the list adjusted.
3247 * @hide
3248 */
3249 public static final String
3250 ACTION_OVERLAY_PRIORITY_CHANGED = "android.intent.action.OVERLAY_PRIORITY_CHANGED";
3251
3252 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003253 * Activity Action: Allow the user to select and return one or more existing
3254 * documents. When invoked, the system will display the various
3255 * {@link DocumentsProvider} instances installed on the device, letting the
3256 * user interactively navigate through them. These documents include local
3257 * media, such as photos and video, and documents provided by installed
3258 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003259 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003260 * Each document is represented as a {@code content://} URI backed by a
3261 * {@link DocumentsProvider}, which can be opened as a stream with
3262 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3263 * {@link android.provider.DocumentsContract.Document} metadata.
3264 * <p>
3265 * All selected documents are returned to the calling application with
3266 * persistable read and write permission grants. If you want to maintain
3267 * access to the documents across device reboots, you need to explicitly
3268 * take the persistable permissions using
3269 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3270 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003271 * Callers must indicate the acceptable document MIME types through
3272 * {@link #setType(String)}. For example, to select photos, use
3273 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3274 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3275 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003276 * <p>
3277 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003278 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3279 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003280 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003281 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3282 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003283 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003284 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003285 * Callers can set a document URI through
3286 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3287 * location of documents navigator. System will do its best to launch the
3288 * navigator in the specified document if it's a folder, or the folder that
3289 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003290 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003291 * Output: The URI of the item that was picked, returned in
3292 * {@link #getData()}. This must be a {@code content://} URI so that any
3293 * receiver can access it. If multiple documents were selected, they are
3294 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003295 *
3296 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003297 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003298 * @see #ACTION_CREATE_DOCUMENT
3299 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003300 */
3301 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3302 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3303
3304 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003305 * Activity Action: Allow the user to create a new document. When invoked,
3306 * the system will display the various {@link DocumentsProvider} instances
3307 * installed on the device, letting the user navigate through them. The
3308 * returned document may be a newly created document with no content, or it
3309 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003310 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003311 * Each document is represented as a {@code content://} URI backed by a
3312 * {@link DocumentsProvider}, which can be opened as a stream with
3313 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3314 * {@link android.provider.DocumentsContract.Document} metadata.
3315 * <p>
3316 * Callers must indicate the concrete MIME type of the document being
3317 * created by setting {@link #setType(String)}. This MIME type cannot be
3318 * changed after the document is created.
3319 * <p>
3320 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3321 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003322 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003323 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3324 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003325 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003326 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003327 * Callers can set a document URI through
3328 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3329 * location of documents navigator. System will do its best to launch the
3330 * navigator in the specified document if it's a folder, or the folder that
3331 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003332 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003333 * Output: The URI of the item that was created. This must be a
3334 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003335 *
3336 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003337 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003338 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003339 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003340 */
3341 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3342 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3343
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003344 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003345 * Activity Action: Allow the user to pick a directory subtree. When
3346 * invoked, the system will display the various {@link DocumentsProvider}
3347 * instances installed on the device, letting the user navigate through
3348 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003349 * <p>
3350 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003351 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3352 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3353 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003354 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003355 * Callers can set a document URI through
3356 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3357 * location of documents navigator. System will do its best to launch the
3358 * navigator in the specified document if it's a folder, or the folder that
3359 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003360 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003361 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003362 *
3363 * @see DocumentsContract
3364 */
3365 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003366 public static final String
3367 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003368
Felipe Lemec7b1f892016-01-15 15:02:31 -08003369 /**
Peng Xua35b5532016-01-20 00:05:45 -08003370 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3371 * exisiting sensor being disconnected.
3372 *
3373 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3374 *
3375 * {@hide}
3376 */
3377 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3378 public static final String
3379 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3380
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003381 /**
Sanket Padawe2c1a49f2017-03-31 12:39:50 -07003382 * Broadcast Action: The default subscription has changed. This has the following
3383 * extra values:</p>
3384 * The {@link #EXTRA_SUBSCRIPTION_INDEX} extra indicates the current default subscription index
3385 */
3386 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3387 public static final String ACTION_DEFAULT_SUBSCRIPTION_CHANGED
3388 = "android.intent.action.ACTION_DEFAULT_SUBSCRIPTION_CHANGED";
3389
3390 /**
3391 * Broadcast Action: The default sms subscription has changed. This has the following
3392 * extra values:</p>
3393 * {@link #EXTRA_SUBSCRIPTION_INDEX} extra indicates the current default sms
3394 * subscription index
3395 */
3396 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3397 public static final String ACTION_DEFAULT_SMS_SUBSCRIPTION_CHANGED
3398 = "android.intent.action.ACTION_DEFAULT_SMS_SUBSCRIPTION_CHANGED";
3399
3400 /**
3401 * Integer extra used with {@link #ACTION_DEFAULT_SUBSCRIPTION_CHANGED} and
3402 * {@link #ACTION_DEFAULT_SMS_SUBSCRIPTION_CHANGED} to indicate the subscription
3403 * which has changed.
3404 */
3405 public static final String EXTRA_SUBSCRIPTION_INDEX = "android.intent.extra.SUBSCRIPTION_INDEX";
3406
3407 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003408 * Deprecated - use {@link #ACTION_FACTORY_RESET} instead.
3409 *
3410 * {@hide}
3411 */
3412 @Deprecated
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003413 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3414
Christopher Tate6597e342015-02-17 12:15:25 -08003415 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003416 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3417 * is about to be performed.
3418 * @hide
3419 */
3420 @SystemApi
3421 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3422 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3423 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3424
3425 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003426 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3427 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3428 *
3429 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3430 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003431 * @hide
3432 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003433 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003434 public static final String EXTRA_FORCE_MASTER_CLEAR =
3435 "android.intent.extra.FORCE_MASTER_CLEAR";
3436
3437 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003438 * A broadcast action to trigger a factory reset.
3439 *
3440 * <p> The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission.
3441 *
3442 * <p>Not for use by third-party applications.
3443 *
3444 * @see #EXTRA_FORCE_MASTER_CLEAR
3445 *
3446 * {@hide}
3447 */
3448 @SystemApi
3449 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3450 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3451
3452 /**
3453 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3454 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3455 *
3456 * <p>Not for use by third-party applications.
3457 *
3458 * @hide
3459 */
3460 @SystemApi
3461 public static final String EXTRA_FORCE_FACTORY_RESET =
3462 "android.intent.extra.FORCE_FACTORY_RESET";
3463
3464 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003465 * Broadcast action: report that a settings element is being restored from backup. The intent
3466 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3467 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3468 * is the value of that settings entry prior to the restore operation. All of these values are
3469 * represented as strings.
3470 *
3471 * <p>This broadcast is sent only for settings provider entries known to require special handling
3472 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3473 * the provider's backup agent implementation.
3474 *
3475 * @see #EXTRA_SETTING_NAME
3476 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3477 * @see #EXTRA_SETTING_NEW_VALUE
3478 * {@hide}
3479 */
3480 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3481
3482 /** {@hide} */
3483 public static final String EXTRA_SETTING_NAME = "setting_name";
3484 /** {@hide} */
3485 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3486 /** {@hide} */
3487 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3488
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003489 /**
3490 * Activity Action: Process a piece of text.
3491 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3492 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3493 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3494 */
3495 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3496 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003497
3498 /**
3499 * Broadcast Action: The sim card state has changed.
3500 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3501 * because TelephonyIntents is an internal class.
3502 * @hide
3503 */
3504 @SystemApi
3505 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3506 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3507
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003508 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003509 * The name of the extra used to define the text to be processed, as a
3510 * CharSequence. Note that this may be a styled CharSequence, so you must use
3511 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003512 */
3513 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3514 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003515 * 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 +00003516 */
3517 public static final String EXTRA_PROCESS_TEXT_READONLY =
3518 "android.intent.extra.PROCESS_TEXT_READONLY";
3519
Bryce Leebc58f592015-09-25 16:43:01 -07003520 /**
3521 * Broadcast action: reports when a new thermal event has been reached. When the device
3522 * is reaching its maximum temperatue, the thermal level reported
3523 * {@hide}
3524 */
3525 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3526 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3527
3528 /** {@hide} */
3529 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3530
3531 /**
3532 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003533 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003534 * {@hide}
3535 */
3536 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3537
3538 /**
3539 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003540 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003541 * {@hide}
3542 */
3543 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3544
3545 /**
3546 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003547 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003548 * {@hide}
3549 */
3550 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3551
3552
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003553 // ---------------------------------------------------------------------
3554 // ---------------------------------------------------------------------
3555 // Standard intent categories (see addCategory()).
3556
3557 /**
3558 * Set if the activity should be an option for the default action
3559 * (center press) to perform on a piece of data. Setting this will
3560 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003561 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003562 * Intent when initiating an action -- it is for use in intent filters
3563 * specified in packages.
3564 */
3565 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3566 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3567 /**
3568 * Activities that can be safely invoked from a browser must support this
3569 * category. For example, if the user is viewing a web page or an e-mail
3570 * and clicks on a link in the text, the Intent generated execute that
3571 * link will require the BROWSABLE category, so that only activities
3572 * supporting this category will be considered as possible actions. By
3573 * supporting this category, you are promising that there is nothing
3574 * damaging (without user intervention) that can happen by invoking any
3575 * matching Intent.
3576 */
3577 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3578 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3579 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003580 * Categories for activities that can participate in voice interaction.
3581 * An activity that supports this category must be prepared to run with
3582 * no UI shown at all (though in some case it may have a UI shown), and
3583 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3584 */
3585 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3586 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3587 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003588 * Set if the activity should be considered as an alternative action to
3589 * the data the user is currently viewing. See also
3590 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3591 * applies to the selection in a list of items.
3592 *
3593 * <p>Supporting this category means that you would like your activity to be
3594 * displayed in the set of alternative things the user can do, usually as
3595 * part of the current activity's options menu. You will usually want to
3596 * include a specific label in the &lt;intent-filter&gt; of this action
3597 * describing to the user what it does.
3598 *
3599 * <p>The action of IntentFilter with this category is important in that it
3600 * describes the specific action the target will perform. This generally
3601 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3602 * a specific name such as "com.android.camera.action.CROP. Only one
3603 * alternative of any particular action will be shown to the user, so using
3604 * a specific action like this makes sure that your alternative will be
3605 * displayed while also allowing other applications to provide their own
3606 * overrides of that particular action.
3607 */
3608 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3609 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3610 /**
3611 * Set if the activity should be considered as an alternative selection
3612 * action to the data the user has currently selected. This is like
3613 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3614 * of items from which the user can select, giving them alternatives to the
3615 * default action that will be performed on it.
3616 */
3617 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3618 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3619 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003620 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003621 */
3622 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3623 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3624 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003625 * Should be displayed in the top-level launcher.
3626 */
3627 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3628 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3629 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003630 * Indicates an activity optimized for Leanback mode, and that should
3631 * be displayed in the Leanback launcher.
3632 */
3633 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3634 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3635 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003636 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3637 * @hide
3638 */
3639 @SystemApi
3640 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3641 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003642 * Provides information about the package it is in; typically used if
3643 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3644 * a front-door to the user without having to be shown in the all apps list.
3645 */
3646 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3647 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3648 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003649 * This is the home activity, that is the first activity that is displayed
3650 * when the device boots.
3651 */
3652 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3653 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3654 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003655 * This is the home activity that is displayed when the device is finished setting up and ready
3656 * for use.
3657 * @hide
3658 */
3659 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3660 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3661 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003662 * This is the setup wizard activity, that is the first activity that is displayed
3663 * when the user sets up the device for the first time.
3664 * @hide
3665 */
3666 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3667 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3668 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003669 * This activity is a preference panel.
3670 */
3671 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3672 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3673 /**
3674 * This activity is a development preference panel.
3675 */
3676 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3677 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3678 /**
3679 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003680 */
3681 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3682 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3683 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003684 * This activity allows the user to browse and download new applications.
3685 */
3686 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3687 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3688 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003689 * This activity may be exercised by the monkey or other automated test tools.
3690 */
3691 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3692 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3693 /**
3694 * To be used as a test (not part of the normal user experience).
3695 */
3696 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3697 /**
3698 * To be used as a unit test (run through the Test Harness).
3699 */
3700 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3701 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003702 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003703 * experience).
3704 */
3705 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003706
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003707 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003708 * Used to indicate that an intent only wants URIs that can be opened with
3709 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3710 * must support at least the columns defined in {@link OpenableColumns} when
3711 * queried.
3712 *
3713 * @see #ACTION_GET_CONTENT
3714 * @see #ACTION_OPEN_DOCUMENT
3715 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003716 */
3717 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3718 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3719
3720 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09003721 * Used to indicate that an intent filter can accept files which are not necessarily
3722 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
3723 * at least streamable via
3724 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
3725 * using one of the stream types exposed via
3726 * {@link ContentResolver#getStreamTypes(Uri, String)}.
3727 *
3728 * @see #ACTION_SEND
3729 * @see #ACTION_SEND_MULTIPLE
3730 */
3731 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3732 public static final String CATEGORY_TYPED_OPENABLE =
3733 "android.intent.category.TYPED_OPENABLE";
3734
3735 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003736 * To be used as code under test for framework instrumentation tests.
3737 */
3738 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3739 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003740 /**
3741 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003742 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3743 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003744 */
3745 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3746 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3747 /**
3748 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003749 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3750 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003751 */
3752 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3753 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003754 /**
3755 * An activity to run when device is inserted into a analog (low end) dock.
3756 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3757 * information, see {@link android.app.UiModeManager}.
3758 */
3759 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3760 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3761
3762 /**
3763 * An activity to run when device is inserted into a digital (high end) dock.
3764 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3765 * information, see {@link android.app.UiModeManager}.
3766 */
3767 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3768 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003769
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003770 /**
3771 * Used to indicate that the activity can be used in a car environment.
3772 */
3773 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3774 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3775
Zak Cohendb6ca492017-01-26 14:09:00 -08003776 /**
3777 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
3778 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3779 * information, see {@link android.app.UiModeManager}.
3780 */
3781 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3782 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003783 // ---------------------------------------------------------------------
3784 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003785 // Application launch intent categories (see addCategory()).
3786
3787 /**
3788 * Used with {@link #ACTION_MAIN} to launch the browser application.
3789 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003790 * <p>NOTE: This should not be used as the primary key of an Intent,
3791 * since it will not result in the app launching with the correct
3792 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003793 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003794 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003795 */
3796 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3797 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3798
3799 /**
3800 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3801 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003802 * <p>NOTE: This should not be used as the primary key of an Intent,
3803 * since it will not result in the app launching with the correct
3804 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003805 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003806 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003807 */
3808 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3809 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3810
3811 /**
3812 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3813 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003814 * <p>NOTE: This should not be used as the primary key of an Intent,
3815 * since it will not result in the app launching with the correct
3816 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003817 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003818 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003819 */
3820 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3821 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3822
3823 /**
3824 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3825 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003826 * <p>NOTE: This should not be used as the primary key of an Intent,
3827 * since it will not result in the app launching with the correct
3828 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003829 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003830 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003831 */
3832 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3833 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3834
3835 /**
3836 * Used with {@link #ACTION_MAIN} to launch the email application.
3837 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003838 * <p>NOTE: This should not be used as the primary key of an Intent,
3839 * since it will not result in the app launching with the correct
3840 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003841 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003842 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003843 */
3844 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3845 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3846
3847 /**
3848 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3849 * The activity should be able to view and manipulate image and video files
3850 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003851 * <p>NOTE: This should not be used as the primary key of an Intent,
3852 * since it will not result in the app launching with the correct
3853 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003854 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003855 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003856 */
3857 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3858 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3859
3860 /**
3861 * Used with {@link #ACTION_MAIN} to launch the maps application.
3862 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003863 * <p>NOTE: This should not be used as the primary key of an Intent,
3864 * since it will not result in the app launching with the correct
3865 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003866 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003867 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003868 */
3869 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3870 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3871
3872 /**
3873 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3874 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003875 * <p>NOTE: This should not be used as the primary key of an Intent,
3876 * since it will not result in the app launching with the correct
3877 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003878 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003879 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003880 */
3881 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3882 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3883
3884 /**
3885 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003886 * The activity should be able to play, browse, or manipulate music files
3887 * stored on the device.
3888 * <p>NOTE: This should not be used as the primary key of an Intent,
3889 * since it will not result in the app launching with the correct
3890 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003891 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003892 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003893 */
3894 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3895 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3896
3897 // ---------------------------------------------------------------------
3898 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003899 // Standard extra data keys.
3900
3901 /**
3902 * The initial data to place in a newly created record. Use with
3903 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3904 * fields as would be given to the underlying ContentProvider.insert()
3905 * call.
3906 */
3907 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3908
3909 /**
3910 * A constant CharSequence that is associated with the Intent, used with
3911 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3912 * this may be a styled CharSequence, so you must use
3913 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3914 * retrieve it.
3915 */
3916 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3917
3918 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003919 * A constant String that is associated with the Intent, used with
3920 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3921 * as HTML formatted text. Note that you <em>must</em> also supply
3922 * {@link #EXTRA_TEXT}.
3923 */
3924 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3925
3926 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00003927 * A content: URI holding a stream of data associated with the Intent,
3928 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003929 */
3930 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3931
3932 /**
3933 * A String[] holding e-mail addresses that should be delivered to.
3934 */
3935 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3936
3937 /**
3938 * A String[] holding e-mail addresses that should be carbon copied.
3939 */
3940 public static final String EXTRA_CC = "android.intent.extra.CC";
3941
3942 /**
3943 * A String[] holding e-mail addresses that should be blind carbon copied.
3944 */
3945 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3946
3947 /**
3948 * A constant string holding the desired subject line of a message.
3949 */
3950 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3951
3952 /**
3953 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003954 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003955 */
3956 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3957
3958 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003959 * An int representing the user id to be used.
3960 *
3961 * @hide
3962 */
3963 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3964
3965 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003966 * An int representing the task id to be retrieved. This is used when a launch from recents is
3967 * intercepted by another action such as credentials confirmation to remember which task should
3968 * be resumed when complete.
3969 *
3970 * @hide
3971 */
3972 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3973
3974 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003975 * An Intent[] describing additional, alternate choices you would like shown with
3976 * {@link #ACTION_CHOOSER}.
3977 *
3978 * <p>An app may be capable of providing several different payload types to complete a
3979 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3980 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3981 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3982 * photo data or a hosted link where the photos can be viewed.</p>
3983 *
3984 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3985 * first/primary/preferred intent in the set. Additional intents specified in
3986 * this extra are ordered; by default intents that appear earlier in the array will be
3987 * preferred over intents that appear later in the array as matches for the same
3988 * target component. To alter this preference, a calling app may also supply
3989 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3990 */
3991 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3992
3993 /**
Adam Powell52c39212016-04-07 15:14:18 -07003994 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3995 * and omitted from a list of components presented to the user.
3996 *
3997 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3998 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3999 * from your own package or other apps from your organization if the idea of sending to those
4000 * targets would be redundant with other app functionality. Filtered components will not
4001 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4002 */
4003 public static final String EXTRA_EXCLUDE_COMPONENTS
4004 = "android.intent.extra.EXCLUDE_COMPONENTS";
4005
4006 /**
4007 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4008 * describing additional high-priority deep-link targets for the chooser to present to the user.
4009 *
4010 * <p>Targets provided in this way will be presented inline with all other targets provided
4011 * by services from other apps. They will be prioritized before other service targets, but
4012 * after those targets provided by sources that the user has manually pinned to the front.</p>
4013 *
4014 * @see #ACTION_CHOOSER
4015 */
4016 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4017
4018 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004019 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4020 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4021 *
4022 * <p>An app preparing an action for another app to complete may wish to allow the user to
4023 * disambiguate between several options for completing the action based on the chosen target
4024 * or otherwise refine the action before it is invoked.
4025 * </p>
4026 *
4027 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4028 * <ul>
4029 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4030 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4031 * chosen target beyond the first</li>
4032 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4033 * should fill in and send once the disambiguation is complete</li>
4034 * </ul>
4035 */
4036 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4037 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4038
4039 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004040 * An {@code ArrayList} of {@code String} annotations describing content for
4041 * {@link #ACTION_CHOOSER}.
4042 *
4043 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4044 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4045 *
4046 * <p>Annotations should describe the major components or topics of the content. It is up to
4047 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4048 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
4049 * start {@link #ACTION_CHOOSER}. Performance on customized annotations can suffer, if they are
4050 * rarely used for {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to
4051 * use the following annotations when applicable:</p>
4052 * <ul>
4053 * <li>"product": represents that the topic of the content is mainly about products, e.g.,
4054 * health & beauty, and office supplies.</li>
4055 * <li>"emotion": represents that the topic of the content is mainly about emotions, e.g.,
4056 * happy, and sad.</li>
4057 * <li>"person": represents that the topic of the content is mainly about persons, e.g.,
4058 * face, finger, standing, and walking.</li>
4059 * <li>"child": represents that the topic of the content is mainly about children, e.g.,
4060 * child, and baby.</li>
4061 * <li>"selfie": represents that the topic of the content is mainly about selfies.</li>
4062 * <li>"crowd": represents that the topic of the content is mainly about crowds.</li>
4063 * <li>"party": represents that the topic of the content is mainly about parties.</li>
4064 * <li>"animal": represent that the topic of the content is mainly about animals.</li>
4065 * <li>"plant": represents that the topic of the content is mainly about plants, e.g.,
4066 * flowers.</li>
4067 * <li>"vacation": represents that the topic of the content is mainly about vacations.</li>
4068 * <li>"fashion": represents that the topic of the content is mainly about fashion, e.g.
4069 * sunglasses, jewelry, handbags and clothing.</li>
4070 * <li>"material": represents that the topic of the content is mainly about materials, e.g.,
4071 * paper, and silk.</li>
4072 * <li>"vehicle": represents that the topic of the content is mainly about vehicles, like
4073 * cars, and boats.</li>
4074 * <li>"document": represents that the topic of the content is mainly about documents, e.g.
4075 * posters.</li>
4076 * <li>"design": represents that the topic of the content is mainly about design, e.g. arts
4077 * and designs of houses.</li>
4078 * <li>"holiday": represents that the topic of the content is mainly about holidays, e.g.,
4079 * Christmas and Thanksgiving.</li>
4080 * </ul>
4081 */
4082 public static final String EXTRA_CONTENT_ANNOTATIONS
4083 = "android.intent.extra.CONTENT_ANNOTATIONS";
4084
4085 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004086 * A {@link ResultReceiver} used to return data back to the sender.
4087 *
4088 * <p>Used to complete an app-specific
4089 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4090 *
4091 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4092 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4093 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4094 * when the user selects a target component from the chooser. It is up to the recipient
4095 * to send a result to this ResultReceiver to signal that disambiguation is complete
4096 * and that the chooser should invoke the user's choice.</p>
4097 *
4098 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4099 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4100 * to match and fill in the final Intent or ChooserTarget before starting it.
4101 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4102 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4103 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4104 *
4105 * <p>The result code passed to the ResultReceiver should be
4106 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4107 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4108 * the chooser should finish without starting a target.</p>
4109 */
4110 public static final String EXTRA_RESULT_RECEIVER
4111 = "android.intent.extra.RESULT_RECEIVER";
4112
4113 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004114 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004115 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004116 */
4117 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4118
4119 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004120 * A Parcelable[] of {@link Intent} or
4121 * {@link android.content.pm.LabeledIntent} objects as set with
4122 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4123 * a the front of the list of choices, when shown to the user with a
4124 * {@link #ACTION_CHOOSER}.
4125 */
4126 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4127
4128 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004129 * A {@link IntentSender} to start after ephemeral installation success.
4130 * @hide
4131 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004132 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4133
4134 /**
4135 * A {@link IntentSender} to start after ephemeral installation failure.
4136 * @hide
4137 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004138 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4139
4140 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004141 * The host name that triggered an ephemeral resolution.
4142 * @hide
4143 */
4144 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4145
4146 /**
4147 * An opaque token to track ephemeral resolution.
4148 * @hide
4149 */
4150 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4151
4152 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004153 * The version code of the app to install components from.
4154 * @hide
4155 */
4156 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4157
4158 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004159 * A Bundle forming a mapping of potential target package names to different extras Bundles
4160 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4161 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4162 * be currently installed on the device.
4163 *
4164 * <p>An application may choose to provide alternate extras for the case where a user
4165 * selects an activity from a predetermined set of target packages. If the activity
4166 * the user selects from the chooser belongs to a package with its package name as
4167 * a key in this bundle, the corresponding extras for that package will be merged with
4168 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4169 * extra has the same key as an extra already present in the intent it will overwrite
4170 * the extra from the intent.</p>
4171 *
4172 * <p><em>Examples:</em>
4173 * <ul>
4174 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4175 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4176 * parameters for that target.</li>
4177 * <li>An application may offer additional metadata for known targets of a given intent
4178 * to pass along information only relevant to that target such as account or content
4179 * identifiers already known to that application.</li>
4180 * </ul></p>
4181 */
4182 public static final String EXTRA_REPLACEMENT_EXTRAS =
4183 "android.intent.extra.REPLACEMENT_EXTRAS";
4184
4185 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004186 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4187 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4188 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4189 * {@link ComponentName} of the chosen component.
4190 *
4191 * <p>In some situations this callback may never come, for example if the user abandons
4192 * the chooser, switches to another task or any number of other reasons. Apps should not
4193 * be written assuming that this callback will always occur.</p>
4194 */
4195 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4196 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4197
4198 /**
4199 * The {@link ComponentName} chosen by the user to complete an action.
4200 *
4201 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4202 */
4203 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4204
4205 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004206 * A {@link android.view.KeyEvent} object containing the event that
4207 * triggered the creation of the Intent it is in.
4208 */
4209 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4210
4211 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004212 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4213 * before shutting down.
4214 *
4215 * {@hide}
4216 */
4217 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4218
4219 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004220 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4221 * requested by the user.
4222 *
4223 * {@hide}
4224 */
4225 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4226 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4227
4228 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004229 * 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 -07004230 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4231 * of restarting the application.
4232 */
4233 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4234
4235 /**
4236 * A String holding the phone number originally entered in
4237 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4238 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4239 */
4240 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004241
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004242 /**
4243 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4244 * intents to supply the uid the package had been assigned. Also an optional
4245 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4246 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4247 * purpose.
4248 */
4249 public static final String EXTRA_UID = "android.intent.extra.UID";
4250
4251 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004252 * @hide String array of package names.
4253 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004254 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004255 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4256
4257 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004258 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4259 * intents to indicate whether this represents a full uninstall (removing
4260 * both the code and its data) or a partial uninstall (leaving its data,
4261 * implying that this is an update).
4262 */
4263 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004264
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004265 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004266 * @hide
4267 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4268 * intents to indicate that at this point the package has been removed for
4269 * all users on the device.
4270 */
4271 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4272 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4273
4274 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004275 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4276 * intents to indicate that this is a replacement of the package, so this
4277 * broadcast will immediately be followed by an add broadcast for a
4278 * different version of the same package.
4279 */
4280 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004281
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004282 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004283 * Used as an int extra field in {@link android.app.AlarmManager} intents
4284 * to tell the application being invoked how many pending alarms are being
4285 * delievered with the intent. For one-shot alarms this will always be 1.
4286 * For recurring alarms, this might be greater than 1 if the device was
4287 * asleep or powered off at the time an earlier alarm would have been
4288 * delivered.
4289 */
4290 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004291
Jacek Surazski86b6c532009-05-13 14:38:28 +02004292 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004293 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4294 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004295 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4296 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004297 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4298 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4299 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004300 */
4301 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4302
4303 /**
4304 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4305 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004306 */
4307 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4308
4309 /**
4310 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4311 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004312 */
4313 public static final int EXTRA_DOCK_STATE_DESK = 1;
4314
4315 /**
4316 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4317 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004318 */
4319 public static final int EXTRA_DOCK_STATE_CAR = 2;
4320
4321 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004322 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4323 * to represent that the phone is in a analog (low end) dock.
4324 */
4325 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4326
4327 /**
4328 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4329 * to represent that the phone is in a digital (high end) dock.
4330 */
4331 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4332
4333 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004334 * Boolean that can be supplied as meta-data with a dock activity, to
4335 * indicate that the dock should take over the home key when it is active.
4336 */
4337 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004338
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004339 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004340 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4341 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004342 */
4343 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4344
4345 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004346 * Used in the extra field in the remote intent. It's astring token passed with the
4347 * remote intent.
4348 */
4349 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4350 "android.intent.extra.remote_intent_token";
4351
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004352 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004353 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004354 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004355 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004356 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004357 "android.intent.extra.changed_component_name";
4358
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004359 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004360 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004361 * and contains a string array of all of the components that have changed. If
4362 * the state of the overall package has changed, then it will contain an entry
4363 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004364 */
4365 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4366 "android.intent.extra.changed_component_name_list";
4367
4368 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004369 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004370 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004371 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4372 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4373 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004374 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004375 */
4376 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4377 "android.intent.extra.changed_package_list";
4378
4379 /**
4380 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004381 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4382 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004383 * and contains an integer array of uids of all of the components
4384 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004385 */
4386 public static final String EXTRA_CHANGED_UID_LIST =
4387 "android.intent.extra.changed_uid_list";
4388
4389 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004390 * @hide
4391 * Magic extra system code can use when binding, to give a label for
4392 * who it is that has bound to a service. This is an integer giving
4393 * a framework string resource that can be displayed to the user.
4394 */
4395 public static final String EXTRA_CLIENT_LABEL =
4396 "android.intent.extra.client_label";
4397
4398 /**
4399 * @hide
4400 * Magic extra system code can use when binding, to give a PendingIntent object
4401 * that can be launched for the user to disable the system's use of this
4402 * service.
4403 */
4404 public static final String EXTRA_CLIENT_INTENT =
4405 "android.intent.extra.client_intent";
4406
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004407 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004408 * Extra used to indicate that an intent should only return data that is on
4409 * the local device. This is a boolean extra; the default is false. If true,
4410 * an implementation should only allow the user to select data that is
4411 * already on the device, not requiring it be downloaded from a remote
4412 * service when opened.
4413 *
4414 * @see #ACTION_GET_CONTENT
4415 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004416 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004417 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004418 */
4419 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004420 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004421
Amith Yamasani13593602012-03-22 16:16:17 -07004422 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004423 * Extra used to indicate that an intent can allow the user to select and
4424 * return multiple items. This is a boolean extra; the default is false. If
4425 * true, an implementation is allowed to present the user with a UI where
4426 * they can pick multiple items that are all returned to the caller. When
4427 * this happens, they should be returned as the {@link #getClipData()} part
4428 * of the result Intent.
4429 *
4430 * @see #ACTION_GET_CONTENT
4431 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004432 */
4433 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004434 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004435
4436 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004437 * The integer userHandle carried with broadcast intents related to addition, removal and
4438 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4439 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4440 *
Amith Yamasani13593602012-03-22 16:16:17 -07004441 * @hide
4442 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004443 public static final String EXTRA_USER_HANDLE =
4444 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004445
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004446 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004447 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4448 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4449 */
4450 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004451 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004452
4453 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004454 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004455 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4456 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004457 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004458 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4459
4460 /**
4461 * Extra sent in the intent to the BroadcastReceiver that handles
4462 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4463 * the restrictions as key/value pairs.
4464 */
4465 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4466 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004467
Amith Yamasani86118ba2013-03-28 14:33:16 -07004468 /**
4469 * Extra used in the response from a BroadcastReceiver that handles
4470 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4471 */
4472 public static final String EXTRA_RESTRICTIONS_INTENT =
4473 "android.intent.extra.restrictions_intent";
4474
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004475 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004476 * Extra used to communicate a set of acceptable MIME types. The type of the
4477 * extra is {@code String[]}. Values may be a combination of concrete MIME
4478 * types (such as "image/png") and/or partial MIME types (such as
4479 * "audio/*").
4480 *
4481 * @see #ACTION_GET_CONTENT
4482 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004483 */
4484 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4485
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004486 /**
4487 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4488 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004489 * When this is true, hardware devices can use this information to determine that
4490 * they shouldn't do a complete shutdown of their device since this is not a
4491 * complete shutdown down to the kernel, but only user space restarting.
4492 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004493 */
4494 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4495 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4496
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004497 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004498 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4499 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4500 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4501 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004502 *
4503 * @hide for internal use only.
4504 */
4505 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4506 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004507 /** @hide */
4508 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4509 /** @hide */
4510 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4511 /** @hide */
4512 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004513
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004514 /** {@hide} */
4515 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4516
Rubin Xue8490f12015-06-25 12:17:48 +01004517 /** {@hide} */
4518 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4519
Santos Cordon15a13782015-03-31 18:32:31 -07004520 /**
4521 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4522 * activation request.
4523 * TODO: Add information about the structure and response data used with the pending intent.
4524 * @hide
4525 */
4526 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4527 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4528
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004529 /**
4530 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004531 *
4532 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07004533 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004534 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004535 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4536
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004537 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004538 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
4539 * such as opening in other apps, sharing, opening, editing, printing, deleting,
4540 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004541 *
4542 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07004543 * @see #ACTION_QUICK_VIEW
4544 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004545 */
Garfield Tance1d0e92017-03-23 10:52:48 -07004546 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004547 public static final String EXTRA_QUICK_VIEW_ADVANCED =
4548 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004549
4550 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07004551 * An optional extra of {@code String[]} indicating which quick view features should be made
4552 * available to the user in the quick view UI while handing a
4553 * {@link Intent#ACTION_QUICK_VIEW} intent.
4554 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
4555 * Quick viewer can implement features not listed below.
4556 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
4557 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DOWNLOAD},
4558 * {@link QuickViewConstants#FEATURE_SEND}, {@link QuickViewConstants#FEATURE_PRINT}.
4559 * <p>
4560 * Requirements:
4561 * <li>Quick viewer shouldn't show a feature if the feature is absent in
4562 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
4563 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
4564 * internal policies.
4565 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
4566 * requirement that the feature be shown. Quick viewer may, according to its own policies,
4567 * disable or hide features.
4568 *
4569 * @see #ACTION_QUICK_VIEW
4570 */
4571 public static final String EXTRA_QUICK_VIEW_FEATURES =
4572 "android.intent.extra.QUICK_VIEW_FEATURES";
4573
4574 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004575 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004576 * When a profile goes into quiet mode, all apps in the profile are killed and the
4577 * profile user is stopped. Widgets originating from the profile are masked, and app
4578 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004579 */
4580 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004581
4582 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004583 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004584 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004585 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4586 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004587 *
4588 * @hide
4589 */
4590 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4591 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4592
4593 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004594 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4595 * whether to show the chooser or not when there is only one application available
4596 * to choose from.
4597 *
4598 * @hide
4599 */
4600 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4601 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4602
4603 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004604 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004605 * to represent that a video codec is allowed to use.
4606 *
4607 * @hide
4608 */
4609 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4610
4611 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004612 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004613 * to represent that a audio codec is allowed to use.
4614 *
4615 * @hide
4616 */
4617 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4618
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004619 // ---------------------------------------------------------------------
4620 // ---------------------------------------------------------------------
4621 // Intent flags (see mFlags variable).
4622
Tor Norbyed9273d62013-05-30 15:59:53 -07004623 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004624 @IntDef(flag = true, value = {
4625 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4626 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004627 @Retention(RetentionPolicy.SOURCE)
4628 public @interface GrantUriMode {}
4629
Jeff Sharkey846318a2014-04-04 12:12:41 -07004630 /** @hide */
4631 @IntDef(flag = true, value = {
4632 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4633 @Retention(RetentionPolicy.SOURCE)
4634 public @interface AccessUriMode {}
4635
4636 /**
4637 * Test if given mode flags specify an access mode, which must be at least
4638 * read and/or write.
4639 *
4640 * @hide
4641 */
4642 public static boolean isAccessUriMode(int modeFlags) {
4643 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4644 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4645 }
4646
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004647 /**
4648 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004649 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004650 * specified in its ClipData. When applying to an Intent's ClipData,
4651 * all URIs as well as recursive traversals through data or other ClipData
4652 * in Intent items will be granted; only the grant flags of the top-level
4653 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004654 */
4655 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4656 /**
4657 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004658 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004659 * specified in its ClipData. When applying to an Intent's ClipData,
4660 * all URIs as well as recursive traversals through data or other ClipData
4661 * in Intent items will be granted; only the grant flags of the top-level
4662 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004663 */
4664 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4665 /**
4666 * Can be set by the caller to indicate that this Intent is coming from
4667 * a background operation, not from direct user interaction.
4668 */
4669 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4670 /**
4671 * A flag you can enable for debugging: when set, log messages will be
4672 * printed during the resolution of this intent to show you what has
4673 * been found to create the final resolved list.
4674 */
4675 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004676 /**
4677 * If set, this intent will not match any components in packages that
4678 * are currently stopped. If this is not set, then the default behavior
4679 * is to include such applications in the result.
4680 */
4681 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4682 /**
4683 * If set, this intent will always match any components in packages that
4684 * are currently stopped. This is the default behavior when
4685 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4686 * flags are set, this one wins (it allows overriding of exclude for
4687 * places where the framework may automatically set the exclude flag).
4688 */
4689 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004690
4691 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004692 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004693 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004694 * persisted across device reboots until explicitly revoked with
4695 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4696 * grant for possible persisting; the receiving application must call
4697 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4698 * actually persist.
4699 *
4700 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4701 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4702 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004703 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004704 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004705 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004706
4707 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004708 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4709 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4710 * applies to any URI that is a prefix match against the original granted
4711 * URI. (Without this flag, the URI must match exactly for access to be
4712 * granted.) Another URI is considered a prefix match only when scheme,
4713 * authority, and all path segments defined by the prefix are an exact
4714 * match.
4715 */
4716 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4717
4718 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004719 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004720 * homework and verified that they correctly handle packages and components
4721 * that come and go over time. In particular:
4722 * <ul>
4723 * <li>Apps installed on external storage, which will appear to be
4724 * uninstalled while the the device is ejected.
4725 * <li>Apps with encryption unaware components, which will appear to not
4726 * exist while the device is locked.
4727 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004728 *
4729 * @hide
4730 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004731 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004732
4733 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07004734 * Internal flag used to indicate ephemeral applications should not be
4735 * considered when resolving the intent.
4736 *
4737 * @hide
4738 */
4739 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
4740
4741 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004742 * If set, the new activity is not kept in the history stack. As soon as
4743 * the user navigates away from it, the activity is finished. This may also
4744 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4745 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004746 *
4747 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4748 * is never invoked when the current activity starts a new activity which
4749 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004750 */
4751 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4752 /**
4753 * If set, the activity will not be launched if it is already running
4754 * at the top of the history stack.
4755 */
4756 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4757 /**
4758 * If set, this activity will become the start of a new task on this
4759 * history stack. A task (from the activity that started it to the
4760 * next task activity) defines an atomic group of activities that the
4761 * user can move to. Tasks can be moved to the foreground and background;
4762 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004763 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004764 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4765 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004766 *
4767 * <p>This flag is generally used by activities that want
4768 * to present a "launcher" style behavior: they give the user a list of
4769 * separate things that can be done, which otherwise run completely
4770 * independently of the activity launching them.
4771 *
4772 * <p>When using this flag, if a task is already running for the activity
4773 * you are now starting, then a new activity will not be started; instead,
4774 * the current task will simply be brought to the front of the screen with
4775 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4776 * to disable this behavior.
4777 *
4778 * <p>This flag can not be used when the caller is requesting a result from
4779 * the activity being launched.
4780 */
4781 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4782 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004783 * This flag is used to create a new task and launch an activity into it.
4784 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4785 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4786 * search through existing tasks for ones matching this Intent. Only if no such
4787 * task is found would a new task be created. When paired with
4788 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4789 * the search for a matching task and unconditionally start a new task.
4790 *
4791 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4792 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004793 * top-level application launcher.</strong> Used in conjunction with
4794 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4795 * behavior of bringing an existing task to the foreground. When set,
4796 * a new task is <em>always</em> started to host the Activity for the
4797 * Intent, regardless of whether there is already an existing task running
4798 * the same thing.
4799 *
4800 * <p><strong>Because the default system does not include graphical task management,
4801 * you should not use this flag unless you provide some way for a user to
4802 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004803 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004804 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4805 * creating new document tasks.
4806 *
4807 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004808 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004809 *
Scott Main7aee61f2011-02-08 11:25:01 -08004810 * <p>See
4811 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4812 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004813 *
4814 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4815 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004816 */
4817 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4818 /**
4819 * If set, and the activity being launched is already running in the
4820 * current task, then instead of launching a new instance of that activity,
4821 * all of the other activities on top of it will be closed and this Intent
4822 * will be delivered to the (now on top) old activity as a new Intent.
4823 *
4824 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4825 * If D calls startActivity() with an Intent that resolves to the component
4826 * of activity B, then C and D will be finished and B receive the given
4827 * Intent, resulting in the stack now being: A, B.
4828 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004829 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004830 * either receive the new intent you are starting here in its
4831 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004832 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004833 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4834 * the same intent, then it will be finished and re-created; for all other
4835 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4836 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004837 *
4838 * <p>This launch mode can also be used to good effect in conjunction with
4839 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4840 * of a task, it will bring any currently running instance of that task
4841 * to the foreground, and then clear it to its root state. This is
4842 * especially useful, for example, when launching an activity from the
4843 * notification manager.
4844 *
Scott Main7aee61f2011-02-08 11:25:01 -08004845 * <p>See
4846 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4847 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004848 */
4849 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4850 /**
4851 * If set and this intent is being used to launch a new activity from an
4852 * existing one, then the reply target of the existing activity will be
4853 * transfered to the new activity. This way the new activity can call
4854 * {@link android.app.Activity#setResult} and have that result sent back to
4855 * the reply target of the original activity.
4856 */
4857 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4858 /**
4859 * If set and this intent is being used to launch a new activity from an
4860 * existing one, the current activity will not be counted as the top
4861 * activity for deciding whether the new intent should be delivered to
4862 * the top instead of starting a new one. The previous activity will
4863 * be used as the top, with the assumption being that the current activity
4864 * will finish itself immediately.
4865 */
4866 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4867 /**
4868 * If set, the new activity is not kept in the list of recently launched
4869 * activities.
4870 */
4871 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4872 /**
4873 * This flag is not normally set by application code, but set for you by
4874 * the system as described in the
4875 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4876 * launchMode} documentation for the singleTask mode.
4877 */
4878 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4879 /**
4880 * If set, and this activity is either being started in a new task or
4881 * bringing to the top an existing task, then it will be launched as
4882 * the front door of the task. This will result in the application of
4883 * any affinities needed to have that task in the proper state (either
4884 * moving activities to or from it), or simply resetting that task to
4885 * its initial state if needed.
4886 */
4887 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4888 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004889 * This flag is not normally set by application code, but set for you by
4890 * the system if this activity is being launched from history
4891 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004892 */
4893 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004894 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004895 * @deprecated As of API 21 this performs identically to
4896 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004897 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004898 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004899 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004900 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004901 * This flag is used to open a document into a new task rooted at the activity launched
4902 * by this Intent. Through the use of this flag, or its equivalent attribute,
4903 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004904 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004905 *
Craig Mautner026596b2014-05-21 15:35:44 -07004906 * <p>The use of the activity attribute form of this,
4907 * {@link android.R.attr#documentLaunchMode}, is
4908 * preferred over the Intent flag described here. The attribute form allows the
4909 * Activity to specify multiple document behavior for all launchers of the Activity
4910 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004911 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004912 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4913 * it is kept after the activity is finished is different than the use of
4914 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4915 * this flag is being used to create a new recents entry, then by default that entry
4916 * will be removed once the activity is finished. You can modify this behavior with
4917 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4918 *
Craig Mautner026596b2014-05-21 15:35:44 -07004919 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4920 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4921 * equivalent of the Activity manifest specifying {@link
4922 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4923 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4924 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004925 *
Craig Mautner026596b2014-05-21 15:35:44 -07004926 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004927 *
Craig Mautner026596b2014-05-21 15:35:44 -07004928 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004929 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4930 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004931 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004932 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004933 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004934 * callback from occurring on the current frontmost activity before it is
4935 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004936 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004937 * <p>Typically, an activity can rely on that callback to indicate that an
4938 * explicit user action has caused their activity to be moved out of the
4939 * foreground. The callback marks an appropriate point in the activity's
4940 * lifecycle for it to dismiss any notifications that it intends to display
4941 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004942 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004943 * <p>If an activity is ever started via any non-user-driven events such as
4944 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4945 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004946 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004947 */
4948 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004949 /**
4950 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4951 * this flag will cause the launched activity to be brought to the front of its
4952 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004953 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004954 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4955 * If D calls startActivity() with an Intent that resolves to the component
4956 * of activity B, then B will be brought to the front of the history stack,
4957 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004958 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004959 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004960 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004961 */
4962 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004963 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004964 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4965 * this flag will prevent the system from applying an activity transition
4966 * animation to go to the next activity state. This doesn't mean an
4967 * animation will never run -- if another activity change happens that doesn't
4968 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004969 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004970 * when you are going to do a series of activity operations but the
4971 * animation seen by the user shouldn't be driven by the first activity
4972 * change but rather a later one.
4973 */
4974 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4975 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004976 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4977 * this flag will cause any existing task that would be associated with the
4978 * activity to be cleared before the activity is started. That is, the activity
4979 * becomes the new root of an otherwise empty task, and any old activities
4980 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4981 */
4982 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4983 /**
4984 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4985 * this flag will cause a newly launching task to be placed on top of the current
4986 * home activity task (if there is one). That is, pressing back from the task
4987 * will always return the user to home even if that was not the last activity they
4988 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4989 */
4990 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4991 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004992 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4993 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004994 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004995 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004996 * this flag. When set and the task's activity is finished, the recents
4997 * entry will remain in the interface for the user to re-launch it, like a
4998 * recents entry for a top-level application.
4999 * <p>
5000 * The receiving activity can override this request with
5001 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5002 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005003 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005004 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005005 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005006
5007 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005008 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5009 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005010 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5011 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005012 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005013 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005014
5015 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005016 * If set, when sending a broadcast only registered receivers will be
5017 * called -- no BroadcastReceiver components will be launched.
5018 */
5019 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005020 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005021 * If set, when sending a broadcast the new broadcast will replace
5022 * any existing pending broadcast that matches it. Matching is defined
5023 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5024 * true for the intents of the two broadcasts. When a match is found,
5025 * the new broadcast (and receivers associated with it) will replace the
5026 * existing one in the pending broadcast list, remaining at the same
5027 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005028 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005029 * <p>This flag is most typically used with sticky broadcasts, which
5030 * only care about delivering the most recent values of the broadcast
5031 * to their receivers.
5032 */
5033 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5034 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005035 * If set, when sending a broadcast the recipient is allowed to run at
5036 * foreground priority, with a shorter timeout interval. During normal
5037 * broadcasts the receivers are not automatically hoisted out of the
5038 * background priority class.
5039 */
5040 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5041 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005042 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5043 * They can still propagate results through to later receivers, but they can not prevent
5044 * later receivers from seeing the broadcast.
5045 */
5046 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5047 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005048 * If set, when sending a broadcast <i>before boot has completed</i> only
5049 * registered receivers will be called -- no BroadcastReceiver components
5050 * will be launched. Sticky intent state will be recorded properly even
5051 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5052 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005053 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005054 * <p>This flag is only for use by system sevices as a convenience to
5055 * avoid having to implement a more complex mechanism around detection
5056 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005057 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005058 * @hide
5059 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005060 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005061 /**
5062 * Set when this broadcast is for a boot upgrade, a special mode that
5063 * allows the broadcast to be sent before the system is ready and launches
5064 * the app process with no providers running in it.
5065 * @hide
5066 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005067 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005068 /**
5069 * If set, the broadcast will always go to manifest receivers in background (cached
5070 * or not running) apps, regardless of whether that would be done by default. By
5071 * default they will only receive broadcasts if the broadcast has specified an
5072 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005073 *
5074 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5075 * the broadcast code there must also be changed to match.
5076 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005077 * @hide
5078 */
5079 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5080 /**
5081 * If set, the broadcast will never go to manifest receivers in background (cached
5082 * or not running) apps, regardless of whether that would be done by default. By
5083 * default they will receive broadcasts if the broadcast has specified an
5084 * explicit component or package name.
5085 * @hide
5086 */
5087 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005088 /**
5089 * If set, this broadcast is being sent from the shell.
5090 * @hide
5091 */
5092 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005093
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005094 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005095 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5096 * will not receive broadcasts.
5097 *
5098 * <em>This flag has no effect when used by an Instant App.</em>
5099 */
5100 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5101
5102 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005103 * @hide Flags that can't be changed with PendingIntent.
5104 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005105 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5106 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5107 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005108
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005109 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005110 // ---------------------------------------------------------------------
5111 // toUri() and parseUri() options.
5112
5113 /**
5114 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5115 * always has the "intent:" scheme. This syntax can be used when you want
5116 * to later disambiguate between URIs that are intended to describe an
5117 * Intent vs. all others that should be treated as raw URIs. When used
5118 * with {@link #parseUri}, any other scheme will result in a generic
5119 * VIEW action for that raw URI.
5120 */
5121 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005122
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005123 /**
5124 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5125 * always has the "android-app:" scheme. This is a variation of
5126 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5127 * http/https URI being delivered to a specific package name. The format
5128 * is:
5129 *
5130 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005131 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005132 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005133 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5134 * you must also include a scheme; including a path also requires both a host and a scheme.
5135 * The final #Intent; fragment can be used without a scheme, host, or path.
5136 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005137 * used with intents that have a {@link #setSelector}, since the base intent
5138 * will always have an explicit package name.</p>
5139 *
5140 * <p>Some examples of how this scheme maps to Intent objects:</p>
5141 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5142 * <colgroup align="left" />
5143 * <colgroup align="left" />
5144 * <thead>
5145 * <tr><th>URI</th> <th>Intent</th></tr>
5146 * </thead>
5147 *
5148 * <tbody>
5149 * <tr><td><code>android-app://com.example.app</code></td>
5150 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5151 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5152 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5153 * </table></td>
5154 * </tr>
5155 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5156 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5157 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5158 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5159 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5160 * </table></td>
5161 * </tr>
5162 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5163 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5164 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5165 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5166 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5167 * </table></td>
5168 * </tr>
5169 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5170 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5171 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5172 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5173 * </table></td>
5174 * </tr>
5175 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5176 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5177 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5178 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5179 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5180 * </table></td>
5181 * </tr>
5182 * <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>
5183 * <td><table border="" style="margin:0" >
5184 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5185 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5186 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5187 * </table></td>
5188 * </tr>
5189 * </tbody>
5190 * </table>
5191 */
5192 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5193
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005194 /**
5195 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5196 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5197 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5198 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5199 * generated Intent can not cause unexpected data access to happen.
5200 *
5201 * <p>If you do not trust the source of the URI being parsed, you should still do further
5202 * processing to protect yourself from it. In particular, when using it to start an
5203 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5204 * that can handle it.</p>
5205 */
5206 public static final int URI_ALLOW_UNSAFE = 1<<2;
5207
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005208 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005209
5210 private String mAction;
5211 private Uri mData;
5212 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005213 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005214 private ComponentName mComponent;
5215 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005216 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005217 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005218 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005219 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005220 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005221 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005222 /** Token to track instant app launches. Local only; do not copy cross-process. */
5223 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005224
5225 // ---------------------------------------------------------------------
5226
5227 /**
5228 * Create an empty intent.
5229 */
5230 public Intent() {
5231 }
5232
5233 /**
5234 * Copy constructor.
5235 */
5236 public Intent(Intent o) {
5237 this.mAction = o.mAction;
5238 this.mData = o.mData;
5239 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005240 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005241 this.mComponent = o.mComponent;
5242 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005243 this.mContentUserHint = o.mContentUserHint;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005244 this.mLaunchToken = o.mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005245 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005246 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005247 }
5248 if (o.mExtras != null) {
5249 this.mExtras = new Bundle(o.mExtras);
5250 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005251 if (o.mSourceBounds != null) {
5252 this.mSourceBounds = new Rect(o.mSourceBounds);
5253 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005254 if (o.mSelector != null) {
5255 this.mSelector = new Intent(o.mSelector);
5256 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005257 if (o.mClipData != null) {
5258 this.mClipData = new ClipData(o.mClipData);
5259 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005260 }
5261
5262 @Override
5263 public Object clone() {
5264 return new Intent(this);
5265 }
5266
5267 private Intent(Intent o, boolean all) {
5268 this.mAction = o.mAction;
5269 this.mData = o.mData;
5270 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005271 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005272 this.mComponent = o.mComponent;
5273 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005274 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005275 }
5276 }
5277
5278 /**
5279 * Make a clone of only the parts of the Intent that are relevant for
5280 * filter matching: the action, data, type, component, and categories.
5281 */
5282 public Intent cloneFilter() {
5283 return new Intent(this, false);
5284 }
5285
5286 /**
5287 * Create an intent with a given action. All other fields (data, type,
5288 * class) are null. Note that the action <em>must</em> be in a
5289 * namespace because Intents are used globally in the system -- for
5290 * example the system VIEW action is android.intent.action.VIEW; an
5291 * application's custom action would be something like
5292 * com.google.app.myapp.CUSTOM_ACTION.
5293 *
5294 * @param action The Intent action, such as ACTION_VIEW.
5295 */
5296 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005297 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005298 }
5299
5300 /**
5301 * Create an intent with a given action and for a given data url. Note
5302 * that the action <em>must</em> be in a namespace because Intents are
5303 * used globally in the system -- for example the system VIEW action is
5304 * android.intent.action.VIEW; an application's custom action would be
5305 * something like com.google.app.myapp.CUSTOM_ACTION.
5306 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005307 * <p><em>Note: scheme and host name matching in the Android framework is
5308 * case-sensitive, unlike the formal RFC. As a result,
5309 * you should always ensure that you write your Uri with these elements
5310 * using lower case letters, and normalize any Uris you receive from
5311 * outside of Android to ensure the scheme and host is lower case.</em></p>
5312 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005313 * @param action The Intent action, such as ACTION_VIEW.
5314 * @param uri The Intent data URI.
5315 */
5316 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005317 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005318 mData = uri;
5319 }
5320
5321 /**
5322 * Create an intent for a specific component. All other fields (action, data,
5323 * type, class) are null, though they can be modified later with explicit
5324 * calls. This provides a convenient way to create an intent that is
5325 * intended to execute a hard-coded class name, rather than relying on the
5326 * system to find an appropriate class for you; see {@link #setComponent}
5327 * for more information on the repercussions of this.
5328 *
5329 * @param packageContext A Context of the application package implementing
5330 * this class.
5331 * @param cls The component class that is to be used for the intent.
5332 *
5333 * @see #setClass
5334 * @see #setComponent
5335 * @see #Intent(String, android.net.Uri , Context, Class)
5336 */
5337 public Intent(Context packageContext, Class<?> cls) {
5338 mComponent = new ComponentName(packageContext, cls);
5339 }
5340
5341 /**
5342 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005343 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005344 * construct the Intent and then calling {@link #setClass} to set its
5345 * class.
5346 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005347 * <p><em>Note: scheme and host name matching in the Android framework is
5348 * case-sensitive, unlike the formal RFC. As a result,
5349 * you should always ensure that you write your Uri with these elements
5350 * using lower case letters, and normalize any Uris you receive from
5351 * outside of Android to ensure the scheme and host is lower case.</em></p>
5352 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005353 * @param action The Intent action, such as ACTION_VIEW.
5354 * @param uri The Intent data URI.
5355 * @param packageContext A Context of the application package implementing
5356 * this class.
5357 * @param cls The component class that is to be used for the intent.
5358 *
5359 * @see #Intent(String, android.net.Uri)
5360 * @see #Intent(Context, Class)
5361 * @see #setClass
5362 * @see #setComponent
5363 */
5364 public Intent(String action, Uri uri,
5365 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005366 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005367 mData = uri;
5368 mComponent = new ComponentName(packageContext, cls);
5369 }
5370
5371 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005372 * Create an intent to launch the main (root) activity of a task. This
5373 * is the Intent that is started when the application's is launched from
5374 * Home. For anything else that wants to launch an application in the
5375 * same way, it is important that they use an Intent structured the same
5376 * way, and can use this function to ensure this is the case.
5377 *
5378 * <p>The returned Intent has the given Activity component as its explicit
5379 * component, {@link #ACTION_MAIN} as its action, and includes the
5380 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5381 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5382 * to do that through {@link #addFlags(int)} on the returned Intent.
5383 *
5384 * @param mainActivity The main activity component that this Intent will
5385 * launch.
5386 * @return Returns a newly created Intent that can be used to launch the
5387 * activity as a main application entry.
5388 *
5389 * @see #setClass
5390 * @see #setComponent
5391 */
5392 public static Intent makeMainActivity(ComponentName mainActivity) {
5393 Intent intent = new Intent(ACTION_MAIN);
5394 intent.setComponent(mainActivity);
5395 intent.addCategory(CATEGORY_LAUNCHER);
5396 return intent;
5397 }
5398
5399 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005400 * Make an Intent for the main activity of an application, without
5401 * specifying a specific activity to run but giving a selector to find
5402 * the activity. This results in a final Intent that is structured
5403 * the same as when the application is launched from
5404 * Home. For anything else that wants to launch an application in the
5405 * same way, it is important that they use an Intent structured the same
5406 * way, and can use this function to ensure this is the case.
5407 *
5408 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5409 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5410 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5411 * to do that through {@link #addFlags(int)} on the returned Intent.
5412 *
5413 * @param selectorAction The action name of the Intent's selector.
5414 * @param selectorCategory The name of a category to add to the Intent's
5415 * selector.
5416 * @return Returns a newly created Intent that can be used to launch the
5417 * activity as a main application entry.
5418 *
5419 * @see #setSelector(Intent)
5420 */
5421 public static Intent makeMainSelectorActivity(String selectorAction,
5422 String selectorCategory) {
5423 Intent intent = new Intent(ACTION_MAIN);
5424 intent.addCategory(CATEGORY_LAUNCHER);
5425 Intent selector = new Intent();
5426 selector.setAction(selectorAction);
5427 selector.addCategory(selectorCategory);
5428 intent.setSelector(selector);
5429 return intent;
5430 }
5431
5432 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005433 * Make an Intent that can be used to re-launch an application's task
5434 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5435 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5436 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5437 *
5438 * @param mainActivity The activity component that is the root of the
5439 * task; this is the activity that has been published in the application's
5440 * manifest as the main launcher icon.
5441 *
5442 * @return Returns a newly created Intent that can be used to relaunch the
5443 * activity's task in its root state.
5444 */
5445 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5446 Intent intent = makeMainActivity(mainActivity);
5447 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5448 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5449 return intent;
5450 }
5451
5452 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005453 * Call {@link #parseUri} with 0 flags.
5454 * @deprecated Use {@link #parseUri} instead.
5455 */
5456 @Deprecated
5457 public static Intent getIntent(String uri) throws URISyntaxException {
5458 return parseUri(uri, 0);
5459 }
Tom Taylord4a47292009-12-21 13:59:18 -08005460
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005461 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005462 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005463 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005464 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005465 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005466 *
5467 * <p>The URI given here must not be relative -- that is, it must include
5468 * the scheme and full path.
5469 *
5470 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005471 * @param flags Additional processing flags. Either 0,
5472 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005473 *
5474 * @return Intent The newly created Intent object.
5475 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005476 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5477 * it bad (as parsed by the Uri class) or the Intent data within the
5478 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005479 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005480 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005481 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005482 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005483 int i = 0;
5484 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005485 final boolean androidApp = uri.startsWith("android-app:");
5486
5487 // Validate intent scheme if requested.
5488 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5489 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005490 Intent intent = new Intent(ACTION_VIEW);
5491 try {
5492 intent.setData(Uri.parse(uri));
5493 } catch (IllegalArgumentException e) {
5494 throw new URISyntaxException(uri, e.getMessage());
5495 }
5496 return intent;
5497 }
5498 }
Tom Taylord4a47292009-12-21 13:59:18 -08005499
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005500 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005501 // simple case
5502 if (i == -1) {
5503 if (!androidApp) {
5504 return new Intent(ACTION_VIEW, Uri.parse(uri));
5505 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005506
5507 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005508 } else if (!uri.startsWith("#Intent;", i)) {
5509 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005510 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005511 } else {
5512 i = -1;
5513 }
5514 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005515
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005516 // new format
5517 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005518 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005519 boolean explicitAction = false;
5520 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005521
5522 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005523 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005524 String data;
5525 if (i >= 0) {
5526 data = uri.substring(0, i);
5527 i += 8; // length of "#Intent;"
5528 } else {
5529 data = uri;
5530 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005531
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005532 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005533 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005534 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005535 if (eq < 0) eq = i-1;
5536 int semi = uri.indexOf(';', i);
5537 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005538
5539 // action
5540 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005541 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005542 if (!inSelector) {
5543 explicitAction = true;
5544 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005545 }
5546
5547 // categories
5548 else if (uri.startsWith("category=", i)) {
5549 intent.addCategory(value);
5550 }
5551
5552 // type
5553 else if (uri.startsWith("type=", i)) {
5554 intent.mType = value;
5555 }
5556
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005557 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005558 else if (uri.startsWith("launchFlags=", i)) {
5559 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005560 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5561 intent.mFlags &= ~IMMUTABLE_FLAGS;
5562 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005563 }
5564
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005565 // package
5566 else if (uri.startsWith("package=", i)) {
5567 intent.mPackage = value;
5568 }
5569
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005570 // component
5571 else if (uri.startsWith("component=", i)) {
5572 intent.mComponent = ComponentName.unflattenFromString(value);
5573 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005574
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005575 // scheme
5576 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005577 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005578 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005579 } else {
5580 scheme = value;
5581 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005582 }
5583
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005584 // source bounds
5585 else if (uri.startsWith("sourceBounds=", i)) {
5586 intent.mSourceBounds = Rect.unflattenFromString(value);
5587 }
5588
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005589 // selector
5590 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5591 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005592 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005593 }
5594
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005595 // extra
5596 else {
5597 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005598 // create Bundle if it doesn't already exist
5599 if (intent.mExtras == null) intent.mExtras = new Bundle();
5600 Bundle b = intent.mExtras;
5601 // add EXTRA
5602 if (uri.startsWith("S.", i)) b.putString(key, value);
5603 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5604 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5605 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5606 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5607 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5608 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5609 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5610 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5611 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5612 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005613
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005614 // move to the next item
5615 i = semi + 1;
5616 }
5617
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005618 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005619 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005620 if (baseIntent.mPackage == null) {
5621 baseIntent.setSelector(intent);
5622 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005623 intent = baseIntent;
5624 }
5625
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005626 if (data != null) {
5627 if (data.startsWith("intent:")) {
5628 data = data.substring(7);
5629 if (scheme != null) {
5630 data = scheme + ':' + data;
5631 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005632 } else if (data.startsWith("android-app:")) {
5633 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5634 // Correctly formed android-app, first part is package name.
5635 int end = data.indexOf('/', 14);
5636 if (end < 0) {
5637 // All we have is a package name.
5638 intent.mPackage = data.substring(14);
5639 if (!explicitAction) {
5640 intent.setAction(ACTION_MAIN);
5641 }
5642 data = "";
5643 } else {
5644 // Target the Intent at the given package name always.
5645 String authority = null;
5646 intent.mPackage = data.substring(14, end);
5647 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005648 if ((end+1) < data.length()) {
5649 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5650 // Found a scheme, remember it.
5651 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005652 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005653 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5654 // Found a authority, remember it.
5655 authority = data.substring(end+1, newEnd);
5656 end = newEnd;
5657 }
5658 } else {
5659 // All we have is a scheme.
5660 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005661 }
5662 }
5663 if (scheme == null) {
5664 // If there was no scheme, then this just targets the package.
5665 if (!explicitAction) {
5666 intent.setAction(ACTION_MAIN);
5667 }
5668 data = "";
5669 } else if (authority == null) {
5670 data = scheme + ":";
5671 } else {
5672 data = scheme + "://" + authority + data.substring(end);
5673 }
5674 }
5675 } else {
5676 data = "";
5677 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005678 }
Tom Taylord4a47292009-12-21 13:59:18 -08005679
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005680 if (data.length() > 0) {
5681 try {
5682 intent.mData = Uri.parse(data);
5683 } catch (IllegalArgumentException e) {
5684 throw new URISyntaxException(uri, e.getMessage());
5685 }
5686 }
5687 }
Tom Taylord4a47292009-12-21 13:59:18 -08005688
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005689 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005690
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005691 } catch (IndexOutOfBoundsException e) {
5692 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5693 }
5694 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005695
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005696 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005697 return getIntentOld(uri, 0);
5698 }
5699
5700 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005701 Intent intent;
5702
5703 int i = uri.lastIndexOf('#');
5704 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005705 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005706 final int intentFragmentStart = i;
5707 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005708
5709 i++;
5710
5711 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005712 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005713 i += 7;
5714 int j = uri.indexOf(')', i);
5715 action = uri.substring(i, j);
5716 i = j + 1;
5717 }
5718
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005719 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005720
5721 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005722 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005723 i += 11;
5724 int j = uri.indexOf(')', i);
5725 while (i < j) {
5726 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005727 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005728 if (i < sep) {
5729 intent.addCategory(uri.substring(i, sep));
5730 }
5731 i = sep + 1;
5732 }
5733 i = j + 1;
5734 }
5735
5736 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005737 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005738 i += 5;
5739 int j = uri.indexOf(')', i);
5740 intent.mType = uri.substring(i, j);
5741 i = j + 1;
5742 }
5743
5744 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005745 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005746 i += 12;
5747 int j = uri.indexOf(')', i);
5748 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005749 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5750 intent.mFlags &= ~IMMUTABLE_FLAGS;
5751 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005752 i = j + 1;
5753 }
5754
5755 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005756 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005757 i += 10;
5758 int j = uri.indexOf(')', i);
5759 int sep = uri.indexOf('!', i);
5760 if (sep >= 0 && sep < j) {
5761 String pkg = uri.substring(i, sep);
5762 String cls = uri.substring(sep + 1, j);
5763 intent.mComponent = new ComponentName(pkg, cls);
5764 }
5765 i = j + 1;
5766 }
5767
5768 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005769 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005770 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005771
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005772 final int closeParen = uri.indexOf(')', i);
5773 if (closeParen == -1) throw new URISyntaxException(uri,
5774 "EXTRA missing trailing ')'", i);
5775
5776 while (i < closeParen) {
5777 // fetch the key value
5778 int j = uri.indexOf('=', i);
5779 if (j <= i + 1 || i >= closeParen) {
5780 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5781 }
5782 char type = uri.charAt(i);
5783 i++;
5784 String key = uri.substring(i, j);
5785 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005786
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005787 // get type-value
5788 j = uri.indexOf('!', i);
5789 if (j == -1 || j >= closeParen) j = closeParen;
5790 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5791 String value = uri.substring(i, j);
5792 i = j;
5793
5794 // create Bundle if it doesn't already exist
5795 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005796
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005797 // add item to bundle
5798 try {
5799 switch (type) {
5800 case 'S':
5801 intent.mExtras.putString(key, Uri.decode(value));
5802 break;
5803 case 'B':
5804 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5805 break;
5806 case 'b':
5807 intent.mExtras.putByte(key, Byte.parseByte(value));
5808 break;
5809 case 'c':
5810 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5811 break;
5812 case 'd':
5813 intent.mExtras.putDouble(key, Double.parseDouble(value));
5814 break;
5815 case 'f':
5816 intent.mExtras.putFloat(key, Float.parseFloat(value));
5817 break;
5818 case 'i':
5819 intent.mExtras.putInt(key, Integer.parseInt(value));
5820 break;
5821 case 'l':
5822 intent.mExtras.putLong(key, Long.parseLong(value));
5823 break;
5824 case 's':
5825 intent.mExtras.putShort(key, Short.parseShort(value));
5826 break;
5827 default:
5828 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5829 }
5830 } catch (NumberFormatException e) {
5831 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5832 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005833
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005834 char ch = uri.charAt(i);
5835 if (ch == ')') break;
5836 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5837 i++;
5838 }
5839 }
5840
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005841 if (isIntentFragment) {
5842 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5843 } else {
5844 intent.mData = Uri.parse(uri);
5845 }
Tom Taylord4a47292009-12-21 13:59:18 -08005846
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005847 if (intent.mAction == null) {
5848 // By default, if no action is specified, then use VIEW.
5849 intent.mAction = ACTION_VIEW;
5850 }
5851
5852 } else {
5853 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5854 }
5855
5856 return intent;
5857 }
5858
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005859 /** @hide */
5860 public interface CommandOptionHandler {
5861 boolean handleOption(String opt, ShellCommand cmd);
5862 }
5863
5864 /** @hide */
5865 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5866 throws URISyntaxException {
5867 Intent intent = new Intent();
5868 Intent baseIntent = intent;
5869 boolean hasIntentInfo = false;
5870
5871 Uri data = null;
5872 String type = null;
5873
5874 String opt;
5875 while ((opt=cmd.getNextOption()) != null) {
5876 switch (opt) {
5877 case "-a":
5878 intent.setAction(cmd.getNextArgRequired());
5879 if (intent == baseIntent) {
5880 hasIntentInfo = true;
5881 }
5882 break;
5883 case "-d":
5884 data = Uri.parse(cmd.getNextArgRequired());
5885 if (intent == baseIntent) {
5886 hasIntentInfo = true;
5887 }
5888 break;
5889 case "-t":
5890 type = cmd.getNextArgRequired();
5891 if (intent == baseIntent) {
5892 hasIntentInfo = true;
5893 }
5894 break;
5895 case "-c":
5896 intent.addCategory(cmd.getNextArgRequired());
5897 if (intent == baseIntent) {
5898 hasIntentInfo = true;
5899 }
5900 break;
5901 case "-e":
5902 case "--es": {
5903 String key = cmd.getNextArgRequired();
5904 String value = cmd.getNextArgRequired();
5905 intent.putExtra(key, value);
5906 }
5907 break;
5908 case "--esn": {
5909 String key = cmd.getNextArgRequired();
5910 intent.putExtra(key, (String) null);
5911 }
5912 break;
5913 case "--ei": {
5914 String key = cmd.getNextArgRequired();
5915 String value = cmd.getNextArgRequired();
5916 intent.putExtra(key, Integer.decode(value));
5917 }
5918 break;
5919 case "--eu": {
5920 String key = cmd.getNextArgRequired();
5921 String value = cmd.getNextArgRequired();
5922 intent.putExtra(key, Uri.parse(value));
5923 }
5924 break;
5925 case "--ecn": {
5926 String key = cmd.getNextArgRequired();
5927 String value = cmd.getNextArgRequired();
5928 ComponentName cn = ComponentName.unflattenFromString(value);
5929 if (cn == null)
5930 throw new IllegalArgumentException("Bad component name: " + value);
5931 intent.putExtra(key, cn);
5932 }
5933 break;
5934 case "--eia": {
5935 String key = cmd.getNextArgRequired();
5936 String value = cmd.getNextArgRequired();
5937 String[] strings = value.split(",");
5938 int[] list = new int[strings.length];
5939 for (int i = 0; i < strings.length; i++) {
5940 list[i] = Integer.decode(strings[i]);
5941 }
5942 intent.putExtra(key, list);
5943 }
5944 break;
5945 case "--eial": {
5946 String key = cmd.getNextArgRequired();
5947 String value = cmd.getNextArgRequired();
5948 String[] strings = value.split(",");
5949 ArrayList<Integer> list = new ArrayList<>(strings.length);
5950 for (int i = 0; i < strings.length; i++) {
5951 list.add(Integer.decode(strings[i]));
5952 }
5953 intent.putExtra(key, list);
5954 }
5955 break;
5956 case "--el": {
5957 String key = cmd.getNextArgRequired();
5958 String value = cmd.getNextArgRequired();
5959 intent.putExtra(key, Long.valueOf(value));
5960 }
5961 break;
5962 case "--ela": {
5963 String key = cmd.getNextArgRequired();
5964 String value = cmd.getNextArgRequired();
5965 String[] strings = value.split(",");
5966 long[] list = new long[strings.length];
5967 for (int i = 0; i < strings.length; i++) {
5968 list[i] = Long.valueOf(strings[i]);
5969 }
5970 intent.putExtra(key, list);
5971 hasIntentInfo = true;
5972 }
5973 break;
5974 case "--elal": {
5975 String key = cmd.getNextArgRequired();
5976 String value = cmd.getNextArgRequired();
5977 String[] strings = value.split(",");
5978 ArrayList<Long> list = new ArrayList<>(strings.length);
5979 for (int i = 0; i < strings.length; i++) {
5980 list.add(Long.valueOf(strings[i]));
5981 }
5982 intent.putExtra(key, list);
5983 hasIntentInfo = true;
5984 }
5985 break;
5986 case "--ef": {
5987 String key = cmd.getNextArgRequired();
5988 String value = cmd.getNextArgRequired();
5989 intent.putExtra(key, Float.valueOf(value));
5990 hasIntentInfo = true;
5991 }
5992 break;
5993 case "--efa": {
5994 String key = cmd.getNextArgRequired();
5995 String value = cmd.getNextArgRequired();
5996 String[] strings = value.split(",");
5997 float[] list = new float[strings.length];
5998 for (int i = 0; i < strings.length; i++) {
5999 list[i] = Float.valueOf(strings[i]);
6000 }
6001 intent.putExtra(key, list);
6002 hasIntentInfo = true;
6003 }
6004 break;
6005 case "--efal": {
6006 String key = cmd.getNextArgRequired();
6007 String value = cmd.getNextArgRequired();
6008 String[] strings = value.split(",");
6009 ArrayList<Float> list = new ArrayList<>(strings.length);
6010 for (int i = 0; i < strings.length; i++) {
6011 list.add(Float.valueOf(strings[i]));
6012 }
6013 intent.putExtra(key, list);
6014 hasIntentInfo = true;
6015 }
6016 break;
6017 case "--esa": {
6018 String key = cmd.getNextArgRequired();
6019 String value = cmd.getNextArgRequired();
6020 // Split on commas unless they are preceeded by an escape.
6021 // The escape character must be escaped for the string and
6022 // again for the regex, thus four escape characters become one.
6023 String[] strings = value.split("(?<!\\\\),");
6024 intent.putExtra(key, strings);
6025 hasIntentInfo = true;
6026 }
6027 break;
6028 case "--esal": {
6029 String key = cmd.getNextArgRequired();
6030 String value = cmd.getNextArgRequired();
6031 // Split on commas unless they are preceeded by an escape.
6032 // The escape character must be escaped for the string and
6033 // again for the regex, thus four escape characters become one.
6034 String[] strings = value.split("(?<!\\\\),");
6035 ArrayList<String> list = new ArrayList<>(strings.length);
6036 for (int i = 0; i < strings.length; i++) {
6037 list.add(strings[i]);
6038 }
6039 intent.putExtra(key, list);
6040 hasIntentInfo = true;
6041 }
6042 break;
6043 case "--ez": {
6044 String key = cmd.getNextArgRequired();
6045 String value = cmd.getNextArgRequired().toLowerCase();
6046 // Boolean.valueOf() results in false for anything that is not "true", which is
6047 // error-prone in shell commands
6048 boolean arg;
6049 if ("true".equals(value) || "t".equals(value)) {
6050 arg = true;
6051 } else if ("false".equals(value) || "f".equals(value)) {
6052 arg = false;
6053 } else {
6054 try {
6055 arg = Integer.decode(value) != 0;
6056 } catch (NumberFormatException ex) {
6057 throw new IllegalArgumentException("Invalid boolean value: " + value);
6058 }
6059 }
6060
6061 intent.putExtra(key, arg);
6062 }
6063 break;
6064 case "-n": {
6065 String str = cmd.getNextArgRequired();
6066 ComponentName cn = ComponentName.unflattenFromString(str);
6067 if (cn == null)
6068 throw new IllegalArgumentException("Bad component name: " + str);
6069 intent.setComponent(cn);
6070 if (intent == baseIntent) {
6071 hasIntentInfo = true;
6072 }
6073 }
6074 break;
6075 case "-p": {
6076 String str = cmd.getNextArgRequired();
6077 intent.setPackage(str);
6078 if (intent == baseIntent) {
6079 hasIntentInfo = true;
6080 }
6081 }
6082 break;
6083 case "-f":
6084 String str = cmd.getNextArgRequired();
6085 intent.setFlags(Integer.decode(str).intValue());
6086 break;
6087 case "--grant-read-uri-permission":
6088 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6089 break;
6090 case "--grant-write-uri-permission":
6091 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6092 break;
6093 case "--grant-persistable-uri-permission":
6094 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6095 break;
6096 case "--grant-prefix-uri-permission":
6097 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6098 break;
6099 case "--exclude-stopped-packages":
6100 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6101 break;
6102 case "--include-stopped-packages":
6103 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6104 break;
6105 case "--debug-log-resolution":
6106 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6107 break;
6108 case "--activity-brought-to-front":
6109 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6110 break;
6111 case "--activity-clear-top":
6112 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6113 break;
6114 case "--activity-clear-when-task-reset":
6115 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6116 break;
6117 case "--activity-exclude-from-recents":
6118 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6119 break;
6120 case "--activity-launched-from-history":
6121 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6122 break;
6123 case "--activity-multiple-task":
6124 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6125 break;
6126 case "--activity-no-animation":
6127 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6128 break;
6129 case "--activity-no-history":
6130 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6131 break;
6132 case "--activity-no-user-action":
6133 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6134 break;
6135 case "--activity-previous-is-top":
6136 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6137 break;
6138 case "--activity-reorder-to-front":
6139 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6140 break;
6141 case "--activity-reset-task-if-needed":
6142 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6143 break;
6144 case "--activity-single-top":
6145 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6146 break;
6147 case "--activity-clear-task":
6148 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6149 break;
6150 case "--activity-task-on-home":
6151 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6152 break;
6153 case "--receiver-registered-only":
6154 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6155 break;
6156 case "--receiver-replace-pending":
6157 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6158 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006159 case "--receiver-foreground":
6160 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6161 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006162 case "--receiver-no-abort":
6163 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6164 break;
6165 case "--receiver-include-background":
6166 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6167 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006168 case "--selector":
6169 intent.setDataAndType(data, type);
6170 intent = new Intent();
6171 break;
6172 default:
6173 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6174 // Okay, caller handled this option.
6175 } else {
6176 throw new IllegalArgumentException("Unknown option: " + opt);
6177 }
6178 break;
6179 }
6180 }
6181 intent.setDataAndType(data, type);
6182
6183 final boolean hasSelector = intent != baseIntent;
6184 if (hasSelector) {
6185 // A selector was specified; fix up.
6186 baseIntent.setSelector(intent);
6187 intent = baseIntent;
6188 }
6189
6190 String arg = cmd.getNextArg();
6191 baseIntent = null;
6192 if (arg == null) {
6193 if (hasSelector) {
6194 // If a selector has been specified, and no arguments
6195 // have been supplied for the main Intent, then we can
6196 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6197 // need to have a component name specified yet, the
6198 // selector will take care of that.
6199 baseIntent = new Intent(Intent.ACTION_MAIN);
6200 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6201 }
6202 } else if (arg.indexOf(':') >= 0) {
6203 // The argument is a URI. Fully parse it, and use that result
6204 // to fill in any data not specified so far.
6205 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6206 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6207 } else if (arg.indexOf('/') >= 0) {
6208 // The argument is a component name. Build an Intent to launch
6209 // it.
6210 baseIntent = new Intent(Intent.ACTION_MAIN);
6211 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6212 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6213 } else {
6214 // Assume the argument is a package name.
6215 baseIntent = new Intent(Intent.ACTION_MAIN);
6216 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6217 baseIntent.setPackage(arg);
6218 }
6219 if (baseIntent != null) {
6220 Bundle extras = intent.getExtras();
6221 intent.replaceExtras((Bundle)null);
6222 Bundle uriExtras = baseIntent.getExtras();
6223 baseIntent.replaceExtras((Bundle)null);
6224 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6225 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6226 for (String c : cats) {
6227 baseIntent.removeCategory(c);
6228 }
6229 }
6230 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6231 if (extras == null) {
6232 extras = uriExtras;
6233 } else if (uriExtras != null) {
6234 uriExtras.putAll(extras);
6235 extras = uriExtras;
6236 }
6237 intent.replaceExtras(extras);
6238 hasIntentInfo = true;
6239 }
6240
6241 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6242 return intent;
6243 }
6244
6245 /** @hide */
6246 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6247 final String[] lines = new String[] {
6248 "<INTENT> specifications include these flags and arguments:",
6249 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6250 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6251 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6252 " [--esn <EXTRA_KEY> ...]",
6253 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6254 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6255 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6256 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6257 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6258 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6259 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6260 " (mutiple extras passed as Integer[])",
6261 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6262 " (mutiple extras passed as List<Integer>)",
6263 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6264 " (mutiple extras passed as Long[])",
6265 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6266 " (mutiple extras passed as List<Long>)",
6267 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6268 " (mutiple extras passed as Float[])",
6269 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6270 " (mutiple extras passed as List<Float>)",
6271 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6272 " (mutiple extras passed as String[]; to embed a comma into a string,",
6273 " escape it using \"\\,\")",
6274 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6275 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6276 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006277 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006278 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6279 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6280 " [--debug-log-resolution] [--exclude-stopped-packages]",
6281 " [--include-stopped-packages]",
6282 " [--activity-brought-to-front] [--activity-clear-top]",
6283 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6284 " [--activity-launched-from-history] [--activity-multiple-task]",
6285 " [--activity-no-animation] [--activity-no-history]",
6286 " [--activity-no-user-action] [--activity-previous-is-top]",
6287 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6288 " [--activity-single-top] [--activity-clear-task]",
6289 " [--activity-task-on-home]",
6290 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08006291 " [--receiver-foreground] [--receiver-no-abort]",
6292 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006293 " [--selector]",
6294 " [<URI> | <PACKAGE> | <COMPONENT>]"
6295 };
6296 for (String line : lines) {
6297 pw.print(prefix);
6298 pw.println(line);
6299 }
6300 }
6301
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006302 /**
6303 * Retrieve the general action to be performed, such as
6304 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6305 * the information in the intent should be interpreted -- most importantly,
6306 * what to do with the data returned by {@link #getData}.
6307 *
6308 * @return The action of this intent or null if none is specified.
6309 *
6310 * @see #setAction
6311 */
6312 public String getAction() {
6313 return mAction;
6314 }
6315
6316 /**
6317 * Retrieve data this intent is operating on. This URI specifies the name
6318 * of the data; often it uses the content: scheme, specifying data in a
6319 * content provider. Other schemes may be handled by specific activities,
6320 * such as http: by the web browser.
6321 *
6322 * @return The URI of the data this intent is targeting or null.
6323 *
6324 * @see #getScheme
6325 * @see #setData
6326 */
6327 public Uri getData() {
6328 return mData;
6329 }
6330
6331 /**
6332 * The same as {@link #getData()}, but returns the URI as an encoded
6333 * String.
6334 */
6335 public String getDataString() {
6336 return mData != null ? mData.toString() : null;
6337 }
6338
6339 /**
6340 * Return the scheme portion of the intent's data. If the data is null or
6341 * does not include a scheme, null is returned. Otherwise, the scheme
6342 * prefix without the final ':' is returned, i.e. "http".
6343 *
6344 * <p>This is the same as calling getData().getScheme() (and checking for
6345 * null data).
6346 *
6347 * @return The scheme of this intent.
6348 *
6349 * @see #getData
6350 */
6351 public String getScheme() {
6352 return mData != null ? mData.getScheme() : null;
6353 }
6354
6355 /**
6356 * Retrieve any explicit MIME type included in the intent. This is usually
6357 * null, as the type is determined by the intent data.
6358 *
6359 * @return If a type was manually set, it is returned; else null is
6360 * returned.
6361 *
6362 * @see #resolveType(ContentResolver)
6363 * @see #setType
6364 */
6365 public String getType() {
6366 return mType;
6367 }
6368
6369 /**
6370 * Return the MIME data type of this intent. If the type field is
6371 * explicitly set, that is simply returned. Otherwise, if the data is set,
6372 * the type of that data is returned. If neither fields are set, a null is
6373 * returned.
6374 *
6375 * @return The MIME type of this intent.
6376 *
6377 * @see #getType
6378 * @see #resolveType(ContentResolver)
6379 */
6380 public String resolveType(Context context) {
6381 return resolveType(context.getContentResolver());
6382 }
6383
6384 /**
6385 * Return the MIME data type of this intent. If the type field is
6386 * explicitly set, that is simply returned. Otherwise, if the data is set,
6387 * the type of that data is returned. If neither fields are set, a null is
6388 * returned.
6389 *
6390 * @param resolver A ContentResolver that can be used to determine the MIME
6391 * type of the intent's data.
6392 *
6393 * @return The MIME type of this intent.
6394 *
6395 * @see #getType
6396 * @see #resolveType(Context)
6397 */
6398 public String resolveType(ContentResolver resolver) {
6399 if (mType != null) {
6400 return mType;
6401 }
6402 if (mData != null) {
6403 if ("content".equals(mData.getScheme())) {
6404 return resolver.getType(mData);
6405 }
6406 }
6407 return null;
6408 }
6409
6410 /**
6411 * Return the MIME data type of this intent, only if it will be needed for
6412 * intent resolution. This is not generally useful for application code;
6413 * it is used by the frameworks for communicating with back-end system
6414 * services.
6415 *
6416 * @param resolver A ContentResolver that can be used to determine the MIME
6417 * type of the intent's data.
6418 *
6419 * @return The MIME type of this intent, or null if it is unknown or not
6420 * needed.
6421 */
6422 public String resolveTypeIfNeeded(ContentResolver resolver) {
6423 if (mComponent != null) {
6424 return mType;
6425 }
6426 return resolveType(resolver);
6427 }
6428
6429 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006430 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006431 *
6432 * @param category The category to check.
6433 *
6434 * @return boolean True if the intent contains the category, else false.
6435 *
6436 * @see #getCategories
6437 * @see #addCategory
6438 */
6439 public boolean hasCategory(String category) {
6440 return mCategories != null && mCategories.contains(category);
6441 }
6442
6443 /**
6444 * Return the set of all categories in the intent. If there are no categories,
6445 * returns NULL.
6446 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006447 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006448 *
6449 * @see #hasCategory
6450 * @see #addCategory
6451 */
6452 public Set<String> getCategories() {
6453 return mCategories;
6454 }
6455
6456 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006457 * Return the specific selector associated with this Intent. If there is
6458 * none, returns null. See {@link #setSelector} for more information.
6459 *
6460 * @see #setSelector
6461 */
6462 public Intent getSelector() {
6463 return mSelector;
6464 }
6465
6466 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006467 * Return the {@link ClipData} associated with this Intent. If there is
6468 * none, returns null. See {@link #setClipData} for more information.
6469 *
John Spurlock125d1332013-11-25 11:58:37 -05006470 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006471 */
6472 public ClipData getClipData() {
6473 return mClipData;
6474 }
6475
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006476 /** @hide */
6477 public int getContentUserHint() {
6478 return mContentUserHint;
6479 }
6480
Todd Kennedyb3b431302017-03-20 16:05:48 -07006481 /** @hide */
6482 public String getLaunchToken() {
6483 return mLaunchToken;
6484 }
6485
6486 /** @hide */
6487 public void setLaunchToken(String launchToken) {
6488 mLaunchToken = launchToken;
6489 }
6490
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006491 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006492 * Sets the ClassLoader that will be used when unmarshalling
6493 * any Parcelable values from the extras of this Intent.
6494 *
6495 * @param loader a ClassLoader, or null to use the default loader
6496 * at the time of unmarshalling.
6497 */
6498 public void setExtrasClassLoader(ClassLoader loader) {
6499 if (mExtras != null) {
6500 mExtras.setClassLoader(loader);
6501 }
6502 }
6503
6504 /**
6505 * Returns true if an extra value is associated with the given name.
6506 * @param name the extra's name
6507 * @return true if the given extra is present.
6508 */
6509 public boolean hasExtra(String name) {
6510 return mExtras != null && mExtras.containsKey(name);
6511 }
6512
6513 /**
6514 * Returns true if the Intent's extras contain a parcelled file descriptor.
6515 * @return true if the Intent contains a parcelled file descriptor.
6516 */
6517 public boolean hasFileDescriptors() {
6518 return mExtras != null && mExtras.hasFileDescriptors();
6519 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006520
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006521 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006522 public void setAllowFds(boolean allowFds) {
6523 if (mExtras != null) {
6524 mExtras.setAllowFds(allowFds);
6525 }
6526 }
6527
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006528 /** {@hide} */
6529 public void setDefusable(boolean defusable) {
6530 if (mExtras != null) {
6531 mExtras.setDefusable(defusable);
6532 }
6533 }
6534
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006535 /**
6536 * Retrieve extended data from the intent.
6537 *
6538 * @param name The name of the desired item.
6539 *
6540 * @return the value of an item that previously added with putExtra()
6541 * or null if none was found.
6542 *
6543 * @deprecated
6544 * @hide
6545 */
6546 @Deprecated
6547 public Object getExtra(String name) {
6548 return getExtra(name, null);
6549 }
6550
6551 /**
6552 * Retrieve extended data from the intent.
6553 *
6554 * @param name The name of the desired item.
6555 * @param defaultValue the value to be returned if no value of the desired
6556 * type is stored with the given name.
6557 *
6558 * @return the value of an item that previously added with putExtra()
6559 * or the default value if none was found.
6560 *
6561 * @see #putExtra(String, boolean)
6562 */
6563 public boolean getBooleanExtra(String name, boolean defaultValue) {
6564 return mExtras == null ? defaultValue :
6565 mExtras.getBoolean(name, defaultValue);
6566 }
6567
6568 /**
6569 * Retrieve extended data from the intent.
6570 *
6571 * @param name The name of the desired item.
6572 * @param defaultValue the value to be returned if no value of the desired
6573 * type is stored with the given name.
6574 *
6575 * @return the value of an item that previously added with putExtra()
6576 * or the default value if none was found.
6577 *
6578 * @see #putExtra(String, byte)
6579 */
6580 public byte getByteExtra(String name, byte defaultValue) {
6581 return mExtras == null ? defaultValue :
6582 mExtras.getByte(name, defaultValue);
6583 }
6584
6585 /**
6586 * Retrieve extended data from the intent.
6587 *
6588 * @param name The name of the desired item.
6589 * @param defaultValue the value to be returned if no value of the desired
6590 * type is stored with the given name.
6591 *
6592 * @return the value of an item that previously added with putExtra()
6593 * or the default value if none was found.
6594 *
6595 * @see #putExtra(String, short)
6596 */
6597 public short getShortExtra(String name, short defaultValue) {
6598 return mExtras == null ? defaultValue :
6599 mExtras.getShort(name, defaultValue);
6600 }
6601
6602 /**
6603 * Retrieve extended data from the intent.
6604 *
6605 * @param name The name of the desired item.
6606 * @param defaultValue the value to be returned if no value of the desired
6607 * type is stored with the given name.
6608 *
6609 * @return the value of an item that previously added with putExtra()
6610 * or the default value if none was found.
6611 *
6612 * @see #putExtra(String, char)
6613 */
6614 public char getCharExtra(String name, char defaultValue) {
6615 return mExtras == null ? defaultValue :
6616 mExtras.getChar(name, defaultValue);
6617 }
6618
6619 /**
6620 * Retrieve extended data from the intent.
6621 *
6622 * @param name The name of the desired item.
6623 * @param defaultValue the value to be returned if no value of the desired
6624 * type is stored with the given name.
6625 *
6626 * @return the value of an item that previously added with putExtra()
6627 * or the default value if none was found.
6628 *
6629 * @see #putExtra(String, int)
6630 */
6631 public int getIntExtra(String name, int defaultValue) {
6632 return mExtras == null ? defaultValue :
6633 mExtras.getInt(name, defaultValue);
6634 }
6635
6636 /**
6637 * Retrieve extended data from the intent.
6638 *
6639 * @param name The name of the desired item.
6640 * @param defaultValue the value to be returned if no value of the desired
6641 * type is stored with the given name.
6642 *
6643 * @return the value of an item that previously added with putExtra()
6644 * or the default value if none was found.
6645 *
6646 * @see #putExtra(String, long)
6647 */
6648 public long getLongExtra(String name, long defaultValue) {
6649 return mExtras == null ? defaultValue :
6650 mExtras.getLong(name, defaultValue);
6651 }
6652
6653 /**
6654 * Retrieve extended data from the intent.
6655 *
6656 * @param name The name of the desired item.
6657 * @param defaultValue the value to be returned if no value of the desired
6658 * type is stored with the given name.
6659 *
6660 * @return the value of an item that previously added with putExtra(),
6661 * or the default value if no such item is present
6662 *
6663 * @see #putExtra(String, float)
6664 */
6665 public float getFloatExtra(String name, float defaultValue) {
6666 return mExtras == null ? defaultValue :
6667 mExtras.getFloat(name, defaultValue);
6668 }
6669
6670 /**
6671 * Retrieve extended data from the intent.
6672 *
6673 * @param name The name of the desired item.
6674 * @param defaultValue the value to be returned if no value of the desired
6675 * type is stored with the given name.
6676 *
6677 * @return the value of an item that previously added with putExtra()
6678 * or the default value if none was found.
6679 *
6680 * @see #putExtra(String, double)
6681 */
6682 public double getDoubleExtra(String name, double defaultValue) {
6683 return mExtras == null ? defaultValue :
6684 mExtras.getDouble(name, defaultValue);
6685 }
6686
6687 /**
6688 * Retrieve extended data from the intent.
6689 *
6690 * @param name The name of the desired item.
6691 *
6692 * @return the value of an item that previously added with putExtra()
6693 * or null if no String value was found.
6694 *
6695 * @see #putExtra(String, String)
6696 */
6697 public String getStringExtra(String name) {
6698 return mExtras == null ? null : mExtras.getString(name);
6699 }
6700
6701 /**
6702 * Retrieve extended data from the intent.
6703 *
6704 * @param name The name of the desired item.
6705 *
6706 * @return the value of an item that previously added with putExtra()
6707 * or null if no CharSequence value was found.
6708 *
6709 * @see #putExtra(String, CharSequence)
6710 */
6711 public CharSequence getCharSequenceExtra(String name) {
6712 return mExtras == null ? null : mExtras.getCharSequence(name);
6713 }
6714
6715 /**
6716 * Retrieve extended data from the intent.
6717 *
6718 * @param name The name of the desired item.
6719 *
6720 * @return the value of an item that previously added with putExtra()
6721 * or null if no Parcelable value was found.
6722 *
6723 * @see #putExtra(String, Parcelable)
6724 */
6725 public <T extends Parcelable> T getParcelableExtra(String name) {
6726 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6727 }
6728
6729 /**
6730 * Retrieve extended data from the intent.
6731 *
6732 * @param name The name of the desired item.
6733 *
6734 * @return the value of an item that previously added with putExtra()
6735 * or null if no Parcelable[] value was found.
6736 *
6737 * @see #putExtra(String, Parcelable[])
6738 */
6739 public Parcelable[] getParcelableArrayExtra(String name) {
6740 return mExtras == null ? null : mExtras.getParcelableArray(name);
6741 }
6742
6743 /**
6744 * Retrieve extended data from the intent.
6745 *
6746 * @param name The name of the desired item.
6747 *
6748 * @return the value of an item that previously added with putExtra()
6749 * or null if no ArrayList<Parcelable> value was found.
6750 *
6751 * @see #putParcelableArrayListExtra(String, ArrayList)
6752 */
6753 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6754 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6755 }
6756
6757 /**
6758 * Retrieve extended data from the intent.
6759 *
6760 * @param name The name of the desired item.
6761 *
6762 * @return the value of an item that previously added with putExtra()
6763 * or null if no Serializable value was found.
6764 *
6765 * @see #putExtra(String, Serializable)
6766 */
6767 public Serializable getSerializableExtra(String name) {
6768 return mExtras == null ? null : mExtras.getSerializable(name);
6769 }
6770
6771 /**
6772 * Retrieve extended data from the intent.
6773 *
6774 * @param name The name of the desired item.
6775 *
6776 * @return the value of an item that previously added with putExtra()
6777 * or null if no ArrayList<Integer> value was found.
6778 *
6779 * @see #putIntegerArrayListExtra(String, ArrayList)
6780 */
6781 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6782 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6783 }
6784
6785 /**
6786 * Retrieve extended data from the intent.
6787 *
6788 * @param name The name of the desired item.
6789 *
6790 * @return the value of an item that previously added with putExtra()
6791 * or null if no ArrayList<String> value was found.
6792 *
6793 * @see #putStringArrayListExtra(String, ArrayList)
6794 */
6795 public ArrayList<String> getStringArrayListExtra(String name) {
6796 return mExtras == null ? null : mExtras.getStringArrayList(name);
6797 }
6798
6799 /**
6800 * Retrieve extended data from the intent.
6801 *
6802 * @param name The name of the desired item.
6803 *
6804 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006805 * or null if no ArrayList<CharSequence> value was found.
6806 *
6807 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6808 */
6809 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6810 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6811 }
6812
6813 /**
6814 * Retrieve extended data from the intent.
6815 *
6816 * @param name The name of the desired item.
6817 *
6818 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006819 * or null if no boolean array value was found.
6820 *
6821 * @see #putExtra(String, boolean[])
6822 */
6823 public boolean[] getBooleanArrayExtra(String name) {
6824 return mExtras == null ? null : mExtras.getBooleanArray(name);
6825 }
6826
6827 /**
6828 * Retrieve extended data from the intent.
6829 *
6830 * @param name The name of the desired item.
6831 *
6832 * @return the value of an item that previously added with putExtra()
6833 * or null if no byte array value was found.
6834 *
6835 * @see #putExtra(String, byte[])
6836 */
6837 public byte[] getByteArrayExtra(String name) {
6838 return mExtras == null ? null : mExtras.getByteArray(name);
6839 }
6840
6841 /**
6842 * Retrieve extended data from the intent.
6843 *
6844 * @param name The name of the desired item.
6845 *
6846 * @return the value of an item that previously added with putExtra()
6847 * or null if no short array value was found.
6848 *
6849 * @see #putExtra(String, short[])
6850 */
6851 public short[] getShortArrayExtra(String name) {
6852 return mExtras == null ? null : mExtras.getShortArray(name);
6853 }
6854
6855 /**
6856 * Retrieve extended data from the intent.
6857 *
6858 * @param name The name of the desired item.
6859 *
6860 * @return the value of an item that previously added with putExtra()
6861 * or null if no char array value was found.
6862 *
6863 * @see #putExtra(String, char[])
6864 */
6865 public char[] getCharArrayExtra(String name) {
6866 return mExtras == null ? null : mExtras.getCharArray(name);
6867 }
6868
6869 /**
6870 * Retrieve extended data from the intent.
6871 *
6872 * @param name The name of the desired item.
6873 *
6874 * @return the value of an item that previously added with putExtra()
6875 * or null if no int array value was found.
6876 *
6877 * @see #putExtra(String, int[])
6878 */
6879 public int[] getIntArrayExtra(String name) {
6880 return mExtras == null ? null : mExtras.getIntArray(name);
6881 }
6882
6883 /**
6884 * Retrieve extended data from the intent.
6885 *
6886 * @param name The name of the desired item.
6887 *
6888 * @return the value of an item that previously added with putExtra()
6889 * or null if no long array value was found.
6890 *
6891 * @see #putExtra(String, long[])
6892 */
6893 public long[] getLongArrayExtra(String name) {
6894 return mExtras == null ? null : mExtras.getLongArray(name);
6895 }
6896
6897 /**
6898 * Retrieve extended data from the intent.
6899 *
6900 * @param name The name of the desired item.
6901 *
6902 * @return the value of an item that previously added with putExtra()
6903 * or null if no float array value was found.
6904 *
6905 * @see #putExtra(String, float[])
6906 */
6907 public float[] getFloatArrayExtra(String name) {
6908 return mExtras == null ? null : mExtras.getFloatArray(name);
6909 }
6910
6911 /**
6912 * Retrieve extended data from the intent.
6913 *
6914 * @param name The name of the desired item.
6915 *
6916 * @return the value of an item that previously added with putExtra()
6917 * or null if no double array value was found.
6918 *
6919 * @see #putExtra(String, double[])
6920 */
6921 public double[] getDoubleArrayExtra(String name) {
6922 return mExtras == null ? null : mExtras.getDoubleArray(name);
6923 }
6924
6925 /**
6926 * Retrieve extended data from the intent.
6927 *
6928 * @param name The name of the desired item.
6929 *
6930 * @return the value of an item that previously added with putExtra()
6931 * or null if no String array value was found.
6932 *
6933 * @see #putExtra(String, String[])
6934 */
6935 public String[] getStringArrayExtra(String name) {
6936 return mExtras == null ? null : mExtras.getStringArray(name);
6937 }
6938
6939 /**
6940 * Retrieve extended data from the intent.
6941 *
6942 * @param name The name of the desired item.
6943 *
6944 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006945 * or null if no CharSequence array value was found.
6946 *
6947 * @see #putExtra(String, CharSequence[])
6948 */
6949 public CharSequence[] getCharSequenceArrayExtra(String name) {
6950 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6951 }
6952
6953 /**
6954 * Retrieve extended data from the intent.
6955 *
6956 * @param name The name of the desired item.
6957 *
6958 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006959 * or null if no Bundle value was found.
6960 *
6961 * @see #putExtra(String, Bundle)
6962 */
6963 public Bundle getBundleExtra(String name) {
6964 return mExtras == null ? null : mExtras.getBundle(name);
6965 }
6966
6967 /**
6968 * Retrieve extended data from the intent.
6969 *
6970 * @param name The name of the desired item.
6971 *
6972 * @return the value of an item that previously added with putExtra()
6973 * or null if no IBinder value was found.
6974 *
6975 * @see #putExtra(String, IBinder)
6976 *
6977 * @deprecated
6978 * @hide
6979 */
6980 @Deprecated
6981 public IBinder getIBinderExtra(String name) {
6982 return mExtras == null ? null : mExtras.getIBinder(name);
6983 }
6984
6985 /**
6986 * Retrieve extended data from the intent.
6987 *
6988 * @param name The name of the desired item.
6989 * @param defaultValue The default value to return in case no item is
6990 * associated with the key 'name'
6991 *
6992 * @return the value of an item that previously added with putExtra()
6993 * or defaultValue if none was found.
6994 *
6995 * @see #putExtra
6996 *
6997 * @deprecated
6998 * @hide
6999 */
7000 @Deprecated
7001 public Object getExtra(String name, Object defaultValue) {
7002 Object result = defaultValue;
7003 if (mExtras != null) {
7004 Object result2 = mExtras.get(name);
7005 if (result2 != null) {
7006 result = result2;
7007 }
7008 }
7009
7010 return result;
7011 }
7012
7013 /**
7014 * Retrieves a map of extended data from the intent.
7015 *
7016 * @return the map of all extras previously added with putExtra(),
7017 * or null if none have been added.
7018 */
7019 public Bundle getExtras() {
7020 return (mExtras != null)
7021 ? new Bundle(mExtras)
7022 : null;
7023 }
7024
7025 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007026 * Filter extras to only basic types.
7027 * @hide
7028 */
7029 public void removeUnsafeExtras() {
7030 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007031 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007032 }
7033 }
7034
7035 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007036 * Retrieve any special flags associated with this intent. You will
7037 * normally just set them with {@link #setFlags} and let the system
7038 * take the appropriate action with them.
7039 *
7040 * @return int The currently set flags.
7041 *
7042 * @see #setFlags
7043 */
7044 public int getFlags() {
7045 return mFlags;
7046 }
7047
Dianne Hackborne7f97212011-02-24 14:40:20 -08007048 /** @hide */
7049 public boolean isExcludingStopped() {
7050 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7051 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7052 }
7053
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007054 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007055 * Retrieve the application package name this Intent is limited to. When
7056 * resolving an Intent, if non-null this limits the resolution to only
7057 * components in the given application package.
7058 *
7059 * @return The name of the application package for the Intent.
7060 *
7061 * @see #resolveActivity
7062 * @see #setPackage
7063 */
7064 public String getPackage() {
7065 return mPackage;
7066 }
7067
7068 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007069 * Retrieve the concrete component associated with the intent. When receiving
7070 * an intent, this is the component that was found to best handle it (that is,
7071 * yourself) and will always be non-null; in all other cases it will be
7072 * null unless explicitly set.
7073 *
7074 * @return The name of the application component to handle the intent.
7075 *
7076 * @see #resolveActivity
7077 * @see #setComponent
7078 */
7079 public ComponentName getComponent() {
7080 return mComponent;
7081 }
7082
7083 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007084 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7085 * used as a hint to the receiver for animations and the like. Null means that there
7086 * is no source bounds.
7087 */
7088 public Rect getSourceBounds() {
7089 return mSourceBounds;
7090 }
7091
7092 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007093 * Return the Activity component that should be used to handle this intent.
7094 * The appropriate component is determined based on the information in the
7095 * intent, evaluated as follows:
7096 *
7097 * <p>If {@link #getComponent} returns an explicit class, that is returned
7098 * without any further consideration.
7099 *
7100 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7101 * category to be considered.
7102 *
7103 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7104 * action.
7105 *
7106 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7107 * this type.
7108 *
7109 * <p>If {@link #addCategory} has added any categories, the activity must
7110 * handle ALL of the categories specified.
7111 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007112 * <p>If {@link #getPackage} is non-NULL, only activity components in
7113 * that application package will be considered.
7114 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007115 * <p>If there are no activities that satisfy all of these conditions, a
7116 * null string is returned.
7117 *
7118 * <p>If multiple activities are found to satisfy the intent, the one with
7119 * the highest priority will be used. If there are multiple activities
7120 * with the same priority, the system will either pick the best activity
7121 * based on user preference, or resolve to a system class that will allow
7122 * the user to pick an activity and forward from there.
7123 *
7124 * <p>This method is implemented simply by calling
7125 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7126 * true.</p>
7127 * <p> This API is called for you as part of starting an activity from an
7128 * intent. You do not normally need to call it yourself.</p>
7129 *
7130 * @param pm The package manager with which to resolve the Intent.
7131 *
7132 * @return Name of the component implementing an activity that can
7133 * display the intent.
7134 *
7135 * @see #setComponent
7136 * @see #getComponent
7137 * @see #resolveActivityInfo
7138 */
7139 public ComponentName resolveActivity(PackageManager pm) {
7140 if (mComponent != null) {
7141 return mComponent;
7142 }
7143
7144 ResolveInfo info = pm.resolveActivity(
7145 this, PackageManager.MATCH_DEFAULT_ONLY);
7146 if (info != null) {
7147 return new ComponentName(
7148 info.activityInfo.applicationInfo.packageName,
7149 info.activityInfo.name);
7150 }
7151
7152 return null;
7153 }
7154
7155 /**
7156 * Resolve the Intent into an {@link ActivityInfo}
7157 * describing the activity that should execute the intent. Resolution
7158 * follows the same rules as described for {@link #resolveActivity}, but
7159 * you get back the completely information about the resolved activity
7160 * instead of just its class name.
7161 *
7162 * @param pm The package manager with which to resolve the Intent.
7163 * @param flags Addition information to retrieve as per
7164 * {@link PackageManager#getActivityInfo(ComponentName, int)
7165 * PackageManager.getActivityInfo()}.
7166 *
7167 * @return PackageManager.ActivityInfo
7168 *
7169 * @see #resolveActivity
7170 */
7171 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
7172 ActivityInfo ai = null;
7173 if (mComponent != null) {
7174 try {
7175 ai = pm.getActivityInfo(mComponent, flags);
7176 } catch (PackageManager.NameNotFoundException e) {
7177 // ignore
7178 }
7179 } else {
7180 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007181 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007182 if (info != null) {
7183 ai = info.activityInfo;
7184 }
7185 }
7186
7187 return ai;
7188 }
7189
7190 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007191 * Special function for use by the system to resolve service
7192 * intents to system apps. Throws an exception if there are
7193 * multiple potential matches to the Intent. Returns null if
7194 * there are no matches.
7195 * @hide
7196 */
7197 public ComponentName resolveSystemService(PackageManager pm, int flags) {
7198 if (mComponent != null) {
7199 return mComponent;
7200 }
7201
7202 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7203 if (results == null) {
7204 return null;
7205 }
7206 ComponentName comp = null;
7207 for (int i=0; i<results.size(); i++) {
7208 ResolveInfo ri = results.get(i);
7209 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7210 continue;
7211 }
7212 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7213 ri.serviceInfo.name);
7214 if (comp != null) {
7215 throw new IllegalStateException("Multiple system services handle " + this
7216 + ": " + comp + ", " + foundComp);
7217 }
7218 comp = foundComp;
7219 }
7220 return comp;
7221 }
7222
7223 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007224 * Set the general action to be performed.
7225 *
7226 * @param action An action name, such as ACTION_VIEW. Application-specific
7227 * actions should be prefixed with the vendor's package name.
7228 *
7229 * @return Returns the same Intent object, for chaining multiple calls
7230 * into a single statement.
7231 *
7232 * @see #getAction
7233 */
7234 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007235 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007236 return this;
7237 }
7238
7239 /**
7240 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007241 * clears any type that was previously set by {@link #setType} or
7242 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007243 *
Nick Pellyccae4122012-01-09 14:12:58 -08007244 * <p><em>Note: scheme matching in the Android framework is
7245 * case-sensitive, unlike the formal RFC. As a result,
7246 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007247 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007248 * {@link #setDataAndNormalize}
7249 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007250 *
Nick Pellyccae4122012-01-09 14:12:58 -08007251 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007252 *
7253 * @return Returns the same Intent object, for chaining multiple calls
7254 * into a single statement.
7255 *
7256 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007257 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007258 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007259 */
7260 public Intent setData(Uri data) {
7261 mData = data;
7262 mType = null;
7263 return this;
7264 }
7265
7266 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007267 * Normalize and set the data this intent is operating on.
7268 *
7269 * <p>This method automatically clears any type that was
7270 * previously set (for example, by {@link #setType}).
7271 *
7272 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007273 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007274 * so really this is just a convenience method for
7275 * <pre>
7276 * setData(data.normalize())
7277 * </pre>
7278 *
7279 * @param data The Uri of the data this intent is now targeting.
7280 *
7281 * @return Returns the same Intent object, for chaining multiple calls
7282 * into a single statement.
7283 *
7284 * @see #getData
7285 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007286 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007287 */
7288 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007289 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007290 }
7291
7292 /**
7293 * Set an explicit MIME data type.
7294 *
7295 * <p>This is used to create intents that only specify a type and not data,
7296 * for example to indicate the type of data to return.
7297 *
7298 * <p>This method automatically clears any data that was
7299 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007300 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007301 * <p><em>Note: MIME type matching in the Android framework is
7302 * case-sensitive, unlike formal RFC MIME types. As a result,
7303 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007304 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7305 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007306 *
7307 * @param type The MIME type of the data being handled by this intent.
7308 *
7309 * @return Returns the same Intent object, for chaining multiple calls
7310 * into a single statement.
7311 *
7312 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007313 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007314 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007315 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007316 */
7317 public Intent setType(String type) {
7318 mData = null;
7319 mType = type;
7320 return this;
7321 }
7322
7323 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007324 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007325 *
Nick Pellyccae4122012-01-09 14:12:58 -08007326 * <p>This is used to create intents that only specify a type and not data,
7327 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007328 *
Nick Pellyccae4122012-01-09 14:12:58 -08007329 * <p>This method automatically clears any data that was
7330 * previously set (for example by {@link #setData}).
7331 *
7332 * <p>The MIME type is normalized using
7333 * {@link #normalizeMimeType} before it is set,
7334 * so really this is just a convenience method for
7335 * <pre>
7336 * setType(Intent.normalizeMimeType(type))
7337 * </pre>
7338 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007339 * @param type The MIME type of the data being handled by this intent.
7340 *
7341 * @return Returns the same Intent object, for chaining multiple calls
7342 * into a single statement.
7343 *
Nick Pellyccae4122012-01-09 14:12:58 -08007344 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007345 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007346 * @see #normalizeMimeType
7347 */
7348 public Intent setTypeAndNormalize(String type) {
7349 return setType(normalizeMimeType(type));
7350 }
7351
7352 /**
7353 * (Usually optional) Set the data for the intent along with an explicit
7354 * MIME data type. This method should very rarely be used -- it allows you
7355 * to override the MIME type that would ordinarily be inferred from the
7356 * data with your own type given here.
7357 *
7358 * <p><em>Note: MIME type and Uri scheme matching in the
7359 * Android framework is case-sensitive, unlike the formal RFC definitions.
7360 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007361 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007362 * {@link #setDataAndTypeAndNormalize}
7363 * to ensure that they are converted to lower case.</em>
7364 *
7365 * @param data The Uri of the data this intent is now targeting.
7366 * @param type The MIME type of the data being handled by this intent.
7367 *
7368 * @return Returns the same Intent object, for chaining multiple calls
7369 * into a single statement.
7370 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007371 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007372 * @see #setData
7373 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007374 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007375 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007376 */
7377 public Intent setDataAndType(Uri data, String type) {
7378 mData = data;
7379 mType = type;
7380 return this;
7381 }
7382
7383 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007384 * (Usually optional) Normalize and set both the data Uri and an explicit
7385 * MIME data type. This method should very rarely be used -- it allows you
7386 * to override the MIME type that would ordinarily be inferred from the
7387 * data with your own type given here.
7388 *
7389 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007390 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007391 * before they are set, so really this is just a convenience method for
7392 * <pre>
7393 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7394 * </pre>
7395 *
7396 * @param data The Uri of the data this intent is now targeting.
7397 * @param type The MIME type of the data being handled by this intent.
7398 *
7399 * @return Returns the same Intent object, for chaining multiple calls
7400 * into a single statement.
7401 *
7402 * @see #setType
7403 * @see #setData
7404 * @see #setDataAndType
7405 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007406 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007407 */
7408 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007409 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007410 }
7411
7412 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007413 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007414 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007415 * activities that provide <em>all</em> of the requested categories will be
7416 * used.
7417 *
7418 * @param category The desired category. This can be either one of the
7419 * predefined Intent categories, or a custom category in your own
7420 * namespace.
7421 *
7422 * @return Returns the same Intent object, for chaining multiple calls
7423 * into a single statement.
7424 *
7425 * @see #hasCategory
7426 * @see #removeCategory
7427 */
7428 public Intent addCategory(String category) {
7429 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007430 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007431 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007432 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007433 return this;
7434 }
7435
7436 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007437 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007438 *
7439 * @param category The category to remove.
7440 *
7441 * @see #addCategory
7442 */
7443 public void removeCategory(String category) {
7444 if (mCategories != null) {
7445 mCategories.remove(category);
7446 if (mCategories.size() == 0) {
7447 mCategories = null;
7448 }
7449 }
7450 }
7451
7452 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007453 * Set a selector for this Intent. This is a modification to the kinds of
7454 * things the Intent will match. If the selector is set, it will be used
7455 * when trying to find entities that can handle the Intent, instead of the
7456 * main contents of the Intent. This allows you build an Intent containing
7457 * a generic protocol while targeting it more specifically.
7458 *
7459 * <p>An example of where this may be used is with things like
7460 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7461 * Intent that will launch the Browser application. However, the correct
7462 * main entry point of an application is actually {@link #ACTION_MAIN}
7463 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7464 * used to specify the actual Activity to launch. If you launch the browser
7465 * with something different, undesired behavior may happen if the user has
7466 * previously or later launches it the normal way, since they do not match.
7467 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7468 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7469 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7470 *
7471 * <p>Setting a selector does not impact the behavior of
7472 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7473 * desired behavior of a selector -- it does not impact the base meaning
7474 * of the Intent, just what kinds of things will be matched against it
7475 * when determining who can handle it.</p>
7476 *
7477 * <p>You can not use both a selector and {@link #setPackage(String)} on
7478 * the same base Intent.</p>
7479 *
7480 * @param selector The desired selector Intent; set to null to not use
7481 * a special selector.
7482 */
7483 public void setSelector(Intent selector) {
7484 if (selector == this) {
7485 throw new IllegalArgumentException(
7486 "Intent being set as a selector of itself");
7487 }
7488 if (selector != null && mPackage != null) {
7489 throw new IllegalArgumentException(
7490 "Can't set selector when package name is already set");
7491 }
7492 mSelector = selector;
7493 }
7494
7495 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007496 * Set a {@link ClipData} associated with this Intent. This replaces any
7497 * previously set ClipData.
7498 *
7499 * <p>The ClipData in an intent is not used for Intent matching or other
7500 * such operations. Semantically it is like extras, used to transmit
7501 * additional data with the Intent. The main feature of using this over
7502 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7503 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7504 * items included in the clip data. This is useful, in particular, if
7505 * you want to transmit an Intent containing multiple <code>content:</code>
7506 * URIs for which the recipient may not have global permission to access the
7507 * content provider.
7508 *
7509 * <p>If the ClipData contains items that are themselves Intents, any
7510 * grant flags in those Intents will be ignored. Only the top-level flags
7511 * of the main Intent are respected, and will be applied to all Uri or
7512 * Intent items in the clip (or sub-items of the clip).
7513 *
7514 * <p>The MIME type, label, and icon in the ClipData object are not
7515 * directly used by Intent. Applications should generally rely on the
7516 * MIME type of the Intent itself, not what it may find in the ClipData.
7517 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007518 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007519 *
7520 * @param clip The new clip to set. May be null to clear the current clip.
7521 */
7522 public void setClipData(ClipData clip) {
7523 mClipData = clip;
7524 }
7525
7526 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007527 * This is NOT a secure mechanism to identify the user who sent the intent.
7528 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7529 * who sent the intent.
7530 * @hide
7531 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007532 public void prepareToLeaveUser(int userId) {
7533 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7534 // We want mContentUserHint to refer to the original user, so don't do anything.
7535 if (mContentUserHint == UserHandle.USER_CURRENT) {
7536 mContentUserHint = userId;
7537 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007538 }
7539
7540 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007541 * Add extended data to the intent. The name must include a package
7542 * prefix, for example the app com.android.contacts would use names
7543 * like "com.android.contacts.ShowAll".
7544 *
7545 * @param name The name of the extra data, with package prefix.
7546 * @param value The boolean data value.
7547 *
7548 * @return Returns the same Intent object, for chaining multiple calls
7549 * into a single statement.
7550 *
7551 * @see #putExtras
7552 * @see #removeExtra
7553 * @see #getBooleanExtra(String, boolean)
7554 */
7555 public Intent putExtra(String name, boolean value) {
7556 if (mExtras == null) {
7557 mExtras = new Bundle();
7558 }
7559 mExtras.putBoolean(name, value);
7560 return this;
7561 }
7562
7563 /**
7564 * Add extended data to the intent. The name must include a package
7565 * prefix, for example the app com.android.contacts would use names
7566 * like "com.android.contacts.ShowAll".
7567 *
7568 * @param name The name of the extra data, with package prefix.
7569 * @param value The byte data value.
7570 *
7571 * @return Returns the same Intent object, for chaining multiple calls
7572 * into a single statement.
7573 *
7574 * @see #putExtras
7575 * @see #removeExtra
7576 * @see #getByteExtra(String, byte)
7577 */
7578 public Intent putExtra(String name, byte value) {
7579 if (mExtras == null) {
7580 mExtras = new Bundle();
7581 }
7582 mExtras.putByte(name, value);
7583 return this;
7584 }
7585
7586 /**
7587 * Add extended data to the intent. The name must include a package
7588 * prefix, for example the app com.android.contacts would use names
7589 * like "com.android.contacts.ShowAll".
7590 *
7591 * @param name The name of the extra data, with package prefix.
7592 * @param value The char data value.
7593 *
7594 * @return Returns the same Intent object, for chaining multiple calls
7595 * into a single statement.
7596 *
7597 * @see #putExtras
7598 * @see #removeExtra
7599 * @see #getCharExtra(String, char)
7600 */
7601 public Intent putExtra(String name, char value) {
7602 if (mExtras == null) {
7603 mExtras = new Bundle();
7604 }
7605 mExtras.putChar(name, value);
7606 return this;
7607 }
7608
7609 /**
7610 * Add extended data to the intent. The name must include a package
7611 * prefix, for example the app com.android.contacts would use names
7612 * like "com.android.contacts.ShowAll".
7613 *
7614 * @param name The name of the extra data, with package prefix.
7615 * @param value The short data value.
7616 *
7617 * @return Returns the same Intent object, for chaining multiple calls
7618 * into a single statement.
7619 *
7620 * @see #putExtras
7621 * @see #removeExtra
7622 * @see #getShortExtra(String, short)
7623 */
7624 public Intent putExtra(String name, short value) {
7625 if (mExtras == null) {
7626 mExtras = new Bundle();
7627 }
7628 mExtras.putShort(name, value);
7629 return this;
7630 }
7631
7632 /**
7633 * Add extended data to the intent. The name must include a package
7634 * prefix, for example the app com.android.contacts would use names
7635 * like "com.android.contacts.ShowAll".
7636 *
7637 * @param name The name of the extra data, with package prefix.
7638 * @param value The integer data value.
7639 *
7640 * @return Returns the same Intent object, for chaining multiple calls
7641 * into a single statement.
7642 *
7643 * @see #putExtras
7644 * @see #removeExtra
7645 * @see #getIntExtra(String, int)
7646 */
7647 public Intent putExtra(String name, int value) {
7648 if (mExtras == null) {
7649 mExtras = new Bundle();
7650 }
7651 mExtras.putInt(name, value);
7652 return this;
7653 }
7654
7655 /**
7656 * Add extended data to the intent. The name must include a package
7657 * prefix, for example the app com.android.contacts would use names
7658 * like "com.android.contacts.ShowAll".
7659 *
7660 * @param name The name of the extra data, with package prefix.
7661 * @param value The long data value.
7662 *
7663 * @return Returns the same Intent object, for chaining multiple calls
7664 * into a single statement.
7665 *
7666 * @see #putExtras
7667 * @see #removeExtra
7668 * @see #getLongExtra(String, long)
7669 */
7670 public Intent putExtra(String name, long value) {
7671 if (mExtras == null) {
7672 mExtras = new Bundle();
7673 }
7674 mExtras.putLong(name, value);
7675 return this;
7676 }
7677
7678 /**
7679 * Add extended data to the intent. The name must include a package
7680 * prefix, for example the app com.android.contacts would use names
7681 * like "com.android.contacts.ShowAll".
7682 *
7683 * @param name The name of the extra data, with package prefix.
7684 * @param value The float data value.
7685 *
7686 * @return Returns the same Intent object, for chaining multiple calls
7687 * into a single statement.
7688 *
7689 * @see #putExtras
7690 * @see #removeExtra
7691 * @see #getFloatExtra(String, float)
7692 */
7693 public Intent putExtra(String name, float value) {
7694 if (mExtras == null) {
7695 mExtras = new Bundle();
7696 }
7697 mExtras.putFloat(name, value);
7698 return this;
7699 }
7700
7701 /**
7702 * Add extended data to the intent. The name must include a package
7703 * prefix, for example the app com.android.contacts would use names
7704 * like "com.android.contacts.ShowAll".
7705 *
7706 * @param name The name of the extra data, with package prefix.
7707 * @param value The double data value.
7708 *
7709 * @return Returns the same Intent object, for chaining multiple calls
7710 * into a single statement.
7711 *
7712 * @see #putExtras
7713 * @see #removeExtra
7714 * @see #getDoubleExtra(String, double)
7715 */
7716 public Intent putExtra(String name, double value) {
7717 if (mExtras == null) {
7718 mExtras = new Bundle();
7719 }
7720 mExtras.putDouble(name, value);
7721 return this;
7722 }
7723
7724 /**
7725 * Add extended data to the intent. The name must include a package
7726 * prefix, for example the app com.android.contacts would use names
7727 * like "com.android.contacts.ShowAll".
7728 *
7729 * @param name The name of the extra data, with package prefix.
7730 * @param value The String data value.
7731 *
7732 * @return Returns the same Intent object, for chaining multiple calls
7733 * into a single statement.
7734 *
7735 * @see #putExtras
7736 * @see #removeExtra
7737 * @see #getStringExtra(String)
7738 */
7739 public Intent putExtra(String name, String value) {
7740 if (mExtras == null) {
7741 mExtras = new Bundle();
7742 }
7743 mExtras.putString(name, value);
7744 return this;
7745 }
7746
7747 /**
7748 * Add extended data to the intent. The name must include a package
7749 * prefix, for example the app com.android.contacts would use names
7750 * like "com.android.contacts.ShowAll".
7751 *
7752 * @param name The name of the extra data, with package prefix.
7753 * @param value The CharSequence data value.
7754 *
7755 * @return Returns the same Intent object, for chaining multiple calls
7756 * into a single statement.
7757 *
7758 * @see #putExtras
7759 * @see #removeExtra
7760 * @see #getCharSequenceExtra(String)
7761 */
7762 public Intent putExtra(String name, CharSequence value) {
7763 if (mExtras == null) {
7764 mExtras = new Bundle();
7765 }
7766 mExtras.putCharSequence(name, value);
7767 return this;
7768 }
7769
7770 /**
7771 * Add extended data to the intent. The name must include a package
7772 * prefix, for example the app com.android.contacts would use names
7773 * like "com.android.contacts.ShowAll".
7774 *
7775 * @param name The name of the extra data, with package prefix.
7776 * @param value The Parcelable data value.
7777 *
7778 * @return Returns the same Intent object, for chaining multiple calls
7779 * into a single statement.
7780 *
7781 * @see #putExtras
7782 * @see #removeExtra
7783 * @see #getParcelableExtra(String)
7784 */
7785 public Intent putExtra(String name, Parcelable value) {
7786 if (mExtras == null) {
7787 mExtras = new Bundle();
7788 }
7789 mExtras.putParcelable(name, value);
7790 return this;
7791 }
7792
7793 /**
7794 * Add extended data to the intent. The name must include a package
7795 * prefix, for example the app com.android.contacts would use names
7796 * like "com.android.contacts.ShowAll".
7797 *
7798 * @param name The name of the extra data, with package prefix.
7799 * @param value The Parcelable[] data value.
7800 *
7801 * @return Returns the same Intent object, for chaining multiple calls
7802 * into a single statement.
7803 *
7804 * @see #putExtras
7805 * @see #removeExtra
7806 * @see #getParcelableArrayExtra(String)
7807 */
7808 public Intent putExtra(String name, Parcelable[] value) {
7809 if (mExtras == null) {
7810 mExtras = new Bundle();
7811 }
7812 mExtras.putParcelableArray(name, value);
7813 return this;
7814 }
7815
7816 /**
7817 * Add extended data to the intent. The name must include a package
7818 * prefix, for example the app com.android.contacts would use names
7819 * like "com.android.contacts.ShowAll".
7820 *
7821 * @param name The name of the extra data, with package prefix.
7822 * @param value The ArrayList<Parcelable> data value.
7823 *
7824 * @return Returns the same Intent object, for chaining multiple calls
7825 * into a single statement.
7826 *
7827 * @see #putExtras
7828 * @see #removeExtra
7829 * @see #getParcelableArrayListExtra(String)
7830 */
7831 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7832 if (mExtras == null) {
7833 mExtras = new Bundle();
7834 }
7835 mExtras.putParcelableArrayList(name, value);
7836 return this;
7837 }
7838
7839 /**
7840 * Add extended data to the intent. The name must include a package
7841 * prefix, for example the app com.android.contacts would use names
7842 * like "com.android.contacts.ShowAll".
7843 *
7844 * @param name The name of the extra data, with package prefix.
7845 * @param value The ArrayList<Integer> data value.
7846 *
7847 * @return Returns the same Intent object, for chaining multiple calls
7848 * into a single statement.
7849 *
7850 * @see #putExtras
7851 * @see #removeExtra
7852 * @see #getIntegerArrayListExtra(String)
7853 */
7854 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7855 if (mExtras == null) {
7856 mExtras = new Bundle();
7857 }
7858 mExtras.putIntegerArrayList(name, value);
7859 return this;
7860 }
7861
7862 /**
7863 * Add extended data to the intent. The name must include a package
7864 * prefix, for example the app com.android.contacts would use names
7865 * like "com.android.contacts.ShowAll".
7866 *
7867 * @param name The name of the extra data, with package prefix.
7868 * @param value The ArrayList<String> data value.
7869 *
7870 * @return Returns the same Intent object, for chaining multiple calls
7871 * into a single statement.
7872 *
7873 * @see #putExtras
7874 * @see #removeExtra
7875 * @see #getStringArrayListExtra(String)
7876 */
7877 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7878 if (mExtras == null) {
7879 mExtras = new Bundle();
7880 }
7881 mExtras.putStringArrayList(name, value);
7882 return this;
7883 }
7884
7885 /**
7886 * Add extended data to the intent. The name must include a package
7887 * prefix, for example the app com.android.contacts would use names
7888 * like "com.android.contacts.ShowAll".
7889 *
7890 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007891 * @param value The ArrayList<CharSequence> data value.
7892 *
7893 * @return Returns the same Intent object, for chaining multiple calls
7894 * into a single statement.
7895 *
7896 * @see #putExtras
7897 * @see #removeExtra
7898 * @see #getCharSequenceArrayListExtra(String)
7899 */
7900 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7901 if (mExtras == null) {
7902 mExtras = new Bundle();
7903 }
7904 mExtras.putCharSequenceArrayList(name, value);
7905 return this;
7906 }
7907
7908 /**
7909 * Add extended data to the intent. The name must include a package
7910 * prefix, for example the app com.android.contacts would use names
7911 * like "com.android.contacts.ShowAll".
7912 *
7913 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007914 * @param value The Serializable data value.
7915 *
7916 * @return Returns the same Intent object, for chaining multiple calls
7917 * into a single statement.
7918 *
7919 * @see #putExtras
7920 * @see #removeExtra
7921 * @see #getSerializableExtra(String)
7922 */
7923 public Intent putExtra(String name, Serializable value) {
7924 if (mExtras == null) {
7925 mExtras = new Bundle();
7926 }
7927 mExtras.putSerializable(name, value);
7928 return this;
7929 }
7930
7931 /**
7932 * Add extended data to the intent. The name must include a package
7933 * prefix, for example the app com.android.contacts would use names
7934 * like "com.android.contacts.ShowAll".
7935 *
7936 * @param name The name of the extra data, with package prefix.
7937 * @param value The boolean array data value.
7938 *
7939 * @return Returns the same Intent object, for chaining multiple calls
7940 * into a single statement.
7941 *
7942 * @see #putExtras
7943 * @see #removeExtra
7944 * @see #getBooleanArrayExtra(String)
7945 */
7946 public Intent putExtra(String name, boolean[] value) {
7947 if (mExtras == null) {
7948 mExtras = new Bundle();
7949 }
7950 mExtras.putBooleanArray(name, value);
7951 return this;
7952 }
7953
7954 /**
7955 * Add extended data to the intent. The name must include a package
7956 * prefix, for example the app com.android.contacts would use names
7957 * like "com.android.contacts.ShowAll".
7958 *
7959 * @param name The name of the extra data, with package prefix.
7960 * @param value The byte array data value.
7961 *
7962 * @return Returns the same Intent object, for chaining multiple calls
7963 * into a single statement.
7964 *
7965 * @see #putExtras
7966 * @see #removeExtra
7967 * @see #getByteArrayExtra(String)
7968 */
7969 public Intent putExtra(String name, byte[] value) {
7970 if (mExtras == null) {
7971 mExtras = new Bundle();
7972 }
7973 mExtras.putByteArray(name, value);
7974 return this;
7975 }
7976
7977 /**
7978 * Add extended data to the intent. The name must include a package
7979 * prefix, for example the app com.android.contacts would use names
7980 * like "com.android.contacts.ShowAll".
7981 *
7982 * @param name The name of the extra data, with package prefix.
7983 * @param value The short array data value.
7984 *
7985 * @return Returns the same Intent object, for chaining multiple calls
7986 * into a single statement.
7987 *
7988 * @see #putExtras
7989 * @see #removeExtra
7990 * @see #getShortArrayExtra(String)
7991 */
7992 public Intent putExtra(String name, short[] value) {
7993 if (mExtras == null) {
7994 mExtras = new Bundle();
7995 }
7996 mExtras.putShortArray(name, value);
7997 return this;
7998 }
7999
8000 /**
8001 * Add extended data to the intent. The name must include a package
8002 * prefix, for example the app com.android.contacts would use names
8003 * like "com.android.contacts.ShowAll".
8004 *
8005 * @param name The name of the extra data, with package prefix.
8006 * @param value The char array data value.
8007 *
8008 * @return Returns the same Intent object, for chaining multiple calls
8009 * into a single statement.
8010 *
8011 * @see #putExtras
8012 * @see #removeExtra
8013 * @see #getCharArrayExtra(String)
8014 */
8015 public Intent putExtra(String name, char[] value) {
8016 if (mExtras == null) {
8017 mExtras = new Bundle();
8018 }
8019 mExtras.putCharArray(name, value);
8020 return this;
8021 }
8022
8023 /**
8024 * Add extended data to the intent. The name must include a package
8025 * prefix, for example the app com.android.contacts would use names
8026 * like "com.android.contacts.ShowAll".
8027 *
8028 * @param name The name of the extra data, with package prefix.
8029 * @param value The int array data value.
8030 *
8031 * @return Returns the same Intent object, for chaining multiple calls
8032 * into a single statement.
8033 *
8034 * @see #putExtras
8035 * @see #removeExtra
8036 * @see #getIntArrayExtra(String)
8037 */
8038 public Intent putExtra(String name, int[] value) {
8039 if (mExtras == null) {
8040 mExtras = new Bundle();
8041 }
8042 mExtras.putIntArray(name, value);
8043 return this;
8044 }
8045
8046 /**
8047 * Add extended data to the intent. The name must include a package
8048 * prefix, for example the app com.android.contacts would use names
8049 * like "com.android.contacts.ShowAll".
8050 *
8051 * @param name The name of the extra data, with package prefix.
8052 * @param value The byte array data value.
8053 *
8054 * @return Returns the same Intent object, for chaining multiple calls
8055 * into a single statement.
8056 *
8057 * @see #putExtras
8058 * @see #removeExtra
8059 * @see #getLongArrayExtra(String)
8060 */
8061 public Intent putExtra(String name, long[] value) {
8062 if (mExtras == null) {
8063 mExtras = new Bundle();
8064 }
8065 mExtras.putLongArray(name, value);
8066 return this;
8067 }
8068
8069 /**
8070 * Add extended data to the intent. The name must include a package
8071 * prefix, for example the app com.android.contacts would use names
8072 * like "com.android.contacts.ShowAll".
8073 *
8074 * @param name The name of the extra data, with package prefix.
8075 * @param value The float array data value.
8076 *
8077 * @return Returns the same Intent object, for chaining multiple calls
8078 * into a single statement.
8079 *
8080 * @see #putExtras
8081 * @see #removeExtra
8082 * @see #getFloatArrayExtra(String)
8083 */
8084 public Intent putExtra(String name, float[] value) {
8085 if (mExtras == null) {
8086 mExtras = new Bundle();
8087 }
8088 mExtras.putFloatArray(name, value);
8089 return this;
8090 }
8091
8092 /**
8093 * Add extended data to the intent. The name must include a package
8094 * prefix, for example the app com.android.contacts would use names
8095 * like "com.android.contacts.ShowAll".
8096 *
8097 * @param name The name of the extra data, with package prefix.
8098 * @param value The double array data value.
8099 *
8100 * @return Returns the same Intent object, for chaining multiple calls
8101 * into a single statement.
8102 *
8103 * @see #putExtras
8104 * @see #removeExtra
8105 * @see #getDoubleArrayExtra(String)
8106 */
8107 public Intent putExtra(String name, double[] value) {
8108 if (mExtras == null) {
8109 mExtras = new Bundle();
8110 }
8111 mExtras.putDoubleArray(name, value);
8112 return this;
8113 }
8114
8115 /**
8116 * Add extended data to the intent. The name must include a package
8117 * prefix, for example the app com.android.contacts would use names
8118 * like "com.android.contacts.ShowAll".
8119 *
8120 * @param name The name of the extra data, with package prefix.
8121 * @param value The String array data value.
8122 *
8123 * @return Returns the same Intent object, for chaining multiple calls
8124 * into a single statement.
8125 *
8126 * @see #putExtras
8127 * @see #removeExtra
8128 * @see #getStringArrayExtra(String)
8129 */
8130 public Intent putExtra(String name, String[] value) {
8131 if (mExtras == null) {
8132 mExtras = new Bundle();
8133 }
8134 mExtras.putStringArray(name, value);
8135 return this;
8136 }
8137
8138 /**
8139 * Add extended data to the intent. The name must include a package
8140 * prefix, for example the app com.android.contacts would use names
8141 * like "com.android.contacts.ShowAll".
8142 *
8143 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008144 * @param value The CharSequence array data value.
8145 *
8146 * @return Returns the same Intent object, for chaining multiple calls
8147 * into a single statement.
8148 *
8149 * @see #putExtras
8150 * @see #removeExtra
8151 * @see #getCharSequenceArrayExtra(String)
8152 */
8153 public Intent putExtra(String name, CharSequence[] value) {
8154 if (mExtras == null) {
8155 mExtras = new Bundle();
8156 }
8157 mExtras.putCharSequenceArray(name, value);
8158 return this;
8159 }
8160
8161 /**
8162 * Add extended data to the intent. The name must include a package
8163 * prefix, for example the app com.android.contacts would use names
8164 * like "com.android.contacts.ShowAll".
8165 *
8166 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008167 * @param value The Bundle data value.
8168 *
8169 * @return Returns the same Intent object, for chaining multiple calls
8170 * into a single statement.
8171 *
8172 * @see #putExtras
8173 * @see #removeExtra
8174 * @see #getBundleExtra(String)
8175 */
8176 public Intent putExtra(String name, Bundle value) {
8177 if (mExtras == null) {
8178 mExtras = new Bundle();
8179 }
8180 mExtras.putBundle(name, value);
8181 return this;
8182 }
8183
8184 /**
8185 * Add extended data to the intent. The name must include a package
8186 * prefix, for example the app com.android.contacts would use names
8187 * like "com.android.contacts.ShowAll".
8188 *
8189 * @param name The name of the extra data, with package prefix.
8190 * @param value The IBinder data value.
8191 *
8192 * @return Returns the same Intent object, for chaining multiple calls
8193 * into a single statement.
8194 *
8195 * @see #putExtras
8196 * @see #removeExtra
8197 * @see #getIBinderExtra(String)
8198 *
8199 * @deprecated
8200 * @hide
8201 */
8202 @Deprecated
8203 public Intent putExtra(String name, IBinder value) {
8204 if (mExtras == null) {
8205 mExtras = new Bundle();
8206 }
8207 mExtras.putIBinder(name, value);
8208 return this;
8209 }
8210
8211 /**
8212 * Copy all extras in 'src' in to this intent.
8213 *
8214 * @param src Contains the extras to copy.
8215 *
8216 * @see #putExtra
8217 */
8218 public Intent putExtras(Intent src) {
8219 if (src.mExtras != null) {
8220 if (mExtras == null) {
8221 mExtras = new Bundle(src.mExtras);
8222 } else {
8223 mExtras.putAll(src.mExtras);
8224 }
8225 }
8226 return this;
8227 }
8228
8229 /**
8230 * Add a set of extended data to the intent. The keys must include a package
8231 * prefix, for example the app com.android.contacts would use names
8232 * like "com.android.contacts.ShowAll".
8233 *
8234 * @param extras The Bundle of extras to add to this intent.
8235 *
8236 * @see #putExtra
8237 * @see #removeExtra
8238 */
8239 public Intent putExtras(Bundle extras) {
8240 if (mExtras == null) {
8241 mExtras = new Bundle();
8242 }
8243 mExtras.putAll(extras);
8244 return this;
8245 }
8246
8247 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008248 * Completely replace the extras in the Intent with the extras in the
8249 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008250 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008251 * @param src The exact extras contained in this Intent are copied
8252 * into the target intent, replacing any that were previously there.
8253 */
8254 public Intent replaceExtras(Intent src) {
8255 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8256 return this;
8257 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008258
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008259 /**
8260 * Completely replace the extras in the Intent with the given Bundle of
8261 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008262 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008263 * @param extras The new set of extras in the Intent, or null to erase
8264 * all extras.
8265 */
8266 public Intent replaceExtras(Bundle extras) {
8267 mExtras = extras != null ? new Bundle(extras) : null;
8268 return this;
8269 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008270
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008271 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008272 * Remove extended data from the intent.
8273 *
8274 * @see #putExtra
8275 */
8276 public void removeExtra(String name) {
8277 if (mExtras != null) {
8278 mExtras.remove(name);
8279 if (mExtras.size() == 0) {
8280 mExtras = null;
8281 }
8282 }
8283 }
8284
8285 /**
8286 * Set special flags controlling how this intent is handled. Most values
8287 * here depend on the type of component being executed by the Intent,
8288 * specifically the FLAG_ACTIVITY_* flags are all for use with
8289 * {@link Context#startActivity Context.startActivity()} and the
8290 * FLAG_RECEIVER_* flags are all for use with
8291 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8292 *
Scott Main7aee61f2011-02-08 11:25:01 -08008293 * <p>See the
8294 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8295 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008296 * the behavior of your application.
8297 *
8298 * @param flags The desired flags.
8299 *
8300 * @return Returns the same Intent object, for chaining multiple calls
8301 * into a single statement.
8302 *
8303 * @see #getFlags
8304 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008305 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008306 *
8307 * @see #FLAG_GRANT_READ_URI_PERMISSION
8308 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07008309 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
8310 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008311 * @see #FLAG_DEBUG_LOG_RESOLUTION
8312 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008313 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008314 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008315 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008316 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008317 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
8318 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008319 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008320 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07008321 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008322 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008323 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008324 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08008325 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008326 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
8327 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008328 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008329 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008330 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008331 * @see #FLAG_RECEIVER_REGISTERED_ONLY
8332 */
8333 public Intent setFlags(int flags) {
8334 mFlags = flags;
8335 return this;
8336 }
8337
8338 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008339 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008340 *
8341 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008342 * @return Returns the same Intent object, for chaining multiple calls into
8343 * a single statement.
8344 * @see #setFlags(int)
8345 * @see #removeFlags(int)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008346 */
8347 public Intent addFlags(int flags) {
8348 mFlags |= flags;
8349 return this;
8350 }
8351
8352 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008353 * Remove these flags from the intent.
8354 *
8355 * @param flags The flags to remove.
8356 * @see #setFlags(int)
8357 * @see #addFlags(int)
8358 */
8359 public void removeFlags(int flags) {
8360 mFlags &= ~flags;
8361 }
8362
8363 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008364 * (Usually optional) Set an explicit application package name that limits
8365 * the components this Intent will resolve to. If left to the default
8366 * value of null, all components in all applications will considered.
8367 * If non-null, the Intent can only match the components in the given
8368 * application package.
8369 *
8370 * @param packageName The name of the application package to handle the
8371 * intent, or null to allow any application package.
8372 *
8373 * @return Returns the same Intent object, for chaining multiple calls
8374 * into a single statement.
8375 *
8376 * @see #getPackage
8377 * @see #resolveActivity
8378 */
8379 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008380 if (packageName != null && mSelector != null) {
8381 throw new IllegalArgumentException(
8382 "Can't set package name when selector is already set");
8383 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008384 mPackage = packageName;
8385 return this;
8386 }
8387
8388 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008389 * (Usually optional) Explicitly set the component to handle the intent.
8390 * If left with the default value of null, the system will determine the
8391 * appropriate class to use based on the other fields (action, data,
8392 * type, categories) in the Intent. If this class is defined, the
8393 * specified class will always be used regardless of the other fields. You
8394 * should only set this value when you know you absolutely want a specific
8395 * class to be used; otherwise it is better to let the system find the
8396 * appropriate class so that you will respect the installed applications
8397 * and user preferences.
8398 *
8399 * @param component The name of the application component to handle the
8400 * intent, or null to let the system find one for you.
8401 *
8402 * @return Returns the same Intent object, for chaining multiple calls
8403 * into a single statement.
8404 *
8405 * @see #setClass
8406 * @see #setClassName(Context, String)
8407 * @see #setClassName(String, String)
8408 * @see #getComponent
8409 * @see #resolveActivity
8410 */
8411 public Intent setComponent(ComponentName component) {
8412 mComponent = component;
8413 return this;
8414 }
8415
8416 /**
8417 * Convenience for calling {@link #setComponent} with an
8418 * explicit class name.
8419 *
8420 * @param packageContext A Context of the application package implementing
8421 * this class.
8422 * @param className The name of a class inside of the application package
8423 * that will be used as the component for this Intent.
8424 *
8425 * @return Returns the same Intent object, for chaining multiple calls
8426 * into a single statement.
8427 *
8428 * @see #setComponent
8429 * @see #setClass
8430 */
8431 public Intent setClassName(Context packageContext, String className) {
8432 mComponent = new ComponentName(packageContext, className);
8433 return this;
8434 }
8435
8436 /**
8437 * Convenience for calling {@link #setComponent} with an
8438 * explicit application package name and class name.
8439 *
8440 * @param packageName The name of the package implementing the desired
8441 * component.
8442 * @param className The name of a class inside of the application package
8443 * that will be used as the component for this Intent.
8444 *
8445 * @return Returns the same Intent object, for chaining multiple calls
8446 * into a single statement.
8447 *
8448 * @see #setComponent
8449 * @see #setClass
8450 */
8451 public Intent setClassName(String packageName, String className) {
8452 mComponent = new ComponentName(packageName, className);
8453 return this;
8454 }
8455
8456 /**
8457 * Convenience for calling {@link #setComponent(ComponentName)} with the
8458 * name returned by a {@link Class} object.
8459 *
8460 * @param packageContext A Context of the application package implementing
8461 * this class.
8462 * @param cls The class name to set, equivalent to
8463 * <code>setClassName(context, cls.getName())</code>.
8464 *
8465 * @return Returns the same Intent object, for chaining multiple calls
8466 * into a single statement.
8467 *
8468 * @see #setComponent
8469 */
8470 public Intent setClass(Context packageContext, Class<?> cls) {
8471 mComponent = new ComponentName(packageContext, cls);
8472 return this;
8473 }
8474
8475 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008476 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8477 * used as a hint to the receiver for animations and the like. Null means that there
8478 * is no source bounds.
8479 */
8480 public void setSourceBounds(Rect r) {
8481 if (r != null) {
8482 mSourceBounds = new Rect(r);
8483 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008484 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008485 }
8486 }
8487
Tor Norbyed9273d62013-05-30 15:59:53 -07008488 /** @hide */
8489 @IntDef(flag = true,
8490 value = {
8491 FILL_IN_ACTION,
8492 FILL_IN_DATA,
8493 FILL_IN_CATEGORIES,
8494 FILL_IN_COMPONENT,
8495 FILL_IN_PACKAGE,
8496 FILL_IN_SOURCE_BOUNDS,
8497 FILL_IN_SELECTOR,
8498 FILL_IN_CLIP_DATA
8499 })
8500 @Retention(RetentionPolicy.SOURCE)
8501 public @interface FillInFlags {}
8502
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008503 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008504 * Use with {@link #fillIn} to allow the current action value to be
8505 * overwritten, even if it is already set.
8506 */
8507 public static final int FILL_IN_ACTION = 1<<0;
8508
8509 /**
8510 * Use with {@link #fillIn} to allow the current data or type value
8511 * overwritten, even if it is already set.
8512 */
8513 public static final int FILL_IN_DATA = 1<<1;
8514
8515 /**
8516 * Use with {@link #fillIn} to allow the current categories to be
8517 * overwritten, even if they are already set.
8518 */
8519 public static final int FILL_IN_CATEGORIES = 1<<2;
8520
8521 /**
8522 * Use with {@link #fillIn} to allow the current component value to be
8523 * overwritten, even if it is already set.
8524 */
8525 public static final int FILL_IN_COMPONENT = 1<<3;
8526
8527 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008528 * Use with {@link #fillIn} to allow the current package value to be
8529 * overwritten, even if it is already set.
8530 */
8531 public static final int FILL_IN_PACKAGE = 1<<4;
8532
8533 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008534 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008535 * overwritten, even if it is already set.
8536 */
8537 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8538
8539 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008540 * Use with {@link #fillIn} to allow the current selector to be
8541 * overwritten, even if it is already set.
8542 */
8543 public static final int FILL_IN_SELECTOR = 1<<6;
8544
8545 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008546 * Use with {@link #fillIn} to allow the current ClipData to be
8547 * overwritten, even if it is already set.
8548 */
8549 public static final int FILL_IN_CLIP_DATA = 1<<7;
8550
8551 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008552 * Copy the contents of <var>other</var> in to this object, but only
8553 * where fields are not defined by this object. For purposes of a field
8554 * being defined, the following pieces of data in the Intent are
8555 * considered to be separate fields:
8556 *
8557 * <ul>
8558 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008559 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008560 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8561 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008562 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008563 * <li> component, as set by {@link #setComponent(ComponentName)} or
8564 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008565 * <li> source bounds, as set by {@link #setSourceBounds}.
8566 * <li> selector, as set by {@link #setSelector(Intent)}.
8567 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008568 * <li> each top-level name in the associated extras.
8569 * </ul>
8570 *
8571 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008572 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008573 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8574 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8575 * the restriction where the corresponding field will not be replaced if
8576 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008577 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008578 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8579 * is explicitly specified. The selector will only be copied if
8580 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008581 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008582 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8583 * and Intent B with {action="gotit", data-type="some/thing",
8584 * categories="one","two"}.
8585 *
8586 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8587 * containing: {action="gotit", data-type="some/thing",
8588 * categories="bar"}.
8589 *
8590 * @param other Another Intent whose values are to be used to fill in
8591 * the current one.
8592 * @param flags Options to control which fields can be filled in.
8593 *
8594 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008595 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008596 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08008597 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07008598 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008599 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008600 @FillInFlags
8601 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008602 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008603 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008604 if (other.mAction != null
8605 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008606 mAction = other.mAction;
8607 changes |= FILL_IN_ACTION;
8608 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008609 if ((other.mData != null || other.mType != null)
8610 && ((mData == null && mType == null)
8611 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008612 mData = other.mData;
8613 mType = other.mType;
8614 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008615 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008616 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008617 if (other.mCategories != null
8618 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008619 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008620 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008621 }
8622 changes |= FILL_IN_CATEGORIES;
8623 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008624 if (other.mPackage != null
8625 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008626 // Only do this if mSelector is not set.
8627 if (mSelector == null) {
8628 mPackage = other.mPackage;
8629 changes |= FILL_IN_PACKAGE;
8630 }
8631 }
8632 // Selector is special: it can only be set if explicitly allowed,
8633 // for the same reason as the component name.
8634 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8635 if (mPackage == null) {
8636 mSelector = new Intent(other.mSelector);
8637 mPackage = null;
8638 changes |= FILL_IN_SELECTOR;
8639 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008640 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008641 if (other.mClipData != null
8642 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8643 mClipData = other.mClipData;
8644 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008645 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008646 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008647 // Component is special: it can -only- be set if explicitly allowed,
8648 // since otherwise the sender could force the intent somewhere the
8649 // originator didn't intend.
8650 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008651 mComponent = other.mComponent;
8652 changes |= FILL_IN_COMPONENT;
8653 }
8654 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008655 if (other.mSourceBounds != null
8656 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8657 mSourceBounds = new Rect(other.mSourceBounds);
8658 changes |= FILL_IN_SOURCE_BOUNDS;
8659 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008660 if (mExtras == null) {
8661 if (other.mExtras != null) {
8662 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008663 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008664 }
8665 } else if (other.mExtras != null) {
8666 try {
8667 Bundle newb = new Bundle(other.mExtras);
8668 newb.putAll(mExtras);
8669 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008670 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008671 } catch (RuntimeException e) {
8672 // Modifying the extras can cause us to unparcel the contents
8673 // of the bundle, and if we do this in the system process that
8674 // may fail. We really should handle this (i.e., the Bundle
8675 // impl shouldn't be on top of a plain map), but for now just
8676 // ignore it and keep the original contents. :(
8677 Log.w("Intent", "Failure filling in extras", e);
8678 }
8679 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008680 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8681 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8682 mContentUserHint = other.mContentUserHint;
8683 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008684 return changes;
8685 }
8686
8687 /**
8688 * Wrapper class holding an Intent and implementing comparisons on it for
8689 * the purpose of filtering. The class implements its
8690 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8691 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8692 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8693 * on the wrapped Intent.
8694 */
8695 public static final class FilterComparison {
8696 private final Intent mIntent;
8697 private final int mHashCode;
8698
8699 public FilterComparison(Intent intent) {
8700 mIntent = intent;
8701 mHashCode = intent.filterHashCode();
8702 }
8703
8704 /**
8705 * Return the Intent that this FilterComparison represents.
8706 * @return Returns the Intent held by the FilterComparison. Do
8707 * not modify!
8708 */
8709 public Intent getIntent() {
8710 return mIntent;
8711 }
8712
8713 @Override
8714 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008715 if (obj instanceof FilterComparison) {
8716 Intent other = ((FilterComparison)obj).mIntent;
8717 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008718 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008719 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008720 }
8721
8722 @Override
8723 public int hashCode() {
8724 return mHashCode;
8725 }
8726 }
8727
8728 /**
8729 * Determine if two intents are the same for the purposes of intent
8730 * resolution (filtering). That is, if their action, data, type,
8731 * class, and categories are the same. This does <em>not</em> compare
8732 * any extra data included in the intents.
8733 *
8734 * @param other The other Intent to compare against.
8735 *
8736 * @return Returns true if action, data, type, class, and categories
8737 * are the same.
8738 */
8739 public boolean filterEquals(Intent other) {
8740 if (other == null) {
8741 return false;
8742 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008743 if (!Objects.equals(this.mAction, other.mAction)) return false;
8744 if (!Objects.equals(this.mData, other.mData)) return false;
8745 if (!Objects.equals(this.mType, other.mType)) return false;
8746 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8747 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8748 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008749
8750 return true;
8751 }
8752
8753 /**
8754 * Generate hash code that matches semantics of filterEquals().
8755 *
8756 * @return Returns the hash value of the action, data, type, class, and
8757 * categories.
8758 *
8759 * @see #filterEquals
8760 */
8761 public int filterHashCode() {
8762 int code = 0;
8763 if (mAction != null) {
8764 code += mAction.hashCode();
8765 }
8766 if (mData != null) {
8767 code += mData.hashCode();
8768 }
8769 if (mType != null) {
8770 code += mType.hashCode();
8771 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008772 if (mPackage != null) {
8773 code += mPackage.hashCode();
8774 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008775 if (mComponent != null) {
8776 code += mComponent.hashCode();
8777 }
8778 if (mCategories != null) {
8779 code += mCategories.hashCode();
8780 }
8781 return code;
8782 }
8783
8784 @Override
8785 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008786 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008787
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008788 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008789 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008790 b.append(" }");
8791
8792 return b.toString();
8793 }
8794
8795 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008796 public String toInsecureString() {
8797 StringBuilder b = new StringBuilder(128);
8798
8799 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008800 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008801 b.append(" }");
8802
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008803 return b.toString();
8804 }
Romain Guy4969af72009-06-17 10:53:19 -07008805
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008806 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008807 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008808 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008809
8810 b.append("Intent { ");
8811 toShortString(b, false, true, true, true);
8812 b.append(" }");
8813
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008814 return b.toString();
8815 }
8816
8817 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008818 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8819 StringBuilder b = new StringBuilder(128);
8820 toShortString(b, secure, comp, extras, clip);
8821 return b.toString();
8822 }
8823
8824 /** @hide */
8825 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8826 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008827 boolean first = true;
8828 if (mAction != null) {
8829 b.append("act=").append(mAction);
8830 first = false;
8831 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008832 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008833 if (!first) {
8834 b.append(' ');
8835 }
8836 first = false;
8837 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008838 for (int i=0; i<mCategories.size(); i++) {
8839 if (i > 0) b.append(',');
8840 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008841 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008842 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008843 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008844 if (mData != null) {
8845 if (!first) {
8846 b.append(' ');
8847 }
8848 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008849 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008850 if (secure) {
8851 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008852 } else {
8853 b.append(mData);
8854 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008855 }
8856 if (mType != null) {
8857 if (!first) {
8858 b.append(' ');
8859 }
8860 first = false;
8861 b.append("typ=").append(mType);
8862 }
8863 if (mFlags != 0) {
8864 if (!first) {
8865 b.append(' ');
8866 }
8867 first = false;
8868 b.append("flg=0x").append(Integer.toHexString(mFlags));
8869 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008870 if (mPackage != null) {
8871 if (!first) {
8872 b.append(' ');
8873 }
8874 first = false;
8875 b.append("pkg=").append(mPackage);
8876 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008877 if (comp && mComponent != null) {
8878 if (!first) {
8879 b.append(' ');
8880 }
8881 first = false;
8882 b.append("cmp=").append(mComponent.flattenToShortString());
8883 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008884 if (mSourceBounds != null) {
8885 if (!first) {
8886 b.append(' ');
8887 }
8888 first = false;
8889 b.append("bnds=").append(mSourceBounds.toShortString());
8890 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008891 if (mClipData != null) {
8892 if (!first) {
8893 b.append(' ');
8894 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008895 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008896 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008897 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008898 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008899 if (mClipData.getDescription() != null) {
8900 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8901 } else {
8902 first = true;
8903 }
8904 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008905 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008906 first = false;
8907 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008908 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008909 if (extras && mExtras != null) {
8910 if (!first) {
8911 b.append(' ');
8912 }
8913 first = false;
8914 b.append("(has extras)");
8915 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008916 if (mContentUserHint != UserHandle.USER_CURRENT) {
8917 if (!first) {
8918 b.append(' ');
8919 }
8920 first = false;
8921 b.append("u=").append(mContentUserHint);
8922 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008923 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008924 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008925 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008926 b.append("}");
8927 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008928 }
8929
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008930 /**
8931 * Call {@link #toUri} with 0 flags.
8932 * @deprecated Use {@link #toUri} instead.
8933 */
8934 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008935 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008936 return toUri(0);
8937 }
8938
8939 /**
8940 * Convert this Intent into a String holding a URI representation of it.
8941 * The returned URI string has been properly URI encoded, so it can be
8942 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8943 * Intent's data as the base URI, with an additional fragment describing
8944 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008945 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008946 * <p>You can convert the returned string back to an Intent with
8947 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008948 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008949 * @param flags Additional operating flags. Either 0,
8950 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008951 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008952 * @return Returns a URI encoding URI string describing the entire contents
8953 * of the Intent.
8954 */
8955 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008956 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008957 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8958 if (mPackage == null) {
8959 throw new IllegalArgumentException(
8960 "Intent must include an explicit package name to build an android-app: "
8961 + this);
8962 }
8963 uri.append("android-app://");
8964 uri.append(mPackage);
8965 String scheme = null;
8966 if (mData != null) {
8967 scheme = mData.getScheme();
8968 if (scheme != null) {
8969 uri.append('/');
8970 uri.append(scheme);
8971 String authority = mData.getEncodedAuthority();
8972 if (authority != null) {
8973 uri.append('/');
8974 uri.append(authority);
8975 String path = mData.getEncodedPath();
8976 if (path != null) {
8977 uri.append(path);
8978 }
8979 String queryParams = mData.getEncodedQuery();
8980 if (queryParams != null) {
8981 uri.append('?');
8982 uri.append(queryParams);
8983 }
8984 String fragment = mData.getEncodedFragment();
8985 if (fragment != null) {
8986 uri.append('#');
8987 uri.append(fragment);
8988 }
8989 }
8990 }
8991 }
8992 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8993 mPackage, flags);
8994 return uri.toString();
8995 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008996 String scheme = null;
8997 if (mData != null) {
8998 String data = mData.toString();
8999 if ((flags&URI_INTENT_SCHEME) != 0) {
9000 final int N = data.length();
9001 for (int i=0; i<N; i++) {
9002 char c = data.charAt(i);
9003 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
9004 || c == '.' || c == '-') {
9005 continue;
9006 }
9007 if (c == ':' && i > 0) {
9008 // Valid scheme.
9009 scheme = data.substring(0, i);
9010 uri.append("intent:");
9011 data = data.substring(i+1);
9012 break;
9013 }
Tom Taylord4a47292009-12-21 13:59:18 -08009014
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009015 // No scheme.
9016 break;
9017 }
9018 }
9019 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009020
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009021 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9022 uri.append("intent:");
9023 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009024
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009025 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009026
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009027 return uri.toString();
9028 }
9029
9030 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9031 String defPackage, int flags) {
9032 StringBuilder frag = new StringBuilder(128);
9033
9034 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009035 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009036 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009037 // Note that for now we are not going to try to handle the
9038 // data part; not clear how to represent this as a URI, and
9039 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009040 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9041 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009042 }
9043
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009044 if (frag.length() > 0) {
9045 uri.append("#Intent;");
9046 uri.append(frag);
9047 uri.append("end");
9048 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009049 }
9050
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009051 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9052 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009053 if (scheme != null) {
9054 uri.append("scheme=").append(scheme).append(';');
9055 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009056 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009057 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009058 }
9059 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009060 for (int i=0; i<mCategories.size(); i++) {
9061 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009062 }
9063 }
9064 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009065 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009066 }
9067 if (mFlags != 0) {
9068 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9069 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009070 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009071 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9072 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009073 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009074 uri.append("component=").append(Uri.encode(
9075 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009076 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009077 if (mSourceBounds != null) {
9078 uri.append("sourceBounds=")
9079 .append(Uri.encode(mSourceBounds.flattenToString()))
9080 .append(';');
9081 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009082 if (mExtras != null) {
9083 for (String key : mExtras.keySet()) {
9084 final Object value = mExtras.get(key);
9085 char entryType =
9086 value instanceof String ? 'S' :
9087 value instanceof Boolean ? 'B' :
9088 value instanceof Byte ? 'b' :
9089 value instanceof Character ? 'c' :
9090 value instanceof Double ? 'd' :
9091 value instanceof Float ? 'f' :
9092 value instanceof Integer ? 'i' :
9093 value instanceof Long ? 'l' :
9094 value instanceof Short ? 's' :
9095 '\0';
9096
9097 if (entryType != '\0') {
9098 uri.append(entryType);
9099 uri.append('.');
9100 uri.append(Uri.encode(key));
9101 uri.append('=');
9102 uri.append(Uri.encode(value.toString()));
9103 uri.append(';');
9104 }
9105 }
9106 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009107 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009108
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009109 public int describeContents() {
9110 return (mExtras != null) ? mExtras.describeContents() : 0;
9111 }
9112
9113 public void writeToParcel(Parcel out, int flags) {
9114 out.writeString(mAction);
9115 Uri.writeToParcel(out, mData);
9116 out.writeString(mType);
9117 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009118 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009119 ComponentName.writeToParcel(mComponent, out);
9120
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009121 if (mSourceBounds != null) {
9122 out.writeInt(1);
9123 mSourceBounds.writeToParcel(out, flags);
9124 } else {
9125 out.writeInt(0);
9126 }
9127
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009128 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009129 final int N = mCategories.size();
9130 out.writeInt(N);
9131 for (int i=0; i<N; i++) {
9132 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009133 }
9134 } else {
9135 out.writeInt(0);
9136 }
9137
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009138 if (mSelector != null) {
9139 out.writeInt(1);
9140 mSelector.writeToParcel(out, flags);
9141 } else {
9142 out.writeInt(0);
9143 }
9144
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009145 if (mClipData != null) {
9146 out.writeInt(1);
9147 mClipData.writeToParcel(out, flags);
9148 } else {
9149 out.writeInt(0);
9150 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009151 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009152 out.writeBundle(mExtras);
9153 }
9154
9155 public static final Parcelable.Creator<Intent> CREATOR
9156 = new Parcelable.Creator<Intent>() {
9157 public Intent createFromParcel(Parcel in) {
9158 return new Intent(in);
9159 }
9160 public Intent[] newArray(int size) {
9161 return new Intent[size];
9162 }
9163 };
9164
Dianne Hackborneb034652009-09-07 00:49:58 -07009165 /** @hide */
9166 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009167 readFromParcel(in);
9168 }
9169
9170 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009171 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009172 mData = Uri.CREATOR.createFromParcel(in);
9173 mType = in.readString();
9174 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009175 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009176 mComponent = ComponentName.readFromParcel(in);
9177
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009178 if (in.readInt() != 0) {
9179 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9180 }
9181
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009182 int N = in.readInt();
9183 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009184 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009185 int i;
9186 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009187 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009188 }
9189 } else {
9190 mCategories = null;
9191 }
9192
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009193 if (in.readInt() != 0) {
9194 mSelector = new Intent(in);
9195 }
9196
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009197 if (in.readInt() != 0) {
9198 mClipData = new ClipData(in);
9199 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009200 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009201 mExtras = in.readBundle();
9202 }
9203
9204 /**
9205 * Parses the "intent" element (and its children) from XML and instantiates
9206 * an Intent object. The given XML parser should be located at the tag
9207 * where parsing should start (often named "intent"), from which the
9208 * basic action, data, type, and package and class name will be
9209 * retrieved. The function will then parse in to any child elements,
9210 * looking for <category android:name="xxx"> tags to add categories and
9211 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9212 * to the intent.
9213 *
9214 * @param resources The Resources to use when inflating resources.
9215 * @param parser The XML parser pointing at an "intent" tag.
9216 * @param attrs The AttributeSet interface for retrieving extended
9217 * attribute data at the current <var>parser</var> location.
9218 * @return An Intent object matching the XML data.
9219 * @throws XmlPullParserException If there was an XML parsing error.
9220 * @throws IOException If there was an I/O error.
9221 */
9222 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
9223 throws XmlPullParserException, IOException {
9224 Intent intent = new Intent();
9225
9226 TypedArray sa = resources.obtainAttributes(attrs,
9227 com.android.internal.R.styleable.Intent);
9228
9229 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9230
9231 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9232 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9233 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9234
9235 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9236 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9237 if (packageName != null && className != null) {
9238 intent.setComponent(new ComponentName(packageName, className));
9239 }
9240
9241 sa.recycle();
9242
9243 int outerDepth = parser.getDepth();
9244 int type;
9245 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9246 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9247 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9248 continue;
9249 }
9250
9251 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009252 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009253 sa = resources.obtainAttributes(attrs,
9254 com.android.internal.R.styleable.IntentCategory);
9255 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9256 sa.recycle();
9257
9258 if (cat != null) {
9259 intent.addCategory(cat);
9260 }
9261 XmlUtils.skipCurrentTag(parser);
9262
Craig Mautner21d24a22014-04-23 11:45:37 -07009263 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009264 if (intent.mExtras == null) {
9265 intent.mExtras = new Bundle();
9266 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009267 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009268 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009269
9270 } else {
9271 XmlUtils.skipCurrentTag(parser);
9272 }
9273 }
9274
9275 return intent;
9276 }
Nick Pellyccae4122012-01-09 14:12:58 -08009277
Craig Mautner21d24a22014-04-23 11:45:37 -07009278 /** @hide */
9279 public void saveToXml(XmlSerializer out) throws IOException {
9280 if (mAction != null) {
9281 out.attribute(null, ATTR_ACTION, mAction);
9282 }
9283 if (mData != null) {
9284 out.attribute(null, ATTR_DATA, mData.toString());
9285 }
9286 if (mType != null) {
9287 out.attribute(null, ATTR_TYPE, mType);
9288 }
9289 if (mComponent != null) {
9290 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9291 }
9292 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9293
9294 if (mCategories != null) {
9295 out.startTag(null, TAG_CATEGORIES);
9296 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9297 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9298 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009299 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009300 }
9301 }
9302
9303 /** @hide */
9304 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9305 XmlPullParserException {
9306 Intent intent = new Intent();
9307 final int outerDepth = in.getDepth();
9308
9309 int attrCount = in.getAttributeCount();
9310 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9311 final String attrName = in.getAttributeName(attrNdx);
9312 final String attrValue = in.getAttributeValue(attrNdx);
9313 if (ATTR_ACTION.equals(attrName)) {
9314 intent.setAction(attrValue);
9315 } else if (ATTR_DATA.equals(attrName)) {
9316 intent.setData(Uri.parse(attrValue));
9317 } else if (ATTR_TYPE.equals(attrName)) {
9318 intent.setType(attrValue);
9319 } else if (ATTR_COMPONENT.equals(attrName)) {
9320 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9321 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009322 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009323 } else {
9324 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9325 }
9326 }
9327
9328 int event;
9329 String name;
9330 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9331 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9332 if (event == XmlPullParser.START_TAG) {
9333 name = in.getName();
9334 if (TAG_CATEGORIES.equals(name)) {
9335 attrCount = in.getAttributeCount();
9336 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9337 intent.addCategory(in.getAttributeValue(attrNdx));
9338 }
9339 } else {
9340 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9341 XmlUtils.skipCurrentTag(in);
9342 }
9343 }
9344 }
9345
9346 return intent;
9347 }
9348
Nick Pellyccae4122012-01-09 14:12:58 -08009349 /**
9350 * Normalize a MIME data type.
9351 *
9352 * <p>A normalized MIME type has white-space trimmed,
9353 * content-type parameters removed, and is lower-case.
9354 * This aligns the type with Android best practices for
9355 * intent filtering.
9356 *
9357 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9358 * "text/x-vCard" becomes "text/x-vcard".
9359 *
9360 * <p>All MIME types received from outside Android (such as user input,
9361 * or external sources like Bluetooth, NFC, or the Internet) should
9362 * be normalized before they are used to create an Intent.
9363 *
9364 * @param type MIME data type to normalize
9365 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009366 * @see #setType
9367 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009368 */
9369 public static String normalizeMimeType(String type) {
9370 if (type == null) {
9371 return null;
9372 }
9373
Elliott Hughescb64d432013-08-02 10:00:44 -07009374 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009375
9376 final int semicolonIndex = type.indexOf(';');
9377 if (semicolonIndex != -1) {
9378 type = type.substring(0, semicolonIndex);
9379 }
9380 return type;
9381 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009382
9383 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009384 * Prepare this {@link Intent} to leave an app process.
9385 *
9386 * @hide
9387 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009388 public void prepareToLeaveProcess(Context context) {
9389 final boolean leavingPackage = (mComponent == null)
9390 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9391 prepareToLeaveProcess(leavingPackage);
9392 }
9393
9394 /**
9395 * Prepare this {@link Intent} to leave an app process.
9396 *
9397 * @hide
9398 */
9399 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009400 setAllowFds(false);
9401
9402 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009403 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009404 }
9405 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009406 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009407 }
9408
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -07009409 if (mExtras != null && !mExtras.isParcelled()) {
9410 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
9411 if (intent instanceof Intent) {
9412 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
9413 }
9414 }
9415
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009416 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9417 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009418 switch (mAction) {
9419 case ACTION_MEDIA_REMOVED:
9420 case ACTION_MEDIA_UNMOUNTED:
9421 case ACTION_MEDIA_CHECKING:
9422 case ACTION_MEDIA_NOFS:
9423 case ACTION_MEDIA_MOUNTED:
9424 case ACTION_MEDIA_SHARED:
9425 case ACTION_MEDIA_UNSHARED:
9426 case ACTION_MEDIA_BAD_REMOVAL:
9427 case ACTION_MEDIA_UNMOUNTABLE:
9428 case ACTION_MEDIA_EJECT:
9429 case ACTION_MEDIA_SCANNER_STARTED:
9430 case ACTION_MEDIA_SCANNER_FINISHED:
9431 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009432 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9433 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009434 // Ignore legacy actions
9435 break;
9436 default:
9437 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009438 }
9439 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009440
9441 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
9442 && leavingPackage) {
9443 switch (mAction) {
9444 case ACTION_PROVIDER_CHANGED:
9445 // Ignore actions that don't need to grant
9446 break;
9447 default:
9448 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
9449 }
9450 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009451 }
9452
9453 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009454 * @hide
9455 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009456 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009457 // We just entered destination process, so we should be able to read all
9458 // parcelables inside.
9459 setDefusable(true);
9460
9461 if (mSelector != null) {
9462 mSelector.prepareToEnterProcess();
9463 }
9464 if (mClipData != null) {
9465 mClipData.prepareToEnterProcess();
9466 }
9467
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009468 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009469 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9470 fixUris(mContentUserHint);
9471 mContentUserHint = UserHandle.USER_CURRENT;
9472 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009473 }
9474 }
9475
9476 /**
9477 * @hide
9478 */
9479 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009480 Uri data = getData();
9481 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009482 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009483 }
9484 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009485 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009486 }
9487 String action = getAction();
9488 if (ACTION_SEND.equals(action)) {
9489 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9490 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009491 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009492 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009493 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009494 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9495 if (streams != null) {
9496 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9497 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009498 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009499 }
9500 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9501 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009502 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9503 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9504 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9505 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9506 if (output != null) {
9507 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9508 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009509 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009510 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009511
9512 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009513 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009514 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9515 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009516 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009517 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009518 * @hide
9519 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009520 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009521 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009522 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009523
9524 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009525 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009526
9527 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009528 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009529 // Inspect contained intents to see if we need to migrate extras. We
9530 // don't promote ClipData to the parent, since ChooserActivity will
9531 // already start the picked item as the caller, and we can't combine
9532 // the flags in a safe way.
9533
9534 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009535 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009536 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9537 if (intent != null) {
9538 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009539 }
9540 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009541 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009542 try {
9543 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9544 if (intents != null) {
9545 for (int i = 0; i < intents.length; i++) {
9546 final Intent intent = (Intent) intents[i];
9547 if (intent != null) {
9548 migrated |= intent.migrateExtraStreamToClipData();
9549 }
9550 }
9551 }
9552 } catch (ClassCastException e) {
9553 }
9554 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009555
9556 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009557 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009558 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9559 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9560 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9561 if (stream != null || text != null || htmlText != null) {
9562 final ClipData clipData = new ClipData(
9563 null, new String[] { getType() },
9564 new ClipData.Item(text, htmlText, null, stream));
9565 setClipData(clipData);
9566 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009567 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009568 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009569 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009570 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009571
9572 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009573 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009574 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9575 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9576 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9577 int num = -1;
9578 if (streams != null) {
9579 num = streams.size();
9580 }
9581 if (texts != null) {
9582 if (num >= 0 && num != texts.size()) {
9583 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009584 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009585 }
9586 num = texts.size();
9587 }
9588 if (htmlTexts != null) {
9589 if (num >= 0 && num != htmlTexts.size()) {
9590 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009591 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009592 }
9593 num = htmlTexts.size();
9594 }
9595 if (num > 0) {
9596 final ClipData clipData = new ClipData(
9597 null, new String[] { getType() },
9598 makeClipItem(streams, texts, htmlTexts, 0));
9599
9600 for (int i = 1; i < num; i++) {
9601 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9602 }
9603
9604 setClipData(clipData);
9605 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009606 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009607 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009608 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009609 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009610 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9611 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9612 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9613 final Uri output;
9614 try {
9615 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9616 } catch (ClassCastException e) {
9617 return false;
9618 }
9619 if (output != null) {
9620 setClipData(ClipData.newRawUri("", output));
9621 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9622 return true;
9623 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009624 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009625
9626 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009627 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009628
9629 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9630 ArrayList<String> htmlTexts, int which) {
9631 Uri uri = streams != null ? streams.get(which) : null;
9632 CharSequence text = texts != null ? texts.get(which) : null;
9633 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9634 return new ClipData.Item(text, htmlText, null, uri);
9635 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009636
9637 /** @hide */
9638 public boolean isDocument() {
9639 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9640 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009641}