blob: 1a00cb1d2827727a3d006b5ee1192f4c5611095b [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 Kennedyb8a279e2015-11-18 09:59:47 -08001508 * Activity Action: Launch ephemeral installer.
1509 * <p>
1510 * Input: The data must be a http: URI that the ephemeral application is registered
1511 * to handle.
1512 * <p class="note">
1513 * This is a protected intent that can only be sent by the system.
1514 * </p>
1515 *
1516 * @hide
1517 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001518 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1519 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1520 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1521
1522 /**
1523 * Service Action: Resolve ephemeral application.
1524 * <p>
1525 * The system will have a persistent connection to this service.
1526 * This is a protected intent that can only be sent by the system.
1527 * </p>
1528 *
1529 * @hide
1530 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001531 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1532 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1533 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1534
1535 /**
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001536 * Activity Action: Launch ephemeral settings.
1537 *
1538 * <p class="note">
1539 * This is a protected intent that can only be sent by the system.
1540 * </p>
1541 *
1542 * @hide
1543 */
1544 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1545 public static final String ACTION_EPHEMERAL_RESOLVER_SETTINGS
1546 = "android.intent.action.EPHEMERAL_RESOLVER_SETTINGS";
1547
1548 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001549 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1550 * package. Specifies the installer package name; this package will receive the
1551 * {@link #ACTION_APP_ERROR} intent.
1552 */
1553 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1554 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1555
1556 /**
1557 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1558 * package. Specifies that the application being installed should not be
1559 * treated as coming from an unknown source, but as coming from the app
1560 * invoking the Intent. For this to work you must start the installer with
1561 * startActivityForResult().
1562 */
1563 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1564 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1565
1566 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001567 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1568 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001569 * data field originated from.
1570 */
rich cannings706e8ba2012-08-20 13:20:14 -07001571 public static final String EXTRA_ORIGINATING_URI
1572 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001573
1574 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001575 * This extra can be used with any Intent used to launch an activity, supplying information
1576 * about who is launching that activity. This field contains a {@link android.net.Uri}
1577 * object, typically an http: or https: URI of the web site that the referral came from;
1578 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1579 * a native application that it came from.
1580 *
1581 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1582 * instead of directly retrieving the extra. It is also valid for applications to
1583 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1584 * a string, not a Uri; the field here, if supplied, will always take precedence,
1585 * however.</p>
1586 *
1587 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001588 */
1589 public static final String EXTRA_REFERRER
1590 = "android.intent.extra.REFERRER";
1591
1592 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001593 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1594 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1595 * not be created, in particular when Intent extras are supplied through the
1596 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1597 * schemes.
1598 *
1599 * @see #EXTRA_REFERRER
1600 */
1601 public static final String EXTRA_REFERRER_NAME
1602 = "android.intent.extra.REFERRER_NAME";
1603
1604 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001605 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001606 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Ben Gruver37d83a32012-09-27 13:02:06 -07001607 * @hide
1608 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001609 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001610 public static final String EXTRA_ORIGINATING_UID
1611 = "android.intent.extra.ORIGINATING_UID";
1612
1613 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001614 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1615 * package. Tells the installer UI to skip the confirmation with the user
1616 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001617 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1618 * will no longer show an interstitial message about updating existing
1619 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001620 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001621 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001622 public static final String EXTRA_ALLOW_REPLACE
1623 = "android.intent.extra.ALLOW_REPLACE";
1624
1625 /**
1626 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1627 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1628 * return to the application the result code of the install/uninstall. The returned result
1629 * code will be {@link android.app.Activity#RESULT_OK} on success or
1630 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1631 */
1632 public static final String EXTRA_RETURN_RESULT
1633 = "android.intent.extra.RETURN_RESULT";
1634
1635 /**
1636 * Package manager install result code. @hide because result codes are not
1637 * yet ready to be exposed.
1638 */
1639 public static final String EXTRA_INSTALL_RESULT
1640 = "android.intent.extra.INSTALL_RESULT";
1641
1642 /**
1643 * Activity Action: Launch application uninstaller.
1644 * <p>
1645 * Input: The data must be a package: URI whose scheme specific part is
1646 * the package name of the current installed package to be uninstalled.
1647 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1648 * <p>
1649 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1650 * succeeded.
1651 */
1652 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1653 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1654
1655 /**
msnider3c191b82017-01-23 14:23:16 -08001656 * Activity Action: Launch application uninstaller.
1657 * <p>
1658 * Input: The data must be a package: URI whose scheme specific part is
1659 * the package name of the current installed package to be uninstalled.
1660 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1661 * <p>
1662 * Output: Nothing.
1663 * </p>
1664 */
1665 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1666 public static final String ACTION_CLEAR_PACKAGE = "android.intent.action.CLEAR_PACKAGE";
1667
1668 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001669 * Specify whether the package should be uninstalled for all users.
1670 * @hide because these should not be part of normal application flow.
1671 */
1672 public static final String EXTRA_UNINSTALL_ALL_USERS
1673 = "android.intent.extra.UNINSTALL_ALL_USERS";
1674
1675 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001676 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1677 * describing the last run version of the platform that was setup.
1678 * @hide
1679 */
1680 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1681
Svet Ganov3695b8a2015-03-24 16:30:25 -07001682 /**
1683 * Activity action: Launch UI to manage the permissions of an app.
1684 * <p>
1685 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1686 * will be managed by the launched UI.
1687 * </p>
1688 * <p>
1689 * Output: Nothing.
1690 * </p>
1691 *
1692 * @see #EXTRA_PACKAGE_NAME
1693 *
1694 * @hide
1695 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001696 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001697 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1698 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1699 "android.intent.action.MANAGE_APP_PERMISSIONS";
1700
1701 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001702 * Activity action: Launch UI to manage permissions.
1703 * <p>
1704 * Input: Nothing.
1705 * </p>
1706 * <p>
1707 * Output: Nothing.
1708 * </p>
1709 *
1710 * @hide
1711 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001712 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001713 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1714 public static final String ACTION_MANAGE_PERMISSIONS =
1715 "android.intent.action.MANAGE_PERMISSIONS";
1716
1717 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001718 * Activity action: Launch UI to review permissions for an app.
1719 * The system uses this intent if permission review for apps not
1720 * supporting the new runtime permissions model is enabled. In
1721 * this mode a permission review is required before any of the
1722 * app components can run.
1723 * <p>
1724 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1725 * permissions will be reviewed (mandatory).
1726 * </p>
1727 * <p>
1728 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1729 * be fired after the permission review (optional).
1730 * </p>
1731 * <p>
1732 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1733 * be invoked after the permission review (optional).
1734 * </p>
1735 * <p>
1736 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1737 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1738 * </p>
1739 * <p>
1740 * Output: Nothing.
1741 * </p>
1742 *
1743 * @see #EXTRA_PACKAGE_NAME
1744 * @see #EXTRA_INTENT
1745 * @see #EXTRA_REMOTE_CALLBACK
1746 * @see #EXTRA_RESULT_NEEDED
1747 *
1748 * @hide
1749 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001750 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001751 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1752 public static final String ACTION_REVIEW_PERMISSIONS =
1753 "android.intent.action.REVIEW_PERMISSIONS";
1754
1755 /**
1756 * Intent extra: A callback for reporting remote result as a bundle.
1757 * <p>
1758 * Type: IRemoteCallback
1759 * </p>
1760 *
1761 * @hide
1762 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001763 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001764 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1765
1766 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001767 * Intent extra: An app package name.
1768 * <p>
1769 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001770 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001771 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001772 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001773 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1774
1775 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001776 * Intent extra: An app split name.
1777 * <p>
1778 * Type: String
1779 * </p>
1780 * @hide
1781 */
1782 @SystemApi
1783 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1784
1785 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001786 * Intent extra: An extra for specifying whether a result is needed.
1787 * <p>
1788 * Type: boolean
1789 * </p>
1790 *
1791 * @hide
1792 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001793 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001794 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1795
1796 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001797 * Activity action: Launch UI to manage which apps have a given permission.
1798 * <p>
1799 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1800 * to which will be managed by the launched UI.
1801 * </p>
1802 * <p>
1803 * Output: Nothing.
1804 * </p>
1805 *
1806 * @see #EXTRA_PERMISSION_NAME
1807 *
1808 * @hide
1809 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001810 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001811 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1812 public static final String ACTION_MANAGE_PERMISSION_APPS =
1813 "android.intent.action.MANAGE_PERMISSION_APPS";
1814
1815 /**
1816 * Intent extra: The name of a permission.
1817 * <p>
1818 * Type: String
1819 * </p>
1820 *
1821 * @hide
1822 */
1823 @SystemApi
1824 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1825
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001826 // ---------------------------------------------------------------------
1827 // ---------------------------------------------------------------------
1828 // Standard intent broadcast actions (see action variable).
1829
1830 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001831 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1832 * <p>
1833 * For historical reasons, the name of this broadcast action refers to the power
1834 * state of the screen but it is actually sent in response to changes in the
1835 * overall interactive state of the device.
1836 * </p><p>
1837 * This broadcast is sent when the device becomes non-interactive which may have
1838 * nothing to do with the screen turning off. To determine the
1839 * actual state of the screen, use {@link android.view.Display#getState}.
1840 * </p><p>
1841 * See {@link android.os.PowerManager#isInteractive} for details.
1842 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001843 * You <em>cannot</em> receive this through components declared in
1844 * manifests, only by explicitly registering for it with
1845 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1846 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001847 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001848 * <p class="note">This is a protected intent that can only be sent
1849 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001850 */
1851 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1852 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001853
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001854 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001855 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1856 * <p>
1857 * For historical reasons, the name of this broadcast action refers to the power
1858 * state of the screen but it is actually sent in response to changes in the
1859 * overall interactive state of the device.
1860 * </p><p>
1861 * This broadcast is sent when the device becomes interactive which may have
1862 * nothing to do with the screen turning on. To determine the
1863 * actual state of the screen, use {@link android.view.Display#getState}.
1864 * </p><p>
1865 * See {@link android.os.PowerManager#isInteractive} for details.
1866 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001867 * You <em>cannot</em> receive this through components declared in
1868 * manifests, only by explicitly registering for it with
1869 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1870 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001871 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001872 * <p class="note">This is a protected intent that can only be sent
1873 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001874 */
1875 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1876 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001877
1878 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001879 * Broadcast Action: Sent after the system stops dreaming.
1880 *
1881 * <p class="note">This is a protected intent that can only be sent by the system.
1882 * It is only sent to registered receivers.</p>
1883 */
1884 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1885 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1886
1887 /**
1888 * Broadcast Action: Sent after the system starts dreaming.
1889 *
1890 * <p class="note">This is a protected intent that can only be sent by the system.
1891 * It is only sent to registered receivers.</p>
1892 */
1893 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1894 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1895
1896 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001897 * 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 -07001898 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001899 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001900 * <p class="note">This is a protected intent that can only be sent
1901 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001902 */
1903 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001904 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001905
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001906 /**
1907 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001908 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001909 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001910 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1911 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001912 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001913 * <p class="note">This is a protected intent that can only be sent
1914 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001915 */
1916 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1917 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1918 /**
1919 * Broadcast Action: The time was set.
1920 */
1921 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1922 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1923 /**
1924 * Broadcast Action: The date has changed.
1925 */
1926 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1927 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1928 /**
1929 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1930 * <ul>
1931 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1932 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001933 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001934 * <p class="note">This is a protected intent that can only be sent
1935 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001936 */
1937 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1938 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1939 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001940 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1941 * DNS entries should be tossed.
1942 * @hide
1943 */
1944 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1945 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1946 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001947 * Alarm Changed Action: This is broadcast when the AlarmClock
1948 * application's alarm is set or unset. It is used by the
1949 * AlarmClock application and the StatusBar service.
1950 * @hide
1951 */
1952 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1953 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001954
1955 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001956 * Broadcast Action: This is broadcast once, after the user has finished
1957 * booting, but while still in the "locked" state. It can be used to perform
1958 * application-specific initialization, such as installing alarms. You must
1959 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1960 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001961 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001962 * This broadcast is sent immediately at boot by all devices (regardless of
1963 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1964 * higher. Upon receipt of this broadcast, the user is still locked and only
1965 * device-protected storage can be accessed safely. If you want to access
1966 * credential-protected storage, you need to wait for the user to be
1967 * unlocked (typically by entering their lock pattern or PIN for the first
1968 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1969 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1970 * <p>
1971 * To receive this broadcast, your receiver component must be marked as
1972 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001973 * <p class="note">
1974 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001975 *
1976 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001977 */
1978 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1979 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1980
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001981 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001982 * Broadcast Action: This is broadcast once, after the user has finished
1983 * booting. It can be used to perform application-specific initialization,
1984 * such as installing alarms. You must hold the
1985 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1986 * order to receive this broadcast.
1987 * <p>
1988 * This broadcast is sent at boot by all devices (both with and without
1989 * direct boot support). Upon receipt of this broadcast, the user is
1990 * unlocked and both device-protected and credential-protected storage can
1991 * accessed safely.
1992 * <p>
1993 * If you need to run while the user is still locked (before they've entered
1994 * their lock pattern or PIN for the first time), you can listen for the
1995 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1996 * <p class="note">
1997 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001998 */
1999 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002000 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002001 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002002
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002003 /**
2004 * Broadcast Action: This is broadcast when a user action should request a
2005 * temporary system dialog to dismiss. Some examples of temporary system
2006 * dialogs are the notification window-shade and the recent tasks dialog.
2007 */
2008 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2009 /**
2010 * Broadcast Action: Trigger the download and eventual installation
2011 * of a package.
2012 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002013 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002014 * <p class="note">This is a protected intent that can only be sent
2015 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002016 *
2017 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002018 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002019 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002020 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2021 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2022 /**
2023 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002024 * device. The data contains the name of the package. Note that the
2025 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002026 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002027 * <ul>
2028 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2029 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
2030 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2031 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002032 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002033 * <p class="note">This is a protected intent that can only be sent
2034 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002035 */
2036 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2037 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2038 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002039 * Broadcast Action: A new version of an application package has been
2040 * installed, replacing an existing version that was previously installed.
2041 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002042 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002043 * <ul>
2044 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2045 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002046 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002047 * <p class="note">This is a protected intent that can only be sent
2048 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002049 */
2050 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2051 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2052 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002053 * Broadcast Action: A new version of your application has been installed
2054 * over an existing one. This is only sent to the application that was
2055 * replaced. It does not contain any additional data; to receive it, just
2056 * use an intent filter for this action.
2057 *
2058 * <p class="note">This is a protected intent that can only be sent
2059 * by the system.
2060 */
2061 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2062 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2063 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002064 * Broadcast Action: An existing application package has been removed from
2065 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002066 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002067 * <ul>
2068 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2069 * to the package.
2070 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2071 * application -- data and code -- is being removed.
2072 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2073 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2074 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002075 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002076 * <p class="note">This is a protected intent that can only be sent
2077 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002078 */
2079 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2080 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2081 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002082 * Broadcast Action: An existing application package has been completely
2083 * removed from the device. The data contains the name of the package.
2084 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2085 * {@link #EXTRA_DATA_REMOVED} is true and
2086 * {@link #EXTRA_REPLACING} is false of that broadcast.
2087 *
2088 * <ul>
2089 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2090 * to the package.
2091 * </ul>
2092 *
2093 * <p class="note">This is a protected intent that can only be sent
2094 * by the system.
2095 */
2096 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2097 public static final String ACTION_PACKAGE_FULLY_REMOVED
2098 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2099 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002100 * Broadcast Action: An existing application package has been changed (for
2101 * example, a component has been enabled or disabled). The data contains
2102 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002103 * <ul>
2104 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002105 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002106 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002107 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2108 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002109 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002110 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002111 * <p class="note">This is a protected intent that can only be sent
2112 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2115 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2116 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002117 * @hide
2118 * Broadcast Action: Ask system services if there is any reason to
2119 * restart the given package. The data contains the name of the
2120 * package.
2121 * <ul>
2122 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2123 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2124 * </ul>
2125 *
2126 * <p class="note">This is a protected intent that can only be sent
2127 * by the system.
2128 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002129 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002130 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2131 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2132 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002133 * Broadcast Action: The user has restarted a package, and all of its
2134 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002135 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002136 * be removed. Note that the restarted package does <em>not</em>
2137 * receive this broadcast.
2138 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002139 * <ul>
2140 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2141 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002142 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002143 * <p class="note">This is a protected intent that can only be sent
2144 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002145 */
2146 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2147 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2148 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002149 * Broadcast Action: The user has cleared the data of a package. This should
2150 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002151 * its persistent data is erased and this broadcast sent.
2152 * Note that the cleared package does <em>not</em>
2153 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002154 * <ul>
2155 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2156 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002157 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002158 * <p class="note">This is a protected intent that can only be sent
2159 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002160 */
2161 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2162 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2163 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002164 * Broadcast Action: Packages have been suspended.
2165 * <p>Includes the following extras:
2166 * <ul>
2167 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2168 * </ul>
2169 *
2170 * <p class="note">This is a protected intent that can only be sent
2171 * by the system. It is only sent to registered receivers.
2172 */
2173 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2174 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2175 /**
2176 * Broadcast Action: Packages have been unsuspended.
2177 * <p>Includes the following extras:
2178 * <ul>
2179 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2180 * </ul>
2181 *
2182 * <p class="note">This is a protected intent that can only be sent
2183 * by the system. It is only sent to registered receivers.
2184 */
2185 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2186 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2187 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002188 * Broadcast Action: A user ID has been removed from the system. The user
2189 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002190 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002191 * <p class="note">This is a protected intent that can only be sent
2192 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002193 */
2194 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2195 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002196
2197 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002198 * Broadcast Action: Sent to the installer package of an application when
2199 * that application is first launched (that is the first time it is moved
2200 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002201 *
2202 * <p class="note">This is a protected intent that can only be sent
2203 * by the system.
2204 */
2205 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2206 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2207
2208 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002209 * Broadcast Action: Sent to the system package verifier when a package
2210 * needs to be verified. The data contains the package URI.
2211 * <p class="note">
2212 * This is a protected intent that can only be sent by the system.
2213 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002214 */
2215 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2216 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2217
2218 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002219 * Broadcast Action: Sent to the system package verifier when a package is
2220 * verified. The data contains the package URI.
2221 * <p class="note">
2222 * This is a protected intent that can only be sent by the system.
2223 */
2224 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2225 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2226
2227 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002228 * Broadcast Action: Sent to the system intent filter verifier when an
2229 * intent filter needs to be verified. The data contains the filter data
2230 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002231 * <p class="note">
2232 * This is a protected intent that can only be sent by the system.
2233 * </p>
2234 *
2235 * @hide
2236 */
2237 @SystemApi
2238 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2239 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2240
2241 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002242 * Broadcast Action: Resources for a set of packages (which were
2243 * previously unavailable) are currently
2244 * available since the media on which they exist is available.
2245 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2246 * list of packages whose availability changed.
2247 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2248 * list of uids of packages whose availability changed.
2249 * Note that the
2250 * packages in this list do <em>not</em> receive this broadcast.
2251 * The specified set of packages are now available on the system.
2252 * <p>Includes the following extras:
2253 * <ul>
2254 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2255 * whose resources(were previously unavailable) are currently available.
2256 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2257 * packages whose resources(were previously unavailable)
2258 * are currently available.
2259 * </ul>
2260 *
2261 * <p class="note">This is a protected intent that can only be sent
2262 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002263 */
2264 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002265 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2266 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002267
2268 /**
2269 * Broadcast Action: Resources for a set of packages are currently
2270 * unavailable since the media on which they exist is unavailable.
2271 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2272 * list of packages whose availability changed.
2273 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2274 * list of uids of packages whose availability changed.
2275 * The specified set of packages can no longer be
2276 * launched and are practically unavailable on the system.
2277 * <p>Inclues the following extras:
2278 * <ul>
2279 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2280 * whose resources are no longer available.
2281 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2282 * whose resources are no longer available.
2283 * </ul>
2284 *
2285 * <p class="note">This is a protected intent that can only be sent
2286 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002287 */
2288 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002289 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002290 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002291
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002292 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002293 * Broadcast Action: preferred activities have changed *explicitly*.
2294 *
2295 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2296 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2297 * be sent.
2298 *
2299 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2300 *
2301 * @hide
2302 */
2303 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2304 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2305 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2306
2307
2308 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002309 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002310 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002311 * This should <em>only</em> be used to determine when the wallpaper
2312 * has changed to show the new wallpaper to the user. You should certainly
2313 * never, in response to this, change the wallpaper or other attributes of
2314 * it such as the suggested size. That would be crazy, right? You'd cause
2315 * all kinds of loops, especially if other apps are doing similar things,
2316 * right? Of course. So please don't do this.
2317 *
2318 * @deprecated Modern applications should use
2319 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2320 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2321 * shown behind their UI, rather than watching for this broadcast and
2322 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002323 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002324 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002325 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2326 /**
2327 * Broadcast Action: The current device {@link android.content.res.Configuration}
2328 * (orientation, locale, etc) has changed. When such a change happens, the
2329 * UIs (view hierarchy) will need to be rebuilt based on this new
2330 * information; for the most part, applications don't need to worry about
2331 * this, because the system will take care of stopping and restarting the
2332 * application to make sure it sees the new changes. Some system code that
2333 * can not be restarted will need to watch for this action and handle it
2334 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002335 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002336 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002337 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002338 * in manifests, only by explicitly registering for it with
2339 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2340 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002341 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002342 * <p class="note">This is a protected intent that can only be sent
2343 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002344 *
2345 * @see android.content.res.Configuration
2346 */
2347 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2348 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2349 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002350 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002351 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002352 * <p class="note">This is a protected intent that can only be sent
2353 * by the system.
2354 */
2355 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2356 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2357 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002358 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2359 * charging state, level, and other information about the battery.
2360 * See {@link android.os.BatteryManager} for documentation on the
2361 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002362 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002363 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002364 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002365 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002366 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002367 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2368 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2369 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2370 * broadcasts that are sent and can be received through manifest
2371 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002372 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002373 * <p class="note">This is a protected intent that can only be sent
2374 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002375 */
2376 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2377 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2378 /**
2379 * Broadcast Action: Indicates low battery condition on the device.
2380 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002381 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002382 * <p class="note">This is a protected intent that can only be sent
2383 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002384 */
2385 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2386 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2387 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002388 * Broadcast Action: Indicates the battery is now okay after being low.
2389 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2390 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002391 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002392 * <p class="note">This is a protected intent that can only be sent
2393 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002394 */
2395 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2396 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2397 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002398 * Broadcast Action: External power has been connected to the device.
2399 * This is intended for applications that wish to register specifically to this notification.
2400 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2401 * stay active to receive this notification. This action can be used to implement actions
2402 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002403 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002404 * <p class="note">This is a protected intent that can only be sent
2405 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002406 */
2407 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002408 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002409 /**
2410 * Broadcast Action: External power has been removed from the device.
2411 * This is intended for applications that wish to register specifically to this notification.
2412 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2413 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002414 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002415 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002416 * <p class="note">This is a protected intent that can only be sent
2417 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002418 */
2419 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002420 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002421 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002422 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002423 * Broadcast Action: Device is shutting down.
2424 * This is broadcast when the device is being shut down (completely turned
2425 * off, not sleeping). Once the broadcast is complete, the final shutdown
2426 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002427 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002428 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002429 * <p class="note">This is a protected intent that can only be sent
2430 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002431 * <p>May include the following extras:
2432 * <ul>
2433 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2434 * shutdown is only for userspace processes. If not set, assumed to be false.
2435 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002436 */
2437 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002438 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002439 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002440 * Activity Action: Start this activity to request system shutdown.
2441 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002442 * to request confirmation from the user before shutting down. The optional boolean
2443 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2444 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002445 *
2446 * <p class="note">This is a protected intent that can only be sent
2447 * by the system.
2448 *
2449 * {@hide}
2450 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002451 public static final String ACTION_REQUEST_SHUTDOWN
2452 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002453 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002454 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002455 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002456 * <p class="note">
2457 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002458 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002459 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2460 * or above, this broadcast will no longer be delivered to any
2461 * {@link BroadcastReceiver} defined in your manifest. Instead,
2462 * apps are strongly encouraged to use the improved
2463 * {@link Context#getCacheDir()} behavior so the system can
2464 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002465 */
2466 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002467 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002468 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2469 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002470 * Broadcast Action: Indicates low storage space condition on the device no
2471 * longer exists
2472 * <p class="note">
2473 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002474 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002475 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2476 * or above, this broadcast will no longer be delivered to any
2477 * {@link BroadcastReceiver} defined in your manifest. Instead,
2478 * apps are strongly encouraged to use the improved
2479 * {@link Context#getCacheDir()} behavior so the system can
2480 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002481 */
2482 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002483 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002484 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2485 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002486 * Broadcast Action: A sticky broadcast that indicates a storage space full
2487 * condition on the device. This is intended for activities that want to be
2488 * able to fill the data partition completely, leaving only enough free
2489 * space to prevent system-wide SQLite failures.
2490 * <p class="note">
2491 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002492 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002493 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2494 * or above, this broadcast will no longer be delivered to any
2495 * {@link BroadcastReceiver} defined in your manifest. Instead,
2496 * apps are strongly encouraged to use the improved
2497 * {@link Context#getCacheDir()} behavior so the system can
2498 * automatically free up storage when needed.
2499 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002500 */
2501 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002502 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002503 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2504 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002505 * Broadcast Action: Indicates storage space full condition on the device no
2506 * longer exists.
2507 * <p class="note">
2508 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002509 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002510 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2511 * or above, this broadcast will no longer be delivered to any
2512 * {@link BroadcastReceiver} defined in your manifest. Instead,
2513 * apps are strongly encouraged to use the improved
2514 * {@link Context#getCacheDir()} behavior so the system can
2515 * automatically free up storage when needed.
2516 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002517 */
2518 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002519 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002520 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2521 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002522 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2523 * and package management should be started.
2524 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2525 * notification.
2526 */
2527 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2528 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2529 /**
2530 * Broadcast Action: The device has entered USB Mass Storage mode.
2531 * This is used mainly for the USB Settings panel.
2532 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2533 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002534 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002535 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002536 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002537 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2538
2539 /**
2540 * Broadcast Action: The device has exited USB Mass Storage mode.
2541 * This is used mainly for the USB Settings panel.
2542 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2543 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002544 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002545 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002546 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002547 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2548
2549 /**
2550 * Broadcast Action: External media has been removed.
2551 * The path to the mount point for the removed media is contained in the Intent.mData field.
2552 */
2553 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2554 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2555
2556 /**
2557 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002558 * 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 -07002559 */
2560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2561 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2562
2563 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002564 * Broadcast Action: External media is present, and being disk-checked
2565 * 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 -08002566 */
2567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2568 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2569
2570 /**
2571 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2572 * 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 -08002573 */
2574 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2575 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2576
2577 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002578 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002579 * 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 -07002580 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2581 * media was mounted read only.
2582 */
2583 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2584 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2585
2586 /**
2587 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002588 * 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 -07002589 */
2590 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2591 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2592
2593 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002594 * Broadcast Action: External media is no longer being shared via USB mass storage.
2595 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2596 *
2597 * @hide
2598 */
2599 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2600
2601 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002602 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2603 * The path to the mount point for the removed media is contained in the Intent.mData field.
2604 */
2605 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2606 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2607
2608 /**
2609 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002610 * 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 -07002611 */
2612 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2613 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2614
2615 /**
2616 * Broadcast Action: User has expressed the desire to remove the external storage media.
2617 * Applications should close all files they have open within the mount point when they receive this intent.
2618 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2619 */
2620 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2621 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2622
2623 /**
2624 * Broadcast Action: The media scanner has started scanning a directory.
2625 * The path to the directory being scanned is contained in the Intent.mData field.
2626 */
2627 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2628 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2629
2630 /**
2631 * Broadcast Action: The media scanner has finished scanning a directory.
2632 * The path to the scanned directory is contained in the Intent.mData field.
2633 */
2634 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2635 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2636
2637 /**
2638 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2639 * The path to the file is contained in the Intent.mData field.
2640 */
2641 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2642 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2643
2644 /**
2645 * Broadcast Action: The "Media Button" was pressed. Includes a single
2646 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2647 * caused the broadcast.
2648 */
2649 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2650 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2651
2652 /**
2653 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2654 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2655 * caused the broadcast.
2656 */
2657 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2658 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2659
2660 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2661 // location; they are not general-purpose actions.
2662
2663 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002664 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002665 */
2666 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2667 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2668 "android.intent.action.GTALK_CONNECTED";
2669
2670 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002671 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002672 */
2673 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2674 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2675 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002676
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002677 /**
2678 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002679 */
2680 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2681 public static final String ACTION_INPUT_METHOD_CHANGED =
2682 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002683
2684 /**
2685 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2686 * more radios have been turned off or on. The intent will have the following extra value:</p>
2687 * <ul>
2688 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2689 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2690 * turned off</li>
2691 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002692 *
Peng Xua35b5532016-01-20 00:05:45 -08002693 * <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 -07002694 */
2695 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2696 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2697
2698 /**
2699 * Broadcast Action: Some content providers have parts of their namespace
2700 * where they publish new events or items that the user may be especially
2701 * interested in. For these things, they may broadcast this action when the
2702 * set of interesting items change.
2703 *
2704 * For example, GmailProvider sends this notification when the set of unread
2705 * mail in the inbox changes.
2706 *
2707 * <p>The data of the intent identifies which part of which provider
2708 * changed. When queried through the content resolver, the data URI will
2709 * return the data set in question.
2710 *
2711 * <p>The intent will have the following extra values:
2712 * <ul>
2713 * <li><em>count</em> - The number of items in the data set. This is the
2714 * same as the number of items in the cursor returned by querying the
2715 * data URI. </li>
2716 * </ul>
2717 *
2718 * This intent will be sent at boot (if the count is non-zero) and when the
2719 * data set changes. It is possible for the data set to change without the
2720 * count changing (for example, if a new unread message arrives in the same
2721 * sync operation in which a message is archived). The phone should still
2722 * ring/vibrate/etc as normal in this case.
2723 */
2724 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2725 public static final String ACTION_PROVIDER_CHANGED =
2726 "android.intent.action.PROVIDER_CHANGED";
2727
2728 /**
2729 * Broadcast Action: Wired Headset plugged in or unplugged.
2730 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002731 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2732 * and documentation.
2733 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002734 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002735 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002736 */
2737 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002738 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002739
2740 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002741 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2742 * <ul>
2743 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2744 * </ul>
2745 *
2746 * <p class="note">This is a protected intent that can only be sent
2747 * by the system.
2748 *
2749 * @hide
2750 */
2751 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2752 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2753 = "android.intent.action.ADVANCED_SETTINGS";
2754
2755 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002756 * Broadcast Action: Sent after application restrictions are changed.
2757 *
2758 * <p class="note">This is a protected intent that can only be sent
2759 * by the system.</p>
2760 */
2761 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2762 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2763 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2764
2765 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002766 * Broadcast Action: An outgoing call is about to be placed.
2767 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002768 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002769 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002770 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002771 * the phone number originally intended to be dialed.</li>
2772 * </ul>
2773 * <p>Once the broadcast is finished, the resultData is used as the actual
2774 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002775 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002776 * outgoing call in turn: for example, a parental control application
2777 * might verify that the user is authorized to place the call at that
2778 * time, then a number-rewriting application might add an area code if
2779 * one was not specified.</p>
2780 * <p>For consistency, any receiver whose purpose is to prohibit phone
2781 * calls should have a priority of 0, to ensure it will see the final
2782 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002783 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002784 * should have a positive priority.
2785 * Negative priorities are reserved for the system for this broadcast;
2786 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002787 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2788 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002789 * <p>Emergency calls cannot be intercepted using this mechanism, and
2790 * other calls cannot be modified to call emergency numbers using this
2791 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002792 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2793 * call to use their own service instead. Those apps should first prevent
2794 * the call from being placed by setting resultData to <code>null</code>
2795 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002796 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002797 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2798 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002799 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002800 * <p class="note">This is a protected intent that can only be sent
2801 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002802 */
2803 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2804 public static final String ACTION_NEW_OUTGOING_CALL =
2805 "android.intent.action.NEW_OUTGOING_CALL";
2806
2807 /**
2808 * Broadcast Action: Have the device reboot. This is only for use by
2809 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002810 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002811 * <p class="note">This is a protected intent that can only be sent
2812 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002813 */
2814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2815 public static final String ACTION_REBOOT =
2816 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002817
Wei Huang97ecc9c2009-05-11 17:44:20 -07002818 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002819 * Broadcast Action: A sticky broadcast for changes in the physical
2820 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002821 *
2822 * <p>The intent will have the following extra values:
2823 * <ul>
2824 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002825 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002826 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002827 * <p>This is intended for monitoring the current physical dock state.
2828 * See {@link android.app.UiModeManager} for the normal API dealing with
2829 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002830 */
2831 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2832 public static final String ACTION_DOCK_EVENT =
2833 "android.intent.action.DOCK_EVENT";
2834
2835 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002836 * Broadcast Action: A broadcast when idle maintenance can be started.
2837 * This means that the user is not interacting with the device and is
2838 * not expected to do so soon. Typical use of the idle maintenance is
2839 * to perform somehow expensive tasks that can be postponed at a moment
2840 * when they will not degrade user experience.
2841 * <p>
2842 * <p class="note">In order to keep the device responsive in case of an
2843 * unexpected user interaction, implementations of a maintenance task
2844 * should be interruptible. In such a scenario a broadcast with action
2845 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2846 * should not do the maintenance work in
2847 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2848 * maintenance service by {@link Context#startService(Intent)}. Also
2849 * you should hold a wake lock while your maintenance service is running
2850 * to prevent the device going to sleep.
2851 * </p>
2852 * <p>
2853 * <p class="note">This is a protected intent that can only be sent by
2854 * the system.
2855 * </p>
2856 *
2857 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002858 *
2859 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002860 */
2861 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2862 public static final String ACTION_IDLE_MAINTENANCE_START =
2863 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2864
2865 /**
2866 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2867 * This means that the user was not interacting with the device as a result
2868 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2869 * was sent and now the user started interacting with the device. Typical
2870 * use of the idle maintenance is to perform somehow expensive tasks that
2871 * can be postponed at a moment when they will not degrade user experience.
2872 * <p>
2873 * <p class="note">In order to keep the device responsive in case of an
2874 * unexpected user interaction, implementations of a maintenance task
2875 * should be interruptible. Hence, on receiving a broadcast with this
2876 * action, the maintenance task should be interrupted as soon as possible.
2877 * In other words, you should not do the maintenance work in
2878 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2879 * maintenance service that was started on receiving of
2880 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2881 * lock you acquired when your maintenance service started.
2882 * </p>
2883 * <p class="note">This is a protected intent that can only be sent
2884 * by the system.
2885 *
2886 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002887 *
2888 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002889 */
2890 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2891 public static final String ACTION_IDLE_MAINTENANCE_END =
2892 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2893
2894 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002895 * Broadcast Action: a remote intent is to be broadcasted.
2896 *
2897 * A remote intent is used for remote RPC between devices. The remote intent
2898 * is serialized and sent from one device to another device. The receiving
2899 * device parses the remote intent and broadcasts it. Note that anyone can
2900 * broadcast a remote intent. However, if the intent receiver of the remote intent
2901 * does not trust intent broadcasts from arbitrary intent senders, it should require
2902 * the sender to hold certain permissions so only trusted sender's broadcast will be
2903 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002904 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002905 */
2906 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002907 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002908
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002909 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002910 * Broadcast Action: This is broadcast once when the user is booting after a
2911 * system update. It can be used to perform cleanup or upgrades after a
2912 * system update.
2913 * <p>
2914 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2915 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2916 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2917 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002918 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002919 * @hide
2920 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08002921 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002922 public static final String ACTION_PRE_BOOT_COMPLETED =
2923 "android.intent.action.PRE_BOOT_COMPLETED";
2924
Amith Yamasani13593602012-03-22 16:16:17 -07002925 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002926 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002927 * on restricted users. The broadcast intent contains an extra
2928 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2929 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2930 * String[] depending on the restriction type.<p/>
2931 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002932 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2933 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2934 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002935 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2936 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002937 * @see RestrictionEntry
2938 */
2939 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2940 "android.intent.action.GET_RESTRICTION_ENTRIES";
2941
2942 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002943 * Sent the first time a user is starting, to allow system apps to
2944 * perform one time initialization. (This will not be seen by third
2945 * party applications because a newly initialized user does not have any
2946 * third party applications installed for it.) This is sent early in
2947 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002948 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2949 * broadcast, since it is part of a visible user interaction; be as quick
2950 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002951 */
2952 public static final String ACTION_USER_INITIALIZE =
2953 "android.intent.action.USER_INITIALIZE";
2954
2955 /**
2956 * Sent when a user switch is happening, causing the process's user to be
2957 * brought to the foreground. This is only sent to receivers registered
2958 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2959 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002960 * foreground. This is sent as a foreground
2961 * broadcast, since it is part of a visible user interaction; be as quick
2962 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002963 */
2964 public static final String ACTION_USER_FOREGROUND =
2965 "android.intent.action.USER_FOREGROUND";
2966
2967 /**
2968 * Sent when a user switch is happening, causing the process's user to be
2969 * sent to the background. This is only sent to receivers registered
2970 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2971 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002972 * background. This is sent as a foreground
2973 * broadcast, since it is part of a visible user interaction; be as quick
2974 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002975 */
2976 public static final String ACTION_USER_BACKGROUND =
2977 "android.intent.action.USER_BACKGROUND";
2978
2979 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002980 * Broadcast sent to the system when a user is added. Carries an extra
2981 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2982 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002983 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002984 * @hide
2985 */
2986 public static final String ACTION_USER_ADDED =
2987 "android.intent.action.USER_ADDED";
2988
2989 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002990 * Broadcast sent by the system when a user is started. Carries an extra
2991 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002992 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002993 * that has been started. This is sent as a foreground
2994 * broadcast, since it is part of a visible user interaction; be as quick
2995 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002996 * @hide
2997 */
2998 public static final String ACTION_USER_STARTED =
2999 "android.intent.action.USER_STARTED";
3000
3001 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003002 * Broadcast sent when a user is in the process of starting. Carries an extra
3003 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3004 * sent to registered receivers, not manifest receivers. It is sent to all
3005 * users (including the one that is being started). You must hold
3006 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3007 * this broadcast. This is sent as a background broadcast, since
3008 * its result is not part of the primary UX flow; to safely keep track of
3009 * started/stopped state of a user you can use this in conjunction with
3010 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3011 * other user state broadcasts since those are foreground broadcasts so can
3012 * execute in a different order.
3013 * @hide
3014 */
3015 public static final String ACTION_USER_STARTING =
3016 "android.intent.action.USER_STARTING";
3017
3018 /**
3019 * Broadcast sent when a user is going to be stopped. Carries an extra
3020 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3021 * sent to registered receivers, not manifest receivers. It is sent to all
3022 * users (including the one that is being stopped). You must hold
3023 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3024 * this broadcast. The user will not stop until all receivers have
3025 * handled the broadcast. This is sent as a background broadcast, since
3026 * its result is not part of the primary UX flow; to safely keep track of
3027 * started/stopped state of a user you can use this in conjunction with
3028 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3029 * other user state broadcasts since those are foreground broadcasts so can
3030 * execute in a different order.
3031 * @hide
3032 */
3033 public static final String ACTION_USER_STOPPING =
3034 "android.intent.action.USER_STOPPING";
3035
3036 /**
3037 * Broadcast sent to the system when a user is stopped. Carries an extra
3038 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3039 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3040 * specific package. This is only sent to registered receivers, not manifest
3041 * receivers. It is sent to all running users <em>except</em> the one that
3042 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003043 * @hide
3044 */
3045 public static final String ACTION_USER_STOPPED =
3046 "android.intent.action.USER_STOPPED";
3047
3048 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003049 * 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 -07003050 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003051 * one that has been removed. The user will not be completely removed until all receivers have
3052 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003053 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003054 * @hide
3055 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003056 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003057 public static final String ACTION_USER_REMOVED =
3058 "android.intent.action.USER_REMOVED";
3059
3060 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003061 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003062 * the userHandle of the user to become the current one. This is only sent to
3063 * registered receivers, not manifest receivers. It is sent to all running users.
3064 * You must hold
3065 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003066 * @hide
3067 */
3068 public static final String ACTION_USER_SWITCHED =
3069 "android.intent.action.USER_SWITCHED";
3070
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003071 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003072 * Broadcast Action: Sent when the credential-encrypted private storage has
3073 * become unlocked for the target user. This is only sent to registered
3074 * receivers, not manifest receivers.
3075 */
3076 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3077 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3078
3079 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003080 * Broadcast sent to the system when a user's information changes. Carries an extra
3081 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003082 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003083 * @hide
3084 */
3085 public static final String ACTION_USER_INFO_CHANGED =
3086 "android.intent.action.USER_INFO_CHANGED";
3087
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003088 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003089 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3090 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003091 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3092 * that need to display merged content across both primary and managed profiles need to
3093 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003094 * not manifest receivers.
3095 */
3096 public static final String ACTION_MANAGED_PROFILE_ADDED =
3097 "android.intent.action.MANAGED_PROFILE_ADDED";
3098
3099 /**
3100 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003101 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3102 * Only applications (for example Launchers) that need to display merged content across both
3103 * primary and managed profiles need to worry about this broadcast. This is only sent to
3104 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003105 */
3106 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3107 "android.intent.action.MANAGED_PROFILE_REMOVED";
3108
3109 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003110 * Broadcast sent to the primary user when the credential-encrypted private storage for
3111 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3112 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3113 * Launchers) that need to display merged content across both primary and managed profiles
3114 * need to worry about this broadcast. This is only sent to registered receivers,
3115 * not manifest receivers.
3116 */
3117 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3118 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3119
3120 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003121 * Broadcast sent to the primary user when an associated managed profile has become available.
3122 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003123 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3124 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3125 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003126 */
Rubin Xue95057a2016-04-01 16:49:25 +01003127 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3128 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3129
3130 /**
3131 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3132 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3133 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3134 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3135 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3136 */
3137 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3138 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003139
3140 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003141 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3142 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3143 * the device was locked or unlocked.
3144 *
3145 * This is only sent to registered receivers.
3146 *
3147 * @hide
3148 */
3149 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3150 "android.intent.action.DEVICE_LOCKED_CHANGED";
3151
3152 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003153 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3154 */
3155 public static final String ACTION_QUICK_CLOCK =
3156 "android.intent.action.QUICK_CLOCK";
3157
Michael Wright0087a142013-02-05 16:29:39 -08003158 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003159 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003160 * @hide
3161 */
3162 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003163 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003164
Justin Kohd378ad72013-04-01 12:18:26 -07003165 /**
3166 * Broadcast Action: A global button was pressed. Includes a single
3167 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3168 * caused the broadcast.
3169 * @hide
3170 */
3171 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3172
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003173 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003174 * Broadcast Action: Sent when media resource is granted.
3175 * <p>
3176 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3177 * granted.
3178 * </p>
3179 * <p class="note">
3180 * This is a protected intent that can only be sent by the system.
3181 * </p>
3182 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003183 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003184 * </p>
3185 *
3186 * @hide
3187 */
3188 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3189 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3190
3191 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003192 * Broadcast Action: An overlay package has been installed. The data
3193 * contains the name of the added overlay package.
3194 * @hide
3195 */
3196 public static final String ACTION_OVERLAY_ADDED = "android.intent.action.OVERLAY_ADDED";
3197
3198 /**
3199 * Broadcast Action: An overlay package has changed. The data contains the
3200 * name of the overlay package which has changed. This is broadcast on all
3201 * changes to the OverlayInfo returned by {@link
3202 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3203 * most common change is a state change that will change whether the
3204 * overlay is enabled or not.
3205 * @hide
3206 */
3207 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3208
3209 /**
3210 * Broadcast Action: An overlay package has been removed. The data contains
3211 * the name of the overlay package which has been removed.
3212 * @hide
3213 */
3214 public static final String ACTION_OVERLAY_REMOVED = "android.intent.action.OVERLAY_REMOVED";
3215
3216 /**
3217 * Broadcast Action: The order of a package's list of overlay packages has
3218 * changed. The data contains the package name of the overlay package that
3219 * had its position in the list adjusted.
3220 * @hide
3221 */
3222 public static final String
3223 ACTION_OVERLAY_PRIORITY_CHANGED = "android.intent.action.OVERLAY_PRIORITY_CHANGED";
3224
3225 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003226 * Activity Action: Allow the user to select and return one or more existing
3227 * documents. When invoked, the system will display the various
3228 * {@link DocumentsProvider} instances installed on the device, letting the
3229 * user interactively navigate through them. These documents include local
3230 * media, such as photos and video, and documents provided by installed
3231 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003232 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003233 * Each document is represented as a {@code content://} URI backed by a
3234 * {@link DocumentsProvider}, which can be opened as a stream with
3235 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3236 * {@link android.provider.DocumentsContract.Document} metadata.
3237 * <p>
3238 * All selected documents are returned to the calling application with
3239 * persistable read and write permission grants. If you want to maintain
3240 * access to the documents across device reboots, you need to explicitly
3241 * take the persistable permissions using
3242 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3243 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003244 * Callers must indicate the acceptable document MIME types through
3245 * {@link #setType(String)}. For example, to select photos, use
3246 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3247 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3248 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003249 * <p>
3250 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003251 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3252 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003253 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003254 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3255 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003256 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003257 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003258 * Callers can set a document URI through
3259 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3260 * location of documents navigator. System will do its best to launch the
3261 * navigator in the specified document if it's a folder, or the folder that
3262 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003263 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003264 * Output: The URI of the item that was picked, returned in
3265 * {@link #getData()}. This must be a {@code content://} URI so that any
3266 * receiver can access it. If multiple documents were selected, they are
3267 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003268 *
3269 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003270 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003271 * @see #ACTION_CREATE_DOCUMENT
3272 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003273 */
3274 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3275 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3276
3277 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003278 * Activity Action: Allow the user to create a new document. When invoked,
3279 * the system will display the various {@link DocumentsProvider} instances
3280 * installed on the device, letting the user navigate through them. The
3281 * returned document may be a newly created document with no content, or it
3282 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003283 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003284 * Each document is represented as a {@code content://} URI backed by a
3285 * {@link DocumentsProvider}, which can be opened as a stream with
3286 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3287 * {@link android.provider.DocumentsContract.Document} metadata.
3288 * <p>
3289 * Callers must indicate the concrete MIME type of the document being
3290 * created by setting {@link #setType(String)}. This MIME type cannot be
3291 * changed after the document is created.
3292 * <p>
3293 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3294 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003295 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003296 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3297 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003298 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003299 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003300 * Callers can set a document URI through
3301 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3302 * location of documents navigator. System will do its best to launch the
3303 * navigator in the specified document if it's a folder, or the folder that
3304 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003305 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003306 * Output: The URI of the item that was created. This must be a
3307 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003308 *
3309 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003310 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003311 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003312 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003313 */
3314 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3315 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3316
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003317 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003318 * Activity Action: Allow the user to pick a directory subtree. When
3319 * invoked, the system will display the various {@link DocumentsProvider}
3320 * instances installed on the device, letting the user navigate through
3321 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003322 * <p>
3323 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003324 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3325 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3326 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003327 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003328 * Callers can set a document URI through
3329 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3330 * location of documents navigator. System will do its best to launch the
3331 * navigator in the specified document if it's a folder, or the folder that
3332 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003333 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003334 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003335 *
3336 * @see DocumentsContract
3337 */
3338 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003339 public static final String
3340 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003341
Felipe Lemec7b1f892016-01-15 15:02:31 -08003342 /**
Peng Xua35b5532016-01-20 00:05:45 -08003343 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3344 * exisiting sensor being disconnected.
3345 *
3346 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3347 *
3348 * {@hide}
3349 */
3350 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3351 public static final String
3352 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3353
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003354 /**
Sanket Padawe2c1a49f2017-03-31 12:39:50 -07003355 * Broadcast Action: The default subscription has changed. This has the following
3356 * extra values:</p>
3357 * The {@link #EXTRA_SUBSCRIPTION_INDEX} extra indicates the current default subscription index
3358 */
3359 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3360 public static final String ACTION_DEFAULT_SUBSCRIPTION_CHANGED
3361 = "android.intent.action.ACTION_DEFAULT_SUBSCRIPTION_CHANGED";
3362
3363 /**
3364 * Broadcast Action: The default sms subscription has changed. This has the following
3365 * extra values:</p>
3366 * {@link #EXTRA_SUBSCRIPTION_INDEX} extra indicates the current default sms
3367 * subscription index
3368 */
3369 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3370 public static final String ACTION_DEFAULT_SMS_SUBSCRIPTION_CHANGED
3371 = "android.intent.action.ACTION_DEFAULT_SMS_SUBSCRIPTION_CHANGED";
3372
3373 /**
3374 * Integer extra used with {@link #ACTION_DEFAULT_SUBSCRIPTION_CHANGED} and
3375 * {@link #ACTION_DEFAULT_SMS_SUBSCRIPTION_CHANGED} to indicate the subscription
3376 * which has changed.
3377 */
3378 public static final String EXTRA_SUBSCRIPTION_INDEX = "android.intent.extra.SUBSCRIPTION_INDEX";
3379
3380 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003381 * Deprecated - use {@link #ACTION_FACTORY_RESET} instead.
3382 *
3383 * {@hide}
3384 */
3385 @Deprecated
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003386 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3387
Christopher Tate6597e342015-02-17 12:15:25 -08003388 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003389 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3390 * is about to be performed.
3391 * @hide
3392 */
3393 @SystemApi
3394 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3395 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3396 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3397
3398 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003399 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3400 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3401 *
3402 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3403 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003404 * @hide
3405 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003406 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003407 public static final String EXTRA_FORCE_MASTER_CLEAR =
3408 "android.intent.extra.FORCE_MASTER_CLEAR";
3409
3410 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003411 * A broadcast action to trigger a factory reset.
3412 *
3413 * <p> The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission.
3414 *
3415 * <p>Not for use by third-party applications.
3416 *
3417 * @see #EXTRA_FORCE_MASTER_CLEAR
3418 *
3419 * {@hide}
3420 */
3421 @SystemApi
3422 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3423 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3424
3425 /**
3426 * 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>Not for use by third-party applications.
3430 *
3431 * @hide
3432 */
3433 @SystemApi
3434 public static final String EXTRA_FORCE_FACTORY_RESET =
3435 "android.intent.extra.FORCE_FACTORY_RESET";
3436
3437 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003438 * Broadcast action: report that a settings element is being restored from backup. The intent
3439 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3440 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3441 * is the value of that settings entry prior to the restore operation. All of these values are
3442 * represented as strings.
3443 *
3444 * <p>This broadcast is sent only for settings provider entries known to require special handling
3445 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3446 * the provider's backup agent implementation.
3447 *
3448 * @see #EXTRA_SETTING_NAME
3449 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3450 * @see #EXTRA_SETTING_NEW_VALUE
3451 * {@hide}
3452 */
3453 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3454
3455 /** {@hide} */
3456 public static final String EXTRA_SETTING_NAME = "setting_name";
3457 /** {@hide} */
3458 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3459 /** {@hide} */
3460 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3461
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003462 /**
3463 * Activity Action: Process a piece of text.
3464 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3465 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3466 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3467 */
3468 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3469 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003470
3471 /**
3472 * Broadcast Action: The sim card state has changed.
3473 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3474 * because TelephonyIntents is an internal class.
3475 * @hide
3476 */
3477 @SystemApi
3478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3479 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3480
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003481 /**
fionaxu90fee272017-03-31 12:45:12 -07003482 * Broadcast Action: indicate that the phone service state has changed.
3483 * The intent will have the following extra values:</p>
3484 * <p>
3485 * @see #EXTRA_VOICE_REG_STATE
3486 * @see #EXTRA_DATA_REG_STATE
3487 * @see #EXTRA_VOICE_ROAMING_TYPE
3488 * @see #EXTRA_DATA_ROAMING_TYPE
3489 * @see #EXTRA_OPERATOR_ALPHA_LONG
3490 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3491 * @see #EXTRA_OPERATOR_NUMERIC
3492 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3493 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3494 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3495 * @see #EXTRA_MANUAL
3496 * @see #EXTRA_VOICE_RADIO_TECH
3497 * @see #EXTRA_DATA_RADIO_TECH
3498 * @see #EXTRA_CSS_INDICATOR
3499 * @see #EXTRA_NETWORK_ID
3500 * @see #EXTRA_SYSTEM_ID
3501 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3502 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3503 * @see #EXTRA_EMERGENCY_ONLY
3504 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3505 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3506 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3507 *
3508 * <p class="note">
3509 * Requires the READ_PHONE_STATE permission.
3510 *
3511 * <p class="note">This is a protected intent that can only be sent by the system.
3512 * @hide
3513 */
3514 @Deprecated
3515 @SystemApi
3516 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3517 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3518
3519 /**
3520 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3521 * state.
3522 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3523 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3524 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3525 * @see android.telephony.ServiceState#STATE_POWER_OFF
3526 * @hide
3527 */
3528 @Deprecated
3529 @SystemApi
3530 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3531
3532 /**
3533 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3534 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3535 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3536 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3537 * @see android.telephony.ServiceState#STATE_POWER_OFF
3538 * @hide
3539 */
3540 @Deprecated
3541 @SystemApi
3542 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3543
3544 /**
3545 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3546 * type.
3547 * @hide
3548 */
3549 @Deprecated
3550 @SystemApi
3551 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3552
3553 /**
3554 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3555 * type.
3556 * @hide
3557 */
3558 @Deprecated
3559 @SystemApi
3560 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3561
3562 /**
3563 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3564 * registered voice operator name in long alphanumeric format.
3565 * {@code null} if the operator name is not known or unregistered.
3566 * @hide
3567 */
3568 @Deprecated
3569 @SystemApi
3570 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3571
3572 /**
3573 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3574 * registered voice operator name in short alphanumeric format.
3575 * {@code null} if the operator name is not known or unregistered.
3576 * @hide
3577 */
3578 @Deprecated
3579 @SystemApi
3580 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3581
3582 /**
3583 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3584 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3585 * network.
3586 * @hide
3587 */
3588 @Deprecated
3589 @SystemApi
3590 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3591
3592 /**
3593 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3594 * registered data operator name in long alphanumeric format.
3595 * {@code null} if the operator name is not known or unregistered.
3596 * @hide
3597 */
3598 @Deprecated
3599 @SystemApi
3600 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3601
3602 /**
3603 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3604 * registered data operator name in short alphanumeric format.
3605 * {@code null} if the operator name is not known or unregistered.
3606 * @hide
3607 */
3608 @Deprecated
3609 @SystemApi
3610 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3611
3612 /**
3613 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3614 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3615 * data operator.
3616 * @hide
3617 */
3618 @Deprecated
3619 @SystemApi
3620 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3621
3622 /**
3623 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3624 * network selection mode is manual.
3625 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3626 * @hide
3627 */
3628 @Deprecated
3629 @SystemApi
3630 public static final String EXTRA_MANUAL = "manual";
3631
3632 /**
3633 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3634 * radio technology.
3635 * @hide
3636 */
3637 @Deprecated
3638 @SystemApi
3639 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3640
3641 /**
3642 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3643 * radio technology.
3644 * @hide
3645 */
3646 @Deprecated
3647 @SystemApi
3648 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3649
3650 /**
3651 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3652 * support on CDMA network.
3653 * Will be {@code true} if support, {@code false} otherwise.
3654 * @hide
3655 */
3656 @Deprecated
3657 @SystemApi
3658 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3659
3660 /**
3661 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3662 * id. {@code Integer.MAX_VALUE} if unknown.
3663 * @hide
3664 */
3665 @Deprecated
3666 @SystemApi
3667 public static final String EXTRA_NETWORK_ID = "networkId";
3668
3669 /**
3670 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3671 * {@code Integer.MAX_VALUE} if unknown.
3672 * @hide
3673 */
3674 @Deprecated
3675 @SystemApi
3676 public static final String EXTRA_SYSTEM_ID = "systemId";
3677
3678 /**
3679 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3680 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3681 * @hide
3682 */
3683 @Deprecated
3684 @SystemApi
3685 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3686
3687 /**
3688 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3689 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3690 * @hide
3691 */
3692 @Deprecated
3693 @SystemApi
3694 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3695
3696 /**
3697 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3698 * only mode.
3699 * {@code true} if in emergency only mode, {@code false} otherwise.
3700 * @hide
3701 */
3702 @Deprecated
3703 @SystemApi
3704 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3705
3706 /**
3707 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3708 * registration state is roaming.
3709 * {@code true} if registration indicates roaming, {@code false} otherwise
3710 * @hide
3711 */
3712 @Deprecated
3713 @SystemApi
3714 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
3715 "isDataRoamingFromRegistration";
3716
3717 /**
3718 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
3719 * aggregation is in use.
3720 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
3721 * @hide
3722 */
3723 @Deprecated
3724 @SystemApi
3725 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
3726
3727 /**
3728 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
3729 * is reduced from the rsrp threshold while calculating signal strength level.
3730 * @hide
3731 */
3732 @Deprecated
3733 @SystemApi
3734 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
3735
3736 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003737 * The name of the extra used to define the text to be processed, as a
3738 * CharSequence. Note that this may be a styled CharSequence, so you must use
3739 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003740 */
3741 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3742 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003743 * 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 +00003744 */
3745 public static final String EXTRA_PROCESS_TEXT_READONLY =
3746 "android.intent.extra.PROCESS_TEXT_READONLY";
3747
Bryce Leebc58f592015-09-25 16:43:01 -07003748 /**
3749 * Broadcast action: reports when a new thermal event has been reached. When the device
3750 * is reaching its maximum temperatue, the thermal level reported
3751 * {@hide}
3752 */
3753 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3754 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3755
3756 /** {@hide} */
3757 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3758
3759 /**
3760 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003761 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003762 * {@hide}
3763 */
3764 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3765
3766 /**
3767 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003768 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003769 * {@hide}
3770 */
3771 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3772
3773 /**
3774 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003775 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003776 * {@hide}
3777 */
3778 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3779
3780
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003781 // ---------------------------------------------------------------------
3782 // ---------------------------------------------------------------------
3783 // Standard intent categories (see addCategory()).
3784
3785 /**
3786 * Set if the activity should be an option for the default action
3787 * (center press) to perform on a piece of data. Setting this will
3788 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003789 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003790 * Intent when initiating an action -- it is for use in intent filters
3791 * specified in packages.
3792 */
3793 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3794 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3795 /**
3796 * Activities that can be safely invoked from a browser must support this
3797 * category. For example, if the user is viewing a web page or an e-mail
3798 * and clicks on a link in the text, the Intent generated execute that
3799 * link will require the BROWSABLE category, so that only activities
3800 * supporting this category will be considered as possible actions. By
3801 * supporting this category, you are promising that there is nothing
3802 * damaging (without user intervention) that can happen by invoking any
3803 * matching Intent.
3804 */
3805 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3806 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3807 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003808 * Categories for activities that can participate in voice interaction.
3809 * An activity that supports this category must be prepared to run with
3810 * no UI shown at all (though in some case it may have a UI shown), and
3811 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3812 */
3813 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3814 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3815 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003816 * Set if the activity should be considered as an alternative action to
3817 * the data the user is currently viewing. See also
3818 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3819 * applies to the selection in a list of items.
3820 *
3821 * <p>Supporting this category means that you would like your activity to be
3822 * displayed in the set of alternative things the user can do, usually as
3823 * part of the current activity's options menu. You will usually want to
3824 * include a specific label in the &lt;intent-filter&gt; of this action
3825 * describing to the user what it does.
3826 *
3827 * <p>The action of IntentFilter with this category is important in that it
3828 * describes the specific action the target will perform. This generally
3829 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3830 * a specific name such as "com.android.camera.action.CROP. Only one
3831 * alternative of any particular action will be shown to the user, so using
3832 * a specific action like this makes sure that your alternative will be
3833 * displayed while also allowing other applications to provide their own
3834 * overrides of that particular action.
3835 */
3836 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3837 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3838 /**
3839 * Set if the activity should be considered as an alternative selection
3840 * action to the data the user has currently selected. This is like
3841 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3842 * of items from which the user can select, giving them alternatives to the
3843 * default action that will be performed on it.
3844 */
3845 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3846 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3847 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003848 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003849 */
3850 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3851 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3852 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003853 * Should be displayed in the top-level launcher.
3854 */
3855 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3856 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3857 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003858 * Indicates an activity optimized for Leanback mode, and that should
3859 * be displayed in the Leanback launcher.
3860 */
3861 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3862 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3863 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003864 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3865 * @hide
3866 */
3867 @SystemApi
3868 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3869 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003870 * Provides information about the package it is in; typically used if
3871 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3872 * a front-door to the user without having to be shown in the all apps list.
3873 */
3874 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3875 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3876 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003877 * This is the home activity, that is the first activity that is displayed
3878 * when the device boots.
3879 */
3880 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3881 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3882 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003883 * This is the home activity that is displayed when the device is finished setting up and ready
3884 * for use.
3885 * @hide
3886 */
3887 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3888 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3889 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003890 * This is the setup wizard activity, that is the first activity that is displayed
3891 * when the user sets up the device for the first time.
3892 * @hide
3893 */
3894 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3895 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3896 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003897 * This activity is a preference panel.
3898 */
3899 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3900 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3901 /**
3902 * This activity is a development preference panel.
3903 */
3904 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3905 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3906 /**
3907 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003908 */
3909 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3910 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3911 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003912 * This activity allows the user to browse and download new applications.
3913 */
3914 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3915 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3916 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003917 * This activity may be exercised by the monkey or other automated test tools.
3918 */
3919 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3920 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3921 /**
3922 * To be used as a test (not part of the normal user experience).
3923 */
3924 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3925 /**
3926 * To be used as a unit test (run through the Test Harness).
3927 */
3928 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3929 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003930 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003931 * experience).
3932 */
3933 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003934
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003935 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003936 * Used to indicate that an intent only wants URIs that can be opened with
3937 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3938 * must support at least the columns defined in {@link OpenableColumns} when
3939 * queried.
3940 *
3941 * @see #ACTION_GET_CONTENT
3942 * @see #ACTION_OPEN_DOCUMENT
3943 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003944 */
3945 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3946 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3947
3948 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09003949 * Used to indicate that an intent filter can accept files which are not necessarily
3950 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
3951 * at least streamable via
3952 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
3953 * using one of the stream types exposed via
3954 * {@link ContentResolver#getStreamTypes(Uri, String)}.
3955 *
3956 * @see #ACTION_SEND
3957 * @see #ACTION_SEND_MULTIPLE
3958 */
3959 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3960 public static final String CATEGORY_TYPED_OPENABLE =
3961 "android.intent.category.TYPED_OPENABLE";
3962
3963 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003964 * To be used as code under test for framework instrumentation tests.
3965 */
3966 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3967 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003968 /**
3969 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003970 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3971 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003972 */
3973 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3974 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3975 /**
3976 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003977 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3978 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003979 */
3980 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3981 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003982 /**
3983 * An activity to run when device is inserted into a analog (low end) dock.
3984 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3985 * information, see {@link android.app.UiModeManager}.
3986 */
3987 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3988 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3989
3990 /**
3991 * An activity to run when device is inserted into a digital (high end) dock.
3992 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3993 * information, see {@link android.app.UiModeManager}.
3994 */
3995 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3996 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003997
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003998 /**
3999 * Used to indicate that the activity can be used in a car environment.
4000 */
4001 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4002 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4003
Zak Cohendb6ca492017-01-26 14:09:00 -08004004 /**
4005 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4006 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4007 * information, see {@link android.app.UiModeManager}.
4008 */
4009 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4010 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004011 // ---------------------------------------------------------------------
4012 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004013 // Application launch intent categories (see addCategory()).
4014
4015 /**
4016 * Used with {@link #ACTION_MAIN} to launch the browser application.
4017 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004018 * <p>NOTE: This should not be used as the primary key of an Intent,
4019 * since it will not result in the app launching with the correct
4020 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004021 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004022 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004023 */
4024 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4025 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4026
4027 /**
4028 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4029 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004030 * <p>NOTE: This should not be used as the primary key of an Intent,
4031 * since it will not result in the app launching with the correct
4032 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004033 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004034 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004035 */
4036 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4037 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4038
4039 /**
4040 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4041 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004042 * <p>NOTE: This should not be used as the primary key of an Intent,
4043 * since it will not result in the app launching with the correct
4044 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004045 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004046 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004047 */
4048 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4049 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4050
4051 /**
4052 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4053 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004054 * <p>NOTE: This should not be used as the primary key of an Intent,
4055 * since it will not result in the app launching with the correct
4056 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004057 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004058 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004059 */
4060 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4061 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4062
4063 /**
4064 * Used with {@link #ACTION_MAIN} to launch the email application.
4065 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004066 * <p>NOTE: This should not be used as the primary key of an Intent,
4067 * since it will not result in the app launching with the correct
4068 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004069 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004070 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004071 */
4072 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4073 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4074
4075 /**
4076 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4077 * The activity should be able to view and manipulate image and video files
4078 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004079 * <p>NOTE: This should not be used as the primary key of an Intent,
4080 * since it will not result in the app launching with the correct
4081 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004082 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004083 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004084 */
4085 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4086 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4087
4088 /**
4089 * Used with {@link #ACTION_MAIN} to launch the maps application.
4090 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004091 * <p>NOTE: This should not be used as the primary key of an Intent,
4092 * since it will not result in the app launching with the correct
4093 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004094 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004095 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004096 */
4097 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4098 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4099
4100 /**
4101 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4102 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004103 * <p>NOTE: This should not be used as the primary key of an Intent,
4104 * since it will not result in the app launching with the correct
4105 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004106 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004107 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004108 */
4109 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4110 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4111
4112 /**
4113 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004114 * The activity should be able to play, browse, or manipulate music files
4115 * stored on the device.
4116 * <p>NOTE: This should not be used as the primary key of an Intent,
4117 * since it will not result in the app launching with the correct
4118 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004119 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004120 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004121 */
4122 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4123 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4124
4125 // ---------------------------------------------------------------------
4126 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004127 // Standard extra data keys.
4128
4129 /**
4130 * The initial data to place in a newly created record. Use with
4131 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4132 * fields as would be given to the underlying ContentProvider.insert()
4133 * call.
4134 */
4135 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4136
4137 /**
4138 * A constant CharSequence that is associated with the Intent, used with
4139 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4140 * this may be a styled CharSequence, so you must use
4141 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4142 * retrieve it.
4143 */
4144 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4145
4146 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004147 * A constant String that is associated with the Intent, used with
4148 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4149 * as HTML formatted text. Note that you <em>must</em> also supply
4150 * {@link #EXTRA_TEXT}.
4151 */
4152 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4153
4154 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004155 * A content: URI holding a stream of data associated with the Intent,
4156 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004157 */
4158 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4159
4160 /**
4161 * A String[] holding e-mail addresses that should be delivered to.
4162 */
4163 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4164
4165 /**
4166 * A String[] holding e-mail addresses that should be carbon copied.
4167 */
4168 public static final String EXTRA_CC = "android.intent.extra.CC";
4169
4170 /**
4171 * A String[] holding e-mail addresses that should be blind carbon copied.
4172 */
4173 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4174
4175 /**
4176 * A constant string holding the desired subject line of a message.
4177 */
4178 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4179
4180 /**
4181 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004182 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004183 */
4184 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4185
4186 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004187 * An int representing the user id to be used.
4188 *
4189 * @hide
4190 */
4191 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4192
4193 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004194 * An int representing the task id to be retrieved. This is used when a launch from recents is
4195 * intercepted by another action such as credentials confirmation to remember which task should
4196 * be resumed when complete.
4197 *
4198 * @hide
4199 */
4200 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4201
4202 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004203 * An Intent[] describing additional, alternate choices you would like shown with
4204 * {@link #ACTION_CHOOSER}.
4205 *
4206 * <p>An app may be capable of providing several different payload types to complete a
4207 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4208 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4209 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4210 * photo data or a hosted link where the photos can be viewed.</p>
4211 *
4212 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4213 * first/primary/preferred intent in the set. Additional intents specified in
4214 * this extra are ordered; by default intents that appear earlier in the array will be
4215 * preferred over intents that appear later in the array as matches for the same
4216 * target component. To alter this preference, a calling app may also supply
4217 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4218 */
4219 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4220
4221 /**
Adam Powell52c39212016-04-07 15:14:18 -07004222 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4223 * and omitted from a list of components presented to the user.
4224 *
4225 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4226 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4227 * from your own package or other apps from your organization if the idea of sending to those
4228 * targets would be redundant with other app functionality. Filtered components will not
4229 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4230 */
4231 public static final String EXTRA_EXCLUDE_COMPONENTS
4232 = "android.intent.extra.EXCLUDE_COMPONENTS";
4233
4234 /**
4235 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4236 * describing additional high-priority deep-link targets for the chooser to present to the user.
4237 *
4238 * <p>Targets provided in this way will be presented inline with all other targets provided
4239 * by services from other apps. They will be prioritized before other service targets, but
4240 * after those targets provided by sources that the user has manually pinned to the front.</p>
4241 *
4242 * @see #ACTION_CHOOSER
4243 */
4244 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4245
4246 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004247 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4248 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4249 *
4250 * <p>An app preparing an action for another app to complete may wish to allow the user to
4251 * disambiguate between several options for completing the action based on the chosen target
4252 * or otherwise refine the action before it is invoked.
4253 * </p>
4254 *
4255 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4256 * <ul>
4257 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4258 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4259 * chosen target beyond the first</li>
4260 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4261 * should fill in and send once the disambiguation is complete</li>
4262 * </ul>
4263 */
4264 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4265 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4266
4267 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004268 * An {@code ArrayList} of {@code String} annotations describing content for
4269 * {@link #ACTION_CHOOSER}.
4270 *
4271 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4272 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4273 *
4274 * <p>Annotations should describe the major components or topics of the content. It is up to
4275 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4276 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
4277 * start {@link #ACTION_CHOOSER}. Performance on customized annotations can suffer, if they are
4278 * rarely used for {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to
4279 * use the following annotations when applicable:</p>
4280 * <ul>
4281 * <li>"product": represents that the topic of the content is mainly about products, e.g.,
4282 * health & beauty, and office supplies.</li>
4283 * <li>"emotion": represents that the topic of the content is mainly about emotions, e.g.,
4284 * happy, and sad.</li>
4285 * <li>"person": represents that the topic of the content is mainly about persons, e.g.,
4286 * face, finger, standing, and walking.</li>
4287 * <li>"child": represents that the topic of the content is mainly about children, e.g.,
4288 * child, and baby.</li>
4289 * <li>"selfie": represents that the topic of the content is mainly about selfies.</li>
4290 * <li>"crowd": represents that the topic of the content is mainly about crowds.</li>
4291 * <li>"party": represents that the topic of the content is mainly about parties.</li>
4292 * <li>"animal": represent that the topic of the content is mainly about animals.</li>
4293 * <li>"plant": represents that the topic of the content is mainly about plants, e.g.,
4294 * flowers.</li>
4295 * <li>"vacation": represents that the topic of the content is mainly about vacations.</li>
4296 * <li>"fashion": represents that the topic of the content is mainly about fashion, e.g.
4297 * sunglasses, jewelry, handbags and clothing.</li>
4298 * <li>"material": represents that the topic of the content is mainly about materials, e.g.,
4299 * paper, and silk.</li>
4300 * <li>"vehicle": represents that the topic of the content is mainly about vehicles, like
4301 * cars, and boats.</li>
4302 * <li>"document": represents that the topic of the content is mainly about documents, e.g.
4303 * posters.</li>
4304 * <li>"design": represents that the topic of the content is mainly about design, e.g. arts
4305 * and designs of houses.</li>
4306 * <li>"holiday": represents that the topic of the content is mainly about holidays, e.g.,
4307 * Christmas and Thanksgiving.</li>
4308 * </ul>
4309 */
4310 public static final String EXTRA_CONTENT_ANNOTATIONS
4311 = "android.intent.extra.CONTENT_ANNOTATIONS";
4312
4313 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004314 * A {@link ResultReceiver} used to return data back to the sender.
4315 *
4316 * <p>Used to complete an app-specific
4317 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4318 *
4319 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4320 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4321 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4322 * when the user selects a target component from the chooser. It is up to the recipient
4323 * to send a result to this ResultReceiver to signal that disambiguation is complete
4324 * and that the chooser should invoke the user's choice.</p>
4325 *
4326 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4327 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4328 * to match and fill in the final Intent or ChooserTarget before starting it.
4329 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4330 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4331 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4332 *
4333 * <p>The result code passed to the ResultReceiver should be
4334 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4335 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4336 * the chooser should finish without starting a target.</p>
4337 */
4338 public static final String EXTRA_RESULT_RECEIVER
4339 = "android.intent.extra.RESULT_RECEIVER";
4340
4341 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004342 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004343 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004344 */
4345 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4346
4347 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004348 * A Parcelable[] of {@link Intent} or
4349 * {@link android.content.pm.LabeledIntent} objects as set with
4350 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4351 * a the front of the list of choices, when shown to the user with a
4352 * {@link #ACTION_CHOOSER}.
4353 */
4354 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4355
4356 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004357 * A {@link IntentSender} to start after ephemeral installation success.
4358 * @hide
4359 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004360 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4361
4362 /**
4363 * A {@link IntentSender} to start after ephemeral installation failure.
4364 * @hide
4365 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004366 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4367
4368 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004369 * The host name that triggered an ephemeral resolution.
4370 * @hide
4371 */
4372 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4373
4374 /**
4375 * An opaque token to track ephemeral resolution.
4376 * @hide
4377 */
4378 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4379
4380 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004381 * The version code of the app to install components from.
4382 * @hide
4383 */
4384 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4385
4386 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004387 * A Bundle forming a mapping of potential target package names to different extras Bundles
4388 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4389 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4390 * be currently installed on the device.
4391 *
4392 * <p>An application may choose to provide alternate extras for the case where a user
4393 * selects an activity from a predetermined set of target packages. If the activity
4394 * the user selects from the chooser belongs to a package with its package name as
4395 * a key in this bundle, the corresponding extras for that package will be merged with
4396 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4397 * extra has the same key as an extra already present in the intent it will overwrite
4398 * the extra from the intent.</p>
4399 *
4400 * <p><em>Examples:</em>
4401 * <ul>
4402 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4403 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4404 * parameters for that target.</li>
4405 * <li>An application may offer additional metadata for known targets of a given intent
4406 * to pass along information only relevant to that target such as account or content
4407 * identifiers already known to that application.</li>
4408 * </ul></p>
4409 */
4410 public static final String EXTRA_REPLACEMENT_EXTRAS =
4411 "android.intent.extra.REPLACEMENT_EXTRAS";
4412
4413 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004414 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4415 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4416 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4417 * {@link ComponentName} of the chosen component.
4418 *
4419 * <p>In some situations this callback may never come, for example if the user abandons
4420 * the chooser, switches to another task or any number of other reasons. Apps should not
4421 * be written assuming that this callback will always occur.</p>
4422 */
4423 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4424 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4425
4426 /**
4427 * The {@link ComponentName} chosen by the user to complete an action.
4428 *
4429 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4430 */
4431 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4432
4433 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004434 * A {@link android.view.KeyEvent} object containing the event that
4435 * triggered the creation of the Intent it is in.
4436 */
4437 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4438
4439 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004440 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4441 * before shutting down.
4442 *
4443 * {@hide}
4444 */
4445 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4446
4447 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004448 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4449 * requested by the user.
4450 *
4451 * {@hide}
4452 */
4453 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4454 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4455
4456 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004457 * 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 -07004458 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4459 * of restarting the application.
4460 */
4461 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4462
4463 /**
4464 * A String holding the phone number originally entered in
4465 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4466 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4467 */
4468 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004469
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004470 /**
4471 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4472 * intents to supply the uid the package had been assigned. Also an optional
4473 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4474 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4475 * purpose.
4476 */
4477 public static final String EXTRA_UID = "android.intent.extra.UID";
4478
4479 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004480 * @hide String array of package names.
4481 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004482 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004483 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4484
4485 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004486 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4487 * intents to indicate whether this represents a full uninstall (removing
4488 * both the code and its data) or a partial uninstall (leaving its data,
4489 * implying that this is an update).
4490 */
4491 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004492
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004493 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004494 * @hide
4495 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4496 * intents to indicate that at this point the package has been removed for
4497 * all users on the device.
4498 */
4499 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4500 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4501
4502 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004503 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4504 * intents to indicate that this is a replacement of the package, so this
4505 * broadcast will immediately be followed by an add broadcast for a
4506 * different version of the same package.
4507 */
4508 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004509
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004510 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004511 * Used as an int extra field in {@link android.app.AlarmManager} intents
4512 * to tell the application being invoked how many pending alarms are being
4513 * delievered with the intent. For one-shot alarms this will always be 1.
4514 * For recurring alarms, this might be greater than 1 if the device was
4515 * asleep or powered off at the time an earlier alarm would have been
4516 * delivered.
4517 */
4518 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004519
Jacek Surazski86b6c532009-05-13 14:38:28 +02004520 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004521 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4522 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004523 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4524 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004525 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4526 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4527 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004528 */
4529 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4530
4531 /**
4532 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4533 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004534 */
4535 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4536
4537 /**
4538 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4539 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004540 */
4541 public static final int EXTRA_DOCK_STATE_DESK = 1;
4542
4543 /**
4544 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4545 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004546 */
4547 public static final int EXTRA_DOCK_STATE_CAR = 2;
4548
4549 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004550 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4551 * to represent that the phone is in a analog (low end) dock.
4552 */
4553 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4554
4555 /**
4556 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4557 * to represent that the phone is in a digital (high end) dock.
4558 */
4559 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4560
4561 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004562 * Boolean that can be supplied as meta-data with a dock activity, to
4563 * indicate that the dock should take over the home key when it is active.
4564 */
4565 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004566
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004567 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004568 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4569 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004570 */
4571 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4572
4573 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004574 * Used in the extra field in the remote intent. It's astring token passed with the
4575 * remote intent.
4576 */
4577 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4578 "android.intent.extra.remote_intent_token";
4579
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004580 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004581 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004582 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004583 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004584 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004585 "android.intent.extra.changed_component_name";
4586
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004587 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004588 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004589 * and contains a string array of all of the components that have changed. If
4590 * the state of the overall package has changed, then it will contain an entry
4591 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004592 */
4593 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4594 "android.intent.extra.changed_component_name_list";
4595
4596 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004597 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004598 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004599 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4600 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4601 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004602 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004603 */
4604 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4605 "android.intent.extra.changed_package_list";
4606
4607 /**
4608 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004609 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4610 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004611 * and contains an integer array of uids of all of the components
4612 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004613 */
4614 public static final String EXTRA_CHANGED_UID_LIST =
4615 "android.intent.extra.changed_uid_list";
4616
4617 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004618 * @hide
4619 * Magic extra system code can use when binding, to give a label for
4620 * who it is that has bound to a service. This is an integer giving
4621 * a framework string resource that can be displayed to the user.
4622 */
4623 public static final String EXTRA_CLIENT_LABEL =
4624 "android.intent.extra.client_label";
4625
4626 /**
4627 * @hide
4628 * Magic extra system code can use when binding, to give a PendingIntent object
4629 * that can be launched for the user to disable the system's use of this
4630 * service.
4631 */
4632 public static final String EXTRA_CLIENT_INTENT =
4633 "android.intent.extra.client_intent";
4634
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004635 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004636 * Extra used to indicate that an intent should only return data that is on
4637 * the local device. This is a boolean extra; the default is false. If true,
4638 * an implementation should only allow the user to select data that is
4639 * already on the device, not requiring it be downloaded from a remote
4640 * service when opened.
4641 *
4642 * @see #ACTION_GET_CONTENT
4643 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004644 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004645 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004646 */
4647 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004648 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004649
Amith Yamasani13593602012-03-22 16:16:17 -07004650 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004651 * Extra used to indicate that an intent can allow the user to select and
4652 * return multiple items. This is a boolean extra; the default is false. If
4653 * true, an implementation is allowed to present the user with a UI where
4654 * they can pick multiple items that are all returned to the caller. When
4655 * this happens, they should be returned as the {@link #getClipData()} part
4656 * of the result Intent.
4657 *
4658 * @see #ACTION_GET_CONTENT
4659 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004660 */
4661 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004662 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004663
4664 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004665 * The integer userHandle carried with broadcast intents related to addition, removal and
4666 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4667 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4668 *
Amith Yamasani13593602012-03-22 16:16:17 -07004669 * @hide
4670 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004671 public static final String EXTRA_USER_HANDLE =
4672 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004673
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004674 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004675 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4676 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4677 */
4678 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004679 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004680
4681 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004682 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004683 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4684 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004685 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004686 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4687
4688 /**
4689 * Extra sent in the intent to the BroadcastReceiver that handles
4690 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4691 * the restrictions as key/value pairs.
4692 */
4693 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4694 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004695
Amith Yamasani86118ba2013-03-28 14:33:16 -07004696 /**
4697 * Extra used in the response from a BroadcastReceiver that handles
4698 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4699 */
4700 public static final String EXTRA_RESTRICTIONS_INTENT =
4701 "android.intent.extra.restrictions_intent";
4702
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004703 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004704 * Extra used to communicate a set of acceptable MIME types. The type of the
4705 * extra is {@code String[]}. Values may be a combination of concrete MIME
4706 * types (such as "image/png") and/or partial MIME types (such as
4707 * "audio/*").
4708 *
4709 * @see #ACTION_GET_CONTENT
4710 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004711 */
4712 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4713
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004714 /**
4715 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4716 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004717 * When this is true, hardware devices can use this information to determine that
4718 * they shouldn't do a complete shutdown of their device since this is not a
4719 * complete shutdown down to the kernel, but only user space restarting.
4720 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004721 */
4722 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4723 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4724
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004725 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004726 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4727 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4728 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4729 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004730 *
4731 * @hide for internal use only.
4732 */
4733 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4734 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004735 /** @hide */
4736 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4737 /** @hide */
4738 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4739 /** @hide */
4740 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004741
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004742 /** {@hide} */
4743 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4744
Rubin Xue8490f12015-06-25 12:17:48 +01004745 /** {@hide} */
4746 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4747
Santos Cordon15a13782015-03-31 18:32:31 -07004748 /**
4749 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4750 * activation request.
4751 * TODO: Add information about the structure and response data used with the pending intent.
4752 * @hide
4753 */
4754 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4755 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4756
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004757 /**
4758 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004759 *
4760 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07004761 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004762 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004763 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4764
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004765 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004766 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
4767 * such as opening in other apps, sharing, opening, editing, printing, deleting,
4768 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004769 *
4770 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07004771 * @see #ACTION_QUICK_VIEW
4772 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004773 */
Garfield Tance1d0e92017-03-23 10:52:48 -07004774 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004775 public static final String EXTRA_QUICK_VIEW_ADVANCED =
4776 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004777
4778 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07004779 * An optional extra of {@code String[]} indicating which quick view features should be made
4780 * available to the user in the quick view UI while handing a
4781 * {@link Intent#ACTION_QUICK_VIEW} intent.
4782 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
4783 * Quick viewer can implement features not listed below.
4784 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
4785 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DOWNLOAD},
4786 * {@link QuickViewConstants#FEATURE_SEND}, {@link QuickViewConstants#FEATURE_PRINT}.
4787 * <p>
4788 * Requirements:
4789 * <li>Quick viewer shouldn't show a feature if the feature is absent in
4790 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
4791 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
4792 * internal policies.
4793 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
4794 * requirement that the feature be shown. Quick viewer may, according to its own policies,
4795 * disable or hide features.
4796 *
4797 * @see #ACTION_QUICK_VIEW
4798 */
4799 public static final String EXTRA_QUICK_VIEW_FEATURES =
4800 "android.intent.extra.QUICK_VIEW_FEATURES";
4801
4802 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004803 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004804 * When a profile goes into quiet mode, all apps in the profile are killed and the
4805 * profile user is stopped. Widgets originating from the profile are masked, and app
4806 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004807 */
4808 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004809
4810 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004811 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004812 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004813 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4814 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004815 *
4816 * @hide
4817 */
4818 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4819 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4820
4821 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004822 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4823 * whether to show the chooser or not when there is only one application available
4824 * to choose from.
4825 *
4826 * @hide
4827 */
4828 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4829 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4830
4831 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004832 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004833 * to represent that a video codec is allowed to use.
4834 *
4835 * @hide
4836 */
4837 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4838
4839 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004840 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004841 * to represent that a audio codec is allowed to use.
4842 *
4843 * @hide
4844 */
4845 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4846
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004847 // ---------------------------------------------------------------------
4848 // ---------------------------------------------------------------------
4849 // Intent flags (see mFlags variable).
4850
Tor Norbyed9273d62013-05-30 15:59:53 -07004851 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004852 @IntDef(flag = true, value = {
4853 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4854 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004855 @Retention(RetentionPolicy.SOURCE)
4856 public @interface GrantUriMode {}
4857
Jeff Sharkey846318a2014-04-04 12:12:41 -07004858 /** @hide */
4859 @IntDef(flag = true, value = {
4860 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4861 @Retention(RetentionPolicy.SOURCE)
4862 public @interface AccessUriMode {}
4863
4864 /**
4865 * Test if given mode flags specify an access mode, which must be at least
4866 * read and/or write.
4867 *
4868 * @hide
4869 */
4870 public static boolean isAccessUriMode(int modeFlags) {
4871 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4872 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4873 }
4874
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004875 /**
4876 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004877 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004878 * specified in its ClipData. When applying to an Intent's ClipData,
4879 * all URIs as well as recursive traversals through data or other ClipData
4880 * in Intent items will be granted; only the grant flags of the top-level
4881 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004882 */
4883 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4884 /**
4885 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004886 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004887 * specified in its ClipData. When applying to an Intent's ClipData,
4888 * all URIs as well as recursive traversals through data or other ClipData
4889 * in Intent items will be granted; only the grant flags of the top-level
4890 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004891 */
4892 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4893 /**
4894 * Can be set by the caller to indicate that this Intent is coming from
4895 * a background operation, not from direct user interaction.
4896 */
4897 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4898 /**
4899 * A flag you can enable for debugging: when set, log messages will be
4900 * printed during the resolution of this intent to show you what has
4901 * been found to create the final resolved list.
4902 */
4903 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004904 /**
4905 * If set, this intent will not match any components in packages that
4906 * are currently stopped. If this is not set, then the default behavior
4907 * is to include such applications in the result.
4908 */
4909 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4910 /**
4911 * If set, this intent will always match any components in packages that
4912 * are currently stopped. This is the default behavior when
4913 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4914 * flags are set, this one wins (it allows overriding of exclude for
4915 * places where the framework may automatically set the exclude flag).
4916 */
4917 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004918
4919 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004920 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004921 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004922 * persisted across device reboots until explicitly revoked with
4923 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4924 * grant for possible persisting; the receiving application must call
4925 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4926 * actually persist.
4927 *
4928 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4929 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4930 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004931 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004932 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004933 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004934
4935 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004936 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4937 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4938 * applies to any URI that is a prefix match against the original granted
4939 * URI. (Without this flag, the URI must match exactly for access to be
4940 * granted.) Another URI is considered a prefix match only when scheme,
4941 * authority, and all path segments defined by the prefix are an exact
4942 * match.
4943 */
4944 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4945
4946 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004947 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004948 * homework and verified that they correctly handle packages and components
4949 * that come and go over time. In particular:
4950 * <ul>
4951 * <li>Apps installed on external storage, which will appear to be
4952 * uninstalled while the the device is ejected.
4953 * <li>Apps with encryption unaware components, which will appear to not
4954 * exist while the device is locked.
4955 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004956 *
4957 * @hide
4958 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004959 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004960
4961 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07004962 * Internal flag used to indicate ephemeral applications should not be
4963 * considered when resolving the intent.
4964 *
4965 * @hide
4966 */
4967 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
4968
4969 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004970 * If set, the new activity is not kept in the history stack. As soon as
4971 * the user navigates away from it, the activity is finished. This may also
4972 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4973 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004974 *
4975 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4976 * is never invoked when the current activity starts a new activity which
4977 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004978 */
4979 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4980 /**
4981 * If set, the activity will not be launched if it is already running
4982 * at the top of the history stack.
4983 */
4984 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4985 /**
4986 * If set, this activity will become the start of a new task on this
4987 * history stack. A task (from the activity that started it to the
4988 * next task activity) defines an atomic group of activities that the
4989 * user can move to. Tasks can be moved to the foreground and background;
4990 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004991 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004992 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4993 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004994 *
4995 * <p>This flag is generally used by activities that want
4996 * to present a "launcher" style behavior: they give the user a list of
4997 * separate things that can be done, which otherwise run completely
4998 * independently of the activity launching them.
4999 *
5000 * <p>When using this flag, if a task is already running for the activity
5001 * you are now starting, then a new activity will not be started; instead,
5002 * the current task will simply be brought to the front of the screen with
5003 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5004 * to disable this behavior.
5005 *
5006 * <p>This flag can not be used when the caller is requesting a result from
5007 * the activity being launched.
5008 */
5009 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5010 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005011 * This flag is used to create a new task and launch an activity into it.
5012 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5013 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5014 * search through existing tasks for ones matching this Intent. Only if no such
5015 * task is found would a new task be created. When paired with
5016 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5017 * the search for a matching task and unconditionally start a new task.
5018 *
5019 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5020 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005021 * top-level application launcher.</strong> Used in conjunction with
5022 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5023 * behavior of bringing an existing task to the foreground. When set,
5024 * a new task is <em>always</em> started to host the Activity for the
5025 * Intent, regardless of whether there is already an existing task running
5026 * the same thing.
5027 *
5028 * <p><strong>Because the default system does not include graphical task management,
5029 * you should not use this flag unless you provide some way for a user to
5030 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005031 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005032 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5033 * creating new document tasks.
5034 *
5035 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005036 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005037 *
Scott Main7aee61f2011-02-08 11:25:01 -08005038 * <p>See
5039 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5040 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005041 *
5042 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5043 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005044 */
5045 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5046 /**
5047 * If set, and the activity being launched is already running in the
5048 * current task, then instead of launching a new instance of that activity,
5049 * all of the other activities on top of it will be closed and this Intent
5050 * will be delivered to the (now on top) old activity as a new Intent.
5051 *
5052 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5053 * If D calls startActivity() with an Intent that resolves to the component
5054 * of activity B, then C and D will be finished and B receive the given
5055 * Intent, resulting in the stack now being: A, B.
5056 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005057 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005058 * either receive the new intent you are starting here in its
5059 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005060 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005061 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5062 * the same intent, then it will be finished and re-created; for all other
5063 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5064 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005065 *
5066 * <p>This launch mode can also be used to good effect in conjunction with
5067 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5068 * of a task, it will bring any currently running instance of that task
5069 * to the foreground, and then clear it to its root state. This is
5070 * especially useful, for example, when launching an activity from the
5071 * notification manager.
5072 *
Scott Main7aee61f2011-02-08 11:25:01 -08005073 * <p>See
5074 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5075 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005076 */
5077 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5078 /**
5079 * If set and this intent is being used to launch a new activity from an
5080 * existing one, then the reply target of the existing activity will be
5081 * transfered to the new activity. This way the new activity can call
5082 * {@link android.app.Activity#setResult} and have that result sent back to
5083 * the reply target of the original activity.
5084 */
5085 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5086 /**
5087 * If set and this intent is being used to launch a new activity from an
5088 * existing one, the current activity will not be counted as the top
5089 * activity for deciding whether the new intent should be delivered to
5090 * the top instead of starting a new one. The previous activity will
5091 * be used as the top, with the assumption being that the current activity
5092 * will finish itself immediately.
5093 */
5094 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5095 /**
5096 * If set, the new activity is not kept in the list of recently launched
5097 * activities.
5098 */
5099 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5100 /**
5101 * This flag is not normally set by application code, but set for you by
5102 * the system as described in the
5103 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5104 * launchMode} documentation for the singleTask mode.
5105 */
5106 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5107 /**
5108 * If set, and this activity is either being started in a new task or
5109 * bringing to the top an existing task, then it will be launched as
5110 * the front door of the task. This will result in the application of
5111 * any affinities needed to have that task in the proper state (either
5112 * moving activities to or from it), or simply resetting that task to
5113 * its initial state if needed.
5114 */
5115 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5116 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005117 * This flag is not normally set by application code, but set for you by
5118 * the system if this activity is being launched from history
5119 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005120 */
5121 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005122 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005123 * @deprecated As of API 21 this performs identically to
5124 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005125 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005126 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005127 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005128 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005129 * This flag is used to open a document into a new task rooted at the activity launched
5130 * by this Intent. Through the use of this flag, or its equivalent attribute,
5131 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005132 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005133 *
Craig Mautner026596b2014-05-21 15:35:44 -07005134 * <p>The use of the activity attribute form of this,
5135 * {@link android.R.attr#documentLaunchMode}, is
5136 * preferred over the Intent flag described here. The attribute form allows the
5137 * Activity to specify multiple document behavior for all launchers of the Activity
5138 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005139 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005140 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5141 * it is kept after the activity is finished is different than the use of
5142 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5143 * this flag is being used to create a new recents entry, then by default that entry
5144 * will be removed once the activity is finished. You can modify this behavior with
5145 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5146 *
Craig Mautner026596b2014-05-21 15:35:44 -07005147 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5148 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5149 * equivalent of the Activity manifest specifying {@link
5150 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5151 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5152 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005153 *
Craig Mautner026596b2014-05-21 15:35:44 -07005154 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005155 *
Craig Mautner026596b2014-05-21 15:35:44 -07005156 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005157 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5158 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005159 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005160 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005161 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005162 * callback from occurring on the current frontmost activity before it is
5163 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005164 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005165 * <p>Typically, an activity can rely on that callback to indicate that an
5166 * explicit user action has caused their activity to be moved out of the
5167 * foreground. The callback marks an appropriate point in the activity's
5168 * lifecycle for it to dismiss any notifications that it intends to display
5169 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005170 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005171 * <p>If an activity is ever started via any non-user-driven events such as
5172 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5173 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005174 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005175 */
5176 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005177 /**
5178 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5179 * this flag will cause the launched activity to be brought to the front of its
5180 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005181 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005182 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5183 * If D calls startActivity() with an Intent that resolves to the component
5184 * of activity B, then B will be brought to the front of the history stack,
5185 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005186 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005187 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005188 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005189 */
5190 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005191 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005192 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5193 * this flag will prevent the system from applying an activity transition
5194 * animation to go to the next activity state. This doesn't mean an
5195 * animation will never run -- if another activity change happens that doesn't
5196 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005197 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005198 * when you are going to do a series of activity operations but the
5199 * animation seen by the user shouldn't be driven by the first activity
5200 * change but rather a later one.
5201 */
5202 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5203 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005204 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5205 * this flag will cause any existing task that would be associated with the
5206 * activity to be cleared before the activity is started. That is, the activity
5207 * becomes the new root of an otherwise empty task, and any old activities
5208 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5209 */
5210 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5211 /**
5212 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5213 * this flag will cause a newly launching task to be placed on top of the current
5214 * home activity task (if there is one). That is, pressing back from the task
5215 * will always return the user to home even if that was not the last activity they
5216 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5217 */
5218 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5219 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005220 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5221 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005222 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005223 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005224 * this flag. When set and the task's activity is finished, the recents
5225 * entry will remain in the interface for the user to re-launch it, like a
5226 * recents entry for a top-level application.
5227 * <p>
5228 * The receiving activity can override this request with
5229 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5230 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005231 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005232 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005233 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005234
5235 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005236 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5237 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005238 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5239 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005240 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005241 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005242
5243 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005244 * If set, when sending a broadcast only registered receivers will be
5245 * called -- no BroadcastReceiver components will be launched.
5246 */
5247 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005248 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005249 * If set, when sending a broadcast the new broadcast will replace
5250 * any existing pending broadcast that matches it. Matching is defined
5251 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5252 * true for the intents of the two broadcasts. When a match is found,
5253 * the new broadcast (and receivers associated with it) will replace the
5254 * existing one in the pending broadcast list, remaining at the same
5255 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005256 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005257 * <p>This flag is most typically used with sticky broadcasts, which
5258 * only care about delivering the most recent values of the broadcast
5259 * to their receivers.
5260 */
5261 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5262 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005263 * If set, when sending a broadcast the recipient is allowed to run at
5264 * foreground priority, with a shorter timeout interval. During normal
5265 * broadcasts the receivers are not automatically hoisted out of the
5266 * background priority class.
5267 */
5268 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5269 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005270 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5271 * They can still propagate results through to later receivers, but they can not prevent
5272 * later receivers from seeing the broadcast.
5273 */
5274 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5275 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005276 * If set, when sending a broadcast <i>before boot has completed</i> only
5277 * registered receivers will be called -- no BroadcastReceiver components
5278 * will be launched. Sticky intent state will be recorded properly even
5279 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5280 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005281 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005282 * <p>This flag is only for use by system sevices as a convenience to
5283 * avoid having to implement a more complex mechanism around detection
5284 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005285 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005286 * @hide
5287 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005288 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005289 /**
5290 * Set when this broadcast is for a boot upgrade, a special mode that
5291 * allows the broadcast to be sent before the system is ready and launches
5292 * the app process with no providers running in it.
5293 * @hide
5294 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005295 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005296 /**
5297 * If set, the broadcast will always go to manifest receivers in background (cached
5298 * or not running) apps, regardless of whether that would be done by default. By
5299 * default they will only receive broadcasts if the broadcast has specified an
5300 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005301 *
5302 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5303 * the broadcast code there must also be changed to match.
5304 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005305 * @hide
5306 */
5307 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5308 /**
5309 * If set, the broadcast will never go to manifest receivers in background (cached
5310 * or not running) apps, regardless of whether that would be done by default. By
5311 * default they will receive broadcasts if the broadcast has specified an
5312 * explicit component or package name.
5313 * @hide
5314 */
5315 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005316 /**
5317 * If set, this broadcast is being sent from the shell.
5318 * @hide
5319 */
5320 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005321
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005322 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005323 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5324 * will not receive broadcasts.
5325 *
5326 * <em>This flag has no effect when used by an Instant App.</em>
5327 */
5328 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5329
5330 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005331 * @hide Flags that can't be changed with PendingIntent.
5332 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005333 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5334 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5335 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005336
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005337 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005338 // ---------------------------------------------------------------------
5339 // toUri() and parseUri() options.
5340
5341 /**
5342 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5343 * always has the "intent:" scheme. This syntax can be used when you want
5344 * to later disambiguate between URIs that are intended to describe an
5345 * Intent vs. all others that should be treated as raw URIs. When used
5346 * with {@link #parseUri}, any other scheme will result in a generic
5347 * VIEW action for that raw URI.
5348 */
5349 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005350
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005351 /**
5352 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5353 * always has the "android-app:" scheme. This is a variation of
5354 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5355 * http/https URI being delivered to a specific package name. The format
5356 * is:
5357 *
5358 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005359 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005360 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005361 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5362 * you must also include a scheme; including a path also requires both a host and a scheme.
5363 * The final #Intent; fragment can be used without a scheme, host, or path.
5364 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005365 * used with intents that have a {@link #setSelector}, since the base intent
5366 * will always have an explicit package name.</p>
5367 *
5368 * <p>Some examples of how this scheme maps to Intent objects:</p>
5369 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5370 * <colgroup align="left" />
5371 * <colgroup align="left" />
5372 * <thead>
5373 * <tr><th>URI</th> <th>Intent</th></tr>
5374 * </thead>
5375 *
5376 * <tbody>
5377 * <tr><td><code>android-app://com.example.app</code></td>
5378 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5379 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5380 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5381 * </table></td>
5382 * </tr>
5383 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5384 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5385 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5386 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5387 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5388 * </table></td>
5389 * </tr>
5390 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5391 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5392 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5393 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5394 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5395 * </table></td>
5396 * </tr>
5397 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5398 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5399 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5400 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5401 * </table></td>
5402 * </tr>
5403 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5404 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5405 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5406 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5407 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5408 * </table></td>
5409 * </tr>
5410 * <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>
5411 * <td><table border="" style="margin:0" >
5412 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5413 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5414 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5415 * </table></td>
5416 * </tr>
5417 * </tbody>
5418 * </table>
5419 */
5420 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5421
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005422 /**
5423 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5424 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5425 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5426 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5427 * generated Intent can not cause unexpected data access to happen.
5428 *
5429 * <p>If you do not trust the source of the URI being parsed, you should still do further
5430 * processing to protect yourself from it. In particular, when using it to start an
5431 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5432 * that can handle it.</p>
5433 */
5434 public static final int URI_ALLOW_UNSAFE = 1<<2;
5435
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005436 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005437
5438 private String mAction;
5439 private Uri mData;
5440 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005441 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005442 private ComponentName mComponent;
5443 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005444 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005445 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005446 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005447 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005448 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005449 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005450 /** Token to track instant app launches. Local only; do not copy cross-process. */
5451 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005452
5453 // ---------------------------------------------------------------------
5454
5455 /**
5456 * Create an empty intent.
5457 */
5458 public Intent() {
5459 }
5460
5461 /**
5462 * Copy constructor.
5463 */
5464 public Intent(Intent o) {
5465 this.mAction = o.mAction;
5466 this.mData = o.mData;
5467 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005468 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005469 this.mComponent = o.mComponent;
5470 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005471 this.mContentUserHint = o.mContentUserHint;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005472 this.mLaunchToken = o.mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005473 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005474 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005475 }
5476 if (o.mExtras != null) {
5477 this.mExtras = new Bundle(o.mExtras);
5478 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005479 if (o.mSourceBounds != null) {
5480 this.mSourceBounds = new Rect(o.mSourceBounds);
5481 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005482 if (o.mSelector != null) {
5483 this.mSelector = new Intent(o.mSelector);
5484 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005485 if (o.mClipData != null) {
5486 this.mClipData = new ClipData(o.mClipData);
5487 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005488 }
5489
5490 @Override
5491 public Object clone() {
5492 return new Intent(this);
5493 }
5494
5495 private Intent(Intent o, boolean all) {
5496 this.mAction = o.mAction;
5497 this.mData = o.mData;
5498 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005499 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005500 this.mComponent = o.mComponent;
5501 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005502 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005503 }
5504 }
5505
5506 /**
5507 * Make a clone of only the parts of the Intent that are relevant for
5508 * filter matching: the action, data, type, component, and categories.
5509 */
5510 public Intent cloneFilter() {
5511 return new Intent(this, false);
5512 }
5513
5514 /**
5515 * Create an intent with a given action. All other fields (data, type,
5516 * class) are null. Note that the action <em>must</em> be in a
5517 * namespace because Intents are used globally in the system -- for
5518 * example the system VIEW action is android.intent.action.VIEW; an
5519 * application's custom action would be something like
5520 * com.google.app.myapp.CUSTOM_ACTION.
5521 *
5522 * @param action The Intent action, such as ACTION_VIEW.
5523 */
5524 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005525 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005526 }
5527
5528 /**
5529 * Create an intent with a given action and for a given data url. Note
5530 * that the action <em>must</em> be in a namespace because Intents are
5531 * used globally in the system -- for example the system VIEW action is
5532 * android.intent.action.VIEW; an application's custom action would be
5533 * something like com.google.app.myapp.CUSTOM_ACTION.
5534 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005535 * <p><em>Note: scheme and host name matching in the Android framework is
5536 * case-sensitive, unlike the formal RFC. As a result,
5537 * you should always ensure that you write your Uri with these elements
5538 * using lower case letters, and normalize any Uris you receive from
5539 * outside of Android to ensure the scheme and host is lower case.</em></p>
5540 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005541 * @param action The Intent action, such as ACTION_VIEW.
5542 * @param uri The Intent data URI.
5543 */
5544 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005545 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005546 mData = uri;
5547 }
5548
5549 /**
5550 * Create an intent for a specific component. All other fields (action, data,
5551 * type, class) are null, though they can be modified later with explicit
5552 * calls. This provides a convenient way to create an intent that is
5553 * intended to execute a hard-coded class name, rather than relying on the
5554 * system to find an appropriate class for you; see {@link #setComponent}
5555 * for more information on the repercussions of this.
5556 *
5557 * @param packageContext A Context of the application package implementing
5558 * this class.
5559 * @param cls The component class that is to be used for the intent.
5560 *
5561 * @see #setClass
5562 * @see #setComponent
5563 * @see #Intent(String, android.net.Uri , Context, Class)
5564 */
5565 public Intent(Context packageContext, Class<?> cls) {
5566 mComponent = new ComponentName(packageContext, cls);
5567 }
5568
5569 /**
5570 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005571 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005572 * construct the Intent and then calling {@link #setClass} to set its
5573 * class.
5574 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005575 * <p><em>Note: scheme and host name matching in the Android framework is
5576 * case-sensitive, unlike the formal RFC. As a result,
5577 * you should always ensure that you write your Uri with these elements
5578 * using lower case letters, and normalize any Uris you receive from
5579 * outside of Android to ensure the scheme and host is lower case.</em></p>
5580 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005581 * @param action The Intent action, such as ACTION_VIEW.
5582 * @param uri The Intent data URI.
5583 * @param packageContext A Context of the application package implementing
5584 * this class.
5585 * @param cls The component class that is to be used for the intent.
5586 *
5587 * @see #Intent(String, android.net.Uri)
5588 * @see #Intent(Context, Class)
5589 * @see #setClass
5590 * @see #setComponent
5591 */
5592 public Intent(String action, Uri uri,
5593 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005594 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005595 mData = uri;
5596 mComponent = new ComponentName(packageContext, cls);
5597 }
5598
5599 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005600 * Create an intent to launch the main (root) activity of a task. This
5601 * is the Intent that is started when the application's is launched from
5602 * Home. For anything else that wants to launch an application in the
5603 * same way, it is important that they use an Intent structured the same
5604 * way, and can use this function to ensure this is the case.
5605 *
5606 * <p>The returned Intent has the given Activity component as its explicit
5607 * component, {@link #ACTION_MAIN} as its action, and includes the
5608 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5609 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5610 * to do that through {@link #addFlags(int)} on the returned Intent.
5611 *
5612 * @param mainActivity The main activity component that this Intent will
5613 * launch.
5614 * @return Returns a newly created Intent that can be used to launch the
5615 * activity as a main application entry.
5616 *
5617 * @see #setClass
5618 * @see #setComponent
5619 */
5620 public static Intent makeMainActivity(ComponentName mainActivity) {
5621 Intent intent = new Intent(ACTION_MAIN);
5622 intent.setComponent(mainActivity);
5623 intent.addCategory(CATEGORY_LAUNCHER);
5624 return intent;
5625 }
5626
5627 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005628 * Make an Intent for the main activity of an application, without
5629 * specifying a specific activity to run but giving a selector to find
5630 * the activity. This results in a final Intent that is structured
5631 * the same as when the application is launched from
5632 * Home. For anything else that wants to launch an application in the
5633 * same way, it is important that they use an Intent structured the same
5634 * way, and can use this function to ensure this is the case.
5635 *
5636 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5637 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5638 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5639 * to do that through {@link #addFlags(int)} on the returned Intent.
5640 *
5641 * @param selectorAction The action name of the Intent's selector.
5642 * @param selectorCategory The name of a category to add to the Intent's
5643 * selector.
5644 * @return Returns a newly created Intent that can be used to launch the
5645 * activity as a main application entry.
5646 *
5647 * @see #setSelector(Intent)
5648 */
5649 public static Intent makeMainSelectorActivity(String selectorAction,
5650 String selectorCategory) {
5651 Intent intent = new Intent(ACTION_MAIN);
5652 intent.addCategory(CATEGORY_LAUNCHER);
5653 Intent selector = new Intent();
5654 selector.setAction(selectorAction);
5655 selector.addCategory(selectorCategory);
5656 intent.setSelector(selector);
5657 return intent;
5658 }
5659
5660 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005661 * Make an Intent that can be used to re-launch an application's task
5662 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5663 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5664 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5665 *
5666 * @param mainActivity The activity component that is the root of the
5667 * task; this is the activity that has been published in the application's
5668 * manifest as the main launcher icon.
5669 *
5670 * @return Returns a newly created Intent that can be used to relaunch the
5671 * activity's task in its root state.
5672 */
5673 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5674 Intent intent = makeMainActivity(mainActivity);
5675 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5676 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5677 return intent;
5678 }
5679
5680 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005681 * Call {@link #parseUri} with 0 flags.
5682 * @deprecated Use {@link #parseUri} instead.
5683 */
5684 @Deprecated
5685 public static Intent getIntent(String uri) throws URISyntaxException {
5686 return parseUri(uri, 0);
5687 }
Tom Taylord4a47292009-12-21 13:59:18 -08005688
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005689 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005690 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005691 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005692 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005693 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005694 *
5695 * <p>The URI given here must not be relative -- that is, it must include
5696 * the scheme and full path.
5697 *
5698 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005699 * @param flags Additional processing flags. Either 0,
5700 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005701 *
5702 * @return Intent The newly created Intent object.
5703 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005704 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5705 * it bad (as parsed by the Uri class) or the Intent data within the
5706 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005707 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005708 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005709 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005710 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005711 int i = 0;
5712 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005713 final boolean androidApp = uri.startsWith("android-app:");
5714
5715 // Validate intent scheme if requested.
5716 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5717 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005718 Intent intent = new Intent(ACTION_VIEW);
5719 try {
5720 intent.setData(Uri.parse(uri));
5721 } catch (IllegalArgumentException e) {
5722 throw new URISyntaxException(uri, e.getMessage());
5723 }
5724 return intent;
5725 }
5726 }
Tom Taylord4a47292009-12-21 13:59:18 -08005727
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005728 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005729 // simple case
5730 if (i == -1) {
5731 if (!androidApp) {
5732 return new Intent(ACTION_VIEW, Uri.parse(uri));
5733 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005734
5735 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005736 } else if (!uri.startsWith("#Intent;", i)) {
5737 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005738 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005739 } else {
5740 i = -1;
5741 }
5742 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005743
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005744 // new format
5745 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005746 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005747 boolean explicitAction = false;
5748 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005749
5750 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005751 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005752 String data;
5753 if (i >= 0) {
5754 data = uri.substring(0, i);
5755 i += 8; // length of "#Intent;"
5756 } else {
5757 data = uri;
5758 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005759
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005760 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005761 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005762 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005763 if (eq < 0) eq = i-1;
5764 int semi = uri.indexOf(';', i);
5765 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005766
5767 // action
5768 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005769 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005770 if (!inSelector) {
5771 explicitAction = true;
5772 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005773 }
5774
5775 // categories
5776 else if (uri.startsWith("category=", i)) {
5777 intent.addCategory(value);
5778 }
5779
5780 // type
5781 else if (uri.startsWith("type=", i)) {
5782 intent.mType = value;
5783 }
5784
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005785 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005786 else if (uri.startsWith("launchFlags=", i)) {
5787 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005788 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5789 intent.mFlags &= ~IMMUTABLE_FLAGS;
5790 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005791 }
5792
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005793 // package
5794 else if (uri.startsWith("package=", i)) {
5795 intent.mPackage = value;
5796 }
5797
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005798 // component
5799 else if (uri.startsWith("component=", i)) {
5800 intent.mComponent = ComponentName.unflattenFromString(value);
5801 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005802
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005803 // scheme
5804 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005805 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005806 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005807 } else {
5808 scheme = value;
5809 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005810 }
5811
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005812 // source bounds
5813 else if (uri.startsWith("sourceBounds=", i)) {
5814 intent.mSourceBounds = Rect.unflattenFromString(value);
5815 }
5816
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005817 // selector
5818 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5819 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005820 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005821 }
5822
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005823 // extra
5824 else {
5825 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005826 // create Bundle if it doesn't already exist
5827 if (intent.mExtras == null) intent.mExtras = new Bundle();
5828 Bundle b = intent.mExtras;
5829 // add EXTRA
5830 if (uri.startsWith("S.", i)) b.putString(key, value);
5831 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5832 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5833 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5834 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5835 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5836 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5837 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5838 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5839 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5840 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005841
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005842 // move to the next item
5843 i = semi + 1;
5844 }
5845
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005846 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005847 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005848 if (baseIntent.mPackage == null) {
5849 baseIntent.setSelector(intent);
5850 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005851 intent = baseIntent;
5852 }
5853
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005854 if (data != null) {
5855 if (data.startsWith("intent:")) {
5856 data = data.substring(7);
5857 if (scheme != null) {
5858 data = scheme + ':' + data;
5859 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005860 } else if (data.startsWith("android-app:")) {
5861 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5862 // Correctly formed android-app, first part is package name.
5863 int end = data.indexOf('/', 14);
5864 if (end < 0) {
5865 // All we have is a package name.
5866 intent.mPackage = data.substring(14);
5867 if (!explicitAction) {
5868 intent.setAction(ACTION_MAIN);
5869 }
5870 data = "";
5871 } else {
5872 // Target the Intent at the given package name always.
5873 String authority = null;
5874 intent.mPackage = data.substring(14, end);
5875 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005876 if ((end+1) < data.length()) {
5877 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5878 // Found a scheme, remember it.
5879 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005880 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005881 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5882 // Found a authority, remember it.
5883 authority = data.substring(end+1, newEnd);
5884 end = newEnd;
5885 }
5886 } else {
5887 // All we have is a scheme.
5888 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005889 }
5890 }
5891 if (scheme == null) {
5892 // If there was no scheme, then this just targets the package.
5893 if (!explicitAction) {
5894 intent.setAction(ACTION_MAIN);
5895 }
5896 data = "";
5897 } else if (authority == null) {
5898 data = scheme + ":";
5899 } else {
5900 data = scheme + "://" + authority + data.substring(end);
5901 }
5902 }
5903 } else {
5904 data = "";
5905 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005906 }
Tom Taylord4a47292009-12-21 13:59:18 -08005907
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005908 if (data.length() > 0) {
5909 try {
5910 intent.mData = Uri.parse(data);
5911 } catch (IllegalArgumentException e) {
5912 throw new URISyntaxException(uri, e.getMessage());
5913 }
5914 }
5915 }
Tom Taylord4a47292009-12-21 13:59:18 -08005916
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005917 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005918
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005919 } catch (IndexOutOfBoundsException e) {
5920 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5921 }
5922 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005923
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005924 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005925 return getIntentOld(uri, 0);
5926 }
5927
5928 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005929 Intent intent;
5930
5931 int i = uri.lastIndexOf('#');
5932 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005933 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005934 final int intentFragmentStart = i;
5935 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005936
5937 i++;
5938
5939 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005940 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005941 i += 7;
5942 int j = uri.indexOf(')', i);
5943 action = uri.substring(i, j);
5944 i = j + 1;
5945 }
5946
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005947 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005948
5949 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005950 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005951 i += 11;
5952 int j = uri.indexOf(')', i);
5953 while (i < j) {
5954 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005955 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005956 if (i < sep) {
5957 intent.addCategory(uri.substring(i, sep));
5958 }
5959 i = sep + 1;
5960 }
5961 i = j + 1;
5962 }
5963
5964 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005965 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005966 i += 5;
5967 int j = uri.indexOf(')', i);
5968 intent.mType = uri.substring(i, j);
5969 i = j + 1;
5970 }
5971
5972 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005973 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005974 i += 12;
5975 int j = uri.indexOf(')', i);
5976 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005977 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5978 intent.mFlags &= ~IMMUTABLE_FLAGS;
5979 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005980 i = j + 1;
5981 }
5982
5983 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005984 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005985 i += 10;
5986 int j = uri.indexOf(')', i);
5987 int sep = uri.indexOf('!', i);
5988 if (sep >= 0 && sep < j) {
5989 String pkg = uri.substring(i, sep);
5990 String cls = uri.substring(sep + 1, j);
5991 intent.mComponent = new ComponentName(pkg, cls);
5992 }
5993 i = j + 1;
5994 }
5995
5996 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005997 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005998 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005999
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006000 final int closeParen = uri.indexOf(')', i);
6001 if (closeParen == -1) throw new URISyntaxException(uri,
6002 "EXTRA missing trailing ')'", i);
6003
6004 while (i < closeParen) {
6005 // fetch the key value
6006 int j = uri.indexOf('=', i);
6007 if (j <= i + 1 || i >= closeParen) {
6008 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6009 }
6010 char type = uri.charAt(i);
6011 i++;
6012 String key = uri.substring(i, j);
6013 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006014
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006015 // get type-value
6016 j = uri.indexOf('!', i);
6017 if (j == -1 || j >= closeParen) j = closeParen;
6018 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6019 String value = uri.substring(i, j);
6020 i = j;
6021
6022 // create Bundle if it doesn't already exist
6023 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006024
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006025 // add item to bundle
6026 try {
6027 switch (type) {
6028 case 'S':
6029 intent.mExtras.putString(key, Uri.decode(value));
6030 break;
6031 case 'B':
6032 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6033 break;
6034 case 'b':
6035 intent.mExtras.putByte(key, Byte.parseByte(value));
6036 break;
6037 case 'c':
6038 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6039 break;
6040 case 'd':
6041 intent.mExtras.putDouble(key, Double.parseDouble(value));
6042 break;
6043 case 'f':
6044 intent.mExtras.putFloat(key, Float.parseFloat(value));
6045 break;
6046 case 'i':
6047 intent.mExtras.putInt(key, Integer.parseInt(value));
6048 break;
6049 case 'l':
6050 intent.mExtras.putLong(key, Long.parseLong(value));
6051 break;
6052 case 's':
6053 intent.mExtras.putShort(key, Short.parseShort(value));
6054 break;
6055 default:
6056 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6057 }
6058 } catch (NumberFormatException e) {
6059 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6060 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006061
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006062 char ch = uri.charAt(i);
6063 if (ch == ')') break;
6064 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6065 i++;
6066 }
6067 }
6068
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006069 if (isIntentFragment) {
6070 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6071 } else {
6072 intent.mData = Uri.parse(uri);
6073 }
Tom Taylord4a47292009-12-21 13:59:18 -08006074
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006075 if (intent.mAction == null) {
6076 // By default, if no action is specified, then use VIEW.
6077 intent.mAction = ACTION_VIEW;
6078 }
6079
6080 } else {
6081 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6082 }
6083
6084 return intent;
6085 }
6086
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006087 /** @hide */
6088 public interface CommandOptionHandler {
6089 boolean handleOption(String opt, ShellCommand cmd);
6090 }
6091
6092 /** @hide */
6093 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6094 throws URISyntaxException {
6095 Intent intent = new Intent();
6096 Intent baseIntent = intent;
6097 boolean hasIntentInfo = false;
6098
6099 Uri data = null;
6100 String type = null;
6101
6102 String opt;
6103 while ((opt=cmd.getNextOption()) != null) {
6104 switch (opt) {
6105 case "-a":
6106 intent.setAction(cmd.getNextArgRequired());
6107 if (intent == baseIntent) {
6108 hasIntentInfo = true;
6109 }
6110 break;
6111 case "-d":
6112 data = Uri.parse(cmd.getNextArgRequired());
6113 if (intent == baseIntent) {
6114 hasIntentInfo = true;
6115 }
6116 break;
6117 case "-t":
6118 type = cmd.getNextArgRequired();
6119 if (intent == baseIntent) {
6120 hasIntentInfo = true;
6121 }
6122 break;
6123 case "-c":
6124 intent.addCategory(cmd.getNextArgRequired());
6125 if (intent == baseIntent) {
6126 hasIntentInfo = true;
6127 }
6128 break;
6129 case "-e":
6130 case "--es": {
6131 String key = cmd.getNextArgRequired();
6132 String value = cmd.getNextArgRequired();
6133 intent.putExtra(key, value);
6134 }
6135 break;
6136 case "--esn": {
6137 String key = cmd.getNextArgRequired();
6138 intent.putExtra(key, (String) null);
6139 }
6140 break;
6141 case "--ei": {
6142 String key = cmd.getNextArgRequired();
6143 String value = cmd.getNextArgRequired();
6144 intent.putExtra(key, Integer.decode(value));
6145 }
6146 break;
6147 case "--eu": {
6148 String key = cmd.getNextArgRequired();
6149 String value = cmd.getNextArgRequired();
6150 intent.putExtra(key, Uri.parse(value));
6151 }
6152 break;
6153 case "--ecn": {
6154 String key = cmd.getNextArgRequired();
6155 String value = cmd.getNextArgRequired();
6156 ComponentName cn = ComponentName.unflattenFromString(value);
6157 if (cn == null)
6158 throw new IllegalArgumentException("Bad component name: " + value);
6159 intent.putExtra(key, cn);
6160 }
6161 break;
6162 case "--eia": {
6163 String key = cmd.getNextArgRequired();
6164 String value = cmd.getNextArgRequired();
6165 String[] strings = value.split(",");
6166 int[] list = new int[strings.length];
6167 for (int i = 0; i < strings.length; i++) {
6168 list[i] = Integer.decode(strings[i]);
6169 }
6170 intent.putExtra(key, list);
6171 }
6172 break;
6173 case "--eial": {
6174 String key = cmd.getNextArgRequired();
6175 String value = cmd.getNextArgRequired();
6176 String[] strings = value.split(",");
6177 ArrayList<Integer> list = new ArrayList<>(strings.length);
6178 for (int i = 0; i < strings.length; i++) {
6179 list.add(Integer.decode(strings[i]));
6180 }
6181 intent.putExtra(key, list);
6182 }
6183 break;
6184 case "--el": {
6185 String key = cmd.getNextArgRequired();
6186 String value = cmd.getNextArgRequired();
6187 intent.putExtra(key, Long.valueOf(value));
6188 }
6189 break;
6190 case "--ela": {
6191 String key = cmd.getNextArgRequired();
6192 String value = cmd.getNextArgRequired();
6193 String[] strings = value.split(",");
6194 long[] list = new long[strings.length];
6195 for (int i = 0; i < strings.length; i++) {
6196 list[i] = Long.valueOf(strings[i]);
6197 }
6198 intent.putExtra(key, list);
6199 hasIntentInfo = true;
6200 }
6201 break;
6202 case "--elal": {
6203 String key = cmd.getNextArgRequired();
6204 String value = cmd.getNextArgRequired();
6205 String[] strings = value.split(",");
6206 ArrayList<Long> list = new ArrayList<>(strings.length);
6207 for (int i = 0; i < strings.length; i++) {
6208 list.add(Long.valueOf(strings[i]));
6209 }
6210 intent.putExtra(key, list);
6211 hasIntentInfo = true;
6212 }
6213 break;
6214 case "--ef": {
6215 String key = cmd.getNextArgRequired();
6216 String value = cmd.getNextArgRequired();
6217 intent.putExtra(key, Float.valueOf(value));
6218 hasIntentInfo = true;
6219 }
6220 break;
6221 case "--efa": {
6222 String key = cmd.getNextArgRequired();
6223 String value = cmd.getNextArgRequired();
6224 String[] strings = value.split(",");
6225 float[] list = new float[strings.length];
6226 for (int i = 0; i < strings.length; i++) {
6227 list[i] = Float.valueOf(strings[i]);
6228 }
6229 intent.putExtra(key, list);
6230 hasIntentInfo = true;
6231 }
6232 break;
6233 case "--efal": {
6234 String key = cmd.getNextArgRequired();
6235 String value = cmd.getNextArgRequired();
6236 String[] strings = value.split(",");
6237 ArrayList<Float> list = new ArrayList<>(strings.length);
6238 for (int i = 0; i < strings.length; i++) {
6239 list.add(Float.valueOf(strings[i]));
6240 }
6241 intent.putExtra(key, list);
6242 hasIntentInfo = true;
6243 }
6244 break;
6245 case "--esa": {
6246 String key = cmd.getNextArgRequired();
6247 String value = cmd.getNextArgRequired();
6248 // Split on commas unless they are preceeded by an escape.
6249 // The escape character must be escaped for the string and
6250 // again for the regex, thus four escape characters become one.
6251 String[] strings = value.split("(?<!\\\\),");
6252 intent.putExtra(key, strings);
6253 hasIntentInfo = true;
6254 }
6255 break;
6256 case "--esal": {
6257 String key = cmd.getNextArgRequired();
6258 String value = cmd.getNextArgRequired();
6259 // Split on commas unless they are preceeded by an escape.
6260 // The escape character must be escaped for the string and
6261 // again for the regex, thus four escape characters become one.
6262 String[] strings = value.split("(?<!\\\\),");
6263 ArrayList<String> list = new ArrayList<>(strings.length);
6264 for (int i = 0; i < strings.length; i++) {
6265 list.add(strings[i]);
6266 }
6267 intent.putExtra(key, list);
6268 hasIntentInfo = true;
6269 }
6270 break;
6271 case "--ez": {
6272 String key = cmd.getNextArgRequired();
6273 String value = cmd.getNextArgRequired().toLowerCase();
6274 // Boolean.valueOf() results in false for anything that is not "true", which is
6275 // error-prone in shell commands
6276 boolean arg;
6277 if ("true".equals(value) || "t".equals(value)) {
6278 arg = true;
6279 } else if ("false".equals(value) || "f".equals(value)) {
6280 arg = false;
6281 } else {
6282 try {
6283 arg = Integer.decode(value) != 0;
6284 } catch (NumberFormatException ex) {
6285 throw new IllegalArgumentException("Invalid boolean value: " + value);
6286 }
6287 }
6288
6289 intent.putExtra(key, arg);
6290 }
6291 break;
6292 case "-n": {
6293 String str = cmd.getNextArgRequired();
6294 ComponentName cn = ComponentName.unflattenFromString(str);
6295 if (cn == null)
6296 throw new IllegalArgumentException("Bad component name: " + str);
6297 intent.setComponent(cn);
6298 if (intent == baseIntent) {
6299 hasIntentInfo = true;
6300 }
6301 }
6302 break;
6303 case "-p": {
6304 String str = cmd.getNextArgRequired();
6305 intent.setPackage(str);
6306 if (intent == baseIntent) {
6307 hasIntentInfo = true;
6308 }
6309 }
6310 break;
6311 case "-f":
6312 String str = cmd.getNextArgRequired();
6313 intent.setFlags(Integer.decode(str).intValue());
6314 break;
6315 case "--grant-read-uri-permission":
6316 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6317 break;
6318 case "--grant-write-uri-permission":
6319 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6320 break;
6321 case "--grant-persistable-uri-permission":
6322 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6323 break;
6324 case "--grant-prefix-uri-permission":
6325 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6326 break;
6327 case "--exclude-stopped-packages":
6328 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6329 break;
6330 case "--include-stopped-packages":
6331 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6332 break;
6333 case "--debug-log-resolution":
6334 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6335 break;
6336 case "--activity-brought-to-front":
6337 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6338 break;
6339 case "--activity-clear-top":
6340 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6341 break;
6342 case "--activity-clear-when-task-reset":
6343 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6344 break;
6345 case "--activity-exclude-from-recents":
6346 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6347 break;
6348 case "--activity-launched-from-history":
6349 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6350 break;
6351 case "--activity-multiple-task":
6352 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6353 break;
6354 case "--activity-no-animation":
6355 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6356 break;
6357 case "--activity-no-history":
6358 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6359 break;
6360 case "--activity-no-user-action":
6361 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6362 break;
6363 case "--activity-previous-is-top":
6364 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6365 break;
6366 case "--activity-reorder-to-front":
6367 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6368 break;
6369 case "--activity-reset-task-if-needed":
6370 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6371 break;
6372 case "--activity-single-top":
6373 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6374 break;
6375 case "--activity-clear-task":
6376 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6377 break;
6378 case "--activity-task-on-home":
6379 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6380 break;
6381 case "--receiver-registered-only":
6382 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6383 break;
6384 case "--receiver-replace-pending":
6385 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6386 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006387 case "--receiver-foreground":
6388 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6389 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006390 case "--receiver-no-abort":
6391 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6392 break;
6393 case "--receiver-include-background":
6394 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6395 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006396 case "--selector":
6397 intent.setDataAndType(data, type);
6398 intent = new Intent();
6399 break;
6400 default:
6401 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6402 // Okay, caller handled this option.
6403 } else {
6404 throw new IllegalArgumentException("Unknown option: " + opt);
6405 }
6406 break;
6407 }
6408 }
6409 intent.setDataAndType(data, type);
6410
6411 final boolean hasSelector = intent != baseIntent;
6412 if (hasSelector) {
6413 // A selector was specified; fix up.
6414 baseIntent.setSelector(intent);
6415 intent = baseIntent;
6416 }
6417
6418 String arg = cmd.getNextArg();
6419 baseIntent = null;
6420 if (arg == null) {
6421 if (hasSelector) {
6422 // If a selector has been specified, and no arguments
6423 // have been supplied for the main Intent, then we can
6424 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6425 // need to have a component name specified yet, the
6426 // selector will take care of that.
6427 baseIntent = new Intent(Intent.ACTION_MAIN);
6428 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6429 }
6430 } else if (arg.indexOf(':') >= 0) {
6431 // The argument is a URI. Fully parse it, and use that result
6432 // to fill in any data not specified so far.
6433 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6434 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6435 } else if (arg.indexOf('/') >= 0) {
6436 // The argument is a component name. Build an Intent to launch
6437 // it.
6438 baseIntent = new Intent(Intent.ACTION_MAIN);
6439 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6440 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6441 } else {
6442 // Assume the argument is a package name.
6443 baseIntent = new Intent(Intent.ACTION_MAIN);
6444 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6445 baseIntent.setPackage(arg);
6446 }
6447 if (baseIntent != null) {
6448 Bundle extras = intent.getExtras();
6449 intent.replaceExtras((Bundle)null);
6450 Bundle uriExtras = baseIntent.getExtras();
6451 baseIntent.replaceExtras((Bundle)null);
6452 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6453 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6454 for (String c : cats) {
6455 baseIntent.removeCategory(c);
6456 }
6457 }
6458 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6459 if (extras == null) {
6460 extras = uriExtras;
6461 } else if (uriExtras != null) {
6462 uriExtras.putAll(extras);
6463 extras = uriExtras;
6464 }
6465 intent.replaceExtras(extras);
6466 hasIntentInfo = true;
6467 }
6468
6469 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6470 return intent;
6471 }
6472
6473 /** @hide */
6474 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6475 final String[] lines = new String[] {
6476 "<INTENT> specifications include these flags and arguments:",
6477 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6478 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6479 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6480 " [--esn <EXTRA_KEY> ...]",
6481 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6482 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6483 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6484 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6485 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6486 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6487 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6488 " (mutiple extras passed as Integer[])",
6489 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6490 " (mutiple extras passed as List<Integer>)",
6491 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6492 " (mutiple extras passed as Long[])",
6493 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6494 " (mutiple extras passed as List<Long>)",
6495 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6496 " (mutiple extras passed as Float[])",
6497 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6498 " (mutiple extras passed as List<Float>)",
6499 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6500 " (mutiple extras passed as String[]; to embed a comma into a string,",
6501 " escape it using \"\\,\")",
6502 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6503 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6504 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006505 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006506 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6507 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6508 " [--debug-log-resolution] [--exclude-stopped-packages]",
6509 " [--include-stopped-packages]",
6510 " [--activity-brought-to-front] [--activity-clear-top]",
6511 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6512 " [--activity-launched-from-history] [--activity-multiple-task]",
6513 " [--activity-no-animation] [--activity-no-history]",
6514 " [--activity-no-user-action] [--activity-previous-is-top]",
6515 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6516 " [--activity-single-top] [--activity-clear-task]",
6517 " [--activity-task-on-home]",
6518 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08006519 " [--receiver-foreground] [--receiver-no-abort]",
6520 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006521 " [--selector]",
6522 " [<URI> | <PACKAGE> | <COMPONENT>]"
6523 };
6524 for (String line : lines) {
6525 pw.print(prefix);
6526 pw.println(line);
6527 }
6528 }
6529
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006530 /**
6531 * Retrieve the general action to be performed, such as
6532 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6533 * the information in the intent should be interpreted -- most importantly,
6534 * what to do with the data returned by {@link #getData}.
6535 *
6536 * @return The action of this intent or null if none is specified.
6537 *
6538 * @see #setAction
6539 */
6540 public String getAction() {
6541 return mAction;
6542 }
6543
6544 /**
6545 * Retrieve data this intent is operating on. This URI specifies the name
6546 * of the data; often it uses the content: scheme, specifying data in a
6547 * content provider. Other schemes may be handled by specific activities,
6548 * such as http: by the web browser.
6549 *
6550 * @return The URI of the data this intent is targeting or null.
6551 *
6552 * @see #getScheme
6553 * @see #setData
6554 */
6555 public Uri getData() {
6556 return mData;
6557 }
6558
6559 /**
6560 * The same as {@link #getData()}, but returns the URI as an encoded
6561 * String.
6562 */
6563 public String getDataString() {
6564 return mData != null ? mData.toString() : null;
6565 }
6566
6567 /**
6568 * Return the scheme portion of the intent's data. If the data is null or
6569 * does not include a scheme, null is returned. Otherwise, the scheme
6570 * prefix without the final ':' is returned, i.e. "http".
6571 *
6572 * <p>This is the same as calling getData().getScheme() (and checking for
6573 * null data).
6574 *
6575 * @return The scheme of this intent.
6576 *
6577 * @see #getData
6578 */
6579 public String getScheme() {
6580 return mData != null ? mData.getScheme() : null;
6581 }
6582
6583 /**
6584 * Retrieve any explicit MIME type included in the intent. This is usually
6585 * null, as the type is determined by the intent data.
6586 *
6587 * @return If a type was manually set, it is returned; else null is
6588 * returned.
6589 *
6590 * @see #resolveType(ContentResolver)
6591 * @see #setType
6592 */
6593 public String getType() {
6594 return mType;
6595 }
6596
6597 /**
6598 * Return the MIME data type of this intent. If the type field is
6599 * explicitly set, that is simply returned. Otherwise, if the data is set,
6600 * the type of that data is returned. If neither fields are set, a null is
6601 * returned.
6602 *
6603 * @return The MIME type of this intent.
6604 *
6605 * @see #getType
6606 * @see #resolveType(ContentResolver)
6607 */
6608 public String resolveType(Context context) {
6609 return resolveType(context.getContentResolver());
6610 }
6611
6612 /**
6613 * Return the MIME data type of this intent. If the type field is
6614 * explicitly set, that is simply returned. Otherwise, if the data is set,
6615 * the type of that data is returned. If neither fields are set, a null is
6616 * returned.
6617 *
6618 * @param resolver A ContentResolver that can be used to determine the MIME
6619 * type of the intent's data.
6620 *
6621 * @return The MIME type of this intent.
6622 *
6623 * @see #getType
6624 * @see #resolveType(Context)
6625 */
6626 public String resolveType(ContentResolver resolver) {
6627 if (mType != null) {
6628 return mType;
6629 }
6630 if (mData != null) {
6631 if ("content".equals(mData.getScheme())) {
6632 return resolver.getType(mData);
6633 }
6634 }
6635 return null;
6636 }
6637
6638 /**
6639 * Return the MIME data type of this intent, only if it will be needed for
6640 * intent resolution. This is not generally useful for application code;
6641 * it is used by the frameworks for communicating with back-end system
6642 * services.
6643 *
6644 * @param resolver A ContentResolver that can be used to determine the MIME
6645 * type of the intent's data.
6646 *
6647 * @return The MIME type of this intent, or null if it is unknown or not
6648 * needed.
6649 */
6650 public String resolveTypeIfNeeded(ContentResolver resolver) {
6651 if (mComponent != null) {
6652 return mType;
6653 }
6654 return resolveType(resolver);
6655 }
6656
6657 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006658 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006659 *
6660 * @param category The category to check.
6661 *
6662 * @return boolean True if the intent contains the category, else false.
6663 *
6664 * @see #getCategories
6665 * @see #addCategory
6666 */
6667 public boolean hasCategory(String category) {
6668 return mCategories != null && mCategories.contains(category);
6669 }
6670
6671 /**
6672 * Return the set of all categories in the intent. If there are no categories,
6673 * returns NULL.
6674 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006675 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006676 *
6677 * @see #hasCategory
6678 * @see #addCategory
6679 */
6680 public Set<String> getCategories() {
6681 return mCategories;
6682 }
6683
6684 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006685 * Return the specific selector associated with this Intent. If there is
6686 * none, returns null. See {@link #setSelector} for more information.
6687 *
6688 * @see #setSelector
6689 */
6690 public Intent getSelector() {
6691 return mSelector;
6692 }
6693
6694 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006695 * Return the {@link ClipData} associated with this Intent. If there is
6696 * none, returns null. See {@link #setClipData} for more information.
6697 *
John Spurlock125d1332013-11-25 11:58:37 -05006698 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006699 */
6700 public ClipData getClipData() {
6701 return mClipData;
6702 }
6703
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006704 /** @hide */
6705 public int getContentUserHint() {
6706 return mContentUserHint;
6707 }
6708
Todd Kennedyb3b431302017-03-20 16:05:48 -07006709 /** @hide */
6710 public String getLaunchToken() {
6711 return mLaunchToken;
6712 }
6713
6714 /** @hide */
6715 public void setLaunchToken(String launchToken) {
6716 mLaunchToken = launchToken;
6717 }
6718
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006719 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006720 * Sets the ClassLoader that will be used when unmarshalling
6721 * any Parcelable values from the extras of this Intent.
6722 *
6723 * @param loader a ClassLoader, or null to use the default loader
6724 * at the time of unmarshalling.
6725 */
6726 public void setExtrasClassLoader(ClassLoader loader) {
6727 if (mExtras != null) {
6728 mExtras.setClassLoader(loader);
6729 }
6730 }
6731
6732 /**
6733 * Returns true if an extra value is associated with the given name.
6734 * @param name the extra's name
6735 * @return true if the given extra is present.
6736 */
6737 public boolean hasExtra(String name) {
6738 return mExtras != null && mExtras.containsKey(name);
6739 }
6740
6741 /**
6742 * Returns true if the Intent's extras contain a parcelled file descriptor.
6743 * @return true if the Intent contains a parcelled file descriptor.
6744 */
6745 public boolean hasFileDescriptors() {
6746 return mExtras != null && mExtras.hasFileDescriptors();
6747 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006748
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006749 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006750 public void setAllowFds(boolean allowFds) {
6751 if (mExtras != null) {
6752 mExtras.setAllowFds(allowFds);
6753 }
6754 }
6755
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006756 /** {@hide} */
6757 public void setDefusable(boolean defusable) {
6758 if (mExtras != null) {
6759 mExtras.setDefusable(defusable);
6760 }
6761 }
6762
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006763 /**
6764 * Retrieve extended data from the intent.
6765 *
6766 * @param name The name of the desired item.
6767 *
6768 * @return the value of an item that previously added with putExtra()
6769 * or null if none was found.
6770 *
6771 * @deprecated
6772 * @hide
6773 */
6774 @Deprecated
6775 public Object getExtra(String name) {
6776 return getExtra(name, null);
6777 }
6778
6779 /**
6780 * Retrieve extended data from the intent.
6781 *
6782 * @param name The name of the desired item.
6783 * @param defaultValue the value to be returned if no value of the desired
6784 * type is stored with the given name.
6785 *
6786 * @return the value of an item that previously added with putExtra()
6787 * or the default value if none was found.
6788 *
6789 * @see #putExtra(String, boolean)
6790 */
6791 public boolean getBooleanExtra(String name, boolean defaultValue) {
6792 return mExtras == null ? defaultValue :
6793 mExtras.getBoolean(name, defaultValue);
6794 }
6795
6796 /**
6797 * Retrieve extended data from the intent.
6798 *
6799 * @param name The name of the desired item.
6800 * @param defaultValue the value to be returned if no value of the desired
6801 * type is stored with the given name.
6802 *
6803 * @return the value of an item that previously added with putExtra()
6804 * or the default value if none was found.
6805 *
6806 * @see #putExtra(String, byte)
6807 */
6808 public byte getByteExtra(String name, byte defaultValue) {
6809 return mExtras == null ? defaultValue :
6810 mExtras.getByte(name, defaultValue);
6811 }
6812
6813 /**
6814 * Retrieve extended data from the intent.
6815 *
6816 * @param name The name of the desired item.
6817 * @param defaultValue the value to be returned if no value of the desired
6818 * type is stored with the given name.
6819 *
6820 * @return the value of an item that previously added with putExtra()
6821 * or the default value if none was found.
6822 *
6823 * @see #putExtra(String, short)
6824 */
6825 public short getShortExtra(String name, short defaultValue) {
6826 return mExtras == null ? defaultValue :
6827 mExtras.getShort(name, defaultValue);
6828 }
6829
6830 /**
6831 * Retrieve extended data from the intent.
6832 *
6833 * @param name The name of the desired item.
6834 * @param defaultValue the value to be returned if no value of the desired
6835 * type is stored with the given name.
6836 *
6837 * @return the value of an item that previously added with putExtra()
6838 * or the default value if none was found.
6839 *
6840 * @see #putExtra(String, char)
6841 */
6842 public char getCharExtra(String name, char defaultValue) {
6843 return mExtras == null ? defaultValue :
6844 mExtras.getChar(name, defaultValue);
6845 }
6846
6847 /**
6848 * Retrieve extended data from the intent.
6849 *
6850 * @param name The name of the desired item.
6851 * @param defaultValue the value to be returned if no value of the desired
6852 * type is stored with the given name.
6853 *
6854 * @return the value of an item that previously added with putExtra()
6855 * or the default value if none was found.
6856 *
6857 * @see #putExtra(String, int)
6858 */
6859 public int getIntExtra(String name, int defaultValue) {
6860 return mExtras == null ? defaultValue :
6861 mExtras.getInt(name, defaultValue);
6862 }
6863
6864 /**
6865 * Retrieve extended data from the intent.
6866 *
6867 * @param name The name of the desired item.
6868 * @param defaultValue the value to be returned if no value of the desired
6869 * type is stored with the given name.
6870 *
6871 * @return the value of an item that previously added with putExtra()
6872 * or the default value if none was found.
6873 *
6874 * @see #putExtra(String, long)
6875 */
6876 public long getLongExtra(String name, long defaultValue) {
6877 return mExtras == null ? defaultValue :
6878 mExtras.getLong(name, defaultValue);
6879 }
6880
6881 /**
6882 * Retrieve extended data from the intent.
6883 *
6884 * @param name The name of the desired item.
6885 * @param defaultValue the value to be returned if no value of the desired
6886 * type is stored with the given name.
6887 *
6888 * @return the value of an item that previously added with putExtra(),
6889 * or the default value if no such item is present
6890 *
6891 * @see #putExtra(String, float)
6892 */
6893 public float getFloatExtra(String name, float defaultValue) {
6894 return mExtras == null ? defaultValue :
6895 mExtras.getFloat(name, defaultValue);
6896 }
6897
6898 /**
6899 * Retrieve extended data from the intent.
6900 *
6901 * @param name The name of the desired item.
6902 * @param defaultValue the value to be returned if no value of the desired
6903 * type is stored with the given name.
6904 *
6905 * @return the value of an item that previously added with putExtra()
6906 * or the default value if none was found.
6907 *
6908 * @see #putExtra(String, double)
6909 */
6910 public double getDoubleExtra(String name, double defaultValue) {
6911 return mExtras == null ? defaultValue :
6912 mExtras.getDouble(name, defaultValue);
6913 }
6914
6915 /**
6916 * Retrieve extended data from the intent.
6917 *
6918 * @param name The name of the desired item.
6919 *
6920 * @return the value of an item that previously added with putExtra()
6921 * or null if no String value was found.
6922 *
6923 * @see #putExtra(String, String)
6924 */
6925 public String getStringExtra(String name) {
6926 return mExtras == null ? null : mExtras.getString(name);
6927 }
6928
6929 /**
6930 * Retrieve extended data from the intent.
6931 *
6932 * @param name The name of the desired item.
6933 *
6934 * @return the value of an item that previously added with putExtra()
6935 * or null if no CharSequence value was found.
6936 *
6937 * @see #putExtra(String, CharSequence)
6938 */
6939 public CharSequence getCharSequenceExtra(String name) {
6940 return mExtras == null ? null : mExtras.getCharSequence(name);
6941 }
6942
6943 /**
6944 * Retrieve extended data from the intent.
6945 *
6946 * @param name The name of the desired item.
6947 *
6948 * @return the value of an item that previously added with putExtra()
6949 * or null if no Parcelable value was found.
6950 *
6951 * @see #putExtra(String, Parcelable)
6952 */
6953 public <T extends Parcelable> T getParcelableExtra(String name) {
6954 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6955 }
6956
6957 /**
6958 * Retrieve extended data from the intent.
6959 *
6960 * @param name The name of the desired item.
6961 *
6962 * @return the value of an item that previously added with putExtra()
6963 * or null if no Parcelable[] value was found.
6964 *
6965 * @see #putExtra(String, Parcelable[])
6966 */
6967 public Parcelable[] getParcelableArrayExtra(String name) {
6968 return mExtras == null ? null : mExtras.getParcelableArray(name);
6969 }
6970
6971 /**
6972 * Retrieve extended data from the intent.
6973 *
6974 * @param name The name of the desired item.
6975 *
6976 * @return the value of an item that previously added with putExtra()
6977 * or null if no ArrayList<Parcelable> value was found.
6978 *
6979 * @see #putParcelableArrayListExtra(String, ArrayList)
6980 */
6981 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6982 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6983 }
6984
6985 /**
6986 * Retrieve extended data from the intent.
6987 *
6988 * @param name The name of the desired item.
6989 *
6990 * @return the value of an item that previously added with putExtra()
6991 * or null if no Serializable value was found.
6992 *
6993 * @see #putExtra(String, Serializable)
6994 */
6995 public Serializable getSerializableExtra(String name) {
6996 return mExtras == null ? null : mExtras.getSerializable(name);
6997 }
6998
6999 /**
7000 * Retrieve extended data from the intent.
7001 *
7002 * @param name The name of the desired item.
7003 *
7004 * @return the value of an item that previously added with putExtra()
7005 * or null if no ArrayList<Integer> value was found.
7006 *
7007 * @see #putIntegerArrayListExtra(String, ArrayList)
7008 */
7009 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
7010 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7011 }
7012
7013 /**
7014 * Retrieve extended data from the intent.
7015 *
7016 * @param name The name of the desired item.
7017 *
7018 * @return the value of an item that previously added with putExtra()
7019 * or null if no ArrayList<String> value was found.
7020 *
7021 * @see #putStringArrayListExtra(String, ArrayList)
7022 */
7023 public ArrayList<String> getStringArrayListExtra(String name) {
7024 return mExtras == null ? null : mExtras.getStringArrayList(name);
7025 }
7026
7027 /**
7028 * Retrieve extended data from the intent.
7029 *
7030 * @param name The name of the desired item.
7031 *
7032 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007033 * or null if no ArrayList<CharSequence> value was found.
7034 *
7035 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7036 */
7037 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
7038 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7039 }
7040
7041 /**
7042 * Retrieve extended data from the intent.
7043 *
7044 * @param name The name of the desired item.
7045 *
7046 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007047 * or null if no boolean array value was found.
7048 *
7049 * @see #putExtra(String, boolean[])
7050 */
7051 public boolean[] getBooleanArrayExtra(String name) {
7052 return mExtras == null ? null : mExtras.getBooleanArray(name);
7053 }
7054
7055 /**
7056 * Retrieve extended data from the intent.
7057 *
7058 * @param name The name of the desired item.
7059 *
7060 * @return the value of an item that previously added with putExtra()
7061 * or null if no byte array value was found.
7062 *
7063 * @see #putExtra(String, byte[])
7064 */
7065 public byte[] getByteArrayExtra(String name) {
7066 return mExtras == null ? null : mExtras.getByteArray(name);
7067 }
7068
7069 /**
7070 * Retrieve extended data from the intent.
7071 *
7072 * @param name The name of the desired item.
7073 *
7074 * @return the value of an item that previously added with putExtra()
7075 * or null if no short array value was found.
7076 *
7077 * @see #putExtra(String, short[])
7078 */
7079 public short[] getShortArrayExtra(String name) {
7080 return mExtras == null ? null : mExtras.getShortArray(name);
7081 }
7082
7083 /**
7084 * Retrieve extended data from the intent.
7085 *
7086 * @param name The name of the desired item.
7087 *
7088 * @return the value of an item that previously added with putExtra()
7089 * or null if no char array value was found.
7090 *
7091 * @see #putExtra(String, char[])
7092 */
7093 public char[] getCharArrayExtra(String name) {
7094 return mExtras == null ? null : mExtras.getCharArray(name);
7095 }
7096
7097 /**
7098 * Retrieve extended data from the intent.
7099 *
7100 * @param name The name of the desired item.
7101 *
7102 * @return the value of an item that previously added with putExtra()
7103 * or null if no int array value was found.
7104 *
7105 * @see #putExtra(String, int[])
7106 */
7107 public int[] getIntArrayExtra(String name) {
7108 return mExtras == null ? null : mExtras.getIntArray(name);
7109 }
7110
7111 /**
7112 * Retrieve extended data from the intent.
7113 *
7114 * @param name The name of the desired item.
7115 *
7116 * @return the value of an item that previously added with putExtra()
7117 * or null if no long array value was found.
7118 *
7119 * @see #putExtra(String, long[])
7120 */
7121 public long[] getLongArrayExtra(String name) {
7122 return mExtras == null ? null : mExtras.getLongArray(name);
7123 }
7124
7125 /**
7126 * Retrieve extended data from the intent.
7127 *
7128 * @param name The name of the desired item.
7129 *
7130 * @return the value of an item that previously added with putExtra()
7131 * or null if no float array value was found.
7132 *
7133 * @see #putExtra(String, float[])
7134 */
7135 public float[] getFloatArrayExtra(String name) {
7136 return mExtras == null ? null : mExtras.getFloatArray(name);
7137 }
7138
7139 /**
7140 * Retrieve extended data from the intent.
7141 *
7142 * @param name The name of the desired item.
7143 *
7144 * @return the value of an item that previously added with putExtra()
7145 * or null if no double array value was found.
7146 *
7147 * @see #putExtra(String, double[])
7148 */
7149 public double[] getDoubleArrayExtra(String name) {
7150 return mExtras == null ? null : mExtras.getDoubleArray(name);
7151 }
7152
7153 /**
7154 * Retrieve extended data from the intent.
7155 *
7156 * @param name The name of the desired item.
7157 *
7158 * @return the value of an item that previously added with putExtra()
7159 * or null if no String array value was found.
7160 *
7161 * @see #putExtra(String, String[])
7162 */
7163 public String[] getStringArrayExtra(String name) {
7164 return mExtras == null ? null : mExtras.getStringArray(name);
7165 }
7166
7167 /**
7168 * Retrieve extended data from the intent.
7169 *
7170 * @param name The name of the desired item.
7171 *
7172 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007173 * or null if no CharSequence array value was found.
7174 *
7175 * @see #putExtra(String, CharSequence[])
7176 */
7177 public CharSequence[] getCharSequenceArrayExtra(String name) {
7178 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7179 }
7180
7181 /**
7182 * Retrieve extended data from the intent.
7183 *
7184 * @param name The name of the desired item.
7185 *
7186 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007187 * or null if no Bundle value was found.
7188 *
7189 * @see #putExtra(String, Bundle)
7190 */
7191 public Bundle getBundleExtra(String name) {
7192 return mExtras == null ? null : mExtras.getBundle(name);
7193 }
7194
7195 /**
7196 * Retrieve extended data from the intent.
7197 *
7198 * @param name The name of the desired item.
7199 *
7200 * @return the value of an item that previously added with putExtra()
7201 * or null if no IBinder value was found.
7202 *
7203 * @see #putExtra(String, IBinder)
7204 *
7205 * @deprecated
7206 * @hide
7207 */
7208 @Deprecated
7209 public IBinder getIBinderExtra(String name) {
7210 return mExtras == null ? null : mExtras.getIBinder(name);
7211 }
7212
7213 /**
7214 * Retrieve extended data from the intent.
7215 *
7216 * @param name The name of the desired item.
7217 * @param defaultValue The default value to return in case no item is
7218 * associated with the key 'name'
7219 *
7220 * @return the value of an item that previously added with putExtra()
7221 * or defaultValue if none was found.
7222 *
7223 * @see #putExtra
7224 *
7225 * @deprecated
7226 * @hide
7227 */
7228 @Deprecated
7229 public Object getExtra(String name, Object defaultValue) {
7230 Object result = defaultValue;
7231 if (mExtras != null) {
7232 Object result2 = mExtras.get(name);
7233 if (result2 != null) {
7234 result = result2;
7235 }
7236 }
7237
7238 return result;
7239 }
7240
7241 /**
7242 * Retrieves a map of extended data from the intent.
7243 *
7244 * @return the map of all extras previously added with putExtra(),
7245 * or null if none have been added.
7246 */
7247 public Bundle getExtras() {
7248 return (mExtras != null)
7249 ? new Bundle(mExtras)
7250 : null;
7251 }
7252
7253 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007254 * Filter extras to only basic types.
7255 * @hide
7256 */
7257 public void removeUnsafeExtras() {
7258 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007259 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007260 }
7261 }
7262
7263 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007264 * Retrieve any special flags associated with this intent. You will
7265 * normally just set them with {@link #setFlags} and let the system
7266 * take the appropriate action with them.
7267 *
7268 * @return int The currently set flags.
7269 *
7270 * @see #setFlags
7271 */
7272 public int getFlags() {
7273 return mFlags;
7274 }
7275
Dianne Hackborne7f97212011-02-24 14:40:20 -08007276 /** @hide */
7277 public boolean isExcludingStopped() {
7278 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7279 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7280 }
7281
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007282 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007283 * Retrieve the application package name this Intent is limited to. When
7284 * resolving an Intent, if non-null this limits the resolution to only
7285 * components in the given application package.
7286 *
7287 * @return The name of the application package for the Intent.
7288 *
7289 * @see #resolveActivity
7290 * @see #setPackage
7291 */
7292 public String getPackage() {
7293 return mPackage;
7294 }
7295
7296 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007297 * Retrieve the concrete component associated with the intent. When receiving
7298 * an intent, this is the component that was found to best handle it (that is,
7299 * yourself) and will always be non-null; in all other cases it will be
7300 * null unless explicitly set.
7301 *
7302 * @return The name of the application component to handle the intent.
7303 *
7304 * @see #resolveActivity
7305 * @see #setComponent
7306 */
7307 public ComponentName getComponent() {
7308 return mComponent;
7309 }
7310
7311 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007312 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7313 * used as a hint to the receiver for animations and the like. Null means that there
7314 * is no source bounds.
7315 */
7316 public Rect getSourceBounds() {
7317 return mSourceBounds;
7318 }
7319
7320 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007321 * Return the Activity component that should be used to handle this intent.
7322 * The appropriate component is determined based on the information in the
7323 * intent, evaluated as follows:
7324 *
7325 * <p>If {@link #getComponent} returns an explicit class, that is returned
7326 * without any further consideration.
7327 *
7328 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7329 * category to be considered.
7330 *
7331 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7332 * action.
7333 *
7334 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7335 * this type.
7336 *
7337 * <p>If {@link #addCategory} has added any categories, the activity must
7338 * handle ALL of the categories specified.
7339 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007340 * <p>If {@link #getPackage} is non-NULL, only activity components in
7341 * that application package will be considered.
7342 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007343 * <p>If there are no activities that satisfy all of these conditions, a
7344 * null string is returned.
7345 *
7346 * <p>If multiple activities are found to satisfy the intent, the one with
7347 * the highest priority will be used. If there are multiple activities
7348 * with the same priority, the system will either pick the best activity
7349 * based on user preference, or resolve to a system class that will allow
7350 * the user to pick an activity and forward from there.
7351 *
7352 * <p>This method is implemented simply by calling
7353 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7354 * true.</p>
7355 * <p> This API is called for you as part of starting an activity from an
7356 * intent. You do not normally need to call it yourself.</p>
7357 *
7358 * @param pm The package manager with which to resolve the Intent.
7359 *
7360 * @return Name of the component implementing an activity that can
7361 * display the intent.
7362 *
7363 * @see #setComponent
7364 * @see #getComponent
7365 * @see #resolveActivityInfo
7366 */
7367 public ComponentName resolveActivity(PackageManager pm) {
7368 if (mComponent != null) {
7369 return mComponent;
7370 }
7371
7372 ResolveInfo info = pm.resolveActivity(
7373 this, PackageManager.MATCH_DEFAULT_ONLY);
7374 if (info != null) {
7375 return new ComponentName(
7376 info.activityInfo.applicationInfo.packageName,
7377 info.activityInfo.name);
7378 }
7379
7380 return null;
7381 }
7382
7383 /**
7384 * Resolve the Intent into an {@link ActivityInfo}
7385 * describing the activity that should execute the intent. Resolution
7386 * follows the same rules as described for {@link #resolveActivity}, but
7387 * you get back the completely information about the resolved activity
7388 * instead of just its class name.
7389 *
7390 * @param pm The package manager with which to resolve the Intent.
7391 * @param flags Addition information to retrieve as per
7392 * {@link PackageManager#getActivityInfo(ComponentName, int)
7393 * PackageManager.getActivityInfo()}.
7394 *
7395 * @return PackageManager.ActivityInfo
7396 *
7397 * @see #resolveActivity
7398 */
7399 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
7400 ActivityInfo ai = null;
7401 if (mComponent != null) {
7402 try {
7403 ai = pm.getActivityInfo(mComponent, flags);
7404 } catch (PackageManager.NameNotFoundException e) {
7405 // ignore
7406 }
7407 } else {
7408 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007409 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007410 if (info != null) {
7411 ai = info.activityInfo;
7412 }
7413 }
7414
7415 return ai;
7416 }
7417
7418 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007419 * Special function for use by the system to resolve service
7420 * intents to system apps. Throws an exception if there are
7421 * multiple potential matches to the Intent. Returns null if
7422 * there are no matches.
7423 * @hide
7424 */
7425 public ComponentName resolveSystemService(PackageManager pm, int flags) {
7426 if (mComponent != null) {
7427 return mComponent;
7428 }
7429
7430 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7431 if (results == null) {
7432 return null;
7433 }
7434 ComponentName comp = null;
7435 for (int i=0; i<results.size(); i++) {
7436 ResolveInfo ri = results.get(i);
7437 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7438 continue;
7439 }
7440 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7441 ri.serviceInfo.name);
7442 if (comp != null) {
7443 throw new IllegalStateException("Multiple system services handle " + this
7444 + ": " + comp + ", " + foundComp);
7445 }
7446 comp = foundComp;
7447 }
7448 return comp;
7449 }
7450
7451 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007452 * Set the general action to be performed.
7453 *
7454 * @param action An action name, such as ACTION_VIEW. Application-specific
7455 * actions should be prefixed with the vendor's package name.
7456 *
7457 * @return Returns the same Intent object, for chaining multiple calls
7458 * into a single statement.
7459 *
7460 * @see #getAction
7461 */
7462 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007463 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007464 return this;
7465 }
7466
7467 /**
7468 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007469 * clears any type that was previously set by {@link #setType} or
7470 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007471 *
Nick Pellyccae4122012-01-09 14:12:58 -08007472 * <p><em>Note: scheme matching in the Android framework is
7473 * case-sensitive, unlike the formal RFC. As a result,
7474 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007475 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007476 * {@link #setDataAndNormalize}
7477 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007478 *
Nick Pellyccae4122012-01-09 14:12:58 -08007479 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007480 *
7481 * @return Returns the same Intent object, for chaining multiple calls
7482 * into a single statement.
7483 *
7484 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007485 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007486 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007487 */
7488 public Intent setData(Uri data) {
7489 mData = data;
7490 mType = null;
7491 return this;
7492 }
7493
7494 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007495 * Normalize and set the data this intent is operating on.
7496 *
7497 * <p>This method automatically clears any type that was
7498 * previously set (for example, by {@link #setType}).
7499 *
7500 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007501 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007502 * so really this is just a convenience method for
7503 * <pre>
7504 * setData(data.normalize())
7505 * </pre>
7506 *
7507 * @param data The Uri of the data this intent is now targeting.
7508 *
7509 * @return Returns the same Intent object, for chaining multiple calls
7510 * into a single statement.
7511 *
7512 * @see #getData
7513 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007514 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007515 */
7516 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007517 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007518 }
7519
7520 /**
7521 * Set an explicit MIME data type.
7522 *
7523 * <p>This is used to create intents that only specify a type and not data,
7524 * for example to indicate the type of data to return.
7525 *
7526 * <p>This method automatically clears any data that was
7527 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007528 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007529 * <p><em>Note: MIME type matching in the Android framework is
7530 * case-sensitive, unlike formal RFC MIME types. As a result,
7531 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007532 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7533 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007534 *
7535 * @param type The MIME type of the data being handled by this intent.
7536 *
7537 * @return Returns the same Intent object, for chaining multiple calls
7538 * into a single statement.
7539 *
7540 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007541 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007542 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007543 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007544 */
7545 public Intent setType(String type) {
7546 mData = null;
7547 mType = type;
7548 return this;
7549 }
7550
7551 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007552 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007553 *
Nick Pellyccae4122012-01-09 14:12:58 -08007554 * <p>This is used to create intents that only specify a type and not data,
7555 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007556 *
Nick Pellyccae4122012-01-09 14:12:58 -08007557 * <p>This method automatically clears any data that was
7558 * previously set (for example by {@link #setData}).
7559 *
7560 * <p>The MIME type is normalized using
7561 * {@link #normalizeMimeType} before it is set,
7562 * so really this is just a convenience method for
7563 * <pre>
7564 * setType(Intent.normalizeMimeType(type))
7565 * </pre>
7566 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007567 * @param type The MIME type of the data being handled by this intent.
7568 *
7569 * @return Returns the same Intent object, for chaining multiple calls
7570 * into a single statement.
7571 *
Nick Pellyccae4122012-01-09 14:12:58 -08007572 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007573 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007574 * @see #normalizeMimeType
7575 */
7576 public Intent setTypeAndNormalize(String type) {
7577 return setType(normalizeMimeType(type));
7578 }
7579
7580 /**
7581 * (Usually optional) Set the data for the intent along with an explicit
7582 * MIME data type. This method should very rarely be used -- it allows you
7583 * to override the MIME type that would ordinarily be inferred from the
7584 * data with your own type given here.
7585 *
7586 * <p><em>Note: MIME type and Uri scheme matching in the
7587 * Android framework is case-sensitive, unlike the formal RFC definitions.
7588 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007589 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007590 * {@link #setDataAndTypeAndNormalize}
7591 * to ensure that they are converted to lower case.</em>
7592 *
7593 * @param data The Uri of the data this intent is now targeting.
7594 * @param type The MIME type of the data being handled by this intent.
7595 *
7596 * @return Returns the same Intent object, for chaining multiple calls
7597 * into a single statement.
7598 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007599 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007600 * @see #setData
7601 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007602 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007603 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007604 */
7605 public Intent setDataAndType(Uri data, String type) {
7606 mData = data;
7607 mType = type;
7608 return this;
7609 }
7610
7611 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007612 * (Usually optional) Normalize and set both the data Uri and an explicit
7613 * MIME data type. This method should very rarely be used -- it allows you
7614 * to override the MIME type that would ordinarily be inferred from the
7615 * data with your own type given here.
7616 *
7617 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007618 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007619 * before they are set, so really this is just a convenience method for
7620 * <pre>
7621 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7622 * </pre>
7623 *
7624 * @param data The Uri of the data this intent is now targeting.
7625 * @param type The MIME type of the data being handled by this intent.
7626 *
7627 * @return Returns the same Intent object, for chaining multiple calls
7628 * into a single statement.
7629 *
7630 * @see #setType
7631 * @see #setData
7632 * @see #setDataAndType
7633 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007634 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007635 */
7636 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007637 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007638 }
7639
7640 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007641 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007642 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007643 * activities that provide <em>all</em> of the requested categories will be
7644 * used.
7645 *
7646 * @param category The desired category. This can be either one of the
7647 * predefined Intent categories, or a custom category in your own
7648 * namespace.
7649 *
7650 * @return Returns the same Intent object, for chaining multiple calls
7651 * into a single statement.
7652 *
7653 * @see #hasCategory
7654 * @see #removeCategory
7655 */
7656 public Intent addCategory(String category) {
7657 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007658 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007659 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007660 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007661 return this;
7662 }
7663
7664 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007665 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007666 *
7667 * @param category The category to remove.
7668 *
7669 * @see #addCategory
7670 */
7671 public void removeCategory(String category) {
7672 if (mCategories != null) {
7673 mCategories.remove(category);
7674 if (mCategories.size() == 0) {
7675 mCategories = null;
7676 }
7677 }
7678 }
7679
7680 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007681 * Set a selector for this Intent. This is a modification to the kinds of
7682 * things the Intent will match. If the selector is set, it will be used
7683 * when trying to find entities that can handle the Intent, instead of the
7684 * main contents of the Intent. This allows you build an Intent containing
7685 * a generic protocol while targeting it more specifically.
7686 *
7687 * <p>An example of where this may be used is with things like
7688 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7689 * Intent that will launch the Browser application. However, the correct
7690 * main entry point of an application is actually {@link #ACTION_MAIN}
7691 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7692 * used to specify the actual Activity to launch. If you launch the browser
7693 * with something different, undesired behavior may happen if the user has
7694 * previously or later launches it the normal way, since they do not match.
7695 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7696 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7697 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7698 *
7699 * <p>Setting a selector does not impact the behavior of
7700 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7701 * desired behavior of a selector -- it does not impact the base meaning
7702 * of the Intent, just what kinds of things will be matched against it
7703 * when determining who can handle it.</p>
7704 *
7705 * <p>You can not use both a selector and {@link #setPackage(String)} on
7706 * the same base Intent.</p>
7707 *
7708 * @param selector The desired selector Intent; set to null to not use
7709 * a special selector.
7710 */
7711 public void setSelector(Intent selector) {
7712 if (selector == this) {
7713 throw new IllegalArgumentException(
7714 "Intent being set as a selector of itself");
7715 }
7716 if (selector != null && mPackage != null) {
7717 throw new IllegalArgumentException(
7718 "Can't set selector when package name is already set");
7719 }
7720 mSelector = selector;
7721 }
7722
7723 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007724 * Set a {@link ClipData} associated with this Intent. This replaces any
7725 * previously set ClipData.
7726 *
7727 * <p>The ClipData in an intent is not used for Intent matching or other
7728 * such operations. Semantically it is like extras, used to transmit
7729 * additional data with the Intent. The main feature of using this over
7730 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7731 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7732 * items included in the clip data. This is useful, in particular, if
7733 * you want to transmit an Intent containing multiple <code>content:</code>
7734 * URIs for which the recipient may not have global permission to access the
7735 * content provider.
7736 *
7737 * <p>If the ClipData contains items that are themselves Intents, any
7738 * grant flags in those Intents will be ignored. Only the top-level flags
7739 * of the main Intent are respected, and will be applied to all Uri or
7740 * Intent items in the clip (or sub-items of the clip).
7741 *
7742 * <p>The MIME type, label, and icon in the ClipData object are not
7743 * directly used by Intent. Applications should generally rely on the
7744 * MIME type of the Intent itself, not what it may find in the ClipData.
7745 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007746 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007747 *
7748 * @param clip The new clip to set. May be null to clear the current clip.
7749 */
7750 public void setClipData(ClipData clip) {
7751 mClipData = clip;
7752 }
7753
7754 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007755 * This is NOT a secure mechanism to identify the user who sent the intent.
7756 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7757 * who sent the intent.
7758 * @hide
7759 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007760 public void prepareToLeaveUser(int userId) {
7761 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7762 // We want mContentUserHint to refer to the original user, so don't do anything.
7763 if (mContentUserHint == UserHandle.USER_CURRENT) {
7764 mContentUserHint = userId;
7765 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007766 }
7767
7768 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007769 * Add extended data to the intent. The name must include a package
7770 * prefix, for example the app com.android.contacts would use names
7771 * like "com.android.contacts.ShowAll".
7772 *
7773 * @param name The name of the extra data, with package prefix.
7774 * @param value The boolean data value.
7775 *
7776 * @return Returns the same Intent object, for chaining multiple calls
7777 * into a single statement.
7778 *
7779 * @see #putExtras
7780 * @see #removeExtra
7781 * @see #getBooleanExtra(String, boolean)
7782 */
7783 public Intent putExtra(String name, boolean value) {
7784 if (mExtras == null) {
7785 mExtras = new Bundle();
7786 }
7787 mExtras.putBoolean(name, value);
7788 return this;
7789 }
7790
7791 /**
7792 * Add extended data to the intent. The name must include a package
7793 * prefix, for example the app com.android.contacts would use names
7794 * like "com.android.contacts.ShowAll".
7795 *
7796 * @param name The name of the extra data, with package prefix.
7797 * @param value The byte data value.
7798 *
7799 * @return Returns the same Intent object, for chaining multiple calls
7800 * into a single statement.
7801 *
7802 * @see #putExtras
7803 * @see #removeExtra
7804 * @see #getByteExtra(String, byte)
7805 */
7806 public Intent putExtra(String name, byte value) {
7807 if (mExtras == null) {
7808 mExtras = new Bundle();
7809 }
7810 mExtras.putByte(name, value);
7811 return this;
7812 }
7813
7814 /**
7815 * Add extended data to the intent. The name must include a package
7816 * prefix, for example the app com.android.contacts would use names
7817 * like "com.android.contacts.ShowAll".
7818 *
7819 * @param name The name of the extra data, with package prefix.
7820 * @param value The char data value.
7821 *
7822 * @return Returns the same Intent object, for chaining multiple calls
7823 * into a single statement.
7824 *
7825 * @see #putExtras
7826 * @see #removeExtra
7827 * @see #getCharExtra(String, char)
7828 */
7829 public Intent putExtra(String name, char value) {
7830 if (mExtras == null) {
7831 mExtras = new Bundle();
7832 }
7833 mExtras.putChar(name, value);
7834 return this;
7835 }
7836
7837 /**
7838 * Add extended data to the intent. The name must include a package
7839 * prefix, for example the app com.android.contacts would use names
7840 * like "com.android.contacts.ShowAll".
7841 *
7842 * @param name The name of the extra data, with package prefix.
7843 * @param value The short data value.
7844 *
7845 * @return Returns the same Intent object, for chaining multiple calls
7846 * into a single statement.
7847 *
7848 * @see #putExtras
7849 * @see #removeExtra
7850 * @see #getShortExtra(String, short)
7851 */
7852 public Intent putExtra(String name, short value) {
7853 if (mExtras == null) {
7854 mExtras = new Bundle();
7855 }
7856 mExtras.putShort(name, value);
7857 return this;
7858 }
7859
7860 /**
7861 * Add extended data to the intent. The name must include a package
7862 * prefix, for example the app com.android.contacts would use names
7863 * like "com.android.contacts.ShowAll".
7864 *
7865 * @param name The name of the extra data, with package prefix.
7866 * @param value The integer data value.
7867 *
7868 * @return Returns the same Intent object, for chaining multiple calls
7869 * into a single statement.
7870 *
7871 * @see #putExtras
7872 * @see #removeExtra
7873 * @see #getIntExtra(String, int)
7874 */
7875 public Intent putExtra(String name, int value) {
7876 if (mExtras == null) {
7877 mExtras = new Bundle();
7878 }
7879 mExtras.putInt(name, value);
7880 return this;
7881 }
7882
7883 /**
7884 * Add extended data to the intent. The name must include a package
7885 * prefix, for example the app com.android.contacts would use names
7886 * like "com.android.contacts.ShowAll".
7887 *
7888 * @param name The name of the extra data, with package prefix.
7889 * @param value The long data value.
7890 *
7891 * @return Returns the same Intent object, for chaining multiple calls
7892 * into a single statement.
7893 *
7894 * @see #putExtras
7895 * @see #removeExtra
7896 * @see #getLongExtra(String, long)
7897 */
7898 public Intent putExtra(String name, long value) {
7899 if (mExtras == null) {
7900 mExtras = new Bundle();
7901 }
7902 mExtras.putLong(name, value);
7903 return this;
7904 }
7905
7906 /**
7907 * Add extended data to the intent. The name must include a package
7908 * prefix, for example the app com.android.contacts would use names
7909 * like "com.android.contacts.ShowAll".
7910 *
7911 * @param name The name of the extra data, with package prefix.
7912 * @param value The float data value.
7913 *
7914 * @return Returns the same Intent object, for chaining multiple calls
7915 * into a single statement.
7916 *
7917 * @see #putExtras
7918 * @see #removeExtra
7919 * @see #getFloatExtra(String, float)
7920 */
7921 public Intent putExtra(String name, float value) {
7922 if (mExtras == null) {
7923 mExtras = new Bundle();
7924 }
7925 mExtras.putFloat(name, value);
7926 return this;
7927 }
7928
7929 /**
7930 * Add extended data to the intent. The name must include a package
7931 * prefix, for example the app com.android.contacts would use names
7932 * like "com.android.contacts.ShowAll".
7933 *
7934 * @param name The name of the extra data, with package prefix.
7935 * @param value The double data value.
7936 *
7937 * @return Returns the same Intent object, for chaining multiple calls
7938 * into a single statement.
7939 *
7940 * @see #putExtras
7941 * @see #removeExtra
7942 * @see #getDoubleExtra(String, double)
7943 */
7944 public Intent putExtra(String name, double value) {
7945 if (mExtras == null) {
7946 mExtras = new Bundle();
7947 }
7948 mExtras.putDouble(name, value);
7949 return this;
7950 }
7951
7952 /**
7953 * Add extended data to the intent. The name must include a package
7954 * prefix, for example the app com.android.contacts would use names
7955 * like "com.android.contacts.ShowAll".
7956 *
7957 * @param name The name of the extra data, with package prefix.
7958 * @param value The String data value.
7959 *
7960 * @return Returns the same Intent object, for chaining multiple calls
7961 * into a single statement.
7962 *
7963 * @see #putExtras
7964 * @see #removeExtra
7965 * @see #getStringExtra(String)
7966 */
7967 public Intent putExtra(String name, String value) {
7968 if (mExtras == null) {
7969 mExtras = new Bundle();
7970 }
7971 mExtras.putString(name, value);
7972 return this;
7973 }
7974
7975 /**
7976 * Add extended data to the intent. The name must include a package
7977 * prefix, for example the app com.android.contacts would use names
7978 * like "com.android.contacts.ShowAll".
7979 *
7980 * @param name The name of the extra data, with package prefix.
7981 * @param value The CharSequence data value.
7982 *
7983 * @return Returns the same Intent object, for chaining multiple calls
7984 * into a single statement.
7985 *
7986 * @see #putExtras
7987 * @see #removeExtra
7988 * @see #getCharSequenceExtra(String)
7989 */
7990 public Intent putExtra(String name, CharSequence value) {
7991 if (mExtras == null) {
7992 mExtras = new Bundle();
7993 }
7994 mExtras.putCharSequence(name, value);
7995 return this;
7996 }
7997
7998 /**
7999 * Add extended data to the intent. The name must include a package
8000 * prefix, for example the app com.android.contacts would use names
8001 * like "com.android.contacts.ShowAll".
8002 *
8003 * @param name The name of the extra data, with package prefix.
8004 * @param value The Parcelable data value.
8005 *
8006 * @return Returns the same Intent object, for chaining multiple calls
8007 * into a single statement.
8008 *
8009 * @see #putExtras
8010 * @see #removeExtra
8011 * @see #getParcelableExtra(String)
8012 */
8013 public Intent putExtra(String name, Parcelable value) {
8014 if (mExtras == null) {
8015 mExtras = new Bundle();
8016 }
8017 mExtras.putParcelable(name, value);
8018 return this;
8019 }
8020
8021 /**
8022 * Add extended data to the intent. The name must include a package
8023 * prefix, for example the app com.android.contacts would use names
8024 * like "com.android.contacts.ShowAll".
8025 *
8026 * @param name The name of the extra data, with package prefix.
8027 * @param value The Parcelable[] data value.
8028 *
8029 * @return Returns the same Intent object, for chaining multiple calls
8030 * into a single statement.
8031 *
8032 * @see #putExtras
8033 * @see #removeExtra
8034 * @see #getParcelableArrayExtra(String)
8035 */
8036 public Intent putExtra(String name, Parcelable[] value) {
8037 if (mExtras == null) {
8038 mExtras = new Bundle();
8039 }
8040 mExtras.putParcelableArray(name, value);
8041 return this;
8042 }
8043
8044 /**
8045 * Add extended data to the intent. The name must include a package
8046 * prefix, for example the app com.android.contacts would use names
8047 * like "com.android.contacts.ShowAll".
8048 *
8049 * @param name The name of the extra data, with package prefix.
8050 * @param value The ArrayList<Parcelable> data value.
8051 *
8052 * @return Returns the same Intent object, for chaining multiple calls
8053 * into a single statement.
8054 *
8055 * @see #putExtras
8056 * @see #removeExtra
8057 * @see #getParcelableArrayListExtra(String)
8058 */
8059 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
8060 if (mExtras == null) {
8061 mExtras = new Bundle();
8062 }
8063 mExtras.putParcelableArrayList(name, value);
8064 return this;
8065 }
8066
8067 /**
8068 * Add extended data to the intent. The name must include a package
8069 * prefix, for example the app com.android.contacts would use names
8070 * like "com.android.contacts.ShowAll".
8071 *
8072 * @param name The name of the extra data, with package prefix.
8073 * @param value The ArrayList<Integer> data value.
8074 *
8075 * @return Returns the same Intent object, for chaining multiple calls
8076 * into a single statement.
8077 *
8078 * @see #putExtras
8079 * @see #removeExtra
8080 * @see #getIntegerArrayListExtra(String)
8081 */
8082 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
8083 if (mExtras == null) {
8084 mExtras = new Bundle();
8085 }
8086 mExtras.putIntegerArrayList(name, value);
8087 return this;
8088 }
8089
8090 /**
8091 * Add extended data to the intent. The name must include a package
8092 * prefix, for example the app com.android.contacts would use names
8093 * like "com.android.contacts.ShowAll".
8094 *
8095 * @param name The name of the extra data, with package prefix.
8096 * @param value The ArrayList<String> data value.
8097 *
8098 * @return Returns the same Intent object, for chaining multiple calls
8099 * into a single statement.
8100 *
8101 * @see #putExtras
8102 * @see #removeExtra
8103 * @see #getStringArrayListExtra(String)
8104 */
8105 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
8106 if (mExtras == null) {
8107 mExtras = new Bundle();
8108 }
8109 mExtras.putStringArrayList(name, value);
8110 return this;
8111 }
8112
8113 /**
8114 * Add extended data to the intent. The name must include a package
8115 * prefix, for example the app com.android.contacts would use names
8116 * like "com.android.contacts.ShowAll".
8117 *
8118 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008119 * @param value The ArrayList<CharSequence> data value.
8120 *
8121 * @return Returns the same Intent object, for chaining multiple calls
8122 * into a single statement.
8123 *
8124 * @see #putExtras
8125 * @see #removeExtra
8126 * @see #getCharSequenceArrayListExtra(String)
8127 */
8128 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
8129 if (mExtras == null) {
8130 mExtras = new Bundle();
8131 }
8132 mExtras.putCharSequenceArrayList(name, value);
8133 return this;
8134 }
8135
8136 /**
8137 * Add extended data to the intent. The name must include a package
8138 * prefix, for example the app com.android.contacts would use names
8139 * like "com.android.contacts.ShowAll".
8140 *
8141 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008142 * @param value The Serializable data value.
8143 *
8144 * @return Returns the same Intent object, for chaining multiple calls
8145 * into a single statement.
8146 *
8147 * @see #putExtras
8148 * @see #removeExtra
8149 * @see #getSerializableExtra(String)
8150 */
8151 public Intent putExtra(String name, Serializable value) {
8152 if (mExtras == null) {
8153 mExtras = new Bundle();
8154 }
8155 mExtras.putSerializable(name, value);
8156 return this;
8157 }
8158
8159 /**
8160 * Add extended data to the intent. The name must include a package
8161 * prefix, for example the app com.android.contacts would use names
8162 * like "com.android.contacts.ShowAll".
8163 *
8164 * @param name The name of the extra data, with package prefix.
8165 * @param value The boolean array data value.
8166 *
8167 * @return Returns the same Intent object, for chaining multiple calls
8168 * into a single statement.
8169 *
8170 * @see #putExtras
8171 * @see #removeExtra
8172 * @see #getBooleanArrayExtra(String)
8173 */
8174 public Intent putExtra(String name, boolean[] value) {
8175 if (mExtras == null) {
8176 mExtras = new Bundle();
8177 }
8178 mExtras.putBooleanArray(name, value);
8179 return this;
8180 }
8181
8182 /**
8183 * Add extended data to the intent. The name must include a package
8184 * prefix, for example the app com.android.contacts would use names
8185 * like "com.android.contacts.ShowAll".
8186 *
8187 * @param name The name of the extra data, with package prefix.
8188 * @param value The byte array data value.
8189 *
8190 * @return Returns the same Intent object, for chaining multiple calls
8191 * into a single statement.
8192 *
8193 * @see #putExtras
8194 * @see #removeExtra
8195 * @see #getByteArrayExtra(String)
8196 */
8197 public Intent putExtra(String name, byte[] value) {
8198 if (mExtras == null) {
8199 mExtras = new Bundle();
8200 }
8201 mExtras.putByteArray(name, value);
8202 return this;
8203 }
8204
8205 /**
8206 * Add extended data to the intent. The name must include a package
8207 * prefix, for example the app com.android.contacts would use names
8208 * like "com.android.contacts.ShowAll".
8209 *
8210 * @param name The name of the extra data, with package prefix.
8211 * @param value The short array data value.
8212 *
8213 * @return Returns the same Intent object, for chaining multiple calls
8214 * into a single statement.
8215 *
8216 * @see #putExtras
8217 * @see #removeExtra
8218 * @see #getShortArrayExtra(String)
8219 */
8220 public Intent putExtra(String name, short[] value) {
8221 if (mExtras == null) {
8222 mExtras = new Bundle();
8223 }
8224 mExtras.putShortArray(name, value);
8225 return this;
8226 }
8227
8228 /**
8229 * Add extended data to the intent. The name must include a package
8230 * prefix, for example the app com.android.contacts would use names
8231 * like "com.android.contacts.ShowAll".
8232 *
8233 * @param name The name of the extra data, with package prefix.
8234 * @param value The char array data value.
8235 *
8236 * @return Returns the same Intent object, for chaining multiple calls
8237 * into a single statement.
8238 *
8239 * @see #putExtras
8240 * @see #removeExtra
8241 * @see #getCharArrayExtra(String)
8242 */
8243 public Intent putExtra(String name, char[] value) {
8244 if (mExtras == null) {
8245 mExtras = new Bundle();
8246 }
8247 mExtras.putCharArray(name, value);
8248 return this;
8249 }
8250
8251 /**
8252 * Add extended data to the intent. The name must include a package
8253 * prefix, for example the app com.android.contacts would use names
8254 * like "com.android.contacts.ShowAll".
8255 *
8256 * @param name The name of the extra data, with package prefix.
8257 * @param value The int array data value.
8258 *
8259 * @return Returns the same Intent object, for chaining multiple calls
8260 * into a single statement.
8261 *
8262 * @see #putExtras
8263 * @see #removeExtra
8264 * @see #getIntArrayExtra(String)
8265 */
8266 public Intent putExtra(String name, int[] value) {
8267 if (mExtras == null) {
8268 mExtras = new Bundle();
8269 }
8270 mExtras.putIntArray(name, value);
8271 return this;
8272 }
8273
8274 /**
8275 * Add extended data to the intent. The name must include a package
8276 * prefix, for example the app com.android.contacts would use names
8277 * like "com.android.contacts.ShowAll".
8278 *
8279 * @param name The name of the extra data, with package prefix.
8280 * @param value The byte array data value.
8281 *
8282 * @return Returns the same Intent object, for chaining multiple calls
8283 * into a single statement.
8284 *
8285 * @see #putExtras
8286 * @see #removeExtra
8287 * @see #getLongArrayExtra(String)
8288 */
8289 public Intent putExtra(String name, long[] value) {
8290 if (mExtras == null) {
8291 mExtras = new Bundle();
8292 }
8293 mExtras.putLongArray(name, value);
8294 return this;
8295 }
8296
8297 /**
8298 * Add extended data to the intent. The name must include a package
8299 * prefix, for example the app com.android.contacts would use names
8300 * like "com.android.contacts.ShowAll".
8301 *
8302 * @param name The name of the extra data, with package prefix.
8303 * @param value The float array data value.
8304 *
8305 * @return Returns the same Intent object, for chaining multiple calls
8306 * into a single statement.
8307 *
8308 * @see #putExtras
8309 * @see #removeExtra
8310 * @see #getFloatArrayExtra(String)
8311 */
8312 public Intent putExtra(String name, float[] value) {
8313 if (mExtras == null) {
8314 mExtras = new Bundle();
8315 }
8316 mExtras.putFloatArray(name, value);
8317 return this;
8318 }
8319
8320 /**
8321 * Add extended data to the intent. The name must include a package
8322 * prefix, for example the app com.android.contacts would use names
8323 * like "com.android.contacts.ShowAll".
8324 *
8325 * @param name The name of the extra data, with package prefix.
8326 * @param value The double array data value.
8327 *
8328 * @return Returns the same Intent object, for chaining multiple calls
8329 * into a single statement.
8330 *
8331 * @see #putExtras
8332 * @see #removeExtra
8333 * @see #getDoubleArrayExtra(String)
8334 */
8335 public Intent putExtra(String name, double[] value) {
8336 if (mExtras == null) {
8337 mExtras = new Bundle();
8338 }
8339 mExtras.putDoubleArray(name, value);
8340 return this;
8341 }
8342
8343 /**
8344 * Add extended data to the intent. The name must include a package
8345 * prefix, for example the app com.android.contacts would use names
8346 * like "com.android.contacts.ShowAll".
8347 *
8348 * @param name The name of the extra data, with package prefix.
8349 * @param value The String array data value.
8350 *
8351 * @return Returns the same Intent object, for chaining multiple calls
8352 * into a single statement.
8353 *
8354 * @see #putExtras
8355 * @see #removeExtra
8356 * @see #getStringArrayExtra(String)
8357 */
8358 public Intent putExtra(String name, String[] value) {
8359 if (mExtras == null) {
8360 mExtras = new Bundle();
8361 }
8362 mExtras.putStringArray(name, value);
8363 return this;
8364 }
8365
8366 /**
8367 * Add extended data to the intent. The name must include a package
8368 * prefix, for example the app com.android.contacts would use names
8369 * like "com.android.contacts.ShowAll".
8370 *
8371 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008372 * @param value The CharSequence array data value.
8373 *
8374 * @return Returns the same Intent object, for chaining multiple calls
8375 * into a single statement.
8376 *
8377 * @see #putExtras
8378 * @see #removeExtra
8379 * @see #getCharSequenceArrayExtra(String)
8380 */
8381 public Intent putExtra(String name, CharSequence[] value) {
8382 if (mExtras == null) {
8383 mExtras = new Bundle();
8384 }
8385 mExtras.putCharSequenceArray(name, value);
8386 return this;
8387 }
8388
8389 /**
8390 * Add extended data to the intent. The name must include a package
8391 * prefix, for example the app com.android.contacts would use names
8392 * like "com.android.contacts.ShowAll".
8393 *
8394 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008395 * @param value The Bundle data value.
8396 *
8397 * @return Returns the same Intent object, for chaining multiple calls
8398 * into a single statement.
8399 *
8400 * @see #putExtras
8401 * @see #removeExtra
8402 * @see #getBundleExtra(String)
8403 */
8404 public Intent putExtra(String name, Bundle value) {
8405 if (mExtras == null) {
8406 mExtras = new Bundle();
8407 }
8408 mExtras.putBundle(name, value);
8409 return this;
8410 }
8411
8412 /**
8413 * Add extended data to the intent. The name must include a package
8414 * prefix, for example the app com.android.contacts would use names
8415 * like "com.android.contacts.ShowAll".
8416 *
8417 * @param name The name of the extra data, with package prefix.
8418 * @param value The IBinder data value.
8419 *
8420 * @return Returns the same Intent object, for chaining multiple calls
8421 * into a single statement.
8422 *
8423 * @see #putExtras
8424 * @see #removeExtra
8425 * @see #getIBinderExtra(String)
8426 *
8427 * @deprecated
8428 * @hide
8429 */
8430 @Deprecated
8431 public Intent putExtra(String name, IBinder value) {
8432 if (mExtras == null) {
8433 mExtras = new Bundle();
8434 }
8435 mExtras.putIBinder(name, value);
8436 return this;
8437 }
8438
8439 /**
8440 * Copy all extras in 'src' in to this intent.
8441 *
8442 * @param src Contains the extras to copy.
8443 *
8444 * @see #putExtra
8445 */
8446 public Intent putExtras(Intent src) {
8447 if (src.mExtras != null) {
8448 if (mExtras == null) {
8449 mExtras = new Bundle(src.mExtras);
8450 } else {
8451 mExtras.putAll(src.mExtras);
8452 }
8453 }
8454 return this;
8455 }
8456
8457 /**
8458 * Add a set of extended data to the intent. The keys must include a package
8459 * prefix, for example the app com.android.contacts would use names
8460 * like "com.android.contacts.ShowAll".
8461 *
8462 * @param extras The Bundle of extras to add to this intent.
8463 *
8464 * @see #putExtra
8465 * @see #removeExtra
8466 */
8467 public Intent putExtras(Bundle extras) {
8468 if (mExtras == null) {
8469 mExtras = new Bundle();
8470 }
8471 mExtras.putAll(extras);
8472 return this;
8473 }
8474
8475 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008476 * Completely replace the extras in the Intent with the extras in the
8477 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008478 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008479 * @param src The exact extras contained in this Intent are copied
8480 * into the target intent, replacing any that were previously there.
8481 */
8482 public Intent replaceExtras(Intent src) {
8483 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8484 return this;
8485 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008486
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008487 /**
8488 * Completely replace the extras in the Intent with the given Bundle of
8489 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008490 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008491 * @param extras The new set of extras in the Intent, or null to erase
8492 * all extras.
8493 */
8494 public Intent replaceExtras(Bundle extras) {
8495 mExtras = extras != null ? new Bundle(extras) : null;
8496 return this;
8497 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008498
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008499 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008500 * Remove extended data from the intent.
8501 *
8502 * @see #putExtra
8503 */
8504 public void removeExtra(String name) {
8505 if (mExtras != null) {
8506 mExtras.remove(name);
8507 if (mExtras.size() == 0) {
8508 mExtras = null;
8509 }
8510 }
8511 }
8512
8513 /**
8514 * Set special flags controlling how this intent is handled. Most values
8515 * here depend on the type of component being executed by the Intent,
8516 * specifically the FLAG_ACTIVITY_* flags are all for use with
8517 * {@link Context#startActivity Context.startActivity()} and the
8518 * FLAG_RECEIVER_* flags are all for use with
8519 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8520 *
Scott Main7aee61f2011-02-08 11:25:01 -08008521 * <p>See the
8522 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8523 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008524 * the behavior of your application.
8525 *
8526 * @param flags The desired flags.
8527 *
8528 * @return Returns the same Intent object, for chaining multiple calls
8529 * into a single statement.
8530 *
8531 * @see #getFlags
8532 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008533 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008534 *
8535 * @see #FLAG_GRANT_READ_URI_PERMISSION
8536 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07008537 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
8538 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008539 * @see #FLAG_DEBUG_LOG_RESOLUTION
8540 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008541 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008542 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008543 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008544 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008545 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
8546 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008547 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008548 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07008549 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008550 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008551 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008552 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08008553 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008554 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
8555 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008556 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008557 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008558 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008559 * @see #FLAG_RECEIVER_REGISTERED_ONLY
8560 */
8561 public Intent setFlags(int flags) {
8562 mFlags = flags;
8563 return this;
8564 }
8565
8566 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008567 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008568 *
8569 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008570 * @return Returns the same Intent object, for chaining multiple calls into
8571 * a single statement.
8572 * @see #setFlags(int)
8573 * @see #removeFlags(int)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008574 */
8575 public Intent addFlags(int flags) {
8576 mFlags |= flags;
8577 return this;
8578 }
8579
8580 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008581 * Remove these flags from the intent.
8582 *
8583 * @param flags The flags to remove.
8584 * @see #setFlags(int)
8585 * @see #addFlags(int)
8586 */
8587 public void removeFlags(int flags) {
8588 mFlags &= ~flags;
8589 }
8590
8591 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008592 * (Usually optional) Set an explicit application package name that limits
8593 * the components this Intent will resolve to. If left to the default
8594 * value of null, all components in all applications will considered.
8595 * If non-null, the Intent can only match the components in the given
8596 * application package.
8597 *
8598 * @param packageName The name of the application package to handle the
8599 * intent, or null to allow any application package.
8600 *
8601 * @return Returns the same Intent object, for chaining multiple calls
8602 * into a single statement.
8603 *
8604 * @see #getPackage
8605 * @see #resolveActivity
8606 */
8607 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008608 if (packageName != null && mSelector != null) {
8609 throw new IllegalArgumentException(
8610 "Can't set package name when selector is already set");
8611 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008612 mPackage = packageName;
8613 return this;
8614 }
8615
8616 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008617 * (Usually optional) Explicitly set the component to handle the intent.
8618 * If left with the default value of null, the system will determine the
8619 * appropriate class to use based on the other fields (action, data,
8620 * type, categories) in the Intent. If this class is defined, the
8621 * specified class will always be used regardless of the other fields. You
8622 * should only set this value when you know you absolutely want a specific
8623 * class to be used; otherwise it is better to let the system find the
8624 * appropriate class so that you will respect the installed applications
8625 * and user preferences.
8626 *
8627 * @param component The name of the application component to handle the
8628 * intent, or null to let the system find one for you.
8629 *
8630 * @return Returns the same Intent object, for chaining multiple calls
8631 * into a single statement.
8632 *
8633 * @see #setClass
8634 * @see #setClassName(Context, String)
8635 * @see #setClassName(String, String)
8636 * @see #getComponent
8637 * @see #resolveActivity
8638 */
8639 public Intent setComponent(ComponentName component) {
8640 mComponent = component;
8641 return this;
8642 }
8643
8644 /**
8645 * Convenience for calling {@link #setComponent} with an
8646 * explicit class name.
8647 *
8648 * @param packageContext A Context of the application package implementing
8649 * this class.
8650 * @param className The name of a class inside of the application package
8651 * that will be used as the component for this Intent.
8652 *
8653 * @return Returns the same Intent object, for chaining multiple calls
8654 * into a single statement.
8655 *
8656 * @see #setComponent
8657 * @see #setClass
8658 */
8659 public Intent setClassName(Context packageContext, String className) {
8660 mComponent = new ComponentName(packageContext, className);
8661 return this;
8662 }
8663
8664 /**
8665 * Convenience for calling {@link #setComponent} with an
8666 * explicit application package name and class name.
8667 *
8668 * @param packageName The name of the package implementing the desired
8669 * component.
8670 * @param className The name of a class inside of the application package
8671 * that will be used as the component for this Intent.
8672 *
8673 * @return Returns the same Intent object, for chaining multiple calls
8674 * into a single statement.
8675 *
8676 * @see #setComponent
8677 * @see #setClass
8678 */
8679 public Intent setClassName(String packageName, String className) {
8680 mComponent = new ComponentName(packageName, className);
8681 return this;
8682 }
8683
8684 /**
8685 * Convenience for calling {@link #setComponent(ComponentName)} with the
8686 * name returned by a {@link Class} object.
8687 *
8688 * @param packageContext A Context of the application package implementing
8689 * this class.
8690 * @param cls The class name to set, equivalent to
8691 * <code>setClassName(context, cls.getName())</code>.
8692 *
8693 * @return Returns the same Intent object, for chaining multiple calls
8694 * into a single statement.
8695 *
8696 * @see #setComponent
8697 */
8698 public Intent setClass(Context packageContext, Class<?> cls) {
8699 mComponent = new ComponentName(packageContext, cls);
8700 return this;
8701 }
8702
8703 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008704 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8705 * used as a hint to the receiver for animations and the like. Null means that there
8706 * is no source bounds.
8707 */
8708 public void setSourceBounds(Rect r) {
8709 if (r != null) {
8710 mSourceBounds = new Rect(r);
8711 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008712 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008713 }
8714 }
8715
Tor Norbyed9273d62013-05-30 15:59:53 -07008716 /** @hide */
8717 @IntDef(flag = true,
8718 value = {
8719 FILL_IN_ACTION,
8720 FILL_IN_DATA,
8721 FILL_IN_CATEGORIES,
8722 FILL_IN_COMPONENT,
8723 FILL_IN_PACKAGE,
8724 FILL_IN_SOURCE_BOUNDS,
8725 FILL_IN_SELECTOR,
8726 FILL_IN_CLIP_DATA
8727 })
8728 @Retention(RetentionPolicy.SOURCE)
8729 public @interface FillInFlags {}
8730
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008731 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008732 * Use with {@link #fillIn} to allow the current action value to be
8733 * overwritten, even if it is already set.
8734 */
8735 public static final int FILL_IN_ACTION = 1<<0;
8736
8737 /**
8738 * Use with {@link #fillIn} to allow the current data or type value
8739 * overwritten, even if it is already set.
8740 */
8741 public static final int FILL_IN_DATA = 1<<1;
8742
8743 /**
8744 * Use with {@link #fillIn} to allow the current categories to be
8745 * overwritten, even if they are already set.
8746 */
8747 public static final int FILL_IN_CATEGORIES = 1<<2;
8748
8749 /**
8750 * Use with {@link #fillIn} to allow the current component value to be
8751 * overwritten, even if it is already set.
8752 */
8753 public static final int FILL_IN_COMPONENT = 1<<3;
8754
8755 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008756 * Use with {@link #fillIn} to allow the current package value to be
8757 * overwritten, even if it is already set.
8758 */
8759 public static final int FILL_IN_PACKAGE = 1<<4;
8760
8761 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008762 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008763 * overwritten, even if it is already set.
8764 */
8765 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8766
8767 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008768 * Use with {@link #fillIn} to allow the current selector to be
8769 * overwritten, even if it is already set.
8770 */
8771 public static final int FILL_IN_SELECTOR = 1<<6;
8772
8773 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008774 * Use with {@link #fillIn} to allow the current ClipData to be
8775 * overwritten, even if it is already set.
8776 */
8777 public static final int FILL_IN_CLIP_DATA = 1<<7;
8778
8779 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008780 * Copy the contents of <var>other</var> in to this object, but only
8781 * where fields are not defined by this object. For purposes of a field
8782 * being defined, the following pieces of data in the Intent are
8783 * considered to be separate fields:
8784 *
8785 * <ul>
8786 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008787 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008788 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8789 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008790 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008791 * <li> component, as set by {@link #setComponent(ComponentName)} or
8792 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008793 * <li> source bounds, as set by {@link #setSourceBounds}.
8794 * <li> selector, as set by {@link #setSelector(Intent)}.
8795 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008796 * <li> each top-level name in the associated extras.
8797 * </ul>
8798 *
8799 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008800 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008801 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8802 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8803 * the restriction where the corresponding field will not be replaced if
8804 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008805 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008806 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8807 * is explicitly specified. The selector will only be copied if
8808 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008809 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008810 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8811 * and Intent B with {action="gotit", data-type="some/thing",
8812 * categories="one","two"}.
8813 *
8814 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8815 * containing: {action="gotit", data-type="some/thing",
8816 * categories="bar"}.
8817 *
8818 * @param other Another Intent whose values are to be used to fill in
8819 * the current one.
8820 * @param flags Options to control which fields can be filled in.
8821 *
8822 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008823 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008824 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08008825 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07008826 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008827 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008828 @FillInFlags
8829 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008830 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008831 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008832 if (other.mAction != null
8833 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008834 mAction = other.mAction;
8835 changes |= FILL_IN_ACTION;
8836 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008837 if ((other.mData != null || other.mType != null)
8838 && ((mData == null && mType == null)
8839 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008840 mData = other.mData;
8841 mType = other.mType;
8842 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008843 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008844 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008845 if (other.mCategories != null
8846 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008847 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008848 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008849 }
8850 changes |= FILL_IN_CATEGORIES;
8851 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008852 if (other.mPackage != null
8853 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008854 // Only do this if mSelector is not set.
8855 if (mSelector == null) {
8856 mPackage = other.mPackage;
8857 changes |= FILL_IN_PACKAGE;
8858 }
8859 }
8860 // Selector is special: it can only be set if explicitly allowed,
8861 // for the same reason as the component name.
8862 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8863 if (mPackage == null) {
8864 mSelector = new Intent(other.mSelector);
8865 mPackage = null;
8866 changes |= FILL_IN_SELECTOR;
8867 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008868 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008869 if (other.mClipData != null
8870 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8871 mClipData = other.mClipData;
8872 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008873 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008874 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008875 // Component is special: it can -only- be set if explicitly allowed,
8876 // since otherwise the sender could force the intent somewhere the
8877 // originator didn't intend.
8878 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008879 mComponent = other.mComponent;
8880 changes |= FILL_IN_COMPONENT;
8881 }
8882 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008883 if (other.mSourceBounds != null
8884 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8885 mSourceBounds = new Rect(other.mSourceBounds);
8886 changes |= FILL_IN_SOURCE_BOUNDS;
8887 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008888 if (mExtras == null) {
8889 if (other.mExtras != null) {
8890 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008891 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008892 }
8893 } else if (other.mExtras != null) {
8894 try {
8895 Bundle newb = new Bundle(other.mExtras);
8896 newb.putAll(mExtras);
8897 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008898 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008899 } catch (RuntimeException e) {
8900 // Modifying the extras can cause us to unparcel the contents
8901 // of the bundle, and if we do this in the system process that
8902 // may fail. We really should handle this (i.e., the Bundle
8903 // impl shouldn't be on top of a plain map), but for now just
8904 // ignore it and keep the original contents. :(
8905 Log.w("Intent", "Failure filling in extras", e);
8906 }
8907 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008908 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8909 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8910 mContentUserHint = other.mContentUserHint;
8911 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008912 return changes;
8913 }
8914
8915 /**
8916 * Wrapper class holding an Intent and implementing comparisons on it for
8917 * the purpose of filtering. The class implements its
8918 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8919 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8920 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8921 * on the wrapped Intent.
8922 */
8923 public static final class FilterComparison {
8924 private final Intent mIntent;
8925 private final int mHashCode;
8926
8927 public FilterComparison(Intent intent) {
8928 mIntent = intent;
8929 mHashCode = intent.filterHashCode();
8930 }
8931
8932 /**
8933 * Return the Intent that this FilterComparison represents.
8934 * @return Returns the Intent held by the FilterComparison. Do
8935 * not modify!
8936 */
8937 public Intent getIntent() {
8938 return mIntent;
8939 }
8940
8941 @Override
8942 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008943 if (obj instanceof FilterComparison) {
8944 Intent other = ((FilterComparison)obj).mIntent;
8945 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008946 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008947 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008948 }
8949
8950 @Override
8951 public int hashCode() {
8952 return mHashCode;
8953 }
8954 }
8955
8956 /**
8957 * Determine if two intents are the same for the purposes of intent
8958 * resolution (filtering). That is, if their action, data, type,
8959 * class, and categories are the same. This does <em>not</em> compare
8960 * any extra data included in the intents.
8961 *
8962 * @param other The other Intent to compare against.
8963 *
8964 * @return Returns true if action, data, type, class, and categories
8965 * are the same.
8966 */
8967 public boolean filterEquals(Intent other) {
8968 if (other == null) {
8969 return false;
8970 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008971 if (!Objects.equals(this.mAction, other.mAction)) return false;
8972 if (!Objects.equals(this.mData, other.mData)) return false;
8973 if (!Objects.equals(this.mType, other.mType)) return false;
8974 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8975 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8976 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008977
8978 return true;
8979 }
8980
8981 /**
8982 * Generate hash code that matches semantics of filterEquals().
8983 *
8984 * @return Returns the hash value of the action, data, type, class, and
8985 * categories.
8986 *
8987 * @see #filterEquals
8988 */
8989 public int filterHashCode() {
8990 int code = 0;
8991 if (mAction != null) {
8992 code += mAction.hashCode();
8993 }
8994 if (mData != null) {
8995 code += mData.hashCode();
8996 }
8997 if (mType != null) {
8998 code += mType.hashCode();
8999 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009000 if (mPackage != null) {
9001 code += mPackage.hashCode();
9002 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009003 if (mComponent != null) {
9004 code += mComponent.hashCode();
9005 }
9006 if (mCategories != null) {
9007 code += mCategories.hashCode();
9008 }
9009 return code;
9010 }
9011
9012 @Override
9013 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009014 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009015
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009016 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009017 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009018 b.append(" }");
9019
9020 return b.toString();
9021 }
9022
9023 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009024 public String toInsecureString() {
9025 StringBuilder b = new StringBuilder(128);
9026
9027 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009028 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009029 b.append(" }");
9030
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009031 return b.toString();
9032 }
Romain Guy4969af72009-06-17 10:53:19 -07009033
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009034 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009035 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009036 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009037
9038 b.append("Intent { ");
9039 toShortString(b, false, true, true, true);
9040 b.append(" }");
9041
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009042 return b.toString();
9043 }
9044
9045 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009046 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9047 StringBuilder b = new StringBuilder(128);
9048 toShortString(b, secure, comp, extras, clip);
9049 return b.toString();
9050 }
9051
9052 /** @hide */
9053 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9054 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009055 boolean first = true;
9056 if (mAction != null) {
9057 b.append("act=").append(mAction);
9058 first = false;
9059 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009060 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009061 if (!first) {
9062 b.append(' ');
9063 }
9064 first = false;
9065 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009066 for (int i=0; i<mCategories.size(); i++) {
9067 if (i > 0) b.append(',');
9068 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009069 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009070 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009071 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009072 if (mData != null) {
9073 if (!first) {
9074 b.append(' ');
9075 }
9076 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009077 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009078 if (secure) {
9079 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009080 } else {
9081 b.append(mData);
9082 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009083 }
9084 if (mType != null) {
9085 if (!first) {
9086 b.append(' ');
9087 }
9088 first = false;
9089 b.append("typ=").append(mType);
9090 }
9091 if (mFlags != 0) {
9092 if (!first) {
9093 b.append(' ');
9094 }
9095 first = false;
9096 b.append("flg=0x").append(Integer.toHexString(mFlags));
9097 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009098 if (mPackage != null) {
9099 if (!first) {
9100 b.append(' ');
9101 }
9102 first = false;
9103 b.append("pkg=").append(mPackage);
9104 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009105 if (comp && mComponent != null) {
9106 if (!first) {
9107 b.append(' ');
9108 }
9109 first = false;
9110 b.append("cmp=").append(mComponent.flattenToShortString());
9111 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009112 if (mSourceBounds != null) {
9113 if (!first) {
9114 b.append(' ');
9115 }
9116 first = false;
9117 b.append("bnds=").append(mSourceBounds.toShortString());
9118 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009119 if (mClipData != null) {
9120 if (!first) {
9121 b.append(' ');
9122 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009123 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009124 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009125 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009126 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009127 if (mClipData.getDescription() != null) {
9128 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9129 } else {
9130 first = true;
9131 }
9132 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009133 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009134 first = false;
9135 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009136 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009137 if (extras && mExtras != null) {
9138 if (!first) {
9139 b.append(' ');
9140 }
9141 first = false;
9142 b.append("(has extras)");
9143 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009144 if (mContentUserHint != UserHandle.USER_CURRENT) {
9145 if (!first) {
9146 b.append(' ');
9147 }
9148 first = false;
9149 b.append("u=").append(mContentUserHint);
9150 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009151 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009152 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009153 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009154 b.append("}");
9155 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009156 }
9157
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009158 /**
9159 * Call {@link #toUri} with 0 flags.
9160 * @deprecated Use {@link #toUri} instead.
9161 */
9162 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009163 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009164 return toUri(0);
9165 }
9166
9167 /**
9168 * Convert this Intent into a String holding a URI representation of it.
9169 * The returned URI string has been properly URI encoded, so it can be
9170 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9171 * Intent's data as the base URI, with an additional fragment describing
9172 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009173 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009174 * <p>You can convert the returned string back to an Intent with
9175 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009176 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009177 * @param flags Additional operating flags. Either 0,
9178 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08009179 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009180 * @return Returns a URI encoding URI string describing the entire contents
9181 * of the Intent.
9182 */
9183 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009184 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009185 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9186 if (mPackage == null) {
9187 throw new IllegalArgumentException(
9188 "Intent must include an explicit package name to build an android-app: "
9189 + this);
9190 }
9191 uri.append("android-app://");
9192 uri.append(mPackage);
9193 String scheme = null;
9194 if (mData != null) {
9195 scheme = mData.getScheme();
9196 if (scheme != null) {
9197 uri.append('/');
9198 uri.append(scheme);
9199 String authority = mData.getEncodedAuthority();
9200 if (authority != null) {
9201 uri.append('/');
9202 uri.append(authority);
9203 String path = mData.getEncodedPath();
9204 if (path != null) {
9205 uri.append(path);
9206 }
9207 String queryParams = mData.getEncodedQuery();
9208 if (queryParams != null) {
9209 uri.append('?');
9210 uri.append(queryParams);
9211 }
9212 String fragment = mData.getEncodedFragment();
9213 if (fragment != null) {
9214 uri.append('#');
9215 uri.append(fragment);
9216 }
9217 }
9218 }
9219 }
9220 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9221 mPackage, flags);
9222 return uri.toString();
9223 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009224 String scheme = null;
9225 if (mData != null) {
9226 String data = mData.toString();
9227 if ((flags&URI_INTENT_SCHEME) != 0) {
9228 final int N = data.length();
9229 for (int i=0; i<N; i++) {
9230 char c = data.charAt(i);
9231 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
9232 || c == '.' || c == '-') {
9233 continue;
9234 }
9235 if (c == ':' && i > 0) {
9236 // Valid scheme.
9237 scheme = data.substring(0, i);
9238 uri.append("intent:");
9239 data = data.substring(i+1);
9240 break;
9241 }
Tom Taylord4a47292009-12-21 13:59:18 -08009242
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009243 // No scheme.
9244 break;
9245 }
9246 }
9247 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009248
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009249 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9250 uri.append("intent:");
9251 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009252
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009253 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009254
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009255 return uri.toString();
9256 }
9257
9258 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9259 String defPackage, int flags) {
9260 StringBuilder frag = new StringBuilder(128);
9261
9262 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009263 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009264 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009265 // Note that for now we are not going to try to handle the
9266 // data part; not clear how to represent this as a URI, and
9267 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009268 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9269 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009270 }
9271
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009272 if (frag.length() > 0) {
9273 uri.append("#Intent;");
9274 uri.append(frag);
9275 uri.append("end");
9276 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009277 }
9278
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009279 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9280 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009281 if (scheme != null) {
9282 uri.append("scheme=").append(scheme).append(';');
9283 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009284 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009285 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009286 }
9287 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009288 for (int i=0; i<mCategories.size(); i++) {
9289 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009290 }
9291 }
9292 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009293 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009294 }
9295 if (mFlags != 0) {
9296 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9297 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009298 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009299 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9300 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009301 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009302 uri.append("component=").append(Uri.encode(
9303 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009304 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009305 if (mSourceBounds != null) {
9306 uri.append("sourceBounds=")
9307 .append(Uri.encode(mSourceBounds.flattenToString()))
9308 .append(';');
9309 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009310 if (mExtras != null) {
9311 for (String key : mExtras.keySet()) {
9312 final Object value = mExtras.get(key);
9313 char entryType =
9314 value instanceof String ? 'S' :
9315 value instanceof Boolean ? 'B' :
9316 value instanceof Byte ? 'b' :
9317 value instanceof Character ? 'c' :
9318 value instanceof Double ? 'd' :
9319 value instanceof Float ? 'f' :
9320 value instanceof Integer ? 'i' :
9321 value instanceof Long ? 'l' :
9322 value instanceof Short ? 's' :
9323 '\0';
9324
9325 if (entryType != '\0') {
9326 uri.append(entryType);
9327 uri.append('.');
9328 uri.append(Uri.encode(key));
9329 uri.append('=');
9330 uri.append(Uri.encode(value.toString()));
9331 uri.append(';');
9332 }
9333 }
9334 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009335 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009336
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009337 public int describeContents() {
9338 return (mExtras != null) ? mExtras.describeContents() : 0;
9339 }
9340
9341 public void writeToParcel(Parcel out, int flags) {
9342 out.writeString(mAction);
9343 Uri.writeToParcel(out, mData);
9344 out.writeString(mType);
9345 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009346 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009347 ComponentName.writeToParcel(mComponent, out);
9348
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009349 if (mSourceBounds != null) {
9350 out.writeInt(1);
9351 mSourceBounds.writeToParcel(out, flags);
9352 } else {
9353 out.writeInt(0);
9354 }
9355
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009356 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009357 final int N = mCategories.size();
9358 out.writeInt(N);
9359 for (int i=0; i<N; i++) {
9360 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009361 }
9362 } else {
9363 out.writeInt(0);
9364 }
9365
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009366 if (mSelector != null) {
9367 out.writeInt(1);
9368 mSelector.writeToParcel(out, flags);
9369 } else {
9370 out.writeInt(0);
9371 }
9372
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009373 if (mClipData != null) {
9374 out.writeInt(1);
9375 mClipData.writeToParcel(out, flags);
9376 } else {
9377 out.writeInt(0);
9378 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009379 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009380 out.writeBundle(mExtras);
9381 }
9382
9383 public static final Parcelable.Creator<Intent> CREATOR
9384 = new Parcelable.Creator<Intent>() {
9385 public Intent createFromParcel(Parcel in) {
9386 return new Intent(in);
9387 }
9388 public Intent[] newArray(int size) {
9389 return new Intent[size];
9390 }
9391 };
9392
Dianne Hackborneb034652009-09-07 00:49:58 -07009393 /** @hide */
9394 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009395 readFromParcel(in);
9396 }
9397
9398 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009399 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009400 mData = Uri.CREATOR.createFromParcel(in);
9401 mType = in.readString();
9402 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009403 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009404 mComponent = ComponentName.readFromParcel(in);
9405
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009406 if (in.readInt() != 0) {
9407 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9408 }
9409
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009410 int N = in.readInt();
9411 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009412 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009413 int i;
9414 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009415 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009416 }
9417 } else {
9418 mCategories = null;
9419 }
9420
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009421 if (in.readInt() != 0) {
9422 mSelector = new Intent(in);
9423 }
9424
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009425 if (in.readInt() != 0) {
9426 mClipData = new ClipData(in);
9427 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009428 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009429 mExtras = in.readBundle();
9430 }
9431
9432 /**
9433 * Parses the "intent" element (and its children) from XML and instantiates
9434 * an Intent object. The given XML parser should be located at the tag
9435 * where parsing should start (often named "intent"), from which the
9436 * basic action, data, type, and package and class name will be
9437 * retrieved. The function will then parse in to any child elements,
9438 * looking for <category android:name="xxx"> tags to add categories and
9439 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9440 * to the intent.
9441 *
9442 * @param resources The Resources to use when inflating resources.
9443 * @param parser The XML parser pointing at an "intent" tag.
9444 * @param attrs The AttributeSet interface for retrieving extended
9445 * attribute data at the current <var>parser</var> location.
9446 * @return An Intent object matching the XML data.
9447 * @throws XmlPullParserException If there was an XML parsing error.
9448 * @throws IOException If there was an I/O error.
9449 */
9450 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
9451 throws XmlPullParserException, IOException {
9452 Intent intent = new Intent();
9453
9454 TypedArray sa = resources.obtainAttributes(attrs,
9455 com.android.internal.R.styleable.Intent);
9456
9457 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9458
9459 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9460 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9461 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9462
9463 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9464 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9465 if (packageName != null && className != null) {
9466 intent.setComponent(new ComponentName(packageName, className));
9467 }
9468
9469 sa.recycle();
9470
9471 int outerDepth = parser.getDepth();
9472 int type;
9473 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9474 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9475 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9476 continue;
9477 }
9478
9479 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009480 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009481 sa = resources.obtainAttributes(attrs,
9482 com.android.internal.R.styleable.IntentCategory);
9483 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9484 sa.recycle();
9485
9486 if (cat != null) {
9487 intent.addCategory(cat);
9488 }
9489 XmlUtils.skipCurrentTag(parser);
9490
Craig Mautner21d24a22014-04-23 11:45:37 -07009491 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009492 if (intent.mExtras == null) {
9493 intent.mExtras = new Bundle();
9494 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009495 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009496 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009497
9498 } else {
9499 XmlUtils.skipCurrentTag(parser);
9500 }
9501 }
9502
9503 return intent;
9504 }
Nick Pellyccae4122012-01-09 14:12:58 -08009505
Craig Mautner21d24a22014-04-23 11:45:37 -07009506 /** @hide */
9507 public void saveToXml(XmlSerializer out) throws IOException {
9508 if (mAction != null) {
9509 out.attribute(null, ATTR_ACTION, mAction);
9510 }
9511 if (mData != null) {
9512 out.attribute(null, ATTR_DATA, mData.toString());
9513 }
9514 if (mType != null) {
9515 out.attribute(null, ATTR_TYPE, mType);
9516 }
9517 if (mComponent != null) {
9518 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9519 }
9520 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9521
9522 if (mCategories != null) {
9523 out.startTag(null, TAG_CATEGORIES);
9524 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9525 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9526 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009527 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009528 }
9529 }
9530
9531 /** @hide */
9532 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9533 XmlPullParserException {
9534 Intent intent = new Intent();
9535 final int outerDepth = in.getDepth();
9536
9537 int attrCount = in.getAttributeCount();
9538 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9539 final String attrName = in.getAttributeName(attrNdx);
9540 final String attrValue = in.getAttributeValue(attrNdx);
9541 if (ATTR_ACTION.equals(attrName)) {
9542 intent.setAction(attrValue);
9543 } else if (ATTR_DATA.equals(attrName)) {
9544 intent.setData(Uri.parse(attrValue));
9545 } else if (ATTR_TYPE.equals(attrName)) {
9546 intent.setType(attrValue);
9547 } else if (ATTR_COMPONENT.equals(attrName)) {
9548 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9549 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009550 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009551 } else {
9552 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9553 }
9554 }
9555
9556 int event;
9557 String name;
9558 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9559 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9560 if (event == XmlPullParser.START_TAG) {
9561 name = in.getName();
9562 if (TAG_CATEGORIES.equals(name)) {
9563 attrCount = in.getAttributeCount();
9564 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9565 intent.addCategory(in.getAttributeValue(attrNdx));
9566 }
9567 } else {
9568 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9569 XmlUtils.skipCurrentTag(in);
9570 }
9571 }
9572 }
9573
9574 return intent;
9575 }
9576
Nick Pellyccae4122012-01-09 14:12:58 -08009577 /**
9578 * Normalize a MIME data type.
9579 *
9580 * <p>A normalized MIME type has white-space trimmed,
9581 * content-type parameters removed, and is lower-case.
9582 * This aligns the type with Android best practices for
9583 * intent filtering.
9584 *
9585 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9586 * "text/x-vCard" becomes "text/x-vcard".
9587 *
9588 * <p>All MIME types received from outside Android (such as user input,
9589 * or external sources like Bluetooth, NFC, or the Internet) should
9590 * be normalized before they are used to create an Intent.
9591 *
9592 * @param type MIME data type to normalize
9593 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009594 * @see #setType
9595 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009596 */
9597 public static String normalizeMimeType(String type) {
9598 if (type == null) {
9599 return null;
9600 }
9601
Elliott Hughescb64d432013-08-02 10:00:44 -07009602 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009603
9604 final int semicolonIndex = type.indexOf(';');
9605 if (semicolonIndex != -1) {
9606 type = type.substring(0, semicolonIndex);
9607 }
9608 return type;
9609 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009610
9611 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009612 * Prepare this {@link Intent} to leave an app process.
9613 *
9614 * @hide
9615 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009616 public void prepareToLeaveProcess(Context context) {
9617 final boolean leavingPackage = (mComponent == null)
9618 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9619 prepareToLeaveProcess(leavingPackage);
9620 }
9621
9622 /**
9623 * Prepare this {@link Intent} to leave an app process.
9624 *
9625 * @hide
9626 */
9627 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009628 setAllowFds(false);
9629
9630 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009631 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009632 }
9633 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009634 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009635 }
9636
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -07009637 if (mExtras != null && !mExtras.isParcelled()) {
9638 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
9639 if (intent instanceof Intent) {
9640 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
9641 }
9642 }
9643
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009644 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9645 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009646 switch (mAction) {
9647 case ACTION_MEDIA_REMOVED:
9648 case ACTION_MEDIA_UNMOUNTED:
9649 case ACTION_MEDIA_CHECKING:
9650 case ACTION_MEDIA_NOFS:
9651 case ACTION_MEDIA_MOUNTED:
9652 case ACTION_MEDIA_SHARED:
9653 case ACTION_MEDIA_UNSHARED:
9654 case ACTION_MEDIA_BAD_REMOVAL:
9655 case ACTION_MEDIA_UNMOUNTABLE:
9656 case ACTION_MEDIA_EJECT:
9657 case ACTION_MEDIA_SCANNER_STARTED:
9658 case ACTION_MEDIA_SCANNER_FINISHED:
9659 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009660 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9661 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009662 // Ignore legacy actions
9663 break;
9664 default:
9665 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009666 }
9667 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009668
9669 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
9670 && leavingPackage) {
9671 switch (mAction) {
9672 case ACTION_PROVIDER_CHANGED:
9673 // Ignore actions that don't need to grant
9674 break;
9675 default:
9676 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
9677 }
9678 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009679 }
9680
9681 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009682 * @hide
9683 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009684 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009685 // We just entered destination process, so we should be able to read all
9686 // parcelables inside.
9687 setDefusable(true);
9688
9689 if (mSelector != null) {
9690 mSelector.prepareToEnterProcess();
9691 }
9692 if (mClipData != null) {
9693 mClipData.prepareToEnterProcess();
9694 }
9695
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009696 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009697 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9698 fixUris(mContentUserHint);
9699 mContentUserHint = UserHandle.USER_CURRENT;
9700 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009701 }
9702 }
9703
9704 /**
9705 * @hide
9706 */
9707 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009708 Uri data = getData();
9709 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009710 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009711 }
9712 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009713 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009714 }
9715 String action = getAction();
9716 if (ACTION_SEND.equals(action)) {
9717 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9718 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009719 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009720 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009721 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009722 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9723 if (streams != null) {
9724 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9725 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009726 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009727 }
9728 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9729 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009730 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9731 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9732 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9733 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9734 if (output != null) {
9735 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9736 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009737 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009738 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009739
9740 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009741 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009742 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9743 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009744 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009745 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009746 * @hide
9747 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009748 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009749 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009750 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009751
9752 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009753 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009754
9755 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009756 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009757 // Inspect contained intents to see if we need to migrate extras. We
9758 // don't promote ClipData to the parent, since ChooserActivity will
9759 // already start the picked item as the caller, and we can't combine
9760 // the flags in a safe way.
9761
9762 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009763 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009764 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9765 if (intent != null) {
9766 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009767 }
9768 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009769 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009770 try {
9771 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9772 if (intents != null) {
9773 for (int i = 0; i < intents.length; i++) {
9774 final Intent intent = (Intent) intents[i];
9775 if (intent != null) {
9776 migrated |= intent.migrateExtraStreamToClipData();
9777 }
9778 }
9779 }
9780 } catch (ClassCastException e) {
9781 }
9782 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009783
9784 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009785 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009786 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9787 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9788 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9789 if (stream != null || text != null || htmlText != null) {
9790 final ClipData clipData = new ClipData(
9791 null, new String[] { getType() },
9792 new ClipData.Item(text, htmlText, null, stream));
9793 setClipData(clipData);
9794 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009795 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009796 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009797 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009798 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009799
9800 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009801 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009802 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9803 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9804 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9805 int num = -1;
9806 if (streams != null) {
9807 num = streams.size();
9808 }
9809 if (texts != null) {
9810 if (num >= 0 && num != texts.size()) {
9811 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009812 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009813 }
9814 num = texts.size();
9815 }
9816 if (htmlTexts != null) {
9817 if (num >= 0 && num != htmlTexts.size()) {
9818 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009819 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009820 }
9821 num = htmlTexts.size();
9822 }
9823 if (num > 0) {
9824 final ClipData clipData = new ClipData(
9825 null, new String[] { getType() },
9826 makeClipItem(streams, texts, htmlTexts, 0));
9827
9828 for (int i = 1; i < num; i++) {
9829 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9830 }
9831
9832 setClipData(clipData);
9833 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009834 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009835 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009836 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009837 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009838 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9839 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9840 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9841 final Uri output;
9842 try {
9843 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9844 } catch (ClassCastException e) {
9845 return false;
9846 }
9847 if (output != null) {
9848 setClipData(ClipData.newRawUri("", output));
9849 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9850 return true;
9851 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009852 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009853
9854 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009855 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009856
9857 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9858 ArrayList<String> htmlTexts, int which) {
9859 Uri uri = streams != null ? streams.get(which) : null;
9860 CharSequence text = texts != null ? texts.get(which) : null;
9861 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9862 return new ClipData.Item(text, htmlText, null, uri);
9863 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009864
9865 /** @hide */
9866 public boolean isDocument() {
9867 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9868 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009869}