blob: 426dafb4190d182c5a1ad279265eeb6ea98a2bed [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
Dianne Hackborn221ea892013-08-04 16:50:16 -070019import android.content.pm.ApplicationInfo;
Adam Powell2ed547e2015-04-29 18:45:04 -070020import android.os.ResultReceiver;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080021import android.os.ShellCommand;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010022import android.provider.MediaStore;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070023import android.util.ArraySet;
Jeff Sharkey846318a2014-04-04 12:12:41 -070024
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070025import org.xmlpull.v1.XmlPullParser;
26import org.xmlpull.v1.XmlPullParserException;
27
Tor Norbye7b9c9122013-05-30 16:48:33 -070028import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070029import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.annotation.SdkConstant;
Jose Lima73915cf2014-07-29 17:16:31 -070031import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.annotation.SdkConstant.SdkConstantType;
33import android.content.pm.ActivityInfo;
Jose Lima73915cf2014-07-29 17:16:31 -070034
Nicolas Prevotd85fc722014-04-16 19:52:08 +010035import static android.content.ContentProvider.maybeAddUserId;
Jose Lima73915cf2014-07-29 17:16:31 -070036
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070037import android.content.pm.PackageManager;
38import android.content.pm.ResolveInfo;
39import android.content.res.Resources;
40import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080041import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070042import android.net.Uri;
43import android.os.Bundle;
Felipe Lemec7b1f892016-01-15 15:02:31 -080044import android.os.Environment;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070045import android.os.IBinder;
46import android.os.Parcel;
47import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000048import android.os.Process;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070049import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010050import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070051import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070052import android.provider.DocumentsProvider;
53import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054import android.util.AttributeSet;
55import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080056
57import com.android.internal.util.XmlUtils;
Jose Lima73915cf2014-07-29 17:16:31 -070058
Craig Mautner21d24a22014-04-23 11:45:37 -070059import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070060
61import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080062import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070063import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070064import java.lang.annotation.Retention;
65import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.net.URISyntaxException;
67import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080068import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070069import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080070import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070071import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070072import java.util.Set;
73
74/**
75 * An intent is an abstract description of an operation to be performed. It
76 * can be used with {@link Context#startActivity(Intent) startActivity} to
77 * launch an {@link android.app.Activity},
78 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
79 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
80 * and {@link android.content.Context#startService} or
81 * {@link android.content.Context#bindService} to communicate with a
82 * background {@link android.app.Service}.
83 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070084 * <p>An Intent provides a facility for performing late runtime binding between the code in
85 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070086 * can be thought of as the glue between activities. It is basically a passive data structure
87 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070088 *
89 * <div class="special reference">
90 * <h3>Developer Guides</h3>
91 * <p>For information about how to create and resolve intents, read the
92 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
93 * developer guide.</p>
94 * </div>
95 *
96 * <a name="IntentStructure"></a>
97 * <h3>Intent Structure</h3>
98 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070099 *
100 * <ul>
101 * <li> <p><b>action</b> -- The general action to be performed, such as
102 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
103 * etc.</p>
104 * </li>
105 * <li> <p><b>data</b> -- The data to operate on, such as a person record
106 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
107 * </li>
108 * </ul>
109 *
110 *
111 * <p>Some examples of action/data pairs are:</p>
112 *
113 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700114 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700115 * information about the person whose identifier is "1".</p>
116 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700117 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700118 * the phone dialer with the person filled in.</p>
119 * </li>
120 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
121 * the phone dialer with the given number filled in. Note how the
122 * VIEW action does what what is considered the most reasonable thing for
123 * a particular URI.</p>
124 * </li>
125 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
126 * the phone dialer with the given number filled in.</p>
127 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700128 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700129 * information about the person whose identifier is "1".</p>
130 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700131 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700132 * a list of people, which the user can browse through. This example is a
133 * typical top-level entry into the Contacts application, showing you the
134 * list of people. Selecting a particular person to view would result in a
135 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
136 * being used to start an activity to display that person.</p>
137 * </li>
138 * </ul>
139 *
140 * <p>In addition to these primary attributes, there are a number of secondary
141 * attributes that you can also include with an intent:</p>
142 *
143 * <ul>
144 * <li> <p><b>category</b> -- Gives additional information about the action
145 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
146 * appear in the Launcher as a top-level application, while
147 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
148 * of alternative actions the user can perform on a piece of data.</p>
149 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
150 * intent data. Normally the type is inferred from the data itself.
151 * By setting this attribute, you disable that evaluation and force
152 * an explicit type.</p>
153 * <li> <p><b>component</b> -- Specifies an explicit name of a component
154 * class to use for the intent. Normally this is determined by looking
155 * at the other information in the intent (the action, data/type, and
156 * categories) and matching that with a component that can handle it.
157 * If this attribute is set then none of the evaluation is performed,
158 * and this component is used exactly as is. By specifying this attribute,
159 * all of the other Intent attributes become optional.</p>
160 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
161 * This can be used to provide extended information to the component.
162 * For example, if we have a action to send an e-mail message, we could
163 * also include extra pieces of data here to supply a subject, body,
164 * etc.</p>
165 * </ul>
166 *
167 * <p>Here are some examples of other operations you can specify as intents
168 * using these additional parameters:</p>
169 *
170 * <ul>
171 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
172 * Launch the home screen.</p>
173 * </li>
174 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
175 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
176 * vnd.android.cursor.item/phone}</i></b>
177 * -- Display the list of people's phone numbers, allowing the user to
178 * browse through them and pick one and return it to the parent activity.</p>
179 * </li>
180 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
181 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
182 * -- Display all pickers for data that can be opened with
183 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
184 * allowing the user to pick one of them and then some data inside of it
185 * and returning the resulting URI to the caller. This can be used,
186 * for example, in an e-mail application to allow the user to pick some
187 * data to include as an attachment.</p>
188 * </li>
189 * </ul>
190 *
191 * <p>There are a variety of standard Intent action and category constants
192 * defined in the Intent class, but applications can also define their own.
193 * These strings use java style scoping, to ensure they are unique -- for
194 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700195 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700196 *
197 * <p>Put together, the set of actions, data types, categories, and extra data
198 * defines a language for the system allowing for the expression of phrases
199 * such as "call john smith's cell". As applications are added to the system,
200 * they can extend this language by adding new actions, types, and categories, or
201 * they can modify the behavior of existing phrases by supplying their own
202 * activities that handle them.</p>
203 *
204 * <a name="IntentResolution"></a>
205 * <h3>Intent Resolution</h3>
206 *
207 * <p>There are two primary forms of intents you will use.
208 *
209 * <ul>
210 * <li> <p><b>Explicit Intents</b> have specified a component (via
211 * {@link #setComponent} or {@link #setClass}), which provides the exact
212 * class to be run. Often these will not include any other information,
213 * simply being a way for an application to launch various internal
214 * activities it has as the user interacts with the application.
215 *
216 * <li> <p><b>Implicit Intents</b> have not specified a component;
217 * instead, they must include enough information for the system to
218 * determine which of the available components is best to run for that
219 * intent.
220 * </ul>
221 *
222 * <p>When using implicit intents, given such an arbitrary intent we need to
223 * know what to do with it. This is handled by the process of <em>Intent
224 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
225 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
226 * more activities/receivers) that can handle it.</p>
227 *
228 * <p>The intent resolution mechanism basically revolves around matching an
229 * Intent against all of the &lt;intent-filter&gt; descriptions in the
230 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
231 * objects explicitly registered with {@link Context#registerReceiver}.) More
232 * details on this can be found in the documentation on the {@link
233 * IntentFilter} class.</p>
234 *
235 * <p>There are three pieces of information in the Intent that are used for
236 * resolution: the action, type, and category. Using this information, a query
237 * is done on the {@link PackageManager} for a component that can handle the
238 * intent. The appropriate component is determined based on the intent
239 * information supplied in the <code>AndroidManifest.xml</code> file as
240 * follows:</p>
241 *
242 * <ul>
243 * <li> <p>The <b>action</b>, if given, must be listed by the component as
244 * one it handles.</p>
245 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
246 * already supplied in the Intent. Like the action, if a type is
247 * included in the intent (either explicitly or implicitly in its
248 * data), then this must be listed by the component as one it handles.</p>
249 * <li> For data that is not a <code>content:</code> URI and where no explicit
250 * type is included in the Intent, instead the <b>scheme</b> of the
251 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
252 * considered. Again like the action, if we are matching a scheme it
253 * must be listed by the component as one it can handle.
254 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
255 * by the activity as categories it handles. That is, if you include
256 * the categories {@link #CATEGORY_LAUNCHER} and
257 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
258 * with an intent that lists <em>both</em> of those categories.
259 * Activities will very often need to support the
260 * {@link #CATEGORY_DEFAULT} so that they can be found by
261 * {@link Context#startActivity Context.startActivity()}.</p>
262 * </ul>
263 *
264 * <p>For example, consider the Note Pad sample application that
265 * allows user to browse through a list of notes data and view details about
266 * individual items. Text in italics indicate places were you would replace a
267 * name with one specific to your own package.</p>
268 *
269 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
270 * package="<i>com.android.notepad</i>"&gt;
271 * &lt;application android:icon="@drawable/app_notes"
272 * android:label="@string/app_name"&gt;
273 *
274 * &lt;provider class=".NotePadProvider"
275 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
276 *
277 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
278 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="android.intent.action.MAIN" /&gt;
280 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700281 * &lt;/intent-filter&gt;
282 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700283 * &lt;action android:name="android.intent.action.VIEW" /&gt;
284 * &lt;action android:name="android.intent.action.EDIT" /&gt;
285 * &lt;action android:name="android.intent.action.PICK" /&gt;
286 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
287 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700288 * &lt;/intent-filter&gt;
289 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700293 * &lt;/intent-filter&gt;
294 * &lt;/activity&gt;
295 *
296 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
297 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700298 * &lt;action android:name="android.intent.action.VIEW" /&gt;
299 * &lt;action android:name="android.intent.action.EDIT" /&gt;
300 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
301 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700302 * &lt;/intent-filter&gt;
303 *
304 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700305 * &lt;action android:name="android.intent.action.INSERT" /&gt;
306 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
307 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700308 * &lt;/intent-filter&gt;
309 *
310 * &lt;/activity&gt;
311 *
312 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
313 * android:theme="@android:style/Theme.Dialog"&gt;
314 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700315 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
316 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
317 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
318 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
319 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700320 * &lt;/intent-filter&gt;
321 * &lt;/activity&gt;
322 *
323 * &lt;/application&gt;
324 * &lt;/manifest&gt;</pre>
325 *
326 * <p>The first activity,
327 * <code>com.android.notepad.NotesList</code>, serves as our main
328 * entry into the app. It can do three things as described by its three intent
329 * templates:
330 * <ol>
331 * <li><pre>
332 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700333 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
334 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700335 * &lt;/intent-filter&gt;</pre>
336 * <p>This provides a top-level entry into the NotePad application: the standard
337 * MAIN action is a main entry point (not requiring any other information in
338 * the Intent), and the LAUNCHER category says that this entry point should be
339 * listed in the application launcher.</p>
340 * <li><pre>
341 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700342 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
343 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
344 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
345 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
346 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700347 * &lt;/intent-filter&gt;</pre>
348 * <p>This declares the things that the activity can do on a directory of
349 * notes. The type being supported is given with the &lt;type&gt; tag, where
350 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
351 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
352 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
353 * The activity allows the user to view or edit the directory of data (via
354 * the VIEW and EDIT actions), or to pick a particular note and return it
355 * to the caller (via the PICK action). Note also the DEFAULT category
356 * supplied here: this is <em>required</em> for the
357 * {@link Context#startActivity Context.startActivity} method to resolve your
358 * activity when its component name is not explicitly specified.</p>
359 * <li><pre>
360 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700361 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
362 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
363 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700364 * &lt;/intent-filter&gt;</pre>
365 * <p>This filter describes the ability return to the caller a note selected by
366 * the user without needing to know where it came from. The data type
367 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
368 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
369 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
370 * The GET_CONTENT action is similar to the PICK action, where the activity
371 * will return to its caller a piece of data selected by the user. Here,
372 * however, the caller specifies the type of data they desire instead of
373 * the type of data the user will be picking from.</p>
374 * </ol>
375 *
376 * <p>Given these capabilities, the following intents will resolve to the
377 * NotesList activity:</p>
378 *
379 * <ul>
380 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
381 * activities that can be used as top-level entry points into an
382 * application.</p>
383 * <li> <p><b>{ action=android.app.action.MAIN,
384 * category=android.app.category.LAUNCHER }</b> is the actual intent
385 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700386 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700387 * data=content://com.google.provider.NotePad/notes }</b>
388 * displays a list of all the notes under
389 * "content://com.google.provider.NotePad/notes", which
390 * the user can browse through and see the details on.</p>
391 * <li> <p><b>{ action=android.app.action.PICK
392 * data=content://com.google.provider.NotePad/notes }</b>
393 * provides a list of the notes under
394 * "content://com.google.provider.NotePad/notes", from which
395 * the user can pick a note whose data URL is returned back to the caller.</p>
396 * <li> <p><b>{ action=android.app.action.GET_CONTENT
397 * type=vnd.android.cursor.item/vnd.google.note }</b>
398 * is similar to the pick action, but allows the caller to specify the
399 * kind of data they want back so that the system can find the appropriate
400 * activity to pick something of that data type.</p>
401 * </ul>
402 *
403 * <p>The second activity,
404 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
405 * note entry and allows them to edit it. It can do two things as described
406 * by its two intent templates:
407 * <ol>
408 * <li><pre>
409 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700410 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
411 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
412 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
413 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700414 * &lt;/intent-filter&gt;</pre>
415 * <p>The first, primary, purpose of this activity is to let the user interact
416 * with a single note, as decribed by the MIME type
417 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
418 * either VIEW a note or allow the user to EDIT it. Again we support the
419 * DEFAULT category to allow the activity to be launched without explicitly
420 * specifying its component.</p>
421 * <li><pre>
422 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700423 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
424 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
425 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700426 * &lt;/intent-filter&gt;</pre>
427 * <p>The secondary use of this activity is to insert a new note entry into
428 * an existing directory of notes. This is used when the user creates a new
429 * note: the INSERT action is executed on the directory of notes, causing
430 * this activity to run and have the user create the new note data which
431 * it then adds to the content provider.</p>
432 * </ol>
433 *
434 * <p>Given these capabilities, the following intents will resolve to the
435 * NoteEditor activity:</p>
436 *
437 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700438 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700439 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
440 * shows the user the content of note <var>{ID}</var>.</p>
441 * <li> <p><b>{ action=android.app.action.EDIT
442 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
443 * allows the user to edit the content of note <var>{ID}</var>.</p>
444 * <li> <p><b>{ action=android.app.action.INSERT
445 * data=content://com.google.provider.NotePad/notes }</b>
446 * creates a new, empty note in the notes list at
447 * "content://com.google.provider.NotePad/notes"
448 * and allows the user to edit it. If they keep their changes, the URI
449 * of the newly created note is returned to the caller.</p>
450 * </ul>
451 *
452 * <p>The last activity,
453 * <code>com.android.notepad.TitleEditor</code>, allows the user to
454 * edit the title of a note. This could be implemented as a class that the
455 * application directly invokes (by explicitly setting its component in
456 * the Intent), but here we show a way you can publish alternative
457 * operations on existing data:</p>
458 *
459 * <pre>
460 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700461 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
462 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
463 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
464 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
465 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700466 * &lt;/intent-filter&gt;</pre>
467 *
468 * <p>In the single intent template here, we
469 * have created our own private action called
470 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
471 * edit the title of a note. It must be invoked on a specific note
472 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
473 * view and edit actions, but here displays and edits the title contained
474 * in the note data.
475 *
476 * <p>In addition to supporting the default category as usual, our title editor
477 * also supports two other standard categories: ALTERNATIVE and
478 * SELECTED_ALTERNATIVE. Implementing
479 * these categories allows others to find the special action it provides
480 * without directly knowing about it, through the
481 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
482 * more often to build dynamic menu items with
483 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
484 * template here was also supply an explicit name for the template
485 * (via <code>android:label="@string/resolve_title"</code>) to better control
486 * what the user sees when presented with this activity as an alternative
487 * action to the data they are viewing.
488 *
489 * <p>Given these capabilities, the following intent will resolve to the
490 * TitleEditor activity:</p>
491 *
492 * <ul>
493 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
494 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
495 * displays and allows the user to edit the title associated
496 * with note <var>{ID}</var>.</p>
497 * </ul>
498 *
499 * <h3>Standard Activity Actions</h3>
500 *
501 * <p>These are the current standard actions that Intent defines for launching
502 * activities (usually through {@link Context#startActivity}. The most
503 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
504 * {@link #ACTION_EDIT}.
505 *
506 * <ul>
507 * <li> {@link #ACTION_MAIN}
508 * <li> {@link #ACTION_VIEW}
509 * <li> {@link #ACTION_ATTACH_DATA}
510 * <li> {@link #ACTION_EDIT}
511 * <li> {@link #ACTION_PICK}
512 * <li> {@link #ACTION_CHOOSER}
513 * <li> {@link #ACTION_GET_CONTENT}
514 * <li> {@link #ACTION_DIAL}
515 * <li> {@link #ACTION_CALL}
516 * <li> {@link #ACTION_SEND}
517 * <li> {@link #ACTION_SENDTO}
518 * <li> {@link #ACTION_ANSWER}
519 * <li> {@link #ACTION_INSERT}
520 * <li> {@link #ACTION_DELETE}
521 * <li> {@link #ACTION_RUN}
522 * <li> {@link #ACTION_SYNC}
523 * <li> {@link #ACTION_PICK_ACTIVITY}
524 * <li> {@link #ACTION_SEARCH}
525 * <li> {@link #ACTION_WEB_SEARCH}
526 * <li> {@link #ACTION_FACTORY_TEST}
527 * </ul>
528 *
529 * <h3>Standard Broadcast Actions</h3>
530 *
531 * <p>These are the current standard actions that Intent defines for receiving
532 * broadcasts (usually through {@link Context#registerReceiver} or a
533 * &lt;receiver&gt; tag in a manifest).
534 *
535 * <ul>
536 * <li> {@link #ACTION_TIME_TICK}
537 * <li> {@link #ACTION_TIME_CHANGED}
538 * <li> {@link #ACTION_TIMEZONE_CHANGED}
539 * <li> {@link #ACTION_BOOT_COMPLETED}
540 * <li> {@link #ACTION_PACKAGE_ADDED}
541 * <li> {@link #ACTION_PACKAGE_CHANGED}
542 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800543 * <li> {@link #ACTION_PACKAGE_RESTARTED}
544 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000545 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
546 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700547 * <li> {@link #ACTION_UID_REMOVED}
548 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700549 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700550 * <li> {@link #ACTION_POWER_DISCONNECTED}
551 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700552 * </ul>
553 *
554 * <h3>Standard Categories</h3>
555 *
556 * <p>These are the current standard categories that can be used to further
557 * clarify an Intent via {@link #addCategory}.
558 *
559 * <ul>
560 * <li> {@link #CATEGORY_DEFAULT}
561 * <li> {@link #CATEGORY_BROWSABLE}
562 * <li> {@link #CATEGORY_TAB}
563 * <li> {@link #CATEGORY_ALTERNATIVE}
564 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
565 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800566 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700567 * <li> {@link #CATEGORY_HOME}
568 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700569 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400570 * <li> {@link #CATEGORY_CAR_DOCK}
571 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500572 * <li> {@link #CATEGORY_LE_DESK_DOCK}
573 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200574 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700575 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700576 * </ul>
577 *
578 * <h3>Standard Extra Data</h3>
579 *
580 * <p>These are the current standard fields that can be used as extra data via
581 * {@link #putExtra}.
582 *
583 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800584 * <li> {@link #EXTRA_ALARM_COUNT}
585 * <li> {@link #EXTRA_BCC}
586 * <li> {@link #EXTRA_CC}
587 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
588 * <li> {@link #EXTRA_DATA_REMOVED}
589 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500590 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
591 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800592 * <li> {@link #EXTRA_DOCK_STATE_CAR}
593 * <li> {@link #EXTRA_DOCK_STATE_DESK}
594 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
595 * <li> {@link #EXTRA_DONT_KILL_APP}
596 * <li> {@link #EXTRA_EMAIL}
597 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700598 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800599 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700600 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800601 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700602 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800603 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
604 * <li> {@link #EXTRA_REPLACING}
605 * <li> {@link #EXTRA_SHORTCUT_ICON}
606 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
607 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800609 * <li> {@link #EXTRA_SHORTCUT_NAME}
610 * <li> {@link #EXTRA_SUBJECT}
611 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700612 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800613 * <li> {@link #EXTRA_TITLE}
614 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700615 * </ul>
616 *
617 * <h3>Flags</h3>
618 *
619 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800620 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
621 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700622 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800623public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700624 private static final String ATTR_ACTION = "action";
625 private static final String TAG_CATEGORIES = "categories";
626 private static final String ATTR_CATEGORY = "category";
627 private static final String TAG_EXTRA = "extra";
628 private static final String ATTR_TYPE = "type";
629 private static final String ATTR_COMPONENT = "component";
630 private static final String ATTR_DATA = "data";
631 private static final String ATTR_FLAGS = "flags";
632
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700633 // ---------------------------------------------------------------------
634 // ---------------------------------------------------------------------
635 // Standard intent activity actions (see action variable).
636
637 /**
638 * Activity Action: Start as a main entry point, does not expect to
639 * receive data.
640 * <p>Input: nothing
641 * <p>Output: nothing
642 */
643 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
644 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800645
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700646 /**
647 * Activity Action: Display the data to the user. This is the most common
648 * action performed on data -- it is the generic action you can use on
649 * a piece of data to get the most reasonable thing to occur. For example,
650 * when used on a contacts entry it will view the entry; when used on a
651 * mailto: URI it will bring up a compose window filled with the information
652 * supplied by the URI; when used with a tel: URI it will invoke the
653 * dialer.
654 * <p>Input: {@link #getData} is URI from which to retrieve data.
655 * <p>Output: nothing.
656 */
657 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
658 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700660 /**
661 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
662 * performed on a piece of data.
663 */
664 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800665
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700666 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900667 * Activity Action: Quick view the data. Launches a quick viewer for
668 * a URI or a list of URIs.
669 * <p>Input: {@link #getData} is a mandatory content URI of the item to
670 * preview. {@link #getClipData} contains an optional list of content URIs
671 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
672 * optional index of the URI in the clip data to show first.
Steve McKayc78bcb82015-07-31 14:35:22 -0700673 * <p>Output: nothing.
Steve McKayc78bcb82015-07-31 14:35:22 -0700674 */
675 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
676 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
677
678 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700679 * Used to indicate that some piece of data should be attached to some other
680 * place. For example, image data could be attached to a contact. It is up
681 * to the recipient to decide where the data should be attached; the intent
682 * does not specify the ultimate destination.
683 * <p>Input: {@link #getData} is URI of data to be attached.
684 * <p>Output: nothing.
685 */
686 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
687 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800688
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700689 /**
690 * Activity Action: Provide explicit editable access to the given data.
691 * <p>Input: {@link #getData} is URI of data to be edited.
692 * <p>Output: nothing.
693 */
694 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
695 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800696
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700697 /**
698 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
699 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
700 * The extras can contain type specific data to pass through to the editing/creating
701 * activity.
702 * <p>Output: The URI of the item that was picked. This must be a content:
703 * URI so that any receiver can access it.
704 */
705 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
706 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800707
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700708 /**
709 * Activity Action: Pick an item from the data, returning what was selected.
710 * <p>Input: {@link #getData} is URI containing a directory of data
711 * (vnd.android.cursor.dir/*) from which to pick an item.
712 * <p>Output: The URI of the item that was picked.
713 */
714 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
715 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800716
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700717 /**
718 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800719 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700720 * <p>Output: An Intent representing the shortcut. The intent must contain three
721 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
722 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800723 * (value: ShortcutIconResource).</p>
724 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700725 * @see #EXTRA_SHORTCUT_INTENT
726 * @see #EXTRA_SHORTCUT_NAME
727 * @see #EXTRA_SHORTCUT_ICON
728 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
729 * @see android.content.Intent.ShortcutIconResource
730 */
731 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
732 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
733
734 /**
735 * The name of the extra used to define the Intent of a shortcut.
736 *
737 * @see #ACTION_CREATE_SHORTCUT
738 */
739 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
740 /**
741 * The name of the extra used to define the name of a shortcut.
742 *
743 * @see #ACTION_CREATE_SHORTCUT
744 */
745 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
746 /**
747 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
748 *
749 * @see #ACTION_CREATE_SHORTCUT
750 */
751 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
752 /**
753 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
754 *
755 * @see #ACTION_CREATE_SHORTCUT
756 * @see android.content.Intent.ShortcutIconResource
757 */
758 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
759 "android.intent.extra.shortcut.ICON_RESOURCE";
760
761 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800762 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700763 *
764 * @see Intent#ACTION_CREATE_SHORTCUT
765 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800766 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
767 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700768 */
769 public static class ShortcutIconResource implements Parcelable {
770 /**
771 * The package name of the application containing the icon.
772 */
773 public String packageName;
774
775 /**
776 * The resource name of the icon, including package, name and type.
777 */
778 public String resourceName;
779
780 /**
781 * Creates a new ShortcutIconResource for the specified context and resource
782 * identifier.
783 *
784 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700785 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700786 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700787 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700788 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700789 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700790 ShortcutIconResource icon = new ShortcutIconResource();
791 icon.packageName = context.getPackageName();
792 icon.resourceName = context.getResources().getResourceName(resourceId);
793 return icon;
794 }
795
796 /**
797 * Used to read a ShortcutIconResource from a Parcel.
798 */
799 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
800 new Parcelable.Creator<ShortcutIconResource>() {
801
802 public ShortcutIconResource createFromParcel(Parcel source) {
803 ShortcutIconResource icon = new ShortcutIconResource();
804 icon.packageName = source.readString();
805 icon.resourceName = source.readString();
806 return icon;
807 }
808
809 public ShortcutIconResource[] newArray(int size) {
810 return new ShortcutIconResource[size];
811 }
812 };
813
814 /**
815 * No special parcel contents.
816 */
817 public int describeContents() {
818 return 0;
819 }
820
821 public void writeToParcel(Parcel dest, int flags) {
822 dest.writeString(packageName);
823 dest.writeString(resourceName);
824 }
825
826 @Override
827 public String toString() {
828 return resourceName;
829 }
830 }
831
832 /**
833 * Activity Action: Display an activity chooser, allowing the user to pick
834 * what they want to before proceeding. This can be used as an alternative
835 * to the standard activity picker that is displayed by the system when
836 * you try to start an activity with multiple possible matches, with these
837 * differences in behavior:
838 * <ul>
839 * <li>You can specify the title that will appear in the activity chooser.
840 * <li>The user does not have the option to make one of the matching
841 * activities a preferred activity, and all possible activities will
842 * always be shown even if one of them is currently marked as the
843 * preferred activity.
844 * </ul>
845 * <p>
846 * This action should be used when the user will naturally expect to
847 * select an activity in order to proceed. An example if when not to use
848 * it is when the user clicks on a "mailto:" link. They would naturally
849 * expect to go directly to their mail app, so startActivity() should be
850 * called directly: it will
851 * either launch the current preferred app, or put up a dialog allowing the
852 * user to pick an app to use and optionally marking that as preferred.
853 * <p>
854 * In contrast, if the user is selecting a menu item to send a picture
855 * they are viewing to someone else, there are many different things they
856 * may want to do at this point: send it through e-mail, upload it to a
857 * web service, etc. In this case the CHOOSER action should be used, to
858 * always present to the user a list of the things they can do, with a
859 * nice title given by the caller such as "Send this photo with:".
860 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700861 * If you need to grant URI permissions through a chooser, you must specify
862 * the permissions to be granted on the ACTION_CHOOSER Intent
863 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
864 * {@link #setClipData} to specify the URIs to be granted as well as
865 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
866 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
867 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700868 * As a convenience, an Intent of this form can be created with the
869 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700870 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700871 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700872 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
873 * and can optionally have a {@link #EXTRA_TITLE} field containing the
874 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700875 * <p>
876 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700877 */
878 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
879 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
880
881 /**
882 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
883 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700884 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
885 * target intent, also optionally supplying a title. If the target
886 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
887 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
888 * set in the returned chooser intent, with its ClipData set appropriately:
889 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500890 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700891 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700892 * @param target The Intent that the user will be selecting an activity
893 * to perform.
894 * @param title Optional title that will be displayed in the chooser.
895 * @return Return a new Intent object that you can hand to
896 * {@link Context#startActivity(Intent) Context.startActivity()} and
897 * related methods.
898 */
899 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700900 return createChooser(target, title, null);
901 }
902
903 /**
904 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
905 *
906 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
907 * target intent, also optionally supplying a title. If the target
908 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
909 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
910 * set in the returned chooser intent, with its ClipData set appropriately:
911 * either a direct reflection of {@link #getClipData()} if that is non-null,
912 * or a new ClipData built from {@link #getData()}.</p>
913 *
914 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
915 * when the user makes a choice. This can be useful if the calling application wants
916 * to remember the last chosen target and surface it as a more prominent or one-touch
917 * affordance elsewhere in the UI for next time.</p>
918 *
919 * @param target The Intent that the user will be selecting an activity
920 * to perform.
921 * @param title Optional title that will be displayed in the chooser.
922 * @param sender Optional IntentSender to be called when a choice is made.
923 * @return Return a new Intent object that you can hand to
924 * {@link Context#startActivity(Intent) Context.startActivity()} and
925 * related methods.
926 */
927 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700928 Intent intent = new Intent(ACTION_CHOOSER);
929 intent.putExtra(EXTRA_INTENT, target);
930 if (title != null) {
931 intent.putExtra(EXTRA_TITLE, title);
932 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700933
Adam Powell0b3c1122014-10-09 12:50:14 -0700934 if (sender != null) {
935 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
936 }
937
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700938 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700939 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
940 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
941 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700942 if (permFlags != 0) {
943 ClipData targetClipData = target.getClipData();
944 if (targetClipData == null && target.getData() != null) {
945 ClipData.Item item = new ClipData.Item(target.getData());
946 String[] mimeTypes;
947 if (target.getType() != null) {
948 mimeTypes = new String[] { target.getType() };
949 } else {
950 mimeTypes = new String[] { };
951 }
952 targetClipData = new ClipData(null, mimeTypes, item);
953 }
954 if (targetClipData != null) {
955 intent.setClipData(targetClipData);
956 intent.addFlags(permFlags);
957 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700958 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700959
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700960 return intent;
961 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700962
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700963 /**
964 * Activity Action: Allow the user to select a particular kind of data and
965 * return it. This is different than {@link #ACTION_PICK} in that here we
966 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800967 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700968 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900969 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700970 * etc.
971 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900972 * 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 -0700973 * of data, such as a person contact, you set the MIME type to the kind of
974 * data you want and launch it with {@link Context#startActivity(Intent)}.
975 * The system will then launch the best application to select that kind
976 * of data for you.
977 * <p>
978 * You may also be interested in any of a set of types of content the user
979 * can pick. For example, an e-mail application that wants to allow the
980 * user to add an attachment to an e-mail message can use this action to
981 * bring up a list of all of the types of content the user can attach.
982 * <p>
983 * In this case, you should wrap the GET_CONTENT intent with a chooser
984 * (through {@link #createChooser}), which will give the proper interface
985 * for the user to pick how to send your data and allow you to specify
986 * a prompt indicating what they are doing. You will usually specify a
987 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
988 * broad range of content types the user can select from.
989 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900990 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700991 * only pick from data that can be represented as a stream. This is
992 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
993 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800994 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900995 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800996 * is locally available on the device. For example, if this extra is set
997 * to true then an image picker should not show any pictures that are available
998 * from a remote server but not already on the local device (thus requiring
999 * they be downloaded when opened).
1000 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001001 * If the caller can handle multiple returned items (the user performing
1002 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1003 * to indicate this.
1004 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001005 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1006 * that no URI is supplied in the intent, as there are no constraints on
1007 * where the returned data originally comes from. You may also include the
1008 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001009 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001010 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1011 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001012 * <p>
1013 * Output: The URI of the item that was picked. This must be a content:
1014 * URI so that any receiver can access it.
1015 */
1016 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1017 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1018 /**
1019 * Activity Action: Dial a number as specified by the data. This shows a
1020 * UI with the number being dialed, allowing the user to explicitly
1021 * initiate the call.
1022 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1023 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1024 * number.
1025 * <p>Output: nothing.
1026 */
1027 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1028 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1029 /**
1030 * Activity Action: Perform a call to someone specified by the data.
1031 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1032 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1033 * number.
1034 * <p>Output: nothing.
1035 *
1036 * <p>Note: there will be restrictions on which applications can initiate a
1037 * call; most applications should use the {@link #ACTION_DIAL}.
1038 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1039 * numbers. Applications can <strong>dial</strong> emergency numbers using
1040 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001041 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001042 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001043 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001044 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001045 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001046 */
1047 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1048 public static final String ACTION_CALL = "android.intent.action.CALL";
1049 /**
1050 * Activity Action: Perform a call to an emergency number specified by the
1051 * data.
1052 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1053 * tel: URI of an explicit phone number.
1054 * <p>Output: nothing.
1055 * @hide
1056 */
1057 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1058 /**
1059 * Activity action: Perform a call to any number (emergency or not)
1060 * specified by the data.
1061 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1062 * tel: URI of an explicit phone number.
1063 * <p>Output: nothing.
1064 * @hide
1065 */
1066 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1067 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001068 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1069 * sending this intent is a no-op.
1070 * <p>Input: No data should be specified. get*Extra may have an optional
1071 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1072 * send the activation result.
1073 * <p>Output: nothing.
1074 * @hide
1075 */
1076 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1077 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1078 "android.intent.action.SIM_ACTIVATION_REQUEST";
1079 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001080 * Activity Action: Send a message to someone specified by the data.
1081 * <p>Input: {@link #getData} is URI describing the target.
1082 * <p>Output: nothing.
1083 */
1084 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1085 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1086 /**
1087 * Activity Action: Deliver some data to someone else. Who the data is
1088 * being delivered to is not specified; it is up to the receiver of this
1089 * action to ask the user where the data should be sent.
1090 * <p>
1091 * When launching a SEND intent, you should usually wrap it in a chooser
1092 * (through {@link #createChooser}), which will give the proper interface
1093 * for the user to pick how to send your data and allow you to specify
1094 * a prompt indicating what they are doing.
1095 * <p>
1096 * Input: {@link #getType} is the MIME type of the data being sent.
1097 * get*Extra can have either a {@link #EXTRA_TEXT}
1098 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1099 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1100 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1101 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001102 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1103 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1104 * your text with HTML formatting.
1105 * <p>
1106 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1107 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1108 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1109 * content: URIs and other advanced features of {@link ClipData}. If
1110 * using this approach, you still must supply the same data through the
1111 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1112 * for compatibility with old applications. If you don't set a ClipData,
1113 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001114 * <p>
1115 * Optional standard extras, which may be interpreted by some recipients as
1116 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1117 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1118 * <p>
1119 * Output: nothing.
1120 */
1121 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1122 public static final String ACTION_SEND = "android.intent.action.SEND";
1123 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001124 * Activity Action: Deliver multiple data to someone else.
1125 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001126 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001127 * <p>
1128 * Input: {@link #getType} is the MIME type of the data being sent.
1129 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001130 * #EXTRA_STREAM} field, containing the data to be sent. If using
1131 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1132 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001133 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001134 * Multiple types are supported, and receivers should handle mixed types
1135 * whenever possible. The right way for the receiver to check them is to
1136 * use the content resolver on each URI. The intent sender should try to
1137 * put the most concrete mime type in the intent type, but it can fall
1138 * back to {@literal <type>/*} or {@literal *}/* as needed.
1139 * <p>
1140 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1141 * be image/jpg, but if you are sending image/jpg and image/png, then the
1142 * intent's type should be image/*.
1143 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001144 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1145 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1146 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1147 * content: URIs and other advanced features of {@link ClipData}. If
1148 * using this approach, you still must supply the same data through the
1149 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1150 * for compatibility with old applications. If you don't set a ClipData,
1151 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1152 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001153 * Optional standard extras, which may be interpreted by some recipients as
1154 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1155 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1156 * <p>
1157 * Output: nothing.
1158 */
1159 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1160 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1161 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001162 * Activity Action: Handle an incoming phone call.
1163 * <p>Input: nothing.
1164 * <p>Output: nothing.
1165 */
1166 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1167 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1168 /**
1169 * Activity Action: Insert an empty item into the given container.
1170 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1171 * in which to place the data.
1172 * <p>Output: URI of the new data that was created.
1173 */
1174 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1175 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1176 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001177 * Activity Action: Create a new item in the given container, initializing it
1178 * from the current contents of the clipboard.
1179 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1180 * in which to place the data.
1181 * <p>Output: URI of the new data that was created.
1182 */
1183 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1184 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1185 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001186 * Activity Action: Delete the given data from its container.
1187 * <p>Input: {@link #getData} is URI of data to be deleted.
1188 * <p>Output: nothing.
1189 */
1190 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1191 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1192 /**
1193 * Activity Action: Run the data, whatever that means.
1194 * <p>Input: ? (Note: this is currently specific to the test harness.)
1195 * <p>Output: nothing.
1196 */
1197 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1198 public static final String ACTION_RUN = "android.intent.action.RUN";
1199 /**
1200 * Activity Action: Perform a data synchronization.
1201 * <p>Input: ?
1202 * <p>Output: ?
1203 */
1204 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1205 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1206 /**
1207 * Activity Action: Pick an activity given an intent, returning the class
1208 * selected.
1209 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1210 * used with {@link PackageManager#queryIntentActivities} to determine the
1211 * set of activities from which to pick.
1212 * <p>Output: Class name of the activity that was selected.
1213 */
1214 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1215 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1216 /**
1217 * Activity Action: Perform a search.
1218 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1219 * is the text to search for. If empty, simply
1220 * enter your search results Activity with the search UI activated.
1221 * <p>Output: nothing.
1222 */
1223 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1224 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1225 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001226 * Activity Action: Start the platform-defined tutorial
1227 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1228 * is the text to search for. If empty, simply
1229 * enter your search results Activity with the search UI activated.
1230 * <p>Output: nothing.
1231 */
1232 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1233 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1234 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001235 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001236 * <p>
1237 * Input: {@link android.app.SearchManager#QUERY
1238 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1239 * a url starts with http or https, the site will be opened. If it is plain
1240 * text, Google search will be applied.
1241 * <p>
1242 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001243 */
1244 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1245 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001246
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001247 /**
Jim Miller07994402012-05-02 14:22:27 -07001248 * Activity Action: Perform assist action.
1249 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001250 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1251 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001252 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1253 * information.
Jim Miller07994402012-05-02 14:22:27 -07001254 * Output: nothing.
1255 */
1256 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1257 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001258
1259 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001260 * Activity Action: Perform voice assist action.
1261 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001262 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1263 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001264 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001265 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001266 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001267 */
1268 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1269 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1270
1271 /**
Adam Skory7140a252013-09-11 12:04:58 +01001272 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1273 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001274 */
1275 public static final String EXTRA_ASSIST_PACKAGE
1276 = "android.intent.extra.ASSIST_PACKAGE";
1277
1278 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001279 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1280 * application package at the time the assist was invoked.
1281 */
1282 public static final String EXTRA_ASSIST_UID
1283 = "android.intent.extra.ASSIST_UID";
1284
1285 /**
Adam Skory7140a252013-09-11 12:04:58 +01001286 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1287 * information supplied by the current foreground app at the time of the assist request.
1288 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001289 */
1290 public static final String EXTRA_ASSIST_CONTEXT
1291 = "android.intent.extra.ASSIST_CONTEXT";
1292
Jim Miller07994402012-05-02 14:22:27 -07001293 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001294 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1295 * keyboard as the primary input device for assistance.
1296 */
1297 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1298 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1299
1300 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001301 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1302 * that was used to invoke the assist.
1303 */
1304 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1305 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1306
1307 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001308 * Activity Action: List all available applications
1309 * <p>Input: Nothing.
1310 * <p>Output: nothing.
1311 */
1312 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1313 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1314 /**
1315 * Activity Action: Show settings for choosing wallpaper
1316 * <p>Input: Nothing.
1317 * <p>Output: Nothing.
1318 */
1319 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1320 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1321
1322 /**
1323 * Activity Action: Show activity for reporting a bug.
1324 * <p>Input: Nothing.
1325 * <p>Output: Nothing.
1326 */
1327 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1328 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1329
1330 /**
1331 * Activity Action: Main entry point for factory tests. Only used when
1332 * the device is booting in factory test node. The implementing package
1333 * must be installed in the system image.
1334 * <p>Input: nothing
1335 * <p>Output: nothing
1336 */
1337 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1338
1339 /**
1340 * Activity Action: The user pressed the "call" button to go to the dialer
1341 * or other appropriate UI for placing a call.
1342 * <p>Input: Nothing.
1343 * <p>Output: Nothing.
1344 */
1345 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1346 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1347
1348 /**
1349 * Activity Action: Start Voice Command.
1350 * <p>Input: Nothing.
1351 * <p>Output: Nothing.
1352 */
1353 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1354 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001355
1356 /**
1357 * Activity Action: Start action associated with long pressing on the
1358 * search key.
1359 * <p>Input: Nothing.
1360 * <p>Output: Nothing.
1361 */
1362 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1363 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001364
Jacek Surazski86b6c532009-05-13 14:38:28 +02001365 /**
1366 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1367 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001368 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001369 * <p>Input: No data is specified. The bug report is passed in using
1370 * an {@link #EXTRA_BUG_REPORT} field.
1371 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001372 *
1373 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001374 */
1375 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1376 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001377
1378 /**
1379 * Activity Action: Show power usage information to the user.
1380 * <p>Input: Nothing.
1381 * <p>Output: Nothing.
1382 */
1383 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1384 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001385
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001386 /**
1387 * Activity Action: Setup wizard to launch after a platform update. This
1388 * activity should have a string meta-data field associated with it,
1389 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1390 * the platform for setup. The activity will be launched only if
1391 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1392 * same value.
1393 * <p>Input: Nothing.
1394 * <p>Output: Nothing.
1395 * @hide
1396 */
1397 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1398 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001399
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001400 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001401 * Activity Action: Show settings for managing network data usage of a
1402 * specific application. Applications should define an activity that offers
1403 * options to control data usage.
1404 */
1405 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1406 public static final String ACTION_MANAGE_NETWORK_USAGE =
1407 "android.intent.action.MANAGE_NETWORK_USAGE";
1408
1409 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001410 * Activity Action: Launch application installer.
1411 * <p>
1412 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001413 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1414 * you can also use "package:<package-name>" to install an application for the
1415 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001416 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1417 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1418 * <p>
1419 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1420 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001421 * <p>
1422 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1423 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1424 * in order to launch the application installer.
1425 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001426 *
1427 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1428 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1429 * @see #EXTRA_RETURN_RESULT
1430 */
1431 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1432 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1433
1434 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001435 * Activity Action: Launch ephemeral installer.
1436 * <p>
1437 * Input: The data must be a http: URI that the ephemeral application is registered
1438 * to handle.
1439 * <p class="note">
1440 * This is a protected intent that can only be sent by the system.
1441 * </p>
1442 *
1443 * @hide
1444 */
1445 @SystemApi
1446 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1447 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1448 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1449
1450 /**
1451 * Service Action: Resolve ephemeral application.
1452 * <p>
1453 * The system will have a persistent connection to this service.
1454 * This is a protected intent that can only be sent by the system.
1455 * </p>
1456 *
1457 * @hide
1458 */
1459 @SystemApi
1460 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1461 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1462 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1463
1464 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001465 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1466 * package. Specifies the installer package name; this package will receive the
1467 * {@link #ACTION_APP_ERROR} intent.
1468 */
1469 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1470 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1471
1472 /**
1473 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1474 * package. Specifies that the application being installed should not be
1475 * treated as coming from an unknown source, but as coming from the app
1476 * invoking the Intent. For this to work you must start the installer with
1477 * startActivityForResult().
1478 */
1479 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1480 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1481
1482 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001483 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1484 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001485 * data field originated from.
1486 */
rich cannings706e8ba2012-08-20 13:20:14 -07001487 public static final String EXTRA_ORIGINATING_URI
1488 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001489
1490 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001491 * This extra can be used with any Intent used to launch an activity, supplying information
1492 * about who is launching that activity. This field contains a {@link android.net.Uri}
1493 * object, typically an http: or https: URI of the web site that the referral came from;
1494 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1495 * a native application that it came from.
1496 *
1497 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1498 * instead of directly retrieving the extra. It is also valid for applications to
1499 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1500 * a string, not a Uri; the field here, if supplied, will always take precedence,
1501 * however.</p>
1502 *
1503 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001504 */
1505 public static final String EXTRA_REFERRER
1506 = "android.intent.extra.REFERRER";
1507
1508 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001509 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1510 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1511 * not be created, in particular when Intent extras are supplied through the
1512 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1513 * schemes.
1514 *
1515 * @see #EXTRA_REFERRER
1516 */
1517 public static final String EXTRA_REFERRER_NAME
1518 = "android.intent.extra.REFERRER_NAME";
1519
1520 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001521 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1522 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1523 * @hide
1524 */
1525 public static final String EXTRA_ORIGINATING_UID
1526 = "android.intent.extra.ORIGINATING_UID";
1527
1528 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001529 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1530 * package. Tells the installer UI to skip the confirmation with the user
1531 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001532 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1533 * will no longer show an interstitial message about updating existing
1534 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001535 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001536 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001537 public static final String EXTRA_ALLOW_REPLACE
1538 = "android.intent.extra.ALLOW_REPLACE";
1539
1540 /**
1541 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1542 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1543 * return to the application the result code of the install/uninstall. The returned result
1544 * code will be {@link android.app.Activity#RESULT_OK} on success or
1545 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1546 */
1547 public static final String EXTRA_RETURN_RESULT
1548 = "android.intent.extra.RETURN_RESULT";
1549
1550 /**
1551 * Package manager install result code. @hide because result codes are not
1552 * yet ready to be exposed.
1553 */
1554 public static final String EXTRA_INSTALL_RESULT
1555 = "android.intent.extra.INSTALL_RESULT";
1556
1557 /**
1558 * Activity Action: Launch application uninstaller.
1559 * <p>
1560 * Input: The data must be a package: URI whose scheme specific part is
1561 * the package name of the current installed package to be uninstalled.
1562 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1563 * <p>
1564 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1565 * succeeded.
1566 */
1567 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1568 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1569
1570 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001571 * Specify whether the package should be uninstalled for all users.
1572 * @hide because these should not be part of normal application flow.
1573 */
1574 public static final String EXTRA_UNINSTALL_ALL_USERS
1575 = "android.intent.extra.UNINSTALL_ALL_USERS";
1576
1577 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001578 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1579 * describing the last run version of the platform that was setup.
1580 * @hide
1581 */
1582 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1583
Svet Ganov3695b8a2015-03-24 16:30:25 -07001584 /**
1585 * Activity action: Launch UI to manage the permissions of an app.
1586 * <p>
1587 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1588 * will be managed by the launched UI.
1589 * </p>
1590 * <p>
1591 * Output: Nothing.
1592 * </p>
1593 *
1594 * @see #EXTRA_PACKAGE_NAME
1595 *
1596 * @hide
1597 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001598 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1599 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1600 "android.intent.action.MANAGE_APP_PERMISSIONS";
1601
1602 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001603 * Activity action: Launch UI to manage permissions.
1604 * <p>
1605 * Input: Nothing.
1606 * </p>
1607 * <p>
1608 * Output: Nothing.
1609 * </p>
1610 *
1611 * @hide
1612 */
Svet Ganov321f0152015-05-16 22:51:50 -07001613 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1614 public static final String ACTION_MANAGE_PERMISSIONS =
1615 "android.intent.action.MANAGE_PERMISSIONS";
1616
1617 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001618 * Activity action: Launch UI to review permissions for an app.
1619 * The system uses this intent if permission review for apps not
1620 * supporting the new runtime permissions model is enabled. In
1621 * this mode a permission review is required before any of the
1622 * app components can run.
1623 * <p>
1624 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1625 * permissions will be reviewed (mandatory).
1626 * </p>
1627 * <p>
1628 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1629 * be fired after the permission review (optional).
1630 * </p>
1631 * <p>
1632 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1633 * be invoked after the permission review (optional).
1634 * </p>
1635 * <p>
1636 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1637 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1638 * </p>
1639 * <p>
1640 * Output: Nothing.
1641 * </p>
1642 *
1643 * @see #EXTRA_PACKAGE_NAME
1644 * @see #EXTRA_INTENT
1645 * @see #EXTRA_REMOTE_CALLBACK
1646 * @see #EXTRA_RESULT_NEEDED
1647 *
1648 * @hide
1649 */
1650 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1651 public static final String ACTION_REVIEW_PERMISSIONS =
1652 "android.intent.action.REVIEW_PERMISSIONS";
1653
1654 /**
1655 * Intent extra: A callback for reporting remote result as a bundle.
1656 * <p>
1657 * Type: IRemoteCallback
1658 * </p>
1659 *
1660 * @hide
1661 */
1662 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1663
1664 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001665 * Intent extra: An app package name.
1666 * <p>
1667 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001668 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001669 *
1670 * @hide
1671 */
1672 @SystemApi
1673 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1674
1675 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001676 * Intent extra: An extra for specifying whether a result is needed.
1677 * <p>
1678 * Type: boolean
1679 * </p>
1680 *
1681 * @hide
1682 */
1683 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1684
1685 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001686 * Broadcast action that requests current permission granted information. It will respond
1687 * to the request by sending a broadcast with action defined by
1688 * {@link #EXTRA_GET_PERMISSIONS_RESPONSE_INTENT}. The response will contain
Makoto Onukibbb912a2015-06-05 16:27:23 -07001689 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}, as well as
1690 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}, with contents described below or
1691 * a null upon failure.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001692 *
Makoto Onukibbb912a2015-06-05 16:27:23 -07001693 * <p>If {@link #EXTRA_PACKAGE_NAME} is included then the number of permissions granted, the
1694 * number of permissions requested and the number of granted additional permissions
1695 * by that package will be calculated and included as the first
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001696 * and second elements respectively of an int[] in the response as
Makoto Onukibbb912a2015-06-05 16:27:23 -07001697 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}. The response will also deliver the list
1698 * of localized permission group names that are granted in
1699 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001700 *
1701 * <p>If {@link #EXTRA_PACKAGE_NAME} is not included then the number of apps granted any runtime
1702 * permissions and the total number of apps requesting runtime permissions will be the first
1703 * and second elements respectively of an int[] in the response as
1704 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1705 *
1706 * @hide
1707 */
1708 public static final String ACTION_GET_PERMISSIONS_COUNT
1709 = "android.intent.action.GET_PERMISSIONS_COUNT";
1710
1711 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001712 * Broadcast action that requests list of all apps that have runtime permissions. It will
1713 * respond to the request by sending a broadcast with action defined by
1714 * {@link #EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT}. The response will contain
1715 * {@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT}, as well as
1716 * {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}, with contents described below or
1717 * a null upon failure.
1718 *
1719 * <p>{@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT} will contain a list of package names of
1720 * apps that have runtime permissions. {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}
1721 * will contain the list of app labels corresponding ot the apps in the first list.
1722 *
1723 * @hide
1724 */
1725 public static final String ACTION_GET_PERMISSIONS_PACKAGES
1726 = "android.intent.action.GET_PERMISSIONS_PACKAGES";
1727
1728 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001729 * Extra included in response to {@link #ACTION_GET_PERMISSIONS_COUNT}.
1730 * @hide
1731 */
1732 public static final String EXTRA_GET_PERMISSIONS_COUNT_RESULT
1733 = "android.intent.extra.GET_PERMISSIONS_COUNT_RESULT";
1734
1735 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001736 * List of CharSequence of localized permission group labels.
1737 * @hide
1738 */
1739 public static final String EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT
1740 = "android.intent.extra.GET_PERMISSIONS_GROUP_LIST_RESULT";
1741
1742 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001743 * String list of apps that have one or more runtime permissions.
1744 * @hide
1745 */
1746 public static final String EXTRA_GET_PERMISSIONS_APP_LIST_RESULT
1747 = "android.intent.extra.GET_PERMISSIONS_APP_LIST_RESULT";
1748
1749 /**
1750 * String list of app labels for apps that have one or more runtime permissions.
1751 * @hide
1752 */
1753 public static final String EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT
1754 = "android.intent.extra.GET_PERMISSIONS_APP_LABEL_LIST_RESULT";
1755
1756 /**
Anthony Hugh3575a402015-10-26 17:47:05 -07001757 * Boolean list describing if the app is a system app for apps that have one or more runtime
1758 * permissions.
1759 * @hide
1760 */
1761 public static final String EXTRA_GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT
1762 = "android.intent.extra.GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT";
1763
1764 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001765 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_COUNT} broadcasts.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001766 * @hide
1767 */
1768 public static final String EXTRA_GET_PERMISSIONS_RESPONSE_INTENT
1769 = "android.intent.extra.GET_PERMISSIONS_RESONSE_INTENT";
1770
1771 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001772 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_PACKAGES} broadcasts.
1773 * @hide
1774 */
1775 public static final String EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT
1776 = "android.intent.extra.GET_PERMISSIONS_PACKAGES_RESONSE_INTENT";
1777
1778 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001779 * Activity action: Launch UI to manage which apps have a given permission.
1780 * <p>
1781 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1782 * to which will be managed by the launched UI.
1783 * </p>
1784 * <p>
1785 * Output: Nothing.
1786 * </p>
1787 *
1788 * @see #EXTRA_PERMISSION_NAME
1789 *
1790 * @hide
1791 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001792 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1793 public static final String ACTION_MANAGE_PERMISSION_APPS =
1794 "android.intent.action.MANAGE_PERMISSION_APPS";
1795
1796 /**
1797 * Intent extra: The name of a permission.
1798 * <p>
1799 * Type: String
1800 * </p>
1801 *
1802 * @hide
1803 */
1804 @SystemApi
1805 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1806
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001807 // ---------------------------------------------------------------------
1808 // ---------------------------------------------------------------------
1809 // Standard intent broadcast actions (see action variable).
1810
1811 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001812 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1813 * <p>
1814 * For historical reasons, the name of this broadcast action refers to the power
1815 * state of the screen but it is actually sent in response to changes in the
1816 * overall interactive state of the device.
1817 * </p><p>
1818 * This broadcast is sent when the device becomes non-interactive which may have
1819 * nothing to do with the screen turning off. To determine the
1820 * actual state of the screen, use {@link android.view.Display#getState}.
1821 * </p><p>
1822 * See {@link android.os.PowerManager#isInteractive} for details.
1823 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001824 * You <em>cannot</em> receive this through components declared in
1825 * manifests, only by explicitly registering for it with
1826 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1827 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001828 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001829 * <p class="note">This is a protected intent that can only be sent
1830 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001831 */
1832 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1833 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001834
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001835 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001836 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1837 * <p>
1838 * For historical reasons, the name of this broadcast action refers to the power
1839 * state of the screen but it is actually sent in response to changes in the
1840 * overall interactive state of the device.
1841 * </p><p>
1842 * This broadcast is sent when the device becomes interactive which may have
1843 * nothing to do with the screen turning on. To determine the
1844 * actual state of the screen, use {@link android.view.Display#getState}.
1845 * </p><p>
1846 * See {@link android.os.PowerManager#isInteractive} for details.
1847 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001848 * You <em>cannot</em> receive this through components declared in
1849 * manifests, only by explicitly registering for it with
1850 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1851 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001852 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001853 * <p class="note">This is a protected intent that can only be sent
1854 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001855 */
1856 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1857 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001858
1859 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001860 * Broadcast Action: Sent after the system stops dreaming.
1861 *
1862 * <p class="note">This is a protected intent that can only be sent by the system.
1863 * It is only sent to registered receivers.</p>
1864 */
1865 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1866 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1867
1868 /**
1869 * Broadcast Action: Sent after the system starts dreaming.
1870 *
1871 * <p class="note">This is a protected intent that can only be sent by the system.
1872 * It is only sent to registered receivers.</p>
1873 */
1874 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1875 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1876
1877 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001878 * 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 -07001879 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001880 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001881 * <p class="note">This is a protected intent that can only be sent
1882 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001883 */
1884 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001885 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001886
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001887 /**
1888 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001889 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001890 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001891 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1892 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001893 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001894 * <p class="note">This is a protected intent that can only be sent
1895 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001896 */
1897 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1898 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1899 /**
1900 * Broadcast Action: The time was set.
1901 */
1902 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1903 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1904 /**
1905 * Broadcast Action: The date has changed.
1906 */
1907 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1908 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1909 /**
1910 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1911 * <ul>
1912 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1913 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001914 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001915 * <p class="note">This is a protected intent that can only be sent
1916 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001917 */
1918 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1919 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1920 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001921 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1922 * DNS entries should be tossed.
1923 * @hide
1924 */
1925 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1926 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1927 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001928 * Alarm Changed Action: This is broadcast when the AlarmClock
1929 * application's alarm is set or unset. It is used by the
1930 * AlarmClock application and the StatusBar service.
1931 * @hide
1932 */
1933 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1934 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001935
1936 /**
1937 * Broadcast Action: This is broadcast once, after the system has finished
1938 * booting and the user is in a "locked" state. A user is locked when their
1939 * credential-encrypted private app data storage is unavailable. Once the
1940 * user has entered their credentials (such as a lock pattern or PIN) for
1941 * the first time, the {@link #ACTION_BOOT_COMPLETED} broadcast will be
1942 * sent.
1943 * <p>
1944 * You must hold the
1945 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1946 * order to receive this broadcast.
1947 * <p class="note">
1948 * This is a protected intent that can only be sent by the system.
1949 */
1950 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1951 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1952
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001953 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001954 * Broadcast Action: This is broadcast once, after the system has finished
1955 * booting. It can be used to perform application-specific initialization,
1956 * such as installing alarms. You must hold the
1957 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1958 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001959 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001960 * <p class="note">This is a protected intent that can only be sent
1961 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001962 */
1963 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1964 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001965
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001966 /**
1967 * Broadcast Action: This is broadcast when a user action should request a
1968 * temporary system dialog to dismiss. Some examples of temporary system
1969 * dialogs are the notification window-shade and the recent tasks dialog.
1970 */
1971 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1972 /**
1973 * Broadcast Action: Trigger the download and eventual installation
1974 * of a package.
1975 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001976 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001977 * <p class="note">This is a protected intent that can only be sent
1978 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001979 *
1980 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001981 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001982 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001983 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1984 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1985 /**
1986 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001987 * device. The data contains the name of the package. Note that the
1988 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001989 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001990 * <ul>
1991 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1992 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1993 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1994 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001995 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001996 * <p class="note">This is a protected intent that can only be sent
1997 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001998 */
1999 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2000 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2001 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002002 * Broadcast Action: A new version of an application package has been
2003 * installed, replacing an existing version that was previously installed.
2004 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002005 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002006 * <ul>
2007 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2008 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002009 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002010 * <p class="note">This is a protected intent that can only be sent
2011 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002012 */
2013 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2014 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2015 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002016 * Broadcast Action: A new version of your application has been installed
2017 * over an existing one. This is only sent to the application that was
2018 * replaced. It does not contain any additional data; to receive it, just
2019 * use an intent filter for this action.
2020 *
2021 * <p class="note">This is a protected intent that can only be sent
2022 * by the system.
2023 */
2024 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2025 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2026 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002027 * Broadcast Action: An existing application package has been removed from
2028 * the device. The data contains the name of the package. The package
2029 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002030 * <ul>
2031 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2032 * to the package.
2033 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2034 * application -- data and code -- is being removed.
2035 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2036 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2037 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002038 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002039 * <p class="note">This is a protected intent that can only be sent
2040 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002041 */
2042 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2043 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2044 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002045 * Broadcast Action: An existing application package has been completely
2046 * removed from the device. The data contains the name of the package.
2047 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2048 * {@link #EXTRA_DATA_REMOVED} is true and
2049 * {@link #EXTRA_REPLACING} is false of that broadcast.
2050 *
2051 * <ul>
2052 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2053 * to the package.
2054 * </ul>
2055 *
2056 * <p class="note">This is a protected intent that can only be sent
2057 * by the system.
2058 */
2059 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2060 public static final String ACTION_PACKAGE_FULLY_REMOVED
2061 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2062 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002063 * Broadcast Action: An existing application package has been changed (e.g.
2064 * a component has been enabled or disabled). The data contains the name of
2065 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002066 * <ul>
2067 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002068 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002069 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002070 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2071 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002072 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002073 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002074 * <p class="note">This is a protected intent that can only be sent
2075 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002076 */
2077 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2078 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2079 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002080 * @hide
2081 * Broadcast Action: Ask system services if there is any reason to
2082 * restart the given package. The data contains the name of the
2083 * package.
2084 * <ul>
2085 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2086 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2087 * </ul>
2088 *
2089 * <p class="note">This is a protected intent that can only be sent
2090 * by the system.
2091 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002092 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002093 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2094 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2095 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002096 * Broadcast Action: The user has restarted a package, and all of its
2097 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002098 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002099 * be removed. Note that the restarted package does <em>not</em>
2100 * receive this broadcast.
2101 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002102 * <ul>
2103 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2104 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002105 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002106 * <p class="note">This is a protected intent that can only be sent
2107 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002108 */
2109 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2110 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2111 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002112 * Broadcast Action: The user has cleared the data of a package. This should
2113 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002114 * its persistent data is erased and this broadcast sent.
2115 * Note that the cleared package does <em>not</em>
2116 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002117 * <ul>
2118 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2119 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002120 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002121 * <p class="note">This is a protected intent that can only be sent
2122 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002123 */
2124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2125 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2126 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002127 * Broadcast Action: Packages have been suspended.
2128 * <p>Includes the following extras:
2129 * <ul>
2130 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2131 * </ul>
2132 *
2133 * <p class="note">This is a protected intent that can only be sent
2134 * by the system. It is only sent to registered receivers.
2135 */
2136 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2137 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2138 /**
2139 * Broadcast Action: Packages have been unsuspended.
2140 * <p>Includes the following extras:
2141 * <ul>
2142 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2143 * </ul>
2144 *
2145 * <p class="note">This is a protected intent that can only be sent
2146 * by the system. It is only sent to registered receivers.
2147 */
2148 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2149 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2150 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002151 * Broadcast Action: A user ID has been removed from the system. The user
2152 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002153 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002154 * <p class="note">This is a protected intent that can only be sent
2155 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002156 */
2157 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2158 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002159
2160 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002161 * Broadcast Action: Sent to the installer package of an application
2162 * when that application is first launched (that is the first time it
2163 * is moved out of the stopped state). The data contains the name of the package.
2164 *
2165 * <p class="note">This is a protected intent that can only be sent
2166 * by the system.
2167 */
2168 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2169 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2170
2171 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002172 * Broadcast Action: Sent to the system package verifier when a package
2173 * needs to be verified. The data contains the package URI.
2174 * <p class="note">
2175 * This is a protected intent that can only be sent by the system.
2176 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002177 */
2178 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2179 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2180
2181 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002182 * Broadcast Action: Sent to the system package verifier when a package is
2183 * verified. The data contains the package URI.
2184 * <p class="note">
2185 * This is a protected intent that can only be sent by the system.
2186 */
2187 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2188 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2189
2190 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002191 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
2192 * needs to be verified. The data contains the filter data hosts to be verified against.
2193 * <p class="note">
2194 * This is a protected intent that can only be sent by the system.
2195 * </p>
2196 *
2197 * @hide
2198 */
2199 @SystemApi
2200 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2201 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2202
2203 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002204 * Broadcast Action: Resources for a set of packages (which were
2205 * previously unavailable) are currently
2206 * available since the media on which they exist is available.
2207 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2208 * list of packages whose availability changed.
2209 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2210 * list of uids of packages whose availability changed.
2211 * Note that the
2212 * packages in this list do <em>not</em> receive this broadcast.
2213 * The specified set of packages are now available on the system.
2214 * <p>Includes the following extras:
2215 * <ul>
2216 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2217 * whose resources(were previously unavailable) are currently available.
2218 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2219 * packages whose resources(were previously unavailable)
2220 * are currently available.
2221 * </ul>
2222 *
2223 * <p class="note">This is a protected intent that can only be sent
2224 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002225 */
2226 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002227 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2228 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002229
2230 /**
2231 * Broadcast Action: Resources for a set of packages are currently
2232 * unavailable since the media on which they exist is unavailable.
2233 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2234 * list of packages whose availability changed.
2235 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2236 * list of uids of packages whose availability changed.
2237 * The specified set of packages can no longer be
2238 * launched and are practically unavailable on the system.
2239 * <p>Inclues the following extras:
2240 * <ul>
2241 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2242 * whose resources are no longer available.
2243 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2244 * whose resources are no longer available.
2245 * </ul>
2246 *
2247 * <p class="note">This is a protected intent that can only be sent
2248 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002249 */
2250 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002251 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002252 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002253
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002254 /**
2255 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002256 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002257 * This should <em>only</em> be used to determine when the wallpaper
2258 * has changed to show the new wallpaper to the user. You should certainly
2259 * never, in response to this, change the wallpaper or other attributes of
2260 * it such as the suggested size. That would be crazy, right? You'd cause
2261 * all kinds of loops, especially if other apps are doing similar things,
2262 * right? Of course. So please don't do this.
2263 *
2264 * @deprecated Modern applications should use
2265 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2266 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2267 * shown behind their UI, rather than watching for this broadcast and
2268 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002269 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002270 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002271 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2272 /**
2273 * Broadcast Action: The current device {@link android.content.res.Configuration}
2274 * (orientation, locale, etc) has changed. When such a change happens, the
2275 * UIs (view hierarchy) will need to be rebuilt based on this new
2276 * information; for the most part, applications don't need to worry about
2277 * this, because the system will take care of stopping and restarting the
2278 * application to make sure it sees the new changes. Some system code that
2279 * can not be restarted will need to watch for this action and handle it
2280 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002281 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002282 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002283 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002284 * in manifests, only by explicitly registering for it with
2285 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2286 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002287 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002288 * <p class="note">This is a protected intent that can only be sent
2289 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002290 *
2291 * @see android.content.res.Configuration
2292 */
2293 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2294 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2295 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002296 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002297 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002298 * <p class="note">This is a protected intent that can only be sent
2299 * by the system.
2300 */
2301 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2302 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2303 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002304 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2305 * charging state, level, and other information about the battery.
2306 * See {@link android.os.BatteryManager} for documentation on the
2307 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002308 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002309 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002310 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002311 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002312 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002313 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2314 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2315 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2316 * broadcasts that are sent and can be received through manifest
2317 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002318 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002319 * <p class="note">This is a protected intent that can only be sent
2320 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002321 */
2322 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2323 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2324 /**
2325 * Broadcast Action: Indicates low battery condition on the device.
2326 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002327 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002328 * <p class="note">This is a protected intent that can only be sent
2329 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002330 */
2331 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2332 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2333 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002334 * Broadcast Action: Indicates the battery is now okay after being low.
2335 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2336 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002337 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002338 * <p class="note">This is a protected intent that can only be sent
2339 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002340 */
2341 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2342 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2343 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002344 * Broadcast Action: External power has been connected to the device.
2345 * This is intended for applications that wish to register specifically to this notification.
2346 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2347 * stay active to receive this notification. This action can be used to implement actions
2348 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002349 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002350 * <p class="note">This is a protected intent that can only be sent
2351 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002352 */
2353 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002354 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002355 /**
2356 * Broadcast Action: External power has been removed from the device.
2357 * This is intended for applications that wish to register specifically to this notification.
2358 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2359 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002360 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002361 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002362 * <p class="note">This is a protected intent that can only be sent
2363 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002364 */
2365 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002366 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002367 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002368 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002369 * Broadcast Action: Device is shutting down.
2370 * This is broadcast when the device is being shut down (completely turned
2371 * off, not sleeping). Once the broadcast is complete, the final shutdown
2372 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002373 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002374 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002375 * <p class="note">This is a protected intent that can only be sent
2376 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002377 * <p>May include the following extras:
2378 * <ul>
2379 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2380 * shutdown is only for userspace processes. If not set, assumed to be false.
2381 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002382 */
2383 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002384 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002385 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002386 * Activity Action: Start this activity to request system shutdown.
2387 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002388 * to request confirmation from the user before shutting down. The optional boolean
2389 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2390 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002391 *
2392 * <p class="note">This is a protected intent that can only be sent
2393 * by the system.
2394 *
2395 * {@hide}
2396 */
2397 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2398 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002399 * Broadcast Action: A sticky broadcast that indicates low memory
2400 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002401 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002402 * <p class="note">This is a protected intent that can only be sent
2403 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002404 */
2405 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2406 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2407 /**
2408 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002409 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002410 * <p class="note">This is a protected intent that can only be sent
2411 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002412 */
2413 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2414 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2415 /**
Jake Hambybb371632010-08-23 18:16:48 -07002416 * Broadcast Action: A sticky broadcast that indicates a memory full
2417 * condition on the device. This is intended for activities that want
2418 * to be able to fill the data partition completely, leaving only
2419 * enough free space to prevent system-wide SQLite failures.
2420 *
2421 * <p class="note">This is a protected intent that can only be sent
2422 * by the system.
2423 *
2424 * {@hide}
2425 */
2426 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2427 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2428 /**
2429 * Broadcast Action: Indicates memory full condition on the device
2430 * no longer exists.
2431 *
2432 * <p class="note">This is a protected intent that can only be sent
2433 * by the system.
2434 *
2435 * {@hide}
2436 */
2437 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2438 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2439 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002440 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2441 * and package management should be started.
2442 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2443 * notification.
2444 */
2445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2446 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2447 /**
2448 * Broadcast Action: The device has entered USB Mass Storage mode.
2449 * This is used mainly for the USB Settings panel.
2450 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2451 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002452 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002453 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002454 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002455 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2456
2457 /**
2458 * Broadcast Action: The device has exited USB Mass Storage mode.
2459 * This is used mainly for the USB Settings panel.
2460 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2461 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002462 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002463 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002464 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002465 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2466
2467 /**
2468 * Broadcast Action: External media has been removed.
2469 * The path to the mount point for the removed media is contained in the Intent.mData field.
2470 */
2471 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2472 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2473
2474 /**
2475 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002476 * 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 -07002477 */
2478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2479 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2480
2481 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002482 * Broadcast Action: External media is present, and being disk-checked
2483 * 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 -08002484 */
2485 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2486 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2487
2488 /**
2489 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2490 * 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 -08002491 */
2492 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2493 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2494
2495 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002496 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002497 * 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 -07002498 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2499 * media was mounted read only.
2500 */
2501 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2502 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2503
2504 /**
2505 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002506 * 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 -07002507 */
2508 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2509 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2510
2511 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002512 * Broadcast Action: External media is no longer being shared via USB mass storage.
2513 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2514 *
2515 * @hide
2516 */
2517 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2518
2519 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002520 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2521 * The path to the mount point for the removed media is contained in the Intent.mData field.
2522 */
2523 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2524 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2525
2526 /**
2527 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002528 * 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 -07002529 */
2530 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2531 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2532
2533 /**
2534 * Broadcast Action: User has expressed the desire to remove the external storage media.
2535 * Applications should close all files they have open within the mount point when they receive this intent.
2536 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2537 */
2538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2539 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2540
2541 /**
2542 * Broadcast Action: The media scanner has started scanning a directory.
2543 * The path to the directory being scanned is contained in the Intent.mData field.
2544 */
2545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2546 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2547
2548 /**
2549 * Broadcast Action: The media scanner has finished scanning a directory.
2550 * The path to the scanned directory is contained in the Intent.mData field.
2551 */
2552 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2553 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2554
2555 /**
2556 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2557 * The path to the file is contained in the Intent.mData field.
2558 */
2559 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2560 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2561
2562 /**
2563 * Broadcast Action: The "Media Button" was pressed. Includes a single
2564 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2565 * caused the broadcast.
2566 */
2567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2568 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2569
Jaewan Kim52632e22016-01-14 18:01:52 +09002570 /**
2571 * Broadcast Action: The "Picture-in-picture (PIP) Button" was pressed.
2572 * Includes a single extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2573 * caused the broadcast.
2574 * @hide
2575 */
2576 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2577 public static final String ACTION_PICTURE_IN_PICTURE_BUTTON =
2578 "android.intent.action.PICTURE_IN_PICTURE_BUTTON";
2579
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002580 /**
2581 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2582 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2583 * caused the broadcast.
2584 */
2585 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2586 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2587
2588 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2589 // location; they are not general-purpose actions.
2590
2591 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002592 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002593 */
2594 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2595 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2596 "android.intent.action.GTALK_CONNECTED";
2597
2598 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002599 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002600 */
2601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2602 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2603 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002604
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002605 /**
2606 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002607 */
2608 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2609 public static final String ACTION_INPUT_METHOD_CHANGED =
2610 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002611
2612 /**
2613 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2614 * more radios have been turned off or on. The intent will have the following extra value:</p>
2615 * <ul>
2616 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2617 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2618 * turned off</li>
2619 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002620 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002621 * <p class="note">This is a protected intent that can only be sent
2622 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002623 */
2624 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2625 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2626
2627 /**
2628 * Broadcast Action: Some content providers have parts of their namespace
2629 * where they publish new events or items that the user may be especially
2630 * interested in. For these things, they may broadcast this action when the
2631 * set of interesting items change.
2632 *
2633 * For example, GmailProvider sends this notification when the set of unread
2634 * mail in the inbox changes.
2635 *
2636 * <p>The data of the intent identifies which part of which provider
2637 * changed. When queried through the content resolver, the data URI will
2638 * return the data set in question.
2639 *
2640 * <p>The intent will have the following extra values:
2641 * <ul>
2642 * <li><em>count</em> - The number of items in the data set. This is the
2643 * same as the number of items in the cursor returned by querying the
2644 * data URI. </li>
2645 * </ul>
2646 *
2647 * This intent will be sent at boot (if the count is non-zero) and when the
2648 * data set changes. It is possible for the data set to change without the
2649 * count changing (for example, if a new unread message arrives in the same
2650 * sync operation in which a message is archived). The phone should still
2651 * ring/vibrate/etc as normal in this case.
2652 */
2653 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2654 public static final String ACTION_PROVIDER_CHANGED =
2655 "android.intent.action.PROVIDER_CHANGED";
2656
2657 /**
2658 * Broadcast Action: Wired Headset plugged in or unplugged.
2659 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002660 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2661 * and documentation.
2662 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002663 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002664 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002665 */
2666 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002667 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002668
2669 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002670 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2671 * <ul>
2672 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2673 * </ul>
2674 *
2675 * <p class="note">This is a protected intent that can only be sent
2676 * by the system.
2677 *
2678 * @hide
2679 */
2680 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2681 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2682 = "android.intent.action.ADVANCED_SETTINGS";
2683
2684 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002685 * Broadcast Action: Sent after application restrictions are changed.
2686 *
2687 * <p class="note">This is a protected intent that can only be sent
2688 * by the system.</p>
2689 */
2690 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2691 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2692 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2693
2694 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002695 * Broadcast Action: An outgoing call is about to be placed.
2696 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002697 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002698 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002699 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002700 * the phone number originally intended to be dialed.</li>
2701 * </ul>
2702 * <p>Once the broadcast is finished, the resultData is used as the actual
2703 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002704 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002705 * outgoing call in turn: for example, a parental control application
2706 * might verify that the user is authorized to place the call at that
2707 * time, then a number-rewriting application might add an area code if
2708 * one was not specified.</p>
2709 * <p>For consistency, any receiver whose purpose is to prohibit phone
2710 * calls should have a priority of 0, to ensure it will see the final
2711 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002712 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002713 * should have a positive priority.
2714 * Negative priorities are reserved for the system for this broadcast;
2715 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002716 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2717 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002718 * <p>Emergency calls cannot be intercepted using this mechanism, and
2719 * other calls cannot be modified to call emergency numbers using this
2720 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002721 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2722 * call to use their own service instead. Those apps should first prevent
2723 * the call from being placed by setting resultData to <code>null</code>
2724 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002725 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002726 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2727 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002728 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002729 * <p class="note">This is a protected intent that can only be sent
2730 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002731 */
2732 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2733 public static final String ACTION_NEW_OUTGOING_CALL =
2734 "android.intent.action.NEW_OUTGOING_CALL";
2735
2736 /**
2737 * Broadcast Action: Have the device reboot. This is only for use by
2738 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002739 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002740 * <p class="note">This is a protected intent that can only be sent
2741 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002742 */
2743 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2744 public static final String ACTION_REBOOT =
2745 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002746
Wei Huang97ecc9c2009-05-11 17:44:20 -07002747 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002748 * Broadcast Action: A sticky broadcast for changes in the physical
2749 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002750 *
2751 * <p>The intent will have the following extra values:
2752 * <ul>
2753 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002754 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002755 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002756 * <p>This is intended for monitoring the current physical dock state.
2757 * See {@link android.app.UiModeManager} for the normal API dealing with
2758 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002759 */
2760 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2761 public static final String ACTION_DOCK_EVENT =
2762 "android.intent.action.DOCK_EVENT";
2763
2764 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002765 * Broadcast Action: A broadcast when idle maintenance can be started.
2766 * This means that the user is not interacting with the device and is
2767 * not expected to do so soon. Typical use of the idle maintenance is
2768 * to perform somehow expensive tasks that can be postponed at a moment
2769 * when they will not degrade user experience.
2770 * <p>
2771 * <p class="note">In order to keep the device responsive in case of an
2772 * unexpected user interaction, implementations of a maintenance task
2773 * should be interruptible. In such a scenario a broadcast with action
2774 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2775 * should not do the maintenance work in
2776 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2777 * maintenance service by {@link Context#startService(Intent)}. Also
2778 * you should hold a wake lock while your maintenance service is running
2779 * to prevent the device going to sleep.
2780 * </p>
2781 * <p>
2782 * <p class="note">This is a protected intent that can only be sent by
2783 * the system.
2784 * </p>
2785 *
2786 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002787 *
2788 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002789 */
2790 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2791 public static final String ACTION_IDLE_MAINTENANCE_START =
2792 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2793
2794 /**
2795 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2796 * This means that the user was not interacting with the device as a result
2797 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2798 * was sent and now the user started interacting with the device. Typical
2799 * use of the idle maintenance is to perform somehow expensive tasks that
2800 * can be postponed at a moment when they will not degrade user experience.
2801 * <p>
2802 * <p class="note">In order to keep the device responsive in case of an
2803 * unexpected user interaction, implementations of a maintenance task
2804 * should be interruptible. Hence, on receiving a broadcast with this
2805 * action, the maintenance task should be interrupted as soon as possible.
2806 * In other words, you should not do the maintenance work in
2807 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2808 * maintenance service that was started on receiving of
2809 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2810 * lock you acquired when your maintenance service started.
2811 * </p>
2812 * <p class="note">This is a protected intent that can only be sent
2813 * by the system.
2814 *
2815 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002816 *
2817 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002818 */
2819 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2820 public static final String ACTION_IDLE_MAINTENANCE_END =
2821 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2822
2823 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002824 * Broadcast Action: a remote intent is to be broadcasted.
2825 *
2826 * A remote intent is used for remote RPC between devices. The remote intent
2827 * is serialized and sent from one device to another device. The receiving
2828 * device parses the remote intent and broadcasts it. Note that anyone can
2829 * broadcast a remote intent. However, if the intent receiver of the remote intent
2830 * does not trust intent broadcasts from arbitrary intent senders, it should require
2831 * the sender to hold certain permissions so only trusted sender's broadcast will be
2832 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002833 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002834 */
2835 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002836 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002837
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002838 /**
2839 * Broadcast Action: hook for permforming cleanup after a system update.
2840 *
2841 * The broadcast is sent when the system is booting, before the
2842 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2843 * image. A receiver for this should do its work and then disable itself
2844 * so that it does not get run again at the next boot.
2845 * @hide
2846 */
2847 public static final String ACTION_PRE_BOOT_COMPLETED =
2848 "android.intent.action.PRE_BOOT_COMPLETED";
2849
Amith Yamasani13593602012-03-22 16:16:17 -07002850 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002851 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002852 * on restricted users. The broadcast intent contains an extra
2853 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2854 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2855 * String[] depending on the restriction type.<p/>
2856 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002857 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2858 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2859 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002860 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2861 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002862 * @see RestrictionEntry
2863 */
2864 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2865 "android.intent.action.GET_RESTRICTION_ENTRIES";
2866
2867 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002868 * Sent the first time a user is starting, to allow system apps to
2869 * perform one time initialization. (This will not be seen by third
2870 * party applications because a newly initialized user does not have any
2871 * third party applications installed for it.) This is sent early in
2872 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002873 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2874 * broadcast, since it is part of a visible user interaction; be as quick
2875 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002876 */
2877 public static final String ACTION_USER_INITIALIZE =
2878 "android.intent.action.USER_INITIALIZE";
2879
2880 /**
2881 * Sent when a user switch is happening, causing the process's user to be
2882 * brought to the foreground. This is only sent to receivers registered
2883 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2884 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002885 * foreground. This is sent as a foreground
2886 * broadcast, since it is part of a visible user interaction; be as quick
2887 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002888 */
2889 public static final String ACTION_USER_FOREGROUND =
2890 "android.intent.action.USER_FOREGROUND";
2891
2892 /**
2893 * Sent when a user switch is happening, causing the process's user to be
2894 * sent to the background. This is only sent to receivers registered
2895 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2896 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002897 * background. This is sent as a foreground
2898 * broadcast, since it is part of a visible user interaction; be as quick
2899 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002900 */
2901 public static final String ACTION_USER_BACKGROUND =
2902 "android.intent.action.USER_BACKGROUND";
2903
2904 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002905 * Broadcast sent to the system when a user is added. Carries an extra
2906 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2907 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002908 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002909 * @hide
2910 */
2911 public static final String ACTION_USER_ADDED =
2912 "android.intent.action.USER_ADDED";
2913
2914 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002915 * Broadcast sent by the system when a user is started. Carries an extra
2916 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002917 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002918 * that has been started. This is sent as a foreground
2919 * broadcast, since it is part of a visible user interaction; be as quick
2920 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002921 * @hide
2922 */
2923 public static final String ACTION_USER_STARTED =
2924 "android.intent.action.USER_STARTED";
2925
2926 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002927 * Broadcast sent when a user is in the process of starting. Carries an extra
2928 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2929 * sent to registered receivers, not manifest receivers. It is sent to all
2930 * users (including the one that is being started). You must hold
2931 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2932 * this broadcast. This is sent as a background broadcast, since
2933 * its result is not part of the primary UX flow; to safely keep track of
2934 * started/stopped state of a user you can use this in conjunction with
2935 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2936 * other user state broadcasts since those are foreground broadcasts so can
2937 * execute in a different order.
2938 * @hide
2939 */
2940 public static final String ACTION_USER_STARTING =
2941 "android.intent.action.USER_STARTING";
2942
2943 /**
2944 * Broadcast sent when a user is going to be stopped. Carries an extra
2945 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2946 * sent to registered receivers, not manifest receivers. It is sent to all
2947 * users (including the one that is being stopped). You must hold
2948 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2949 * this broadcast. The user will not stop until all receivers have
2950 * handled the broadcast. This is sent as a background broadcast, since
2951 * its result is not part of the primary UX flow; to safely keep track of
2952 * started/stopped state of a user you can use this in conjunction with
2953 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2954 * other user state broadcasts since those are foreground broadcasts so can
2955 * execute in a different order.
2956 * @hide
2957 */
2958 public static final String ACTION_USER_STOPPING =
2959 "android.intent.action.USER_STOPPING";
2960
2961 /**
2962 * Broadcast sent to the system when a user is stopped. Carries an extra
2963 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2964 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2965 * specific package. This is only sent to registered receivers, not manifest
2966 * receivers. It is sent to all running users <em>except</em> the one that
2967 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002968 * @hide
2969 */
2970 public static final String ACTION_USER_STOPPED =
2971 "android.intent.action.USER_STOPPED";
2972
2973 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002974 * 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 -07002975 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002976 * one that has been removed. The user will not be completely removed until all receivers have
2977 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002978 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002979 * @hide
2980 */
2981 public static final String ACTION_USER_REMOVED =
2982 "android.intent.action.USER_REMOVED";
2983
2984 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002985 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002986 * the userHandle of the user to become the current one. This is only sent to
2987 * registered receivers, not manifest receivers. It is sent to all running users.
2988 * You must hold
2989 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002990 * @hide
2991 */
2992 public static final String ACTION_USER_SWITCHED =
2993 "android.intent.action.USER_SWITCHED";
2994
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002995 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07002996 * Broadcast Action: Sent when the credential-encrypted private storage has
2997 * become unlocked for the target user. This is only sent to registered
2998 * receivers, not manifest receivers.
2999 */
3000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3001 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3002
3003 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003004 * Broadcast sent to the system when a user's information changes. Carries an extra
3005 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003006 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003007 * @hide
3008 */
3009 public static final String ACTION_USER_INFO_CHANGED =
3010 "android.intent.action.USER_INFO_CHANGED";
3011
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003012 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003013 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3014 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003015 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3016 * that need to display merged content across both primary and managed profiles need to
3017 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003018 * not manifest receivers.
3019 */
3020 public static final String ACTION_MANAGED_PROFILE_ADDED =
3021 "android.intent.action.MANAGED_PROFILE_ADDED";
3022
3023 /**
3024 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003025 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3026 * Only applications (for example Launchers) that need to display merged content across both
3027 * primary and managed profiles need to worry about this broadcast. This is only sent to
3028 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003029 */
3030 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3031 "android.intent.action.MANAGED_PROFILE_REMOVED";
3032
3033 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003034 * Broadcast sent to the primary user when an associated managed profile's availability has
Rubin Xuf13c9802016-01-21 18:06:00 +00003035 * changed. This includes when the user toggles the profile's quiet mode. Carries an extra
3036 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3037 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3038 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003039 */
3040 public static final String ACTION_MANAGED_PROFILE_AVAILABILITY_CHANGED =
3041 "android.intent.action.MANAGED_PROFILE_AVAILABILITY_CHANGED";
3042
3043 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003044 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3045 */
3046 public static final String ACTION_QUICK_CLOCK =
3047 "android.intent.action.QUICK_CLOCK";
3048
Michael Wright0087a142013-02-05 16:29:39 -08003049 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003050 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003051 * @hide
3052 */
3053 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3054 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3055
Justin Kohd378ad72013-04-01 12:18:26 -07003056 /**
3057 * Broadcast Action: A global button was pressed. Includes a single
3058 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3059 * caused the broadcast.
3060 * @hide
3061 */
3062 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3063
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003064 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003065 * Broadcast Action: Sent when media resource is granted.
3066 * <p>
3067 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3068 * granted.
3069 * </p>
3070 * <p class="note">
3071 * This is a protected intent that can only be sent by the system.
3072 * </p>
3073 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003074 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003075 * </p>
3076 *
3077 * @hide
3078 */
3079 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3080 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3081
3082 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003083 * Activity Action: Allow the user to select and return one or more existing
3084 * documents. When invoked, the system will display the various
3085 * {@link DocumentsProvider} instances installed on the device, letting the
3086 * user interactively navigate through them. These documents include local
3087 * media, such as photos and video, and documents provided by installed
3088 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003089 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003090 * Each document is represented as a {@code content://} URI backed by a
3091 * {@link DocumentsProvider}, which can be opened as a stream with
3092 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3093 * {@link android.provider.DocumentsContract.Document} metadata.
3094 * <p>
3095 * All selected documents are returned to the calling application with
3096 * persistable read and write permission grants. If you want to maintain
3097 * access to the documents across device reboots, you need to explicitly
3098 * take the persistable permissions using
3099 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3100 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003101 * Callers must indicate the acceptable document MIME types through
3102 * {@link #setType(String)}. For example, to select photos, use
3103 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3104 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3105 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003106 * <p>
3107 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003108 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3109 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003110 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003111 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3112 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003113 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003114 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003115 * Output: The URI of the item that was picked, returned in
3116 * {@link #getData()}. This must be a {@code content://} URI so that any
3117 * receiver can access it. If multiple documents were selected, they are
3118 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003119 *
3120 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003121 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003122 * @see #ACTION_CREATE_DOCUMENT
3123 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003124 */
3125 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3126 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3127
3128 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003129 * Activity Action: Allow the user to create a new document. When invoked,
3130 * the system will display the various {@link DocumentsProvider} instances
3131 * installed on the device, letting the user navigate through them. The
3132 * returned document may be a newly created document with no content, or it
3133 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003134 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003135 * Each document is represented as a {@code content://} URI backed by a
3136 * {@link DocumentsProvider}, which can be opened as a stream with
3137 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3138 * {@link android.provider.DocumentsContract.Document} metadata.
3139 * <p>
3140 * Callers must indicate the concrete MIME type of the document being
3141 * created by setting {@link #setType(String)}. This MIME type cannot be
3142 * changed after the document is created.
3143 * <p>
3144 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3145 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003146 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003147 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3148 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003149 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003150 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003151 * Output: The URI of the item that was created. This must be a
3152 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003153 *
3154 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003155 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003156 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003157 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003158 */
3159 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3160 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3161
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003162 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003163 * Activity Action: Allow the user to pick a directory subtree. When
3164 * invoked, the system will display the various {@link DocumentsProvider}
3165 * instances installed on the device, letting the user navigate through
3166 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003167 * <p>
3168 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003169 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3170 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3171 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003172 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003173 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003174 *
3175 * @see DocumentsContract
3176 */
3177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003178 public static final String
3179 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003180
Felipe Lemec7b1f892016-01-15 15:02:31 -08003181 /**
3182 * Activity Action: Give access to a standard storage directory after obtaining the user's
3183 * approval.
3184 * <p>
3185 * When invoked, the system will ask the user to grant access to the requested directory (and
3186 * its descendants).
3187 * <p>
3188 * To gain access to descendant (child, grandchild, etc) documents, use
3189 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3190 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)} with the returned URI.
3191 * <p>
3192 * Input: full path to a standard directory, in the form of
3193 * {@code STORAGE_ROOT + STANDARD_DIRECTORY}, where {@code STORAGE_ROOT} is the physical path of
3194 * a storage container, and {@code STANDARD_DIRECTORY} is one of
3195 * {@link Environment#DIRECTORY_MUSIC}, {@link Environment#DIRECTORY_PODCASTS},
3196 * {@link Environment#DIRECTORY_RINGTONES}, {@link Environment#DIRECTORY_ALARMS},
3197 * {@link Environment#DIRECTORY_NOTIFICATIONS}, {@link Environment#DIRECTORY_PICTURES},
3198 * {@link Environment#DIRECTORY_MOVIES}, {@link Environment#DIRECTORY_DOWNLOADS},
3199 * {@link Environment#DIRECTORY_DCIM}, or {@link Environment#DIRECTORY_DOCUMENTS}
3200 * <p>
3201 * For example, to open the "Pictures" folder in the default external storage, the intent's data
3202 * would be: {@code Uri.fromFile(new File(Environment.getExternalStorageDirectory(),
3203 * Environment.DIRECTORY_PICTURES))}.
3204 * <p>
3205 * Output: The URI representing the requested directory tree.
3206 *
3207 * @see DocumentsContract
3208 */
3209 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3210 public static final String
3211 ACTION_OPEN_EXTERNAL_DIRECTORY = "android.intent.action.OPEN_EXTERNAL_DIRECTORY";
3212
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003213 /** {@hide} */
3214 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3215
Christopher Tate6597e342015-02-17 12:15:25 -08003216 /**
3217 * Broadcast action: report that a settings element is being restored from backup. The intent
3218 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3219 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3220 * is the value of that settings entry prior to the restore operation. All of these values are
3221 * represented as strings.
3222 *
3223 * <p>This broadcast is sent only for settings provider entries known to require special handling
3224 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3225 * the provider's backup agent implementation.
3226 *
3227 * @see #EXTRA_SETTING_NAME
3228 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3229 * @see #EXTRA_SETTING_NEW_VALUE
3230 * {@hide}
3231 */
3232 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3233
3234 /** {@hide} */
3235 public static final String EXTRA_SETTING_NAME = "setting_name";
3236 /** {@hide} */
3237 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3238 /** {@hide} */
3239 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3240
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003241 /**
3242 * Activity Action: Process a piece of text.
3243 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3244 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3245 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3246 */
3247 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3248 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3249 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003250 * The name of the extra used to define the text to be processed, as a
3251 * CharSequence. Note that this may be a styled CharSequence, so you must use
3252 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003253 */
3254 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3255 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003256 * 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 +00003257 */
3258 public static final String EXTRA_PROCESS_TEXT_READONLY =
3259 "android.intent.extra.PROCESS_TEXT_READONLY";
3260
Bryce Leebc58f592015-09-25 16:43:01 -07003261 /**
3262 * Broadcast action: reports when a new thermal event has been reached. When the device
3263 * is reaching its maximum temperatue, the thermal level reported
3264 * {@hide}
3265 */
3266 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3267 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3268
3269 /** {@hide} */
3270 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3271
3272 /**
3273 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003274 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003275 * {@hide}
3276 */
3277 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3278
3279 /**
3280 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003281 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003282 * {@hide}
3283 */
3284 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3285
3286 /**
3287 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003288 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003289 * {@hide}
3290 */
3291 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3292
3293
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003294 // ---------------------------------------------------------------------
3295 // ---------------------------------------------------------------------
3296 // Standard intent categories (see addCategory()).
3297
3298 /**
3299 * Set if the activity should be an option for the default action
3300 * (center press) to perform on a piece of data. Setting this will
3301 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003302 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003303 * Intent when initiating an action -- it is for use in intent filters
3304 * specified in packages.
3305 */
3306 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3307 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3308 /**
3309 * Activities that can be safely invoked from a browser must support this
3310 * category. For example, if the user is viewing a web page or an e-mail
3311 * and clicks on a link in the text, the Intent generated execute that
3312 * link will require the BROWSABLE category, so that only activities
3313 * supporting this category will be considered as possible actions. By
3314 * supporting this category, you are promising that there is nothing
3315 * damaging (without user intervention) that can happen by invoking any
3316 * matching Intent.
3317 */
3318 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3319 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3320 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003321 * Categories for activities that can participate in voice interaction.
3322 * An activity that supports this category must be prepared to run with
3323 * no UI shown at all (though in some case it may have a UI shown), and
3324 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3325 */
3326 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3327 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3328 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003329 * Set if the activity should be considered as an alternative action to
3330 * the data the user is currently viewing. See also
3331 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3332 * applies to the selection in a list of items.
3333 *
3334 * <p>Supporting this category means that you would like your activity to be
3335 * displayed in the set of alternative things the user can do, usually as
3336 * part of the current activity's options menu. You will usually want to
3337 * include a specific label in the &lt;intent-filter&gt; of this action
3338 * describing to the user what it does.
3339 *
3340 * <p>The action of IntentFilter with this category is important in that it
3341 * describes the specific action the target will perform. This generally
3342 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3343 * a specific name such as "com.android.camera.action.CROP. Only one
3344 * alternative of any particular action will be shown to the user, so using
3345 * a specific action like this makes sure that your alternative will be
3346 * displayed while also allowing other applications to provide their own
3347 * overrides of that particular action.
3348 */
3349 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3350 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3351 /**
3352 * Set if the activity should be considered as an alternative selection
3353 * action to the data the user has currently selected. This is like
3354 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3355 * of items from which the user can select, giving them alternatives to the
3356 * default action that will be performed on it.
3357 */
3358 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3359 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3360 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003361 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003362 */
3363 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3364 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3365 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003366 * Should be displayed in the top-level launcher.
3367 */
3368 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3369 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3370 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003371 * Indicates an activity optimized for Leanback mode, and that should
3372 * be displayed in the Leanback launcher.
3373 */
3374 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3375 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3376 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003377 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3378 * @hide
3379 */
3380 @SystemApi
3381 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3382 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003383 * Provides information about the package it is in; typically used if
3384 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3385 * a front-door to the user without having to be shown in the all apps list.
3386 */
3387 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3388 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3389 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003390 * This is the home activity, that is the first activity that is displayed
3391 * when the device boots.
3392 */
3393 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3394 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3395 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003396 * This is the home activity that is displayed when the device is finished setting up and ready
3397 * for use.
3398 * @hide
3399 */
3400 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3401 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3402 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003403 * This is the setup wizard activity, that is the first activity that is displayed
3404 * when the user sets up the device for the first time.
3405 * @hide
3406 */
3407 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3408 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3409 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003410 * This activity is a preference panel.
3411 */
3412 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3413 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3414 /**
3415 * This activity is a development preference panel.
3416 */
3417 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3418 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3419 /**
3420 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003421 */
3422 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3423 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3424 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003425 * This activity allows the user to browse and download new applications.
3426 */
3427 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3428 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3429 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003430 * This activity may be exercised by the monkey or other automated test tools.
3431 */
3432 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3433 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3434 /**
3435 * To be used as a test (not part of the normal user experience).
3436 */
3437 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3438 /**
3439 * To be used as a unit test (run through the Test Harness).
3440 */
3441 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3442 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003443 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003444 * experience).
3445 */
3446 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003447
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003448 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003449 * Used to indicate that an intent only wants URIs that can be opened with
3450 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3451 * must support at least the columns defined in {@link OpenableColumns} when
3452 * queried.
3453 *
3454 * @see #ACTION_GET_CONTENT
3455 * @see #ACTION_OPEN_DOCUMENT
3456 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003457 */
3458 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3459 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3460
3461 /**
3462 * To be used as code under test for framework instrumentation tests.
3463 */
3464 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3465 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003466 /**
3467 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003468 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3469 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003470 */
3471 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3472 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3473 /**
3474 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003475 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3476 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003477 */
3478 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3479 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003480 /**
3481 * An activity to run when device is inserted into a analog (low end) dock.
3482 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3483 * information, see {@link android.app.UiModeManager}.
3484 */
3485 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3486 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3487
3488 /**
3489 * An activity to run when device is inserted into a digital (high end) dock.
3490 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3491 * information, see {@link android.app.UiModeManager}.
3492 */
3493 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3494 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003495
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003496 /**
3497 * Used to indicate that the activity can be used in a car environment.
3498 */
3499 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3500 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3501
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003502 // ---------------------------------------------------------------------
3503 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003504 // Application launch intent categories (see addCategory()).
3505
3506 /**
3507 * Used with {@link #ACTION_MAIN} to launch the browser application.
3508 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003509 * <p>NOTE: This should not be used as the primary key of an Intent,
3510 * since it will not result in the app launching with the correct
3511 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003512 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003513 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003514 */
3515 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3516 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3517
3518 /**
3519 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3520 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003521 * <p>NOTE: This should not be used as the primary key of an Intent,
3522 * since it will not result in the app launching with the correct
3523 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003524 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003525 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003526 */
3527 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3528 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3529
3530 /**
3531 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3532 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003533 * <p>NOTE: This should not be used as the primary key of an Intent,
3534 * since it will not result in the app launching with the correct
3535 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003536 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003537 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003538 */
3539 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3540 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3541
3542 /**
3543 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3544 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003545 * <p>NOTE: This should not be used as the primary key of an Intent,
3546 * since it will not result in the app launching with the correct
3547 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003548 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003549 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003550 */
3551 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3552 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3553
3554 /**
3555 * Used with {@link #ACTION_MAIN} to launch the email application.
3556 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003557 * <p>NOTE: This should not be used as the primary key of an Intent,
3558 * since it will not result in the app launching with the correct
3559 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003560 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003561 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003562 */
3563 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3564 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3565
3566 /**
3567 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3568 * The activity should be able to view and manipulate image and video files
3569 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003570 * <p>NOTE: This should not be used as the primary key of an Intent,
3571 * since it will not result in the app launching with the correct
3572 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003573 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003574 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003575 */
3576 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3577 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3578
3579 /**
3580 * Used with {@link #ACTION_MAIN} to launch the maps application.
3581 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003582 * <p>NOTE: This should not be used as the primary key of an Intent,
3583 * since it will not result in the app launching with the correct
3584 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003585 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003586 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003587 */
3588 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3589 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3590
3591 /**
3592 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3593 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003594 * <p>NOTE: This should not be used as the primary key of an Intent,
3595 * since it will not result in the app launching with the correct
3596 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003597 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003598 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003599 */
3600 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3601 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3602
3603 /**
3604 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003605 * The activity should be able to play, browse, or manipulate music files
3606 * stored on the device.
3607 * <p>NOTE: This should not be used as the primary key of an Intent,
3608 * since it will not result in the app launching with the correct
3609 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003610 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003611 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003612 */
3613 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3614 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3615
3616 // ---------------------------------------------------------------------
3617 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003618 // Standard extra data keys.
3619
3620 /**
3621 * The initial data to place in a newly created record. Use with
3622 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3623 * fields as would be given to the underlying ContentProvider.insert()
3624 * call.
3625 */
3626 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3627
3628 /**
3629 * A constant CharSequence that is associated with the Intent, used with
3630 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3631 * this may be a styled CharSequence, so you must use
3632 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3633 * retrieve it.
3634 */
3635 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3636
3637 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003638 * A constant String that is associated with the Intent, used with
3639 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3640 * as HTML formatted text. Note that you <em>must</em> also supply
3641 * {@link #EXTRA_TEXT}.
3642 */
3643 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3644
3645 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003646 * A content: URI holding a stream of data associated with the Intent,
3647 * used with {@link #ACTION_SEND} to supply the data being sent.
3648 */
3649 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3650
3651 /**
3652 * A String[] holding e-mail addresses that should be delivered to.
3653 */
3654 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3655
3656 /**
3657 * A String[] holding e-mail addresses that should be carbon copied.
3658 */
3659 public static final String EXTRA_CC = "android.intent.extra.CC";
3660
3661 /**
3662 * A String[] holding e-mail addresses that should be blind carbon copied.
3663 */
3664 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3665
3666 /**
3667 * A constant string holding the desired subject line of a message.
3668 */
3669 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3670
3671 /**
3672 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003673 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003674 */
3675 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3676
3677 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003678 * An int representing the user id to be used.
3679 *
3680 * @hide
3681 */
3682 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3683
3684 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003685 * An int representing the task id to be retrieved. This is used when a launch from recents is
3686 * intercepted by another action such as credentials confirmation to remember which task should
3687 * be resumed when complete.
3688 *
3689 * @hide
3690 */
3691 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3692
3693 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003694 * An Intent[] describing additional, alternate choices you would like shown with
3695 * {@link #ACTION_CHOOSER}.
3696 *
3697 * <p>An app may be capable of providing several different payload types to complete a
3698 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3699 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3700 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3701 * photo data or a hosted link where the photos can be viewed.</p>
3702 *
3703 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3704 * first/primary/preferred intent in the set. Additional intents specified in
3705 * this extra are ordered; by default intents that appear earlier in the array will be
3706 * preferred over intents that appear later in the array as matches for the same
3707 * target component. To alter this preference, a calling app may also supply
3708 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3709 */
3710 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3711
3712 /**
3713 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3714 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3715 *
3716 * <p>An app preparing an action for another app to complete may wish to allow the user to
3717 * disambiguate between several options for completing the action based on the chosen target
3718 * or otherwise refine the action before it is invoked.
3719 * </p>
3720 *
3721 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3722 * <ul>
3723 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3724 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3725 * chosen target beyond the first</li>
3726 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3727 * should fill in and send once the disambiguation is complete</li>
3728 * </ul>
3729 */
3730 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3731 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3732
3733 /**
3734 * A {@link ResultReceiver} used to return data back to the sender.
3735 *
3736 * <p>Used to complete an app-specific
3737 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3738 *
3739 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3740 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3741 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3742 * when the user selects a target component from the chooser. It is up to the recipient
3743 * to send a result to this ResultReceiver to signal that disambiguation is complete
3744 * and that the chooser should invoke the user's choice.</p>
3745 *
3746 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3747 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3748 * to match and fill in the final Intent or ChooserTarget before starting it.
3749 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3750 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3751 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3752 *
3753 * <p>The result code passed to the ResultReceiver should be
3754 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3755 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3756 * the chooser should finish without starting a target.</p>
3757 */
3758 public static final String EXTRA_RESULT_RECEIVER
3759 = "android.intent.extra.RESULT_RECEIVER";
3760
3761 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003762 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003763 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003764 */
3765 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3766
3767 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003768 * A Parcelable[] of {@link Intent} or
3769 * {@link android.content.pm.LabeledIntent} objects as set with
3770 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3771 * a the front of the list of choices, when shown to the user with a
3772 * {@link #ACTION_CHOOSER}.
3773 */
3774 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3775
3776 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003777 * A {@link IntentSender} to start after ephemeral installation success.
3778 * @hide
3779 */
3780 @SystemApi
3781 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3782
3783 /**
3784 * A {@link IntentSender} to start after ephemeral installation failure.
3785 * @hide
3786 */
3787 @SystemApi
3788 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3789
3790 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003791 * A Bundle forming a mapping of potential target package names to different extras Bundles
3792 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3793 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3794 * be currently installed on the device.
3795 *
3796 * <p>An application may choose to provide alternate extras for the case where a user
3797 * selects an activity from a predetermined set of target packages. If the activity
3798 * the user selects from the chooser belongs to a package with its package name as
3799 * a key in this bundle, the corresponding extras for that package will be merged with
3800 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3801 * extra has the same key as an extra already present in the intent it will overwrite
3802 * the extra from the intent.</p>
3803 *
3804 * <p><em>Examples:</em>
3805 * <ul>
3806 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3807 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3808 * parameters for that target.</li>
3809 * <li>An application may offer additional metadata for known targets of a given intent
3810 * to pass along information only relevant to that target such as account or content
3811 * identifiers already known to that application.</li>
3812 * </ul></p>
3813 */
3814 public static final String EXTRA_REPLACEMENT_EXTRAS =
3815 "android.intent.extra.REPLACEMENT_EXTRAS";
3816
3817 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003818 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3819 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3820 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3821 * {@link ComponentName} of the chosen component.
3822 *
3823 * <p>In some situations this callback may never come, for example if the user abandons
3824 * the chooser, switches to another task or any number of other reasons. Apps should not
3825 * be written assuming that this callback will always occur.</p>
3826 */
3827 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3828 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3829
3830 /**
3831 * The {@link ComponentName} chosen by the user to complete an action.
3832 *
3833 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3834 */
3835 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3836
3837 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003838 * A {@link android.view.KeyEvent} object containing the event that
3839 * triggered the creation of the Intent it is in.
3840 */
3841 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3842
3843 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003844 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3845 * before shutting down.
3846 *
3847 * {@hide}
3848 */
3849 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3850
3851 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003852 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3853 * requested by the user.
3854 *
3855 * {@hide}
3856 */
3857 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3858 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3859
3860 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003861 * 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 -07003862 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3863 * of restarting the application.
3864 */
3865 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3866
3867 /**
3868 * A String holding the phone number originally entered in
3869 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3870 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3871 */
3872 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003873
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003874 /**
3875 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3876 * intents to supply the uid the package had been assigned. Also an optional
3877 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3878 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3879 * purpose.
3880 */
3881 public static final String EXTRA_UID = "android.intent.extra.UID";
3882
3883 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003884 * @hide String array of package names.
3885 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003886 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003887 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3888
3889 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003890 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3891 * intents to indicate whether this represents a full uninstall (removing
3892 * both the code and its data) or a partial uninstall (leaving its data,
3893 * implying that this is an update).
3894 */
3895 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003896
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003897 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003898 * @hide
3899 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3900 * intents to indicate that at this point the package has been removed for
3901 * all users on the device.
3902 */
3903 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3904 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3905
3906 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003907 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3908 * intents to indicate that this is a replacement of the package, so this
3909 * broadcast will immediately be followed by an add broadcast for a
3910 * different version of the same package.
3911 */
3912 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003913
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003914 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003915 * Used as an int extra field in {@link android.app.AlarmManager} intents
3916 * to tell the application being invoked how many pending alarms are being
3917 * delievered with the intent. For one-shot alarms this will always be 1.
3918 * For recurring alarms, this might be greater than 1 if the device was
3919 * asleep or powered off at the time an earlier alarm would have been
3920 * delivered.
3921 */
3922 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003923
Jacek Surazski86b6c532009-05-13 14:38:28 +02003924 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003925 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3926 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003927 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3928 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003929 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3930 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3931 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003932 */
3933 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3934
3935 /**
3936 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3937 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003938 */
3939 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3940
3941 /**
3942 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3943 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003944 */
3945 public static final int EXTRA_DOCK_STATE_DESK = 1;
3946
3947 /**
3948 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3949 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003950 */
3951 public static final int EXTRA_DOCK_STATE_CAR = 2;
3952
3953 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003954 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3955 * to represent that the phone is in a analog (low end) dock.
3956 */
3957 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3958
3959 /**
3960 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3961 * to represent that the phone is in a digital (high end) dock.
3962 */
3963 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3964
3965 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003966 * Boolean that can be supplied as meta-data with a dock activity, to
3967 * indicate that the dock should take over the home key when it is active.
3968 */
3969 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003970
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003971 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003972 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3973 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003974 */
3975 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3976
3977 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003978 * Used in the extra field in the remote intent. It's astring token passed with the
3979 * remote intent.
3980 */
3981 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3982 "android.intent.extra.remote_intent_token";
3983
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003984 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003985 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003986 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003987 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003988 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003989 "android.intent.extra.changed_component_name";
3990
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003991 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003992 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003993 * and contains a string array of all of the components that have changed. If
3994 * the state of the overall package has changed, then it will contain an entry
3995 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003996 */
3997 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3998 "android.intent.extra.changed_component_name_list";
3999
4000 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004001 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004002 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004003 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4004 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4005 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004006 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004007 */
4008 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4009 "android.intent.extra.changed_package_list";
4010
4011 /**
4012 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004013 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4014 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004015 * and contains an integer array of uids of all of the components
4016 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004017 */
4018 public static final String EXTRA_CHANGED_UID_LIST =
4019 "android.intent.extra.changed_uid_list";
4020
4021 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004022 * @hide
4023 * Magic extra system code can use when binding, to give a label for
4024 * who it is that has bound to a service. This is an integer giving
4025 * a framework string resource that can be displayed to the user.
4026 */
4027 public static final String EXTRA_CLIENT_LABEL =
4028 "android.intent.extra.client_label";
4029
4030 /**
4031 * @hide
4032 * Magic extra system code can use when binding, to give a PendingIntent object
4033 * that can be launched for the user to disable the system's use of this
4034 * service.
4035 */
4036 public static final String EXTRA_CLIENT_INTENT =
4037 "android.intent.extra.client_intent";
4038
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004039 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004040 * Extra used to indicate that an intent should only return data that is on
4041 * the local device. This is a boolean extra; the default is false. If true,
4042 * an implementation should only allow the user to select data that is
4043 * already on the device, not requiring it be downloaded from a remote
4044 * service when opened.
4045 *
4046 * @see #ACTION_GET_CONTENT
4047 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004048 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004049 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004050 */
4051 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004052 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004053
Amith Yamasani13593602012-03-22 16:16:17 -07004054 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004055 * Extra used to indicate that an intent can allow the user to select and
4056 * return multiple items. This is a boolean extra; the default is false. If
4057 * true, an implementation is allowed to present the user with a UI where
4058 * they can pick multiple items that are all returned to the caller. When
4059 * this happens, they should be returned as the {@link #getClipData()} part
4060 * of the result Intent.
4061 *
4062 * @see #ACTION_GET_CONTENT
4063 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004064 */
4065 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004066 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004067
4068 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004069 * The integer userHandle carried with broadcast intents related to addition, removal and
4070 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4071 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4072 *
Amith Yamasani13593602012-03-22 16:16:17 -07004073 * @hide
4074 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004075 public static final String EXTRA_USER_HANDLE =
4076 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004077
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004078 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004079 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4080 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4081 */
4082 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004083 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004084
4085 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004086 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004087 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4088 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004089 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004090 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4091
4092 /**
4093 * Extra sent in the intent to the BroadcastReceiver that handles
4094 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4095 * the restrictions as key/value pairs.
4096 */
4097 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4098 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004099
Amith Yamasani86118ba2013-03-28 14:33:16 -07004100 /**
4101 * Extra used in the response from a BroadcastReceiver that handles
4102 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4103 */
4104 public static final String EXTRA_RESTRICTIONS_INTENT =
4105 "android.intent.extra.restrictions_intent";
4106
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004107 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004108 * Extra used to communicate a set of acceptable MIME types. The type of the
4109 * extra is {@code String[]}. Values may be a combination of concrete MIME
4110 * types (such as "image/png") and/or partial MIME types (such as
4111 * "audio/*").
4112 *
4113 * @see #ACTION_GET_CONTENT
4114 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004115 */
4116 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4117
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004118 /**
4119 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4120 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004121 * When this is true, hardware devices can use this information to determine that
4122 * they shouldn't do a complete shutdown of their device since this is not a
4123 * complete shutdown down to the kernel, but only user space restarting.
4124 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004125 */
4126 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4127 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4128
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004129 /**
4130 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4131 * user has set their time format preferences to the 24 hour format.
4132 *
4133 * @hide for internal use only.
4134 */
4135 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4136 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4137
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004138 /** {@hide} */
4139 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4140
Rubin Xue8490f12015-06-25 12:17:48 +01004141 /** {@hide} */
4142 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4143
Santos Cordon15a13782015-03-31 18:32:31 -07004144 /**
4145 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4146 * activation request.
4147 * TODO: Add information about the structure and response data used with the pending intent.
4148 * @hide
4149 */
4150 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4151 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4152
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004153 /**
4154 * Optional index with semantics depending on the intent action.
4155 * @see #ACTION_QUICK_VIEW
4156 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004157 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4158
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004159 /**
4160 * Optional boolean extra indicating whether quiet mode has been switched on or off.
4161 */
4162 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004163
4164 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004165 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004166 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004167 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4168 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004169 *
4170 * @hide
4171 */
4172 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4173 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4174
4175 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004176 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004177 * to represent that a video codec is allowed to use.
4178 *
4179 * @hide
4180 */
4181 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4182
4183 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004184 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004185 * to represent that a audio codec is allowed to use.
4186 *
4187 * @hide
4188 */
4189 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4190
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004191 // ---------------------------------------------------------------------
4192 // ---------------------------------------------------------------------
4193 // Intent flags (see mFlags variable).
4194
Tor Norbyed9273d62013-05-30 15:59:53 -07004195 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004196 @IntDef(flag = true, value = {
4197 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4198 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004199 @Retention(RetentionPolicy.SOURCE)
4200 public @interface GrantUriMode {}
4201
Jeff Sharkey846318a2014-04-04 12:12:41 -07004202 /** @hide */
4203 @IntDef(flag = true, value = {
4204 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4205 @Retention(RetentionPolicy.SOURCE)
4206 public @interface AccessUriMode {}
4207
4208 /**
4209 * Test if given mode flags specify an access mode, which must be at least
4210 * read and/or write.
4211 *
4212 * @hide
4213 */
4214 public static boolean isAccessUriMode(int modeFlags) {
4215 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4216 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4217 }
4218
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004219 /**
4220 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004221 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004222 * specified in its ClipData. When applying to an Intent's ClipData,
4223 * all URIs as well as recursive traversals through data or other ClipData
4224 * in Intent items will be granted; only the grant flags of the top-level
4225 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004226 */
4227 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4228 /**
4229 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004230 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004231 * specified in its ClipData. When applying to an Intent's ClipData,
4232 * all URIs as well as recursive traversals through data or other ClipData
4233 * in Intent items will be granted; only the grant flags of the top-level
4234 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004235 */
4236 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4237 /**
4238 * Can be set by the caller to indicate that this Intent is coming from
4239 * a background operation, not from direct user interaction.
4240 */
4241 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4242 /**
4243 * A flag you can enable for debugging: when set, log messages will be
4244 * printed during the resolution of this intent to show you what has
4245 * been found to create the final resolved list.
4246 */
4247 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004248 /**
4249 * If set, this intent will not match any components in packages that
4250 * are currently stopped. If this is not set, then the default behavior
4251 * is to include such applications in the result.
4252 */
4253 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4254 /**
4255 * If set, this intent will always match any components in packages that
4256 * are currently stopped. This is the default behavior when
4257 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4258 * flags are set, this one wins (it allows overriding of exclude for
4259 * places where the framework may automatically set the exclude flag).
4260 */
4261 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004262
4263 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004264 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004265 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004266 * persisted across device reboots until explicitly revoked with
4267 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4268 * grant for possible persisting; the receiving application must call
4269 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4270 * actually persist.
4271 *
4272 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4273 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4274 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004275 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004276 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004277 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004278
4279 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004280 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4281 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4282 * applies to any URI that is a prefix match against the original granted
4283 * URI. (Without this flag, the URI must match exactly for access to be
4284 * granted.) Another URI is considered a prefix match only when scheme,
4285 * authority, and all path segments defined by the prefix are an exact
4286 * match.
4287 */
4288 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4289
4290 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004291 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004292 * homework and verified that they correctly handle packages and components
4293 * that come and go over time. In particular:
4294 * <ul>
4295 * <li>Apps installed on external storage, which will appear to be
4296 * uninstalled while the the device is ejected.
4297 * <li>Apps with encryption unaware components, which will appear to not
4298 * exist while the device is locked.
4299 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004300 *
4301 * @hide
4302 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004303 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004304
4305 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004306 * If set, the new activity is not kept in the history stack. As soon as
4307 * the user navigates away from it, the activity is finished. This may also
4308 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4309 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004310 *
4311 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4312 * is never invoked when the current activity starts a new activity which
4313 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004314 */
4315 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4316 /**
4317 * If set, the activity will not be launched if it is already running
4318 * at the top of the history stack.
4319 */
4320 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4321 /**
4322 * If set, this activity will become the start of a new task on this
4323 * history stack. A task (from the activity that started it to the
4324 * next task activity) defines an atomic group of activities that the
4325 * user can move to. Tasks can be moved to the foreground and background;
4326 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004327 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004328 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4329 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004330 *
4331 * <p>This flag is generally used by activities that want
4332 * to present a "launcher" style behavior: they give the user a list of
4333 * separate things that can be done, which otherwise run completely
4334 * independently of the activity launching them.
4335 *
4336 * <p>When using this flag, if a task is already running for the activity
4337 * you are now starting, then a new activity will not be started; instead,
4338 * the current task will simply be brought to the front of the screen with
4339 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4340 * to disable this behavior.
4341 *
4342 * <p>This flag can not be used when the caller is requesting a result from
4343 * the activity being launched.
4344 */
4345 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4346 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004347 * This flag is used to create a new task and launch an activity into it.
4348 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4349 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4350 * search through existing tasks for ones matching this Intent. Only if no such
4351 * task is found would a new task be created. When paired with
4352 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4353 * the search for a matching task and unconditionally start a new task.
4354 *
4355 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4356 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004357 * top-level application launcher.</strong> Used in conjunction with
4358 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4359 * behavior of bringing an existing task to the foreground. When set,
4360 * a new task is <em>always</em> started to host the Activity for the
4361 * Intent, regardless of whether there is already an existing task running
4362 * the same thing.
4363 *
4364 * <p><strong>Because the default system does not include graphical task management,
4365 * you should not use this flag unless you provide some way for a user to
4366 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004367 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004368 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4369 * creating new document tasks.
4370 *
4371 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004372 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004373 *
Scott Main7aee61f2011-02-08 11:25:01 -08004374 * <p>See
4375 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4376 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004377 *
4378 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4379 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004380 */
4381 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4382 /**
4383 * If set, and the activity being launched is already running in the
4384 * current task, then instead of launching a new instance of that activity,
4385 * all of the other activities on top of it will be closed and this Intent
4386 * will be delivered to the (now on top) old activity as a new Intent.
4387 *
4388 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4389 * If D calls startActivity() with an Intent that resolves to the component
4390 * of activity B, then C and D will be finished and B receive the given
4391 * Intent, resulting in the stack now being: A, B.
4392 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004393 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004394 * either receive the new intent you are starting here in its
4395 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004396 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004397 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4398 * the same intent, then it will be finished and re-created; for all other
4399 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4400 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004401 *
4402 * <p>This launch mode can also be used to good effect in conjunction with
4403 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4404 * of a task, it will bring any currently running instance of that task
4405 * to the foreground, and then clear it to its root state. This is
4406 * especially useful, for example, when launching an activity from the
4407 * notification manager.
4408 *
Scott Main7aee61f2011-02-08 11:25:01 -08004409 * <p>See
4410 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4411 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004412 */
4413 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4414 /**
4415 * If set and this intent is being used to launch a new activity from an
4416 * existing one, then the reply target of the existing activity will be
4417 * transfered to the new activity. This way the new activity can call
4418 * {@link android.app.Activity#setResult} and have that result sent back to
4419 * the reply target of the original activity.
4420 */
4421 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4422 /**
4423 * If set and this intent is being used to launch a new activity from an
4424 * existing one, the current activity will not be counted as the top
4425 * activity for deciding whether the new intent should be delivered to
4426 * the top instead of starting a new one. The previous activity will
4427 * be used as the top, with the assumption being that the current activity
4428 * will finish itself immediately.
4429 */
4430 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4431 /**
4432 * If set, the new activity is not kept in the list of recently launched
4433 * activities.
4434 */
4435 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4436 /**
4437 * This flag is not normally set by application code, but set for you by
4438 * the system as described in the
4439 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4440 * launchMode} documentation for the singleTask mode.
4441 */
4442 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4443 /**
4444 * If set, and this activity is either being started in a new task or
4445 * bringing to the top an existing task, then it will be launched as
4446 * the front door of the task. This will result in the application of
4447 * any affinities needed to have that task in the proper state (either
4448 * moving activities to or from it), or simply resetting that task to
4449 * its initial state if needed.
4450 */
4451 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4452 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004453 * This flag is not normally set by application code, but set for you by
4454 * the system if this activity is being launched from history
4455 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004456 */
4457 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004458 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004459 * @deprecated As of API 21 this performs identically to
4460 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004461 */
4462 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004463 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004464 * This flag is used to open a document into a new task rooted at the activity launched
4465 * by this Intent. Through the use of this flag, or its equivalent attribute,
4466 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004467 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004468 *
Craig Mautner026596b2014-05-21 15:35:44 -07004469 * <p>The use of the activity attribute form of this,
4470 * {@link android.R.attr#documentLaunchMode}, is
4471 * preferred over the Intent flag described here. The attribute form allows the
4472 * Activity to specify multiple document behavior for all launchers of the Activity
4473 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004474 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004475 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4476 * it is kept after the activity is finished is different than the use of
4477 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4478 * this flag is being used to create a new recents entry, then by default that entry
4479 * will be removed once the activity is finished. You can modify this behavior with
4480 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4481 *
Craig Mautner026596b2014-05-21 15:35:44 -07004482 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4483 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4484 * equivalent of the Activity manifest specifying {@link
4485 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4486 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4487 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004488 *
Craig Mautner026596b2014-05-21 15:35:44 -07004489 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004490 *
Craig Mautner026596b2014-05-21 15:35:44 -07004491 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004492 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4493 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004494 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004495 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004496 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004497 * callback from occurring on the current frontmost activity before it is
4498 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004499 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004500 * <p>Typically, an activity can rely on that callback to indicate that an
4501 * explicit user action has caused their activity to be moved out of the
4502 * foreground. The callback marks an appropriate point in the activity's
4503 * lifecycle for it to dismiss any notifications that it intends to display
4504 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004505 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004506 * <p>If an activity is ever started via any non-user-driven events such as
4507 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4508 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004509 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004510 */
4511 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004512 /**
4513 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4514 * this flag will cause the launched activity to be brought to the front of its
4515 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004516 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004517 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4518 * If D calls startActivity() with an Intent that resolves to the component
4519 * of activity B, then B will be brought to the front of the history stack,
4520 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004521 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004522 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004523 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004524 */
4525 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004526 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004527 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4528 * this flag will prevent the system from applying an activity transition
4529 * animation to go to the next activity state. This doesn't mean an
4530 * animation will never run -- if another activity change happens that doesn't
4531 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004532 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004533 * when you are going to do a series of activity operations but the
4534 * animation seen by the user shouldn't be driven by the first activity
4535 * change but rather a later one.
4536 */
4537 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4538 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004539 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4540 * this flag will cause any existing task that would be associated with the
4541 * activity to be cleared before the activity is started. That is, the activity
4542 * becomes the new root of an otherwise empty task, and any old activities
4543 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4544 */
4545 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4546 /**
4547 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4548 * this flag will cause a newly launching task to be placed on top of the current
4549 * home activity task (if there is one). That is, pressing back from the task
4550 * will always return the user to home even if that was not the last activity they
4551 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4552 */
4553 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4554 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004555 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4556 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004557 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004558 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004559 * this flag. When set and the task's activity is finished, the recents
4560 * entry will remain in the interface for the user to re-launch it, like a
4561 * recents entry for a top-level application.
4562 * <p>
4563 * The receiving activity can override this request with
4564 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4565 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004566 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004567 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004568 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004569
4570 /**
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004571 * This flag is only used in the multi-window mode. The new activity will be displayed on
4572 * the other side than the one that is launching it. This can only be used in conjunction with
4573 * {@link #FLAG_ACTIVITY_NEW_TASK}.
4574 */
4575 public static final int FLAG_ACTIVITY_LAUNCH_TO_SIDE = 0x00001000;
4576
4577 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004578 * If set, when sending a broadcast only registered receivers will be
4579 * called -- no BroadcastReceiver components will be launched.
4580 */
4581 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004582 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004583 * If set, when sending a broadcast the new broadcast will replace
4584 * any existing pending broadcast that matches it. Matching is defined
4585 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4586 * true for the intents of the two broadcasts. When a match is found,
4587 * the new broadcast (and receivers associated with it) will replace the
4588 * existing one in the pending broadcast list, remaining at the same
4589 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004590 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004591 * <p>This flag is most typically used with sticky broadcasts, which
4592 * only care about delivering the most recent values of the broadcast
4593 * to their receivers.
4594 */
4595 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4596 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004597 * If set, when sending a broadcast the recipient is allowed to run at
4598 * foreground priority, with a shorter timeout interval. During normal
4599 * broadcasts the receivers are not automatically hoisted out of the
4600 * background priority class.
4601 */
4602 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4603 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004604 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4605 * They can still propagate results through to later receivers, but they can not prevent
4606 * later receivers from seeing the broadcast.
4607 */
4608 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4609 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004610 * If set, when sending a broadcast <i>before boot has completed</i> only
4611 * registered receivers will be called -- no BroadcastReceiver components
4612 * will be launched. Sticky intent state will be recorded properly even
4613 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4614 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004615 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004616 * <p>This flag is only for use by system sevices as a convenience to
4617 * avoid having to implement a more complex mechanism around detection
4618 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004619 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004620 * @hide
4621 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004622 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004623 /**
4624 * Set when this broadcast is for a boot upgrade, a special mode that
4625 * allows the broadcast to be sent before the system is ready and launches
4626 * the app process with no providers running in it.
4627 * @hide
4628 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004629 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004630 /**
4631 * If set, the broadcast will always go to manifest receivers in background (cached
4632 * or not running) apps, regardless of whether that would be done by default. By
4633 * default they will only receive broadcasts if the broadcast has specified an
4634 * explicit component or package name.
4635 * @hide
4636 */
4637 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4638 /**
4639 * If set, the broadcast will never go to manifest receivers in background (cached
4640 * or not running) apps, regardless of whether that would be done by default. By
4641 * default they will receive broadcasts if the broadcast has specified an
4642 * explicit component or package name.
4643 * @hide
4644 */
4645 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004646
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004647 /**
4648 * @hide Flags that can't be changed with PendingIntent.
4649 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004650 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4651 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4652 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004653
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004654 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004655 // ---------------------------------------------------------------------
4656 // toUri() and parseUri() options.
4657
4658 /**
4659 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4660 * always has the "intent:" scheme. This syntax can be used when you want
4661 * to later disambiguate between URIs that are intended to describe an
4662 * Intent vs. all others that should be treated as raw URIs. When used
4663 * with {@link #parseUri}, any other scheme will result in a generic
4664 * VIEW action for that raw URI.
4665 */
4666 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004667
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004668 /**
4669 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4670 * always has the "android-app:" scheme. This is a variation of
4671 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4672 * http/https URI being delivered to a specific package name. The format
4673 * is:
4674 *
4675 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004676 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004677 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004678 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4679 * you must also include a scheme; including a path also requires both a host and a scheme.
4680 * The final #Intent; fragment can be used without a scheme, host, or path.
4681 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004682 * used with intents that have a {@link #setSelector}, since the base intent
4683 * will always have an explicit package name.</p>
4684 *
4685 * <p>Some examples of how this scheme maps to Intent objects:</p>
4686 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4687 * <colgroup align="left" />
4688 * <colgroup align="left" />
4689 * <thead>
4690 * <tr><th>URI</th> <th>Intent</th></tr>
4691 * </thead>
4692 *
4693 * <tbody>
4694 * <tr><td><code>android-app://com.example.app</code></td>
4695 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4696 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4697 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4698 * </table></td>
4699 * </tr>
4700 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4701 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4702 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4703 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4704 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4705 * </table></td>
4706 * </tr>
4707 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4708 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4709 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4710 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4711 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4712 * </table></td>
4713 * </tr>
4714 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4715 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4716 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4717 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4718 * </table></td>
4719 * </tr>
4720 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4721 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4722 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4723 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4724 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4725 * </table></td>
4726 * </tr>
4727 * <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>
4728 * <td><table border="" style="margin:0" >
4729 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4730 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4731 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4732 * </table></td>
4733 * </tr>
4734 * </tbody>
4735 * </table>
4736 */
4737 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4738
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004739 /**
4740 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4741 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4742 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4743 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4744 * generated Intent can not cause unexpected data access to happen.
4745 *
4746 * <p>If you do not trust the source of the URI being parsed, you should still do further
4747 * processing to protect yourself from it. In particular, when using it to start an
4748 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4749 * that can handle it.</p>
4750 */
4751 public static final int URI_ALLOW_UNSAFE = 1<<2;
4752
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004753 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004754
4755 private String mAction;
4756 private Uri mData;
4757 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004758 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004759 private ComponentName mComponent;
4760 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004761 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004762 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004763 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004764 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004765 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004766 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004767
4768 // ---------------------------------------------------------------------
4769
4770 /**
4771 * Create an empty intent.
4772 */
4773 public Intent() {
4774 }
4775
4776 /**
4777 * Copy constructor.
4778 */
4779 public Intent(Intent o) {
4780 this.mAction = o.mAction;
4781 this.mData = o.mData;
4782 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004783 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004784 this.mComponent = o.mComponent;
4785 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004786 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004787 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004788 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004789 }
4790 if (o.mExtras != null) {
4791 this.mExtras = new Bundle(o.mExtras);
4792 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004793 if (o.mSourceBounds != null) {
4794 this.mSourceBounds = new Rect(o.mSourceBounds);
4795 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004796 if (o.mSelector != null) {
4797 this.mSelector = new Intent(o.mSelector);
4798 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004799 if (o.mClipData != null) {
4800 this.mClipData = new ClipData(o.mClipData);
4801 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004802 }
4803
4804 @Override
4805 public Object clone() {
4806 return new Intent(this);
4807 }
4808
4809 private Intent(Intent o, boolean all) {
4810 this.mAction = o.mAction;
4811 this.mData = o.mData;
4812 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004813 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004814 this.mComponent = o.mComponent;
4815 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004816 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004817 }
4818 }
4819
4820 /**
4821 * Make a clone of only the parts of the Intent that are relevant for
4822 * filter matching: the action, data, type, component, and categories.
4823 */
4824 public Intent cloneFilter() {
4825 return new Intent(this, false);
4826 }
4827
4828 /**
4829 * Create an intent with a given action. All other fields (data, type,
4830 * class) are null. Note that the action <em>must</em> be in a
4831 * namespace because Intents are used globally in the system -- for
4832 * example the system VIEW action is android.intent.action.VIEW; an
4833 * application's custom action would be something like
4834 * com.google.app.myapp.CUSTOM_ACTION.
4835 *
4836 * @param action The Intent action, such as ACTION_VIEW.
4837 */
4838 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004839 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004840 }
4841
4842 /**
4843 * Create an intent with a given action and for a given data url. Note
4844 * that the action <em>must</em> be in a namespace because Intents are
4845 * used globally in the system -- for example the system VIEW action is
4846 * android.intent.action.VIEW; an application's custom action would be
4847 * something like com.google.app.myapp.CUSTOM_ACTION.
4848 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004849 * <p><em>Note: scheme and host name matching in the Android framework is
4850 * case-sensitive, unlike the formal RFC. As a result,
4851 * you should always ensure that you write your Uri with these elements
4852 * using lower case letters, and normalize any Uris you receive from
4853 * outside of Android to ensure the scheme and host is lower case.</em></p>
4854 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004855 * @param action The Intent action, such as ACTION_VIEW.
4856 * @param uri The Intent data URI.
4857 */
4858 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004859 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004860 mData = uri;
4861 }
4862
4863 /**
4864 * Create an intent for a specific component. All other fields (action, data,
4865 * type, class) are null, though they can be modified later with explicit
4866 * calls. This provides a convenient way to create an intent that is
4867 * intended to execute a hard-coded class name, rather than relying on the
4868 * system to find an appropriate class for you; see {@link #setComponent}
4869 * for more information on the repercussions of this.
4870 *
4871 * @param packageContext A Context of the application package implementing
4872 * this class.
4873 * @param cls The component class that is to be used for the intent.
4874 *
4875 * @see #setClass
4876 * @see #setComponent
4877 * @see #Intent(String, android.net.Uri , Context, Class)
4878 */
4879 public Intent(Context packageContext, Class<?> cls) {
4880 mComponent = new ComponentName(packageContext, cls);
4881 }
4882
4883 /**
4884 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004885 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004886 * construct the Intent and then calling {@link #setClass} to set its
4887 * class.
4888 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004889 * <p><em>Note: scheme and host name matching in the Android framework is
4890 * case-sensitive, unlike the formal RFC. As a result,
4891 * you should always ensure that you write your Uri with these elements
4892 * using lower case letters, and normalize any Uris you receive from
4893 * outside of Android to ensure the scheme and host is lower case.</em></p>
4894 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004895 * @param action The Intent action, such as ACTION_VIEW.
4896 * @param uri The Intent data URI.
4897 * @param packageContext A Context of the application package implementing
4898 * this class.
4899 * @param cls The component class that is to be used for the intent.
4900 *
4901 * @see #Intent(String, android.net.Uri)
4902 * @see #Intent(Context, Class)
4903 * @see #setClass
4904 * @see #setComponent
4905 */
4906 public Intent(String action, Uri uri,
4907 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004908 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004909 mData = uri;
4910 mComponent = new ComponentName(packageContext, cls);
4911 }
4912
4913 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004914 * Create an intent to launch the main (root) activity of a task. This
4915 * is the Intent that is started when the application's is launched from
4916 * Home. For anything else that wants to launch an application in the
4917 * same way, it is important that they use an Intent structured the same
4918 * way, and can use this function to ensure this is the case.
4919 *
4920 * <p>The returned Intent has the given Activity component as its explicit
4921 * component, {@link #ACTION_MAIN} as its action, and includes the
4922 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4923 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4924 * to do that through {@link #addFlags(int)} on the returned Intent.
4925 *
4926 * @param mainActivity The main activity component that this Intent will
4927 * launch.
4928 * @return Returns a newly created Intent that can be used to launch the
4929 * activity as a main application entry.
4930 *
4931 * @see #setClass
4932 * @see #setComponent
4933 */
4934 public static Intent makeMainActivity(ComponentName mainActivity) {
4935 Intent intent = new Intent(ACTION_MAIN);
4936 intent.setComponent(mainActivity);
4937 intent.addCategory(CATEGORY_LAUNCHER);
4938 return intent;
4939 }
4940
4941 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004942 * Make an Intent for the main activity of an application, without
4943 * specifying a specific activity to run but giving a selector to find
4944 * the activity. This results in a final Intent that is structured
4945 * the same as when the application is launched from
4946 * Home. For anything else that wants to launch an application in the
4947 * same way, it is important that they use an Intent structured the same
4948 * way, and can use this function to ensure this is the case.
4949 *
4950 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4951 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4952 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4953 * to do that through {@link #addFlags(int)} on the returned Intent.
4954 *
4955 * @param selectorAction The action name of the Intent's selector.
4956 * @param selectorCategory The name of a category to add to the Intent's
4957 * selector.
4958 * @return Returns a newly created Intent that can be used to launch the
4959 * activity as a main application entry.
4960 *
4961 * @see #setSelector(Intent)
4962 */
4963 public static Intent makeMainSelectorActivity(String selectorAction,
4964 String selectorCategory) {
4965 Intent intent = new Intent(ACTION_MAIN);
4966 intent.addCategory(CATEGORY_LAUNCHER);
4967 Intent selector = new Intent();
4968 selector.setAction(selectorAction);
4969 selector.addCategory(selectorCategory);
4970 intent.setSelector(selector);
4971 return intent;
4972 }
4973
4974 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004975 * Make an Intent that can be used to re-launch an application's task
4976 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4977 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4978 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4979 *
4980 * @param mainActivity The activity component that is the root of the
4981 * task; this is the activity that has been published in the application's
4982 * manifest as the main launcher icon.
4983 *
4984 * @return Returns a newly created Intent that can be used to relaunch the
4985 * activity's task in its root state.
4986 */
4987 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4988 Intent intent = makeMainActivity(mainActivity);
4989 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4990 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4991 return intent;
4992 }
4993
4994 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004995 * Call {@link #parseUri} with 0 flags.
4996 * @deprecated Use {@link #parseUri} instead.
4997 */
4998 @Deprecated
4999 public static Intent getIntent(String uri) throws URISyntaxException {
5000 return parseUri(uri, 0);
5001 }
Tom Taylord4a47292009-12-21 13:59:18 -08005002
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005003 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005004 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005005 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005006 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005007 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005008 *
5009 * <p>The URI given here must not be relative -- that is, it must include
5010 * the scheme and full path.
5011 *
5012 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005013 * @param flags Additional processing flags. Either 0,
5014 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005015 *
5016 * @return Intent The newly created Intent object.
5017 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005018 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5019 * it bad (as parsed by the Uri class) or the Intent data within the
5020 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005021 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005022 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005023 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005024 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005025 int i = 0;
5026 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005027 final boolean androidApp = uri.startsWith("android-app:");
5028
5029 // Validate intent scheme if requested.
5030 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5031 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005032 Intent intent = new Intent(ACTION_VIEW);
5033 try {
5034 intent.setData(Uri.parse(uri));
5035 } catch (IllegalArgumentException e) {
5036 throw new URISyntaxException(uri, e.getMessage());
5037 }
5038 return intent;
5039 }
5040 }
Tom Taylord4a47292009-12-21 13:59:18 -08005041
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005042 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005043 // simple case
5044 if (i == -1) {
5045 if (!androidApp) {
5046 return new Intent(ACTION_VIEW, Uri.parse(uri));
5047 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005048
5049 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005050 } else if (!uri.startsWith("#Intent;", i)) {
5051 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005052 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005053 } else {
5054 i = -1;
5055 }
5056 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005057
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005058 // new format
5059 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005060 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005061 boolean explicitAction = false;
5062 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005063
5064 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005065 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005066 String data;
5067 if (i >= 0) {
5068 data = uri.substring(0, i);
5069 i += 8; // length of "#Intent;"
5070 } else {
5071 data = uri;
5072 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005073
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005074 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005075 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005076 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005077 if (eq < 0) eq = i-1;
5078 int semi = uri.indexOf(';', i);
5079 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005080
5081 // action
5082 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005083 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005084 if (!inSelector) {
5085 explicitAction = true;
5086 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005087 }
5088
5089 // categories
5090 else if (uri.startsWith("category=", i)) {
5091 intent.addCategory(value);
5092 }
5093
5094 // type
5095 else if (uri.startsWith("type=", i)) {
5096 intent.mType = value;
5097 }
5098
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005099 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005100 else if (uri.startsWith("launchFlags=", i)) {
5101 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005102 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5103 intent.mFlags &= ~IMMUTABLE_FLAGS;
5104 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005105 }
5106
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005107 // package
5108 else if (uri.startsWith("package=", i)) {
5109 intent.mPackage = value;
5110 }
5111
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005112 // component
5113 else if (uri.startsWith("component=", i)) {
5114 intent.mComponent = ComponentName.unflattenFromString(value);
5115 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005116
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005117 // scheme
5118 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005119 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005120 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005121 } else {
5122 scheme = value;
5123 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005124 }
5125
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005126 // source bounds
5127 else if (uri.startsWith("sourceBounds=", i)) {
5128 intent.mSourceBounds = Rect.unflattenFromString(value);
5129 }
5130
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005131 // selector
5132 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5133 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005134 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005135 }
5136
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005137 // extra
5138 else {
5139 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005140 // create Bundle if it doesn't already exist
5141 if (intent.mExtras == null) intent.mExtras = new Bundle();
5142 Bundle b = intent.mExtras;
5143 // add EXTRA
5144 if (uri.startsWith("S.", i)) b.putString(key, value);
5145 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5146 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5147 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5148 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5149 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5150 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5151 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5152 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5153 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5154 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005155
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005156 // move to the next item
5157 i = semi + 1;
5158 }
5159
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005160 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005161 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005162 if (baseIntent.mPackage == null) {
5163 baseIntent.setSelector(intent);
5164 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005165 intent = baseIntent;
5166 }
5167
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005168 if (data != null) {
5169 if (data.startsWith("intent:")) {
5170 data = data.substring(7);
5171 if (scheme != null) {
5172 data = scheme + ':' + data;
5173 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005174 } else if (data.startsWith("android-app:")) {
5175 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5176 // Correctly formed android-app, first part is package name.
5177 int end = data.indexOf('/', 14);
5178 if (end < 0) {
5179 // All we have is a package name.
5180 intent.mPackage = data.substring(14);
5181 if (!explicitAction) {
5182 intent.setAction(ACTION_MAIN);
5183 }
5184 data = "";
5185 } else {
5186 // Target the Intent at the given package name always.
5187 String authority = null;
5188 intent.mPackage = data.substring(14, end);
5189 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005190 if ((end+1) < data.length()) {
5191 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5192 // Found a scheme, remember it.
5193 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005194 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005195 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5196 // Found a authority, remember it.
5197 authority = data.substring(end+1, newEnd);
5198 end = newEnd;
5199 }
5200 } else {
5201 // All we have is a scheme.
5202 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005203 }
5204 }
5205 if (scheme == null) {
5206 // If there was no scheme, then this just targets the package.
5207 if (!explicitAction) {
5208 intent.setAction(ACTION_MAIN);
5209 }
5210 data = "";
5211 } else if (authority == null) {
5212 data = scheme + ":";
5213 } else {
5214 data = scheme + "://" + authority + data.substring(end);
5215 }
5216 }
5217 } else {
5218 data = "";
5219 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005220 }
Tom Taylord4a47292009-12-21 13:59:18 -08005221
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005222 if (data.length() > 0) {
5223 try {
5224 intent.mData = Uri.parse(data);
5225 } catch (IllegalArgumentException e) {
5226 throw new URISyntaxException(uri, e.getMessage());
5227 }
5228 }
5229 }
Tom Taylord4a47292009-12-21 13:59:18 -08005230
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005231 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005232
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005233 } catch (IndexOutOfBoundsException e) {
5234 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5235 }
5236 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005237
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005238 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005239 return getIntentOld(uri, 0);
5240 }
5241
5242 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005243 Intent intent;
5244
5245 int i = uri.lastIndexOf('#');
5246 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005247 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005248 final int intentFragmentStart = i;
5249 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005250
5251 i++;
5252
5253 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005254 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005255 i += 7;
5256 int j = uri.indexOf(')', i);
5257 action = uri.substring(i, j);
5258 i = j + 1;
5259 }
5260
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005261 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005262
5263 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005264 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005265 i += 11;
5266 int j = uri.indexOf(')', i);
5267 while (i < j) {
5268 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005269 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005270 if (i < sep) {
5271 intent.addCategory(uri.substring(i, sep));
5272 }
5273 i = sep + 1;
5274 }
5275 i = j + 1;
5276 }
5277
5278 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005279 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005280 i += 5;
5281 int j = uri.indexOf(')', i);
5282 intent.mType = uri.substring(i, j);
5283 i = j + 1;
5284 }
5285
5286 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005287 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005288 i += 12;
5289 int j = uri.indexOf(')', i);
5290 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005291 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5292 intent.mFlags &= ~IMMUTABLE_FLAGS;
5293 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005294 i = j + 1;
5295 }
5296
5297 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005298 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005299 i += 10;
5300 int j = uri.indexOf(')', i);
5301 int sep = uri.indexOf('!', i);
5302 if (sep >= 0 && sep < j) {
5303 String pkg = uri.substring(i, sep);
5304 String cls = uri.substring(sep + 1, j);
5305 intent.mComponent = new ComponentName(pkg, cls);
5306 }
5307 i = j + 1;
5308 }
5309
5310 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005311 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005312 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005313
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005314 final int closeParen = uri.indexOf(')', i);
5315 if (closeParen == -1) throw new URISyntaxException(uri,
5316 "EXTRA missing trailing ')'", i);
5317
5318 while (i < closeParen) {
5319 // fetch the key value
5320 int j = uri.indexOf('=', i);
5321 if (j <= i + 1 || i >= closeParen) {
5322 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5323 }
5324 char type = uri.charAt(i);
5325 i++;
5326 String key = uri.substring(i, j);
5327 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005328
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005329 // get type-value
5330 j = uri.indexOf('!', i);
5331 if (j == -1 || j >= closeParen) j = closeParen;
5332 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5333 String value = uri.substring(i, j);
5334 i = j;
5335
5336 // create Bundle if it doesn't already exist
5337 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005338
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005339 // add item to bundle
5340 try {
5341 switch (type) {
5342 case 'S':
5343 intent.mExtras.putString(key, Uri.decode(value));
5344 break;
5345 case 'B':
5346 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5347 break;
5348 case 'b':
5349 intent.mExtras.putByte(key, Byte.parseByte(value));
5350 break;
5351 case 'c':
5352 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5353 break;
5354 case 'd':
5355 intent.mExtras.putDouble(key, Double.parseDouble(value));
5356 break;
5357 case 'f':
5358 intent.mExtras.putFloat(key, Float.parseFloat(value));
5359 break;
5360 case 'i':
5361 intent.mExtras.putInt(key, Integer.parseInt(value));
5362 break;
5363 case 'l':
5364 intent.mExtras.putLong(key, Long.parseLong(value));
5365 break;
5366 case 's':
5367 intent.mExtras.putShort(key, Short.parseShort(value));
5368 break;
5369 default:
5370 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5371 }
5372 } catch (NumberFormatException e) {
5373 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5374 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005375
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005376 char ch = uri.charAt(i);
5377 if (ch == ')') break;
5378 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5379 i++;
5380 }
5381 }
5382
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005383 if (isIntentFragment) {
5384 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5385 } else {
5386 intent.mData = Uri.parse(uri);
5387 }
Tom Taylord4a47292009-12-21 13:59:18 -08005388
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005389 if (intent.mAction == null) {
5390 // By default, if no action is specified, then use VIEW.
5391 intent.mAction = ACTION_VIEW;
5392 }
5393
5394 } else {
5395 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5396 }
5397
5398 return intent;
5399 }
5400
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005401 /** @hide */
5402 public interface CommandOptionHandler {
5403 boolean handleOption(String opt, ShellCommand cmd);
5404 }
5405
5406 /** @hide */
5407 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5408 throws URISyntaxException {
5409 Intent intent = new Intent();
5410 Intent baseIntent = intent;
5411 boolean hasIntentInfo = false;
5412
5413 Uri data = null;
5414 String type = null;
5415
5416 String opt;
5417 while ((opt=cmd.getNextOption()) != null) {
5418 switch (opt) {
5419 case "-a":
5420 intent.setAction(cmd.getNextArgRequired());
5421 if (intent == baseIntent) {
5422 hasIntentInfo = true;
5423 }
5424 break;
5425 case "-d":
5426 data = Uri.parse(cmd.getNextArgRequired());
5427 if (intent == baseIntent) {
5428 hasIntentInfo = true;
5429 }
5430 break;
5431 case "-t":
5432 type = cmd.getNextArgRequired();
5433 if (intent == baseIntent) {
5434 hasIntentInfo = true;
5435 }
5436 break;
5437 case "-c":
5438 intent.addCategory(cmd.getNextArgRequired());
5439 if (intent == baseIntent) {
5440 hasIntentInfo = true;
5441 }
5442 break;
5443 case "-e":
5444 case "--es": {
5445 String key = cmd.getNextArgRequired();
5446 String value = cmd.getNextArgRequired();
5447 intent.putExtra(key, value);
5448 }
5449 break;
5450 case "--esn": {
5451 String key = cmd.getNextArgRequired();
5452 intent.putExtra(key, (String) null);
5453 }
5454 break;
5455 case "--ei": {
5456 String key = cmd.getNextArgRequired();
5457 String value = cmd.getNextArgRequired();
5458 intent.putExtra(key, Integer.decode(value));
5459 }
5460 break;
5461 case "--eu": {
5462 String key = cmd.getNextArgRequired();
5463 String value = cmd.getNextArgRequired();
5464 intent.putExtra(key, Uri.parse(value));
5465 }
5466 break;
5467 case "--ecn": {
5468 String key = cmd.getNextArgRequired();
5469 String value = cmd.getNextArgRequired();
5470 ComponentName cn = ComponentName.unflattenFromString(value);
5471 if (cn == null)
5472 throw new IllegalArgumentException("Bad component name: " + value);
5473 intent.putExtra(key, cn);
5474 }
5475 break;
5476 case "--eia": {
5477 String key = cmd.getNextArgRequired();
5478 String value = cmd.getNextArgRequired();
5479 String[] strings = value.split(",");
5480 int[] list = new int[strings.length];
5481 for (int i = 0; i < strings.length; i++) {
5482 list[i] = Integer.decode(strings[i]);
5483 }
5484 intent.putExtra(key, list);
5485 }
5486 break;
5487 case "--eial": {
5488 String key = cmd.getNextArgRequired();
5489 String value = cmd.getNextArgRequired();
5490 String[] strings = value.split(",");
5491 ArrayList<Integer> list = new ArrayList<>(strings.length);
5492 for (int i = 0; i < strings.length; i++) {
5493 list.add(Integer.decode(strings[i]));
5494 }
5495 intent.putExtra(key, list);
5496 }
5497 break;
5498 case "--el": {
5499 String key = cmd.getNextArgRequired();
5500 String value = cmd.getNextArgRequired();
5501 intent.putExtra(key, Long.valueOf(value));
5502 }
5503 break;
5504 case "--ela": {
5505 String key = cmd.getNextArgRequired();
5506 String value = cmd.getNextArgRequired();
5507 String[] strings = value.split(",");
5508 long[] list = new long[strings.length];
5509 for (int i = 0; i < strings.length; i++) {
5510 list[i] = Long.valueOf(strings[i]);
5511 }
5512 intent.putExtra(key, list);
5513 hasIntentInfo = true;
5514 }
5515 break;
5516 case "--elal": {
5517 String key = cmd.getNextArgRequired();
5518 String value = cmd.getNextArgRequired();
5519 String[] strings = value.split(",");
5520 ArrayList<Long> list = new ArrayList<>(strings.length);
5521 for (int i = 0; i < strings.length; i++) {
5522 list.add(Long.valueOf(strings[i]));
5523 }
5524 intent.putExtra(key, list);
5525 hasIntentInfo = true;
5526 }
5527 break;
5528 case "--ef": {
5529 String key = cmd.getNextArgRequired();
5530 String value = cmd.getNextArgRequired();
5531 intent.putExtra(key, Float.valueOf(value));
5532 hasIntentInfo = true;
5533 }
5534 break;
5535 case "--efa": {
5536 String key = cmd.getNextArgRequired();
5537 String value = cmd.getNextArgRequired();
5538 String[] strings = value.split(",");
5539 float[] list = new float[strings.length];
5540 for (int i = 0; i < strings.length; i++) {
5541 list[i] = Float.valueOf(strings[i]);
5542 }
5543 intent.putExtra(key, list);
5544 hasIntentInfo = true;
5545 }
5546 break;
5547 case "--efal": {
5548 String key = cmd.getNextArgRequired();
5549 String value = cmd.getNextArgRequired();
5550 String[] strings = value.split(",");
5551 ArrayList<Float> list = new ArrayList<>(strings.length);
5552 for (int i = 0; i < strings.length; i++) {
5553 list.add(Float.valueOf(strings[i]));
5554 }
5555 intent.putExtra(key, list);
5556 hasIntentInfo = true;
5557 }
5558 break;
5559 case "--esa": {
5560 String key = cmd.getNextArgRequired();
5561 String value = cmd.getNextArgRequired();
5562 // Split on commas unless they are preceeded by an escape.
5563 // The escape character must be escaped for the string and
5564 // again for the regex, thus four escape characters become one.
5565 String[] strings = value.split("(?<!\\\\),");
5566 intent.putExtra(key, strings);
5567 hasIntentInfo = true;
5568 }
5569 break;
5570 case "--esal": {
5571 String key = cmd.getNextArgRequired();
5572 String value = cmd.getNextArgRequired();
5573 // Split on commas unless they are preceeded by an escape.
5574 // The escape character must be escaped for the string and
5575 // again for the regex, thus four escape characters become one.
5576 String[] strings = value.split("(?<!\\\\),");
5577 ArrayList<String> list = new ArrayList<>(strings.length);
5578 for (int i = 0; i < strings.length; i++) {
5579 list.add(strings[i]);
5580 }
5581 intent.putExtra(key, list);
5582 hasIntentInfo = true;
5583 }
5584 break;
5585 case "--ez": {
5586 String key = cmd.getNextArgRequired();
5587 String value = cmd.getNextArgRequired().toLowerCase();
5588 // Boolean.valueOf() results in false for anything that is not "true", which is
5589 // error-prone in shell commands
5590 boolean arg;
5591 if ("true".equals(value) || "t".equals(value)) {
5592 arg = true;
5593 } else if ("false".equals(value) || "f".equals(value)) {
5594 arg = false;
5595 } else {
5596 try {
5597 arg = Integer.decode(value) != 0;
5598 } catch (NumberFormatException ex) {
5599 throw new IllegalArgumentException("Invalid boolean value: " + value);
5600 }
5601 }
5602
5603 intent.putExtra(key, arg);
5604 }
5605 break;
5606 case "-n": {
5607 String str = cmd.getNextArgRequired();
5608 ComponentName cn = ComponentName.unflattenFromString(str);
5609 if (cn == null)
5610 throw new IllegalArgumentException("Bad component name: " + str);
5611 intent.setComponent(cn);
5612 if (intent == baseIntent) {
5613 hasIntentInfo = true;
5614 }
5615 }
5616 break;
5617 case "-p": {
5618 String str = cmd.getNextArgRequired();
5619 intent.setPackage(str);
5620 if (intent == baseIntent) {
5621 hasIntentInfo = true;
5622 }
5623 }
5624 break;
5625 case "-f":
5626 String str = cmd.getNextArgRequired();
5627 intent.setFlags(Integer.decode(str).intValue());
5628 break;
5629 case "--grant-read-uri-permission":
5630 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5631 break;
5632 case "--grant-write-uri-permission":
5633 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5634 break;
5635 case "--grant-persistable-uri-permission":
5636 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5637 break;
5638 case "--grant-prefix-uri-permission":
5639 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5640 break;
5641 case "--exclude-stopped-packages":
5642 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5643 break;
5644 case "--include-stopped-packages":
5645 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5646 break;
5647 case "--debug-log-resolution":
5648 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5649 break;
5650 case "--activity-brought-to-front":
5651 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5652 break;
5653 case "--activity-clear-top":
5654 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5655 break;
5656 case "--activity-clear-when-task-reset":
5657 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5658 break;
5659 case "--activity-exclude-from-recents":
5660 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5661 break;
5662 case "--activity-launched-from-history":
5663 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5664 break;
5665 case "--activity-multiple-task":
5666 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5667 break;
5668 case "--activity-no-animation":
5669 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5670 break;
5671 case "--activity-no-history":
5672 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5673 break;
5674 case "--activity-no-user-action":
5675 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5676 break;
5677 case "--activity-previous-is-top":
5678 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5679 break;
5680 case "--activity-reorder-to-front":
5681 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5682 break;
5683 case "--activity-reset-task-if-needed":
5684 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5685 break;
5686 case "--activity-single-top":
5687 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5688 break;
5689 case "--activity-clear-task":
5690 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5691 break;
5692 case "--activity-task-on-home":
5693 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5694 break;
5695 case "--receiver-registered-only":
5696 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5697 break;
5698 case "--receiver-replace-pending":
5699 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5700 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005701 case "--receiver-foreground":
5702 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5703 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005704 case "--selector":
5705 intent.setDataAndType(data, type);
5706 intent = new Intent();
5707 break;
5708 default:
5709 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5710 // Okay, caller handled this option.
5711 } else {
5712 throw new IllegalArgumentException("Unknown option: " + opt);
5713 }
5714 break;
5715 }
5716 }
5717 intent.setDataAndType(data, type);
5718
5719 final boolean hasSelector = intent != baseIntent;
5720 if (hasSelector) {
5721 // A selector was specified; fix up.
5722 baseIntent.setSelector(intent);
5723 intent = baseIntent;
5724 }
5725
5726 String arg = cmd.getNextArg();
5727 baseIntent = null;
5728 if (arg == null) {
5729 if (hasSelector) {
5730 // If a selector has been specified, and no arguments
5731 // have been supplied for the main Intent, then we can
5732 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5733 // need to have a component name specified yet, the
5734 // selector will take care of that.
5735 baseIntent = new Intent(Intent.ACTION_MAIN);
5736 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5737 }
5738 } else if (arg.indexOf(':') >= 0) {
5739 // The argument is a URI. Fully parse it, and use that result
5740 // to fill in any data not specified so far.
5741 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5742 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5743 } else if (arg.indexOf('/') >= 0) {
5744 // The argument is a component name. Build an Intent to launch
5745 // it.
5746 baseIntent = new Intent(Intent.ACTION_MAIN);
5747 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5748 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5749 } else {
5750 // Assume the argument is a package name.
5751 baseIntent = new Intent(Intent.ACTION_MAIN);
5752 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5753 baseIntent.setPackage(arg);
5754 }
5755 if (baseIntent != null) {
5756 Bundle extras = intent.getExtras();
5757 intent.replaceExtras((Bundle)null);
5758 Bundle uriExtras = baseIntent.getExtras();
5759 baseIntent.replaceExtras((Bundle)null);
5760 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5761 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5762 for (String c : cats) {
5763 baseIntent.removeCategory(c);
5764 }
5765 }
5766 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5767 if (extras == null) {
5768 extras = uriExtras;
5769 } else if (uriExtras != null) {
5770 uriExtras.putAll(extras);
5771 extras = uriExtras;
5772 }
5773 intent.replaceExtras(extras);
5774 hasIntentInfo = true;
5775 }
5776
5777 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5778 return intent;
5779 }
5780
5781 /** @hide */
5782 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5783 final String[] lines = new String[] {
5784 "<INTENT> specifications include these flags and arguments:",
5785 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5786 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5787 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5788 " [--esn <EXTRA_KEY> ...]",
5789 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5790 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5791 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5792 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5793 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5794 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5795 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5796 " (mutiple extras passed as Integer[])",
5797 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5798 " (mutiple extras passed as List<Integer>)",
5799 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5800 " (mutiple extras passed as Long[])",
5801 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5802 " (mutiple extras passed as List<Long>)",
5803 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5804 " (mutiple extras passed as Float[])",
5805 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5806 " (mutiple extras passed as List<Float>)",
5807 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5808 " (mutiple extras passed as String[]; to embed a comma into a string,",
5809 " escape it using \"\\,\")",
5810 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5811 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5812 " escape it using \"\\,\")",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005813 " [--f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005814 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5815 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5816 " [--debug-log-resolution] [--exclude-stopped-packages]",
5817 " [--include-stopped-packages]",
5818 " [--activity-brought-to-front] [--activity-clear-top]",
5819 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5820 " [--activity-launched-from-history] [--activity-multiple-task]",
5821 " [--activity-no-animation] [--activity-no-history]",
5822 " [--activity-no-user-action] [--activity-previous-is-top]",
5823 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5824 " [--activity-single-top] [--activity-clear-task]",
5825 " [--activity-task-on-home]",
5826 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005827 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005828 " [--selector]",
5829 " [<URI> | <PACKAGE> | <COMPONENT>]"
5830 };
5831 for (String line : lines) {
5832 pw.print(prefix);
5833 pw.println(line);
5834 }
5835 }
5836
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005837 /**
5838 * Retrieve the general action to be performed, such as
5839 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5840 * the information in the intent should be interpreted -- most importantly,
5841 * what to do with the data returned by {@link #getData}.
5842 *
5843 * @return The action of this intent or null if none is specified.
5844 *
5845 * @see #setAction
5846 */
5847 public String getAction() {
5848 return mAction;
5849 }
5850
5851 /**
5852 * Retrieve data this intent is operating on. This URI specifies the name
5853 * of the data; often it uses the content: scheme, specifying data in a
5854 * content provider. Other schemes may be handled by specific activities,
5855 * such as http: by the web browser.
5856 *
5857 * @return The URI of the data this intent is targeting or null.
5858 *
5859 * @see #getScheme
5860 * @see #setData
5861 */
5862 public Uri getData() {
5863 return mData;
5864 }
5865
5866 /**
5867 * The same as {@link #getData()}, but returns the URI as an encoded
5868 * String.
5869 */
5870 public String getDataString() {
5871 return mData != null ? mData.toString() : null;
5872 }
5873
5874 /**
5875 * Return the scheme portion of the intent's data. If the data is null or
5876 * does not include a scheme, null is returned. Otherwise, the scheme
5877 * prefix without the final ':' is returned, i.e. "http".
5878 *
5879 * <p>This is the same as calling getData().getScheme() (and checking for
5880 * null data).
5881 *
5882 * @return The scheme of this intent.
5883 *
5884 * @see #getData
5885 */
5886 public String getScheme() {
5887 return mData != null ? mData.getScheme() : null;
5888 }
5889
5890 /**
5891 * Retrieve any explicit MIME type included in the intent. This is usually
5892 * null, as the type is determined by the intent data.
5893 *
5894 * @return If a type was manually set, it is returned; else null is
5895 * returned.
5896 *
5897 * @see #resolveType(ContentResolver)
5898 * @see #setType
5899 */
5900 public String getType() {
5901 return mType;
5902 }
5903
5904 /**
5905 * Return the MIME data type of this intent. If the type field is
5906 * explicitly set, that is simply returned. Otherwise, if the data is set,
5907 * the type of that data is returned. If neither fields are set, a null is
5908 * returned.
5909 *
5910 * @return The MIME type of this intent.
5911 *
5912 * @see #getType
5913 * @see #resolveType(ContentResolver)
5914 */
5915 public String resolveType(Context context) {
5916 return resolveType(context.getContentResolver());
5917 }
5918
5919 /**
5920 * Return the MIME data type of this intent. If the type field is
5921 * explicitly set, that is simply returned. Otherwise, if the data is set,
5922 * the type of that data is returned. If neither fields are set, a null is
5923 * returned.
5924 *
5925 * @param resolver A ContentResolver that can be used to determine the MIME
5926 * type of the intent's data.
5927 *
5928 * @return The MIME type of this intent.
5929 *
5930 * @see #getType
5931 * @see #resolveType(Context)
5932 */
5933 public String resolveType(ContentResolver resolver) {
5934 if (mType != null) {
5935 return mType;
5936 }
5937 if (mData != null) {
5938 if ("content".equals(mData.getScheme())) {
5939 return resolver.getType(mData);
5940 }
5941 }
5942 return null;
5943 }
5944
5945 /**
5946 * Return the MIME data type of this intent, only if it will be needed for
5947 * intent resolution. This is not generally useful for application code;
5948 * it is used by the frameworks for communicating with back-end system
5949 * services.
5950 *
5951 * @param resolver A ContentResolver that can be used to determine the MIME
5952 * type of the intent's data.
5953 *
5954 * @return The MIME type of this intent, or null if it is unknown or not
5955 * needed.
5956 */
5957 public String resolveTypeIfNeeded(ContentResolver resolver) {
5958 if (mComponent != null) {
5959 return mType;
5960 }
5961 return resolveType(resolver);
5962 }
5963
5964 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005965 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005966 *
5967 * @param category The category to check.
5968 *
5969 * @return boolean True if the intent contains the category, else false.
5970 *
5971 * @see #getCategories
5972 * @see #addCategory
5973 */
5974 public boolean hasCategory(String category) {
5975 return mCategories != null && mCategories.contains(category);
5976 }
5977
5978 /**
5979 * Return the set of all categories in the intent. If there are no categories,
5980 * returns NULL.
5981 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005982 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005983 *
5984 * @see #hasCategory
5985 * @see #addCategory
5986 */
5987 public Set<String> getCategories() {
5988 return mCategories;
5989 }
5990
5991 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005992 * Return the specific selector associated with this Intent. If there is
5993 * none, returns null. See {@link #setSelector} for more information.
5994 *
5995 * @see #setSelector
5996 */
5997 public Intent getSelector() {
5998 return mSelector;
5999 }
6000
6001 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006002 * Return the {@link ClipData} associated with this Intent. If there is
6003 * none, returns null. See {@link #setClipData} for more information.
6004 *
John Spurlock125d1332013-11-25 11:58:37 -05006005 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006006 */
6007 public ClipData getClipData() {
6008 return mClipData;
6009 }
6010
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006011 /** @hide */
6012 public int getContentUserHint() {
6013 return mContentUserHint;
6014 }
6015
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006016 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006017 * Sets the ClassLoader that will be used when unmarshalling
6018 * any Parcelable values from the extras of this Intent.
6019 *
6020 * @param loader a ClassLoader, or null to use the default loader
6021 * at the time of unmarshalling.
6022 */
6023 public void setExtrasClassLoader(ClassLoader loader) {
6024 if (mExtras != null) {
6025 mExtras.setClassLoader(loader);
6026 }
6027 }
6028
6029 /**
6030 * Returns true if an extra value is associated with the given name.
6031 * @param name the extra's name
6032 * @return true if the given extra is present.
6033 */
6034 public boolean hasExtra(String name) {
6035 return mExtras != null && mExtras.containsKey(name);
6036 }
6037
6038 /**
6039 * Returns true if the Intent's extras contain a parcelled file descriptor.
6040 * @return true if the Intent contains a parcelled file descriptor.
6041 */
6042 public boolean hasFileDescriptors() {
6043 return mExtras != null && mExtras.hasFileDescriptors();
6044 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006045
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006046 /** @hide */
6047 public void setAllowFds(boolean allowFds) {
6048 if (mExtras != null) {
6049 mExtras.setAllowFds(allowFds);
6050 }
6051 }
6052
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006053 /**
6054 * Retrieve extended data from the intent.
6055 *
6056 * @param name The name of the desired item.
6057 *
6058 * @return the value of an item that previously added with putExtra()
6059 * or null if none was found.
6060 *
6061 * @deprecated
6062 * @hide
6063 */
6064 @Deprecated
6065 public Object getExtra(String name) {
6066 return getExtra(name, null);
6067 }
6068
6069 /**
6070 * Retrieve extended data from the intent.
6071 *
6072 * @param name The name of the desired item.
6073 * @param defaultValue the value to be returned if no value of the desired
6074 * type is stored with the given name.
6075 *
6076 * @return the value of an item that previously added with putExtra()
6077 * or the default value if none was found.
6078 *
6079 * @see #putExtra(String, boolean)
6080 */
6081 public boolean getBooleanExtra(String name, boolean defaultValue) {
6082 return mExtras == null ? defaultValue :
6083 mExtras.getBoolean(name, defaultValue);
6084 }
6085
6086 /**
6087 * Retrieve extended data from the intent.
6088 *
6089 * @param name The name of the desired item.
6090 * @param defaultValue the value to be returned if no value of the desired
6091 * type is stored with the given name.
6092 *
6093 * @return the value of an item that previously added with putExtra()
6094 * or the default value if none was found.
6095 *
6096 * @see #putExtra(String, byte)
6097 */
6098 public byte getByteExtra(String name, byte defaultValue) {
6099 return mExtras == null ? defaultValue :
6100 mExtras.getByte(name, defaultValue);
6101 }
6102
6103 /**
6104 * Retrieve extended data from the intent.
6105 *
6106 * @param name The name of the desired item.
6107 * @param defaultValue the value to be returned if no value of the desired
6108 * type is stored with the given name.
6109 *
6110 * @return the value of an item that previously added with putExtra()
6111 * or the default value if none was found.
6112 *
6113 * @see #putExtra(String, short)
6114 */
6115 public short getShortExtra(String name, short defaultValue) {
6116 return mExtras == null ? defaultValue :
6117 mExtras.getShort(name, defaultValue);
6118 }
6119
6120 /**
6121 * Retrieve extended data from the intent.
6122 *
6123 * @param name The name of the desired item.
6124 * @param defaultValue the value to be returned if no value of the desired
6125 * type is stored with the given name.
6126 *
6127 * @return the value of an item that previously added with putExtra()
6128 * or the default value if none was found.
6129 *
6130 * @see #putExtra(String, char)
6131 */
6132 public char getCharExtra(String name, char defaultValue) {
6133 return mExtras == null ? defaultValue :
6134 mExtras.getChar(name, defaultValue);
6135 }
6136
6137 /**
6138 * Retrieve extended data from the intent.
6139 *
6140 * @param name The name of the desired item.
6141 * @param defaultValue the value to be returned if no value of the desired
6142 * type is stored with the given name.
6143 *
6144 * @return the value of an item that previously added with putExtra()
6145 * or the default value if none was found.
6146 *
6147 * @see #putExtra(String, int)
6148 */
6149 public int getIntExtra(String name, int defaultValue) {
6150 return mExtras == null ? defaultValue :
6151 mExtras.getInt(name, defaultValue);
6152 }
6153
6154 /**
6155 * Retrieve extended data from the intent.
6156 *
6157 * @param name The name of the desired item.
6158 * @param defaultValue the value to be returned if no value of the desired
6159 * type is stored with the given name.
6160 *
6161 * @return the value of an item that previously added with putExtra()
6162 * or the default value if none was found.
6163 *
6164 * @see #putExtra(String, long)
6165 */
6166 public long getLongExtra(String name, long defaultValue) {
6167 return mExtras == null ? defaultValue :
6168 mExtras.getLong(name, defaultValue);
6169 }
6170
6171 /**
6172 * Retrieve extended data from the intent.
6173 *
6174 * @param name The name of the desired item.
6175 * @param defaultValue the value to be returned if no value of the desired
6176 * type is stored with the given name.
6177 *
6178 * @return the value of an item that previously added with putExtra(),
6179 * or the default value if no such item is present
6180 *
6181 * @see #putExtra(String, float)
6182 */
6183 public float getFloatExtra(String name, float defaultValue) {
6184 return mExtras == null ? defaultValue :
6185 mExtras.getFloat(name, defaultValue);
6186 }
6187
6188 /**
6189 * Retrieve extended data from the intent.
6190 *
6191 * @param name The name of the desired item.
6192 * @param defaultValue the value to be returned if no value of the desired
6193 * type is stored with the given name.
6194 *
6195 * @return the value of an item that previously added with putExtra()
6196 * or the default value if none was found.
6197 *
6198 * @see #putExtra(String, double)
6199 */
6200 public double getDoubleExtra(String name, double defaultValue) {
6201 return mExtras == null ? defaultValue :
6202 mExtras.getDouble(name, defaultValue);
6203 }
6204
6205 /**
6206 * Retrieve extended data from the intent.
6207 *
6208 * @param name The name of the desired item.
6209 *
6210 * @return the value of an item that previously added with putExtra()
6211 * or null if no String value was found.
6212 *
6213 * @see #putExtra(String, String)
6214 */
6215 public String getStringExtra(String name) {
6216 return mExtras == null ? null : mExtras.getString(name);
6217 }
6218
6219 /**
6220 * Retrieve extended data from the intent.
6221 *
6222 * @param name The name of the desired item.
6223 *
6224 * @return the value of an item that previously added with putExtra()
6225 * or null if no CharSequence value was found.
6226 *
6227 * @see #putExtra(String, CharSequence)
6228 */
6229 public CharSequence getCharSequenceExtra(String name) {
6230 return mExtras == null ? null : mExtras.getCharSequence(name);
6231 }
6232
6233 /**
6234 * Retrieve extended data from the intent.
6235 *
6236 * @param name The name of the desired item.
6237 *
6238 * @return the value of an item that previously added with putExtra()
6239 * or null if no Parcelable value was found.
6240 *
6241 * @see #putExtra(String, Parcelable)
6242 */
6243 public <T extends Parcelable> T getParcelableExtra(String name) {
6244 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6245 }
6246
6247 /**
6248 * Retrieve extended data from the intent.
6249 *
6250 * @param name The name of the desired item.
6251 *
6252 * @return the value of an item that previously added with putExtra()
6253 * or null if no Parcelable[] value was found.
6254 *
6255 * @see #putExtra(String, Parcelable[])
6256 */
6257 public Parcelable[] getParcelableArrayExtra(String name) {
6258 return mExtras == null ? null : mExtras.getParcelableArray(name);
6259 }
6260
6261 /**
6262 * Retrieve extended data from the intent.
6263 *
6264 * @param name The name of the desired item.
6265 *
6266 * @return the value of an item that previously added with putExtra()
6267 * or null if no ArrayList<Parcelable> value was found.
6268 *
6269 * @see #putParcelableArrayListExtra(String, ArrayList)
6270 */
6271 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6272 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6273 }
6274
6275 /**
6276 * Retrieve extended data from the intent.
6277 *
6278 * @param name The name of the desired item.
6279 *
6280 * @return the value of an item that previously added with putExtra()
6281 * or null if no Serializable value was found.
6282 *
6283 * @see #putExtra(String, Serializable)
6284 */
6285 public Serializable getSerializableExtra(String name) {
6286 return mExtras == null ? null : mExtras.getSerializable(name);
6287 }
6288
6289 /**
6290 * Retrieve extended data from the intent.
6291 *
6292 * @param name The name of the desired item.
6293 *
6294 * @return the value of an item that previously added with putExtra()
6295 * or null if no ArrayList<Integer> value was found.
6296 *
6297 * @see #putIntegerArrayListExtra(String, ArrayList)
6298 */
6299 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6300 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6301 }
6302
6303 /**
6304 * Retrieve extended data from the intent.
6305 *
6306 * @param name The name of the desired item.
6307 *
6308 * @return the value of an item that previously added with putExtra()
6309 * or null if no ArrayList<String> value was found.
6310 *
6311 * @see #putStringArrayListExtra(String, ArrayList)
6312 */
6313 public ArrayList<String> getStringArrayListExtra(String name) {
6314 return mExtras == null ? null : mExtras.getStringArrayList(name);
6315 }
6316
6317 /**
6318 * Retrieve extended data from the intent.
6319 *
6320 * @param name The name of the desired item.
6321 *
6322 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006323 * or null if no ArrayList<CharSequence> value was found.
6324 *
6325 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6326 */
6327 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6328 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6329 }
6330
6331 /**
6332 * Retrieve extended data from the intent.
6333 *
6334 * @param name The name of the desired item.
6335 *
6336 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006337 * or null if no boolean array value was found.
6338 *
6339 * @see #putExtra(String, boolean[])
6340 */
6341 public boolean[] getBooleanArrayExtra(String name) {
6342 return mExtras == null ? null : mExtras.getBooleanArray(name);
6343 }
6344
6345 /**
6346 * Retrieve extended data from the intent.
6347 *
6348 * @param name The name of the desired item.
6349 *
6350 * @return the value of an item that previously added with putExtra()
6351 * or null if no byte array value was found.
6352 *
6353 * @see #putExtra(String, byte[])
6354 */
6355 public byte[] getByteArrayExtra(String name) {
6356 return mExtras == null ? null : mExtras.getByteArray(name);
6357 }
6358
6359 /**
6360 * Retrieve extended data from the intent.
6361 *
6362 * @param name The name of the desired item.
6363 *
6364 * @return the value of an item that previously added with putExtra()
6365 * or null if no short array value was found.
6366 *
6367 * @see #putExtra(String, short[])
6368 */
6369 public short[] getShortArrayExtra(String name) {
6370 return mExtras == null ? null : mExtras.getShortArray(name);
6371 }
6372
6373 /**
6374 * Retrieve extended data from the intent.
6375 *
6376 * @param name The name of the desired item.
6377 *
6378 * @return the value of an item that previously added with putExtra()
6379 * or null if no char array value was found.
6380 *
6381 * @see #putExtra(String, char[])
6382 */
6383 public char[] getCharArrayExtra(String name) {
6384 return mExtras == null ? null : mExtras.getCharArray(name);
6385 }
6386
6387 /**
6388 * Retrieve extended data from the intent.
6389 *
6390 * @param name The name of the desired item.
6391 *
6392 * @return the value of an item that previously added with putExtra()
6393 * or null if no int array value was found.
6394 *
6395 * @see #putExtra(String, int[])
6396 */
6397 public int[] getIntArrayExtra(String name) {
6398 return mExtras == null ? null : mExtras.getIntArray(name);
6399 }
6400
6401 /**
6402 * Retrieve extended data from the intent.
6403 *
6404 * @param name The name of the desired item.
6405 *
6406 * @return the value of an item that previously added with putExtra()
6407 * or null if no long array value was found.
6408 *
6409 * @see #putExtra(String, long[])
6410 */
6411 public long[] getLongArrayExtra(String name) {
6412 return mExtras == null ? null : mExtras.getLongArray(name);
6413 }
6414
6415 /**
6416 * Retrieve extended data from the intent.
6417 *
6418 * @param name The name of the desired item.
6419 *
6420 * @return the value of an item that previously added with putExtra()
6421 * or null if no float array value was found.
6422 *
6423 * @see #putExtra(String, float[])
6424 */
6425 public float[] getFloatArrayExtra(String name) {
6426 return mExtras == null ? null : mExtras.getFloatArray(name);
6427 }
6428
6429 /**
6430 * Retrieve extended data from the intent.
6431 *
6432 * @param name The name of the desired item.
6433 *
6434 * @return the value of an item that previously added with putExtra()
6435 * or null if no double array value was found.
6436 *
6437 * @see #putExtra(String, double[])
6438 */
6439 public double[] getDoubleArrayExtra(String name) {
6440 return mExtras == null ? null : mExtras.getDoubleArray(name);
6441 }
6442
6443 /**
6444 * Retrieve extended data from the intent.
6445 *
6446 * @param name The name of the desired item.
6447 *
6448 * @return the value of an item that previously added with putExtra()
6449 * or null if no String array value was found.
6450 *
6451 * @see #putExtra(String, String[])
6452 */
6453 public String[] getStringArrayExtra(String name) {
6454 return mExtras == null ? null : mExtras.getStringArray(name);
6455 }
6456
6457 /**
6458 * Retrieve extended data from the intent.
6459 *
6460 * @param name The name of the desired item.
6461 *
6462 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006463 * or null if no CharSequence array value was found.
6464 *
6465 * @see #putExtra(String, CharSequence[])
6466 */
6467 public CharSequence[] getCharSequenceArrayExtra(String name) {
6468 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6469 }
6470
6471 /**
6472 * Retrieve extended data from the intent.
6473 *
6474 * @param name The name of the desired item.
6475 *
6476 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006477 * or null if no Bundle value was found.
6478 *
6479 * @see #putExtra(String, Bundle)
6480 */
6481 public Bundle getBundleExtra(String name) {
6482 return mExtras == null ? null : mExtras.getBundle(name);
6483 }
6484
6485 /**
6486 * Retrieve extended data from the intent.
6487 *
6488 * @param name The name of the desired item.
6489 *
6490 * @return the value of an item that previously added with putExtra()
6491 * or null if no IBinder value was found.
6492 *
6493 * @see #putExtra(String, IBinder)
6494 *
6495 * @deprecated
6496 * @hide
6497 */
6498 @Deprecated
6499 public IBinder getIBinderExtra(String name) {
6500 return mExtras == null ? null : mExtras.getIBinder(name);
6501 }
6502
6503 /**
6504 * Retrieve extended data from the intent.
6505 *
6506 * @param name The name of the desired item.
6507 * @param defaultValue The default value to return in case no item is
6508 * associated with the key 'name'
6509 *
6510 * @return the value of an item that previously added with putExtra()
6511 * or defaultValue if none was found.
6512 *
6513 * @see #putExtra
6514 *
6515 * @deprecated
6516 * @hide
6517 */
6518 @Deprecated
6519 public Object getExtra(String name, Object defaultValue) {
6520 Object result = defaultValue;
6521 if (mExtras != null) {
6522 Object result2 = mExtras.get(name);
6523 if (result2 != null) {
6524 result = result2;
6525 }
6526 }
6527
6528 return result;
6529 }
6530
6531 /**
6532 * Retrieves a map of extended data from the intent.
6533 *
6534 * @return the map of all extras previously added with putExtra(),
6535 * or null if none have been added.
6536 */
6537 public Bundle getExtras() {
6538 return (mExtras != null)
6539 ? new Bundle(mExtras)
6540 : null;
6541 }
6542
6543 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006544 * Filter extras to only basic types.
6545 * @hide
6546 */
6547 public void removeUnsafeExtras() {
6548 if (mExtras != null) {
6549 mExtras.filterValues();
6550 }
6551 }
6552
6553 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006554 * Retrieve any special flags associated with this intent. You will
6555 * normally just set them with {@link #setFlags} and let the system
6556 * take the appropriate action with them.
6557 *
6558 * @return int The currently set flags.
6559 *
6560 * @see #setFlags
6561 */
6562 public int getFlags() {
6563 return mFlags;
6564 }
6565
Dianne Hackborne7f97212011-02-24 14:40:20 -08006566 /** @hide */
6567 public boolean isExcludingStopped() {
6568 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6569 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6570 }
6571
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006572 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006573 * Retrieve the application package name this Intent is limited to. When
6574 * resolving an Intent, if non-null this limits the resolution to only
6575 * components in the given application package.
6576 *
6577 * @return The name of the application package for the Intent.
6578 *
6579 * @see #resolveActivity
6580 * @see #setPackage
6581 */
6582 public String getPackage() {
6583 return mPackage;
6584 }
6585
6586 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006587 * Retrieve the concrete component associated with the intent. When receiving
6588 * an intent, this is the component that was found to best handle it (that is,
6589 * yourself) and will always be non-null; in all other cases it will be
6590 * null unless explicitly set.
6591 *
6592 * @return The name of the application component to handle the intent.
6593 *
6594 * @see #resolveActivity
6595 * @see #setComponent
6596 */
6597 public ComponentName getComponent() {
6598 return mComponent;
6599 }
6600
6601 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006602 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6603 * used as a hint to the receiver for animations and the like. Null means that there
6604 * is no source bounds.
6605 */
6606 public Rect getSourceBounds() {
6607 return mSourceBounds;
6608 }
6609
6610 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006611 * Return the Activity component that should be used to handle this intent.
6612 * The appropriate component is determined based on the information in the
6613 * intent, evaluated as follows:
6614 *
6615 * <p>If {@link #getComponent} returns an explicit class, that is returned
6616 * without any further consideration.
6617 *
6618 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6619 * category to be considered.
6620 *
6621 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6622 * action.
6623 *
6624 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6625 * this type.
6626 *
6627 * <p>If {@link #addCategory} has added any categories, the activity must
6628 * handle ALL of the categories specified.
6629 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006630 * <p>If {@link #getPackage} is non-NULL, only activity components in
6631 * that application package will be considered.
6632 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006633 * <p>If there are no activities that satisfy all of these conditions, a
6634 * null string is returned.
6635 *
6636 * <p>If multiple activities are found to satisfy the intent, the one with
6637 * the highest priority will be used. If there are multiple activities
6638 * with the same priority, the system will either pick the best activity
6639 * based on user preference, or resolve to a system class that will allow
6640 * the user to pick an activity and forward from there.
6641 *
6642 * <p>This method is implemented simply by calling
6643 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6644 * true.</p>
6645 * <p> This API is called for you as part of starting an activity from an
6646 * intent. You do not normally need to call it yourself.</p>
6647 *
6648 * @param pm The package manager with which to resolve the Intent.
6649 *
6650 * @return Name of the component implementing an activity that can
6651 * display the intent.
6652 *
6653 * @see #setComponent
6654 * @see #getComponent
6655 * @see #resolveActivityInfo
6656 */
6657 public ComponentName resolveActivity(PackageManager pm) {
6658 if (mComponent != null) {
6659 return mComponent;
6660 }
6661
6662 ResolveInfo info = pm.resolveActivity(
6663 this, PackageManager.MATCH_DEFAULT_ONLY);
6664 if (info != null) {
6665 return new ComponentName(
6666 info.activityInfo.applicationInfo.packageName,
6667 info.activityInfo.name);
6668 }
6669
6670 return null;
6671 }
6672
6673 /**
6674 * Resolve the Intent into an {@link ActivityInfo}
6675 * describing the activity that should execute the intent. Resolution
6676 * follows the same rules as described for {@link #resolveActivity}, but
6677 * you get back the completely information about the resolved activity
6678 * instead of just its class name.
6679 *
6680 * @param pm The package manager with which to resolve the Intent.
6681 * @param flags Addition information to retrieve as per
6682 * {@link PackageManager#getActivityInfo(ComponentName, int)
6683 * PackageManager.getActivityInfo()}.
6684 *
6685 * @return PackageManager.ActivityInfo
6686 *
6687 * @see #resolveActivity
6688 */
6689 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6690 ActivityInfo ai = null;
6691 if (mComponent != null) {
6692 try {
6693 ai = pm.getActivityInfo(mComponent, flags);
6694 } catch (PackageManager.NameNotFoundException e) {
6695 // ignore
6696 }
6697 } else {
6698 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006699 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006700 if (info != null) {
6701 ai = info.activityInfo;
6702 }
6703 }
6704
6705 return ai;
6706 }
6707
6708 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006709 * Special function for use by the system to resolve service
6710 * intents to system apps. Throws an exception if there are
6711 * multiple potential matches to the Intent. Returns null if
6712 * there are no matches.
6713 * @hide
6714 */
6715 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6716 if (mComponent != null) {
6717 return mComponent;
6718 }
6719
6720 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6721 if (results == null) {
6722 return null;
6723 }
6724 ComponentName comp = null;
6725 for (int i=0; i<results.size(); i++) {
6726 ResolveInfo ri = results.get(i);
6727 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6728 continue;
6729 }
6730 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6731 ri.serviceInfo.name);
6732 if (comp != null) {
6733 throw new IllegalStateException("Multiple system services handle " + this
6734 + ": " + comp + ", " + foundComp);
6735 }
6736 comp = foundComp;
6737 }
6738 return comp;
6739 }
6740
6741 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006742 * Set the general action to be performed.
6743 *
6744 * @param action An action name, such as ACTION_VIEW. Application-specific
6745 * actions should be prefixed with the vendor's package name.
6746 *
6747 * @return Returns the same Intent object, for chaining multiple calls
6748 * into a single statement.
6749 *
6750 * @see #getAction
6751 */
6752 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006753 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006754 return this;
6755 }
6756
6757 /**
6758 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006759 * clears any type that was previously set by {@link #setType} or
6760 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006761 *
Nick Pellyccae4122012-01-09 14:12:58 -08006762 * <p><em>Note: scheme matching in the Android framework is
6763 * case-sensitive, unlike the formal RFC. As a result,
6764 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006765 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006766 * {@link #setDataAndNormalize}
6767 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006768 *
Nick Pellyccae4122012-01-09 14:12:58 -08006769 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006770 *
6771 * @return Returns the same Intent object, for chaining multiple calls
6772 * into a single statement.
6773 *
6774 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006775 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006776 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006777 */
6778 public Intent setData(Uri data) {
6779 mData = data;
6780 mType = null;
6781 return this;
6782 }
6783
6784 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006785 * Normalize and set the data this intent is operating on.
6786 *
6787 * <p>This method automatically clears any type that was
6788 * previously set (for example, by {@link #setType}).
6789 *
6790 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006791 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006792 * so really this is just a convenience method for
6793 * <pre>
6794 * setData(data.normalize())
6795 * </pre>
6796 *
6797 * @param data The Uri of the data this intent is now targeting.
6798 *
6799 * @return Returns the same Intent object, for chaining multiple calls
6800 * into a single statement.
6801 *
6802 * @see #getData
6803 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006804 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006805 */
6806 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006807 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006808 }
6809
6810 /**
6811 * Set an explicit MIME data type.
6812 *
6813 * <p>This is used to create intents that only specify a type and not data,
6814 * for example to indicate the type of data to return.
6815 *
6816 * <p>This method automatically clears any data that was
6817 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006818 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006819 * <p><em>Note: MIME type matching in the Android framework is
6820 * case-sensitive, unlike formal RFC MIME types. As a result,
6821 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006822 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6823 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006824 *
6825 * @param type The MIME type of the data being handled by this intent.
6826 *
6827 * @return Returns the same Intent object, for chaining multiple calls
6828 * into a single statement.
6829 *
6830 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006831 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006832 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006833 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006834 */
6835 public Intent setType(String type) {
6836 mData = null;
6837 mType = type;
6838 return this;
6839 }
6840
6841 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006842 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006843 *
Nick Pellyccae4122012-01-09 14:12:58 -08006844 * <p>This is used to create intents that only specify a type and not data,
6845 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006846 *
Nick Pellyccae4122012-01-09 14:12:58 -08006847 * <p>This method automatically clears any data that was
6848 * previously set (for example by {@link #setData}).
6849 *
6850 * <p>The MIME type is normalized using
6851 * {@link #normalizeMimeType} before it is set,
6852 * so really this is just a convenience method for
6853 * <pre>
6854 * setType(Intent.normalizeMimeType(type))
6855 * </pre>
6856 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006857 * @param type The MIME type of the data being handled by this intent.
6858 *
6859 * @return Returns the same Intent object, for chaining multiple calls
6860 * into a single statement.
6861 *
Nick Pellyccae4122012-01-09 14:12:58 -08006862 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006863 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006864 * @see #normalizeMimeType
6865 */
6866 public Intent setTypeAndNormalize(String type) {
6867 return setType(normalizeMimeType(type));
6868 }
6869
6870 /**
6871 * (Usually optional) Set the data for the intent along with an explicit
6872 * MIME data type. This method should very rarely be used -- it allows you
6873 * to override the MIME type that would ordinarily be inferred from the
6874 * data with your own type given here.
6875 *
6876 * <p><em>Note: MIME type and Uri scheme matching in the
6877 * Android framework is case-sensitive, unlike the formal RFC definitions.
6878 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006879 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006880 * {@link #setDataAndTypeAndNormalize}
6881 * to ensure that they are converted to lower case.</em>
6882 *
6883 * @param data The Uri of the data this intent is now targeting.
6884 * @param type The MIME type of the data being handled by this intent.
6885 *
6886 * @return Returns the same Intent object, for chaining multiple calls
6887 * into a single statement.
6888 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006889 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006890 * @see #setData
6891 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006892 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006893 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006894 */
6895 public Intent setDataAndType(Uri data, String type) {
6896 mData = data;
6897 mType = type;
6898 return this;
6899 }
6900
6901 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006902 * (Usually optional) Normalize and set both the data Uri and an explicit
6903 * MIME data type. This method should very rarely be used -- it allows you
6904 * to override the MIME type that would ordinarily be inferred from the
6905 * data with your own type given here.
6906 *
6907 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006908 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006909 * before they are set, so really this is just a convenience method for
6910 * <pre>
6911 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6912 * </pre>
6913 *
6914 * @param data The Uri of the data this intent is now targeting.
6915 * @param type The MIME type of the data being handled by this intent.
6916 *
6917 * @return Returns the same Intent object, for chaining multiple calls
6918 * into a single statement.
6919 *
6920 * @see #setType
6921 * @see #setData
6922 * @see #setDataAndType
6923 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006924 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006925 */
6926 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006927 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006928 }
6929
6930 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006931 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006932 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006933 * activities that provide <em>all</em> of the requested categories will be
6934 * used.
6935 *
6936 * @param category The desired category. This can be either one of the
6937 * predefined Intent categories, or a custom category in your own
6938 * namespace.
6939 *
6940 * @return Returns the same Intent object, for chaining multiple calls
6941 * into a single statement.
6942 *
6943 * @see #hasCategory
6944 * @see #removeCategory
6945 */
6946 public Intent addCategory(String category) {
6947 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006948 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006949 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006950 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006951 return this;
6952 }
6953
6954 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006955 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006956 *
6957 * @param category The category to remove.
6958 *
6959 * @see #addCategory
6960 */
6961 public void removeCategory(String category) {
6962 if (mCategories != null) {
6963 mCategories.remove(category);
6964 if (mCategories.size() == 0) {
6965 mCategories = null;
6966 }
6967 }
6968 }
6969
6970 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006971 * Set a selector for this Intent. This is a modification to the kinds of
6972 * things the Intent will match. If the selector is set, it will be used
6973 * when trying to find entities that can handle the Intent, instead of the
6974 * main contents of the Intent. This allows you build an Intent containing
6975 * a generic protocol while targeting it more specifically.
6976 *
6977 * <p>An example of where this may be used is with things like
6978 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6979 * Intent that will launch the Browser application. However, the correct
6980 * main entry point of an application is actually {@link #ACTION_MAIN}
6981 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
6982 * used to specify the actual Activity to launch. If you launch the browser
6983 * with something different, undesired behavior may happen if the user has
6984 * previously or later launches it the normal way, since they do not match.
6985 * Instead, you can build an Intent with the MAIN action (but no ComponentName
6986 * yet specified) and set a selector with {@link #ACTION_MAIN} and
6987 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
6988 *
6989 * <p>Setting a selector does not impact the behavior of
6990 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
6991 * desired behavior of a selector -- it does not impact the base meaning
6992 * of the Intent, just what kinds of things will be matched against it
6993 * when determining who can handle it.</p>
6994 *
6995 * <p>You can not use both a selector and {@link #setPackage(String)} on
6996 * the same base Intent.</p>
6997 *
6998 * @param selector The desired selector Intent; set to null to not use
6999 * a special selector.
7000 */
7001 public void setSelector(Intent selector) {
7002 if (selector == this) {
7003 throw new IllegalArgumentException(
7004 "Intent being set as a selector of itself");
7005 }
7006 if (selector != null && mPackage != null) {
7007 throw new IllegalArgumentException(
7008 "Can't set selector when package name is already set");
7009 }
7010 mSelector = selector;
7011 }
7012
7013 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007014 * Set a {@link ClipData} associated with this Intent. This replaces any
7015 * previously set ClipData.
7016 *
7017 * <p>The ClipData in an intent is not used for Intent matching or other
7018 * such operations. Semantically it is like extras, used to transmit
7019 * additional data with the Intent. The main feature of using this over
7020 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7021 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7022 * items included in the clip data. This is useful, in particular, if
7023 * you want to transmit an Intent containing multiple <code>content:</code>
7024 * URIs for which the recipient may not have global permission to access the
7025 * content provider.
7026 *
7027 * <p>If the ClipData contains items that are themselves Intents, any
7028 * grant flags in those Intents will be ignored. Only the top-level flags
7029 * of the main Intent are respected, and will be applied to all Uri or
7030 * Intent items in the clip (or sub-items of the clip).
7031 *
7032 * <p>The MIME type, label, and icon in the ClipData object are not
7033 * directly used by Intent. Applications should generally rely on the
7034 * MIME type of the Intent itself, not what it may find in the ClipData.
7035 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007036 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007037 *
7038 * @param clip The new clip to set. May be null to clear the current clip.
7039 */
7040 public void setClipData(ClipData clip) {
7041 mClipData = clip;
7042 }
7043
7044 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007045 * This is NOT a secure mechanism to identify the user who sent the intent.
7046 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7047 * who sent the intent.
7048 * @hide
7049 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007050 public void prepareToLeaveUser(int userId) {
7051 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7052 // We want mContentUserHint to refer to the original user, so don't do anything.
7053 if (mContentUserHint == UserHandle.USER_CURRENT) {
7054 mContentUserHint = userId;
7055 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007056 }
7057
7058 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007059 * Add extended data to the intent. The name must include a package
7060 * prefix, for example the app com.android.contacts would use names
7061 * like "com.android.contacts.ShowAll".
7062 *
7063 * @param name The name of the extra data, with package prefix.
7064 * @param value The boolean data value.
7065 *
7066 * @return Returns the same Intent object, for chaining multiple calls
7067 * into a single statement.
7068 *
7069 * @see #putExtras
7070 * @see #removeExtra
7071 * @see #getBooleanExtra(String, boolean)
7072 */
7073 public Intent putExtra(String name, boolean value) {
7074 if (mExtras == null) {
7075 mExtras = new Bundle();
7076 }
7077 mExtras.putBoolean(name, value);
7078 return this;
7079 }
7080
7081 /**
7082 * Add extended data to the intent. The name must include a package
7083 * prefix, for example the app com.android.contacts would use names
7084 * like "com.android.contacts.ShowAll".
7085 *
7086 * @param name The name of the extra data, with package prefix.
7087 * @param value The byte data value.
7088 *
7089 * @return Returns the same Intent object, for chaining multiple calls
7090 * into a single statement.
7091 *
7092 * @see #putExtras
7093 * @see #removeExtra
7094 * @see #getByteExtra(String, byte)
7095 */
7096 public Intent putExtra(String name, byte value) {
7097 if (mExtras == null) {
7098 mExtras = new Bundle();
7099 }
7100 mExtras.putByte(name, value);
7101 return this;
7102 }
7103
7104 /**
7105 * Add extended data to the intent. The name must include a package
7106 * prefix, for example the app com.android.contacts would use names
7107 * like "com.android.contacts.ShowAll".
7108 *
7109 * @param name The name of the extra data, with package prefix.
7110 * @param value The char data value.
7111 *
7112 * @return Returns the same Intent object, for chaining multiple calls
7113 * into a single statement.
7114 *
7115 * @see #putExtras
7116 * @see #removeExtra
7117 * @see #getCharExtra(String, char)
7118 */
7119 public Intent putExtra(String name, char value) {
7120 if (mExtras == null) {
7121 mExtras = new Bundle();
7122 }
7123 mExtras.putChar(name, value);
7124 return this;
7125 }
7126
7127 /**
7128 * Add extended data to the intent. The name must include a package
7129 * prefix, for example the app com.android.contacts would use names
7130 * like "com.android.contacts.ShowAll".
7131 *
7132 * @param name The name of the extra data, with package prefix.
7133 * @param value The short data value.
7134 *
7135 * @return Returns the same Intent object, for chaining multiple calls
7136 * into a single statement.
7137 *
7138 * @see #putExtras
7139 * @see #removeExtra
7140 * @see #getShortExtra(String, short)
7141 */
7142 public Intent putExtra(String name, short value) {
7143 if (mExtras == null) {
7144 mExtras = new Bundle();
7145 }
7146 mExtras.putShort(name, value);
7147 return this;
7148 }
7149
7150 /**
7151 * Add extended data to the intent. The name must include a package
7152 * prefix, for example the app com.android.contacts would use names
7153 * like "com.android.contacts.ShowAll".
7154 *
7155 * @param name The name of the extra data, with package prefix.
7156 * @param value The integer data value.
7157 *
7158 * @return Returns the same Intent object, for chaining multiple calls
7159 * into a single statement.
7160 *
7161 * @see #putExtras
7162 * @see #removeExtra
7163 * @see #getIntExtra(String, int)
7164 */
7165 public Intent putExtra(String name, int value) {
7166 if (mExtras == null) {
7167 mExtras = new Bundle();
7168 }
7169 mExtras.putInt(name, value);
7170 return this;
7171 }
7172
7173 /**
7174 * Add extended data to the intent. The name must include a package
7175 * prefix, for example the app com.android.contacts would use names
7176 * like "com.android.contacts.ShowAll".
7177 *
7178 * @param name The name of the extra data, with package prefix.
7179 * @param value The long data value.
7180 *
7181 * @return Returns the same Intent object, for chaining multiple calls
7182 * into a single statement.
7183 *
7184 * @see #putExtras
7185 * @see #removeExtra
7186 * @see #getLongExtra(String, long)
7187 */
7188 public Intent putExtra(String name, long value) {
7189 if (mExtras == null) {
7190 mExtras = new Bundle();
7191 }
7192 mExtras.putLong(name, value);
7193 return this;
7194 }
7195
7196 /**
7197 * Add extended data to the intent. The name must include a package
7198 * prefix, for example the app com.android.contacts would use names
7199 * like "com.android.contacts.ShowAll".
7200 *
7201 * @param name The name of the extra data, with package prefix.
7202 * @param value The float data value.
7203 *
7204 * @return Returns the same Intent object, for chaining multiple calls
7205 * into a single statement.
7206 *
7207 * @see #putExtras
7208 * @see #removeExtra
7209 * @see #getFloatExtra(String, float)
7210 */
7211 public Intent putExtra(String name, float value) {
7212 if (mExtras == null) {
7213 mExtras = new Bundle();
7214 }
7215 mExtras.putFloat(name, value);
7216 return this;
7217 }
7218
7219 /**
7220 * Add extended data to the intent. The name must include a package
7221 * prefix, for example the app com.android.contacts would use names
7222 * like "com.android.contacts.ShowAll".
7223 *
7224 * @param name The name of the extra data, with package prefix.
7225 * @param value The double data value.
7226 *
7227 * @return Returns the same Intent object, for chaining multiple calls
7228 * into a single statement.
7229 *
7230 * @see #putExtras
7231 * @see #removeExtra
7232 * @see #getDoubleExtra(String, double)
7233 */
7234 public Intent putExtra(String name, double value) {
7235 if (mExtras == null) {
7236 mExtras = new Bundle();
7237 }
7238 mExtras.putDouble(name, value);
7239 return this;
7240 }
7241
7242 /**
7243 * Add extended data to the intent. The name must include a package
7244 * prefix, for example the app com.android.contacts would use names
7245 * like "com.android.contacts.ShowAll".
7246 *
7247 * @param name The name of the extra data, with package prefix.
7248 * @param value The String data value.
7249 *
7250 * @return Returns the same Intent object, for chaining multiple calls
7251 * into a single statement.
7252 *
7253 * @see #putExtras
7254 * @see #removeExtra
7255 * @see #getStringExtra(String)
7256 */
7257 public Intent putExtra(String name, String value) {
7258 if (mExtras == null) {
7259 mExtras = new Bundle();
7260 }
7261 mExtras.putString(name, value);
7262 return this;
7263 }
7264
7265 /**
7266 * Add extended data to the intent. The name must include a package
7267 * prefix, for example the app com.android.contacts would use names
7268 * like "com.android.contacts.ShowAll".
7269 *
7270 * @param name The name of the extra data, with package prefix.
7271 * @param value The CharSequence data value.
7272 *
7273 * @return Returns the same Intent object, for chaining multiple calls
7274 * into a single statement.
7275 *
7276 * @see #putExtras
7277 * @see #removeExtra
7278 * @see #getCharSequenceExtra(String)
7279 */
7280 public Intent putExtra(String name, CharSequence value) {
7281 if (mExtras == null) {
7282 mExtras = new Bundle();
7283 }
7284 mExtras.putCharSequence(name, value);
7285 return this;
7286 }
7287
7288 /**
7289 * Add extended data to the intent. The name must include a package
7290 * prefix, for example the app com.android.contacts would use names
7291 * like "com.android.contacts.ShowAll".
7292 *
7293 * @param name The name of the extra data, with package prefix.
7294 * @param value The Parcelable data value.
7295 *
7296 * @return Returns the same Intent object, for chaining multiple calls
7297 * into a single statement.
7298 *
7299 * @see #putExtras
7300 * @see #removeExtra
7301 * @see #getParcelableExtra(String)
7302 */
7303 public Intent putExtra(String name, Parcelable value) {
7304 if (mExtras == null) {
7305 mExtras = new Bundle();
7306 }
7307 mExtras.putParcelable(name, value);
7308 return this;
7309 }
7310
7311 /**
7312 * Add extended data to the intent. The name must include a package
7313 * prefix, for example the app com.android.contacts would use names
7314 * like "com.android.contacts.ShowAll".
7315 *
7316 * @param name The name of the extra data, with package prefix.
7317 * @param value The Parcelable[] data value.
7318 *
7319 * @return Returns the same Intent object, for chaining multiple calls
7320 * into a single statement.
7321 *
7322 * @see #putExtras
7323 * @see #removeExtra
7324 * @see #getParcelableArrayExtra(String)
7325 */
7326 public Intent putExtra(String name, Parcelable[] value) {
7327 if (mExtras == null) {
7328 mExtras = new Bundle();
7329 }
7330 mExtras.putParcelableArray(name, value);
7331 return this;
7332 }
7333
7334 /**
7335 * Add extended data to the intent. The name must include a package
7336 * prefix, for example the app com.android.contacts would use names
7337 * like "com.android.contacts.ShowAll".
7338 *
7339 * @param name The name of the extra data, with package prefix.
7340 * @param value The ArrayList<Parcelable> data value.
7341 *
7342 * @return Returns the same Intent object, for chaining multiple calls
7343 * into a single statement.
7344 *
7345 * @see #putExtras
7346 * @see #removeExtra
7347 * @see #getParcelableArrayListExtra(String)
7348 */
7349 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7350 if (mExtras == null) {
7351 mExtras = new Bundle();
7352 }
7353 mExtras.putParcelableArrayList(name, value);
7354 return this;
7355 }
7356
7357 /**
7358 * Add extended data to the intent. The name must include a package
7359 * prefix, for example the app com.android.contacts would use names
7360 * like "com.android.contacts.ShowAll".
7361 *
7362 * @param name The name of the extra data, with package prefix.
7363 * @param value The ArrayList<Integer> data value.
7364 *
7365 * @return Returns the same Intent object, for chaining multiple calls
7366 * into a single statement.
7367 *
7368 * @see #putExtras
7369 * @see #removeExtra
7370 * @see #getIntegerArrayListExtra(String)
7371 */
7372 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7373 if (mExtras == null) {
7374 mExtras = new Bundle();
7375 }
7376 mExtras.putIntegerArrayList(name, value);
7377 return this;
7378 }
7379
7380 /**
7381 * Add extended data to the intent. The name must include a package
7382 * prefix, for example the app com.android.contacts would use names
7383 * like "com.android.contacts.ShowAll".
7384 *
7385 * @param name The name of the extra data, with package prefix.
7386 * @param value The ArrayList<String> data value.
7387 *
7388 * @return Returns the same Intent object, for chaining multiple calls
7389 * into a single statement.
7390 *
7391 * @see #putExtras
7392 * @see #removeExtra
7393 * @see #getStringArrayListExtra(String)
7394 */
7395 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7396 if (mExtras == null) {
7397 mExtras = new Bundle();
7398 }
7399 mExtras.putStringArrayList(name, value);
7400 return this;
7401 }
7402
7403 /**
7404 * Add extended data to the intent. The name must include a package
7405 * prefix, for example the app com.android.contacts would use names
7406 * like "com.android.contacts.ShowAll".
7407 *
7408 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007409 * @param value The ArrayList<CharSequence> data value.
7410 *
7411 * @return Returns the same Intent object, for chaining multiple calls
7412 * into a single statement.
7413 *
7414 * @see #putExtras
7415 * @see #removeExtra
7416 * @see #getCharSequenceArrayListExtra(String)
7417 */
7418 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7419 if (mExtras == null) {
7420 mExtras = new Bundle();
7421 }
7422 mExtras.putCharSequenceArrayList(name, value);
7423 return this;
7424 }
7425
7426 /**
7427 * Add extended data to the intent. The name must include a package
7428 * prefix, for example the app com.android.contacts would use names
7429 * like "com.android.contacts.ShowAll".
7430 *
7431 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007432 * @param value The Serializable data value.
7433 *
7434 * @return Returns the same Intent object, for chaining multiple calls
7435 * into a single statement.
7436 *
7437 * @see #putExtras
7438 * @see #removeExtra
7439 * @see #getSerializableExtra(String)
7440 */
7441 public Intent putExtra(String name, Serializable value) {
7442 if (mExtras == null) {
7443 mExtras = new Bundle();
7444 }
7445 mExtras.putSerializable(name, value);
7446 return this;
7447 }
7448
7449 /**
7450 * Add extended data to the intent. The name must include a package
7451 * prefix, for example the app com.android.contacts would use names
7452 * like "com.android.contacts.ShowAll".
7453 *
7454 * @param name The name of the extra data, with package prefix.
7455 * @param value The boolean array data value.
7456 *
7457 * @return Returns the same Intent object, for chaining multiple calls
7458 * into a single statement.
7459 *
7460 * @see #putExtras
7461 * @see #removeExtra
7462 * @see #getBooleanArrayExtra(String)
7463 */
7464 public Intent putExtra(String name, boolean[] value) {
7465 if (mExtras == null) {
7466 mExtras = new Bundle();
7467 }
7468 mExtras.putBooleanArray(name, value);
7469 return this;
7470 }
7471
7472 /**
7473 * Add extended data to the intent. The name must include a package
7474 * prefix, for example the app com.android.contacts would use names
7475 * like "com.android.contacts.ShowAll".
7476 *
7477 * @param name The name of the extra data, with package prefix.
7478 * @param value The byte array data value.
7479 *
7480 * @return Returns the same Intent object, for chaining multiple calls
7481 * into a single statement.
7482 *
7483 * @see #putExtras
7484 * @see #removeExtra
7485 * @see #getByteArrayExtra(String)
7486 */
7487 public Intent putExtra(String name, byte[] value) {
7488 if (mExtras == null) {
7489 mExtras = new Bundle();
7490 }
7491 mExtras.putByteArray(name, value);
7492 return this;
7493 }
7494
7495 /**
7496 * Add extended data to the intent. The name must include a package
7497 * prefix, for example the app com.android.contacts would use names
7498 * like "com.android.contacts.ShowAll".
7499 *
7500 * @param name The name of the extra data, with package prefix.
7501 * @param value The short array data value.
7502 *
7503 * @return Returns the same Intent object, for chaining multiple calls
7504 * into a single statement.
7505 *
7506 * @see #putExtras
7507 * @see #removeExtra
7508 * @see #getShortArrayExtra(String)
7509 */
7510 public Intent putExtra(String name, short[] value) {
7511 if (mExtras == null) {
7512 mExtras = new Bundle();
7513 }
7514 mExtras.putShortArray(name, value);
7515 return this;
7516 }
7517
7518 /**
7519 * Add extended data to the intent. The name must include a package
7520 * prefix, for example the app com.android.contacts would use names
7521 * like "com.android.contacts.ShowAll".
7522 *
7523 * @param name The name of the extra data, with package prefix.
7524 * @param value The char array data value.
7525 *
7526 * @return Returns the same Intent object, for chaining multiple calls
7527 * into a single statement.
7528 *
7529 * @see #putExtras
7530 * @see #removeExtra
7531 * @see #getCharArrayExtra(String)
7532 */
7533 public Intent putExtra(String name, char[] value) {
7534 if (mExtras == null) {
7535 mExtras = new Bundle();
7536 }
7537 mExtras.putCharArray(name, value);
7538 return this;
7539 }
7540
7541 /**
7542 * Add extended data to the intent. The name must include a package
7543 * prefix, for example the app com.android.contacts would use names
7544 * like "com.android.contacts.ShowAll".
7545 *
7546 * @param name The name of the extra data, with package prefix.
7547 * @param value The int array data value.
7548 *
7549 * @return Returns the same Intent object, for chaining multiple calls
7550 * into a single statement.
7551 *
7552 * @see #putExtras
7553 * @see #removeExtra
7554 * @see #getIntArrayExtra(String)
7555 */
7556 public Intent putExtra(String name, int[] value) {
7557 if (mExtras == null) {
7558 mExtras = new Bundle();
7559 }
7560 mExtras.putIntArray(name, value);
7561 return this;
7562 }
7563
7564 /**
7565 * Add extended data to the intent. The name must include a package
7566 * prefix, for example the app com.android.contacts would use names
7567 * like "com.android.contacts.ShowAll".
7568 *
7569 * @param name The name of the extra data, with package prefix.
7570 * @param value The byte array data value.
7571 *
7572 * @return Returns the same Intent object, for chaining multiple calls
7573 * into a single statement.
7574 *
7575 * @see #putExtras
7576 * @see #removeExtra
7577 * @see #getLongArrayExtra(String)
7578 */
7579 public Intent putExtra(String name, long[] value) {
7580 if (mExtras == null) {
7581 mExtras = new Bundle();
7582 }
7583 mExtras.putLongArray(name, value);
7584 return this;
7585 }
7586
7587 /**
7588 * Add extended data to the intent. The name must include a package
7589 * prefix, for example the app com.android.contacts would use names
7590 * like "com.android.contacts.ShowAll".
7591 *
7592 * @param name The name of the extra data, with package prefix.
7593 * @param value The float array data value.
7594 *
7595 * @return Returns the same Intent object, for chaining multiple calls
7596 * into a single statement.
7597 *
7598 * @see #putExtras
7599 * @see #removeExtra
7600 * @see #getFloatArrayExtra(String)
7601 */
7602 public Intent putExtra(String name, float[] value) {
7603 if (mExtras == null) {
7604 mExtras = new Bundle();
7605 }
7606 mExtras.putFloatArray(name, value);
7607 return this;
7608 }
7609
7610 /**
7611 * Add extended data to the intent. The name must include a package
7612 * prefix, for example the app com.android.contacts would use names
7613 * like "com.android.contacts.ShowAll".
7614 *
7615 * @param name The name of the extra data, with package prefix.
7616 * @param value The double array data value.
7617 *
7618 * @return Returns the same Intent object, for chaining multiple calls
7619 * into a single statement.
7620 *
7621 * @see #putExtras
7622 * @see #removeExtra
7623 * @see #getDoubleArrayExtra(String)
7624 */
7625 public Intent putExtra(String name, double[] value) {
7626 if (mExtras == null) {
7627 mExtras = new Bundle();
7628 }
7629 mExtras.putDoubleArray(name, value);
7630 return this;
7631 }
7632
7633 /**
7634 * Add extended data to the intent. The name must include a package
7635 * prefix, for example the app com.android.contacts would use names
7636 * like "com.android.contacts.ShowAll".
7637 *
7638 * @param name The name of the extra data, with package prefix.
7639 * @param value The String array data value.
7640 *
7641 * @return Returns the same Intent object, for chaining multiple calls
7642 * into a single statement.
7643 *
7644 * @see #putExtras
7645 * @see #removeExtra
7646 * @see #getStringArrayExtra(String)
7647 */
7648 public Intent putExtra(String name, String[] value) {
7649 if (mExtras == null) {
7650 mExtras = new Bundle();
7651 }
7652 mExtras.putStringArray(name, value);
7653 return this;
7654 }
7655
7656 /**
7657 * Add extended data to the intent. The name must include a package
7658 * prefix, for example the app com.android.contacts would use names
7659 * like "com.android.contacts.ShowAll".
7660 *
7661 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007662 * @param value The CharSequence array data value.
7663 *
7664 * @return Returns the same Intent object, for chaining multiple calls
7665 * into a single statement.
7666 *
7667 * @see #putExtras
7668 * @see #removeExtra
7669 * @see #getCharSequenceArrayExtra(String)
7670 */
7671 public Intent putExtra(String name, CharSequence[] value) {
7672 if (mExtras == null) {
7673 mExtras = new Bundle();
7674 }
7675 mExtras.putCharSequenceArray(name, value);
7676 return this;
7677 }
7678
7679 /**
7680 * Add extended data to the intent. The name must include a package
7681 * prefix, for example the app com.android.contacts would use names
7682 * like "com.android.contacts.ShowAll".
7683 *
7684 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007685 * @param value The Bundle data value.
7686 *
7687 * @return Returns the same Intent object, for chaining multiple calls
7688 * into a single statement.
7689 *
7690 * @see #putExtras
7691 * @see #removeExtra
7692 * @see #getBundleExtra(String)
7693 */
7694 public Intent putExtra(String name, Bundle value) {
7695 if (mExtras == null) {
7696 mExtras = new Bundle();
7697 }
7698 mExtras.putBundle(name, value);
7699 return this;
7700 }
7701
7702 /**
7703 * Add extended data to the intent. The name must include a package
7704 * prefix, for example the app com.android.contacts would use names
7705 * like "com.android.contacts.ShowAll".
7706 *
7707 * @param name The name of the extra data, with package prefix.
7708 * @param value The IBinder data value.
7709 *
7710 * @return Returns the same Intent object, for chaining multiple calls
7711 * into a single statement.
7712 *
7713 * @see #putExtras
7714 * @see #removeExtra
7715 * @see #getIBinderExtra(String)
7716 *
7717 * @deprecated
7718 * @hide
7719 */
7720 @Deprecated
7721 public Intent putExtra(String name, IBinder value) {
7722 if (mExtras == null) {
7723 mExtras = new Bundle();
7724 }
7725 mExtras.putIBinder(name, value);
7726 return this;
7727 }
7728
7729 /**
7730 * Copy all extras in 'src' in to this intent.
7731 *
7732 * @param src Contains the extras to copy.
7733 *
7734 * @see #putExtra
7735 */
7736 public Intent putExtras(Intent src) {
7737 if (src.mExtras != null) {
7738 if (mExtras == null) {
7739 mExtras = new Bundle(src.mExtras);
7740 } else {
7741 mExtras.putAll(src.mExtras);
7742 }
7743 }
7744 return this;
7745 }
7746
7747 /**
7748 * Add a set of extended data to the intent. The keys must include a package
7749 * prefix, for example the app com.android.contacts would use names
7750 * like "com.android.contacts.ShowAll".
7751 *
7752 * @param extras The Bundle of extras to add to this intent.
7753 *
7754 * @see #putExtra
7755 * @see #removeExtra
7756 */
7757 public Intent putExtras(Bundle extras) {
7758 if (mExtras == null) {
7759 mExtras = new Bundle();
7760 }
7761 mExtras.putAll(extras);
7762 return this;
7763 }
7764
7765 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007766 * Completely replace the extras in the Intent with the extras in the
7767 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007768 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007769 * @param src The exact extras contained in this Intent are copied
7770 * into the target intent, replacing any that were previously there.
7771 */
7772 public Intent replaceExtras(Intent src) {
7773 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7774 return this;
7775 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007776
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007777 /**
7778 * Completely replace the extras in the Intent with the given Bundle of
7779 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007780 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007781 * @param extras The new set of extras in the Intent, or null to erase
7782 * all extras.
7783 */
7784 public Intent replaceExtras(Bundle extras) {
7785 mExtras = extras != null ? new Bundle(extras) : null;
7786 return this;
7787 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007788
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007789 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007790 * Remove extended data from the intent.
7791 *
7792 * @see #putExtra
7793 */
7794 public void removeExtra(String name) {
7795 if (mExtras != null) {
7796 mExtras.remove(name);
7797 if (mExtras.size() == 0) {
7798 mExtras = null;
7799 }
7800 }
7801 }
7802
7803 /**
7804 * Set special flags controlling how this intent is handled. Most values
7805 * here depend on the type of component being executed by the Intent,
7806 * specifically the FLAG_ACTIVITY_* flags are all for use with
7807 * {@link Context#startActivity Context.startActivity()} and the
7808 * FLAG_RECEIVER_* flags are all for use with
7809 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7810 *
Scott Main7aee61f2011-02-08 11:25:01 -08007811 * <p>See the
7812 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7813 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007814 * the behavior of your application.
7815 *
7816 * @param flags The desired flags.
7817 *
7818 * @return Returns the same Intent object, for chaining multiple calls
7819 * into a single statement.
7820 *
7821 * @see #getFlags
7822 * @see #addFlags
7823 *
7824 * @see #FLAG_GRANT_READ_URI_PERMISSION
7825 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007826 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7827 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007828 * @see #FLAG_DEBUG_LOG_RESOLUTION
7829 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007830 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007831 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007832 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007833 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007834 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7835 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007836 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007837 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007838 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007839 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007840 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007841 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007842 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007843 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7844 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007845 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007846 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007847 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007848 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7849 */
7850 public Intent setFlags(int flags) {
7851 mFlags = flags;
7852 return this;
7853 }
7854
7855 /**
7856 * Add additional flags to the intent (or with existing flags
7857 * value).
7858 *
7859 * @param flags The new flags to set.
7860 *
7861 * @return Returns the same Intent object, for chaining multiple calls
7862 * into a single statement.
7863 *
7864 * @see #setFlags
7865 */
7866 public Intent addFlags(int flags) {
7867 mFlags |= flags;
7868 return this;
7869 }
7870
7871 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007872 * (Usually optional) Set an explicit application package name that limits
7873 * the components this Intent will resolve to. If left to the default
7874 * value of null, all components in all applications will considered.
7875 * If non-null, the Intent can only match the components in the given
7876 * application package.
7877 *
7878 * @param packageName The name of the application package to handle the
7879 * intent, or null to allow any application package.
7880 *
7881 * @return Returns the same Intent object, for chaining multiple calls
7882 * into a single statement.
7883 *
7884 * @see #getPackage
7885 * @see #resolveActivity
7886 */
7887 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007888 if (packageName != null && mSelector != null) {
7889 throw new IllegalArgumentException(
7890 "Can't set package name when selector is already set");
7891 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007892 mPackage = packageName;
7893 return this;
7894 }
7895
7896 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007897 * (Usually optional) Explicitly set the component to handle the intent.
7898 * If left with the default value of null, the system will determine the
7899 * appropriate class to use based on the other fields (action, data,
7900 * type, categories) in the Intent. If this class is defined, the
7901 * specified class will always be used regardless of the other fields. You
7902 * should only set this value when you know you absolutely want a specific
7903 * class to be used; otherwise it is better to let the system find the
7904 * appropriate class so that you will respect the installed applications
7905 * and user preferences.
7906 *
7907 * @param component The name of the application component to handle the
7908 * intent, or null to let the system find one for you.
7909 *
7910 * @return Returns the same Intent object, for chaining multiple calls
7911 * into a single statement.
7912 *
7913 * @see #setClass
7914 * @see #setClassName(Context, String)
7915 * @see #setClassName(String, String)
7916 * @see #getComponent
7917 * @see #resolveActivity
7918 */
7919 public Intent setComponent(ComponentName component) {
7920 mComponent = component;
7921 return this;
7922 }
7923
7924 /**
7925 * Convenience for calling {@link #setComponent} with an
7926 * explicit class name.
7927 *
7928 * @param packageContext A Context of the application package implementing
7929 * this class.
7930 * @param className The name of a class inside of the application package
7931 * that will be used as the component for this Intent.
7932 *
7933 * @return Returns the same Intent object, for chaining multiple calls
7934 * into a single statement.
7935 *
7936 * @see #setComponent
7937 * @see #setClass
7938 */
7939 public Intent setClassName(Context packageContext, String className) {
7940 mComponent = new ComponentName(packageContext, className);
7941 return this;
7942 }
7943
7944 /**
7945 * Convenience for calling {@link #setComponent} with an
7946 * explicit application package name and class name.
7947 *
7948 * @param packageName The name of the package implementing the desired
7949 * component.
7950 * @param className The name of a class inside of the application package
7951 * that will be used as the component for this Intent.
7952 *
7953 * @return Returns the same Intent object, for chaining multiple calls
7954 * into a single statement.
7955 *
7956 * @see #setComponent
7957 * @see #setClass
7958 */
7959 public Intent setClassName(String packageName, String className) {
7960 mComponent = new ComponentName(packageName, className);
7961 return this;
7962 }
7963
7964 /**
7965 * Convenience for calling {@link #setComponent(ComponentName)} with the
7966 * name returned by a {@link Class} object.
7967 *
7968 * @param packageContext A Context of the application package implementing
7969 * this class.
7970 * @param cls The class name to set, equivalent to
7971 * <code>setClassName(context, cls.getName())</code>.
7972 *
7973 * @return Returns the same Intent object, for chaining multiple calls
7974 * into a single statement.
7975 *
7976 * @see #setComponent
7977 */
7978 public Intent setClass(Context packageContext, Class<?> cls) {
7979 mComponent = new ComponentName(packageContext, cls);
7980 return this;
7981 }
7982
7983 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007984 * Set the bounds of the sender of this intent, in screen coordinates. This can be
7985 * used as a hint to the receiver for animations and the like. Null means that there
7986 * is no source bounds.
7987 */
7988 public void setSourceBounds(Rect r) {
7989 if (r != null) {
7990 mSourceBounds = new Rect(r);
7991 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07007992 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007993 }
7994 }
7995
Tor Norbyed9273d62013-05-30 15:59:53 -07007996 /** @hide */
7997 @IntDef(flag = true,
7998 value = {
7999 FILL_IN_ACTION,
8000 FILL_IN_DATA,
8001 FILL_IN_CATEGORIES,
8002 FILL_IN_COMPONENT,
8003 FILL_IN_PACKAGE,
8004 FILL_IN_SOURCE_BOUNDS,
8005 FILL_IN_SELECTOR,
8006 FILL_IN_CLIP_DATA
8007 })
8008 @Retention(RetentionPolicy.SOURCE)
8009 public @interface FillInFlags {}
8010
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008011 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008012 * Use with {@link #fillIn} to allow the current action value to be
8013 * overwritten, even if it is already set.
8014 */
8015 public static final int FILL_IN_ACTION = 1<<0;
8016
8017 /**
8018 * Use with {@link #fillIn} to allow the current data or type value
8019 * overwritten, even if it is already set.
8020 */
8021 public static final int FILL_IN_DATA = 1<<1;
8022
8023 /**
8024 * Use with {@link #fillIn} to allow the current categories to be
8025 * overwritten, even if they are already set.
8026 */
8027 public static final int FILL_IN_CATEGORIES = 1<<2;
8028
8029 /**
8030 * Use with {@link #fillIn} to allow the current component value to be
8031 * overwritten, even if it is already set.
8032 */
8033 public static final int FILL_IN_COMPONENT = 1<<3;
8034
8035 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008036 * Use with {@link #fillIn} to allow the current package value to be
8037 * overwritten, even if it is already set.
8038 */
8039 public static final int FILL_IN_PACKAGE = 1<<4;
8040
8041 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008042 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008043 * overwritten, even if it is already set.
8044 */
8045 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8046
8047 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008048 * Use with {@link #fillIn} to allow the current selector to be
8049 * overwritten, even if it is already set.
8050 */
8051 public static final int FILL_IN_SELECTOR = 1<<6;
8052
8053 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008054 * Use with {@link #fillIn} to allow the current ClipData to be
8055 * overwritten, even if it is already set.
8056 */
8057 public static final int FILL_IN_CLIP_DATA = 1<<7;
8058
8059 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008060 * Copy the contents of <var>other</var> in to this object, but only
8061 * where fields are not defined by this object. For purposes of a field
8062 * being defined, the following pieces of data in the Intent are
8063 * considered to be separate fields:
8064 *
8065 * <ul>
8066 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008067 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008068 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8069 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008070 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008071 * <li> component, as set by {@link #setComponent(ComponentName)} or
8072 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008073 * <li> source bounds, as set by {@link #setSourceBounds}.
8074 * <li> selector, as set by {@link #setSelector(Intent)}.
8075 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008076 * <li> each top-level name in the associated extras.
8077 * </ul>
8078 *
8079 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008080 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008081 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8082 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8083 * the restriction where the corresponding field will not be replaced if
8084 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008085 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008086 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8087 * is explicitly specified. The selector will only be copied if
8088 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008089 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008090 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8091 * and Intent B with {action="gotit", data-type="some/thing",
8092 * categories="one","two"}.
8093 *
8094 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8095 * containing: {action="gotit", data-type="some/thing",
8096 * categories="bar"}.
8097 *
8098 * @param other Another Intent whose values are to be used to fill in
8099 * the current one.
8100 * @param flags Options to control which fields can be filled in.
8101 *
8102 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008103 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008104 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8105 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8106 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008107 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008108 @FillInFlags
8109 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008110 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008111 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008112 if (other.mAction != null
8113 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008114 mAction = other.mAction;
8115 changes |= FILL_IN_ACTION;
8116 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008117 if ((other.mData != null || other.mType != null)
8118 && ((mData == null && mType == null)
8119 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008120 mData = other.mData;
8121 mType = other.mType;
8122 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008123 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008124 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008125 if (other.mCategories != null
8126 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008127 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008128 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008129 }
8130 changes |= FILL_IN_CATEGORIES;
8131 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008132 if (other.mPackage != null
8133 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008134 // Only do this if mSelector is not set.
8135 if (mSelector == null) {
8136 mPackage = other.mPackage;
8137 changes |= FILL_IN_PACKAGE;
8138 }
8139 }
8140 // Selector is special: it can only be set if explicitly allowed,
8141 // for the same reason as the component name.
8142 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8143 if (mPackage == null) {
8144 mSelector = new Intent(other.mSelector);
8145 mPackage = null;
8146 changes |= FILL_IN_SELECTOR;
8147 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008148 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008149 if (other.mClipData != null
8150 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8151 mClipData = other.mClipData;
8152 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008153 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008154 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008155 // Component is special: it can -only- be set if explicitly allowed,
8156 // since otherwise the sender could force the intent somewhere the
8157 // originator didn't intend.
8158 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008159 mComponent = other.mComponent;
8160 changes |= FILL_IN_COMPONENT;
8161 }
8162 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008163 if (other.mSourceBounds != null
8164 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8165 mSourceBounds = new Rect(other.mSourceBounds);
8166 changes |= FILL_IN_SOURCE_BOUNDS;
8167 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008168 if (mExtras == null) {
8169 if (other.mExtras != null) {
8170 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008171 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008172 }
8173 } else if (other.mExtras != null) {
8174 try {
8175 Bundle newb = new Bundle(other.mExtras);
8176 newb.putAll(mExtras);
8177 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008178 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008179 } catch (RuntimeException e) {
8180 // Modifying the extras can cause us to unparcel the contents
8181 // of the bundle, and if we do this in the system process that
8182 // may fail. We really should handle this (i.e., the Bundle
8183 // impl shouldn't be on top of a plain map), but for now just
8184 // ignore it and keep the original contents. :(
8185 Log.w("Intent", "Failure filling in extras", e);
8186 }
8187 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008188 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8189 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8190 mContentUserHint = other.mContentUserHint;
8191 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008192 return changes;
8193 }
8194
8195 /**
8196 * Wrapper class holding an Intent and implementing comparisons on it for
8197 * the purpose of filtering. The class implements its
8198 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8199 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8200 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8201 * on the wrapped Intent.
8202 */
8203 public static final class FilterComparison {
8204 private final Intent mIntent;
8205 private final int mHashCode;
8206
8207 public FilterComparison(Intent intent) {
8208 mIntent = intent;
8209 mHashCode = intent.filterHashCode();
8210 }
8211
8212 /**
8213 * Return the Intent that this FilterComparison represents.
8214 * @return Returns the Intent held by the FilterComparison. Do
8215 * not modify!
8216 */
8217 public Intent getIntent() {
8218 return mIntent;
8219 }
8220
8221 @Override
8222 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008223 if (obj instanceof FilterComparison) {
8224 Intent other = ((FilterComparison)obj).mIntent;
8225 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008226 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008227 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008228 }
8229
8230 @Override
8231 public int hashCode() {
8232 return mHashCode;
8233 }
8234 }
8235
8236 /**
8237 * Determine if two intents are the same for the purposes of intent
8238 * resolution (filtering). That is, if their action, data, type,
8239 * class, and categories are the same. This does <em>not</em> compare
8240 * any extra data included in the intents.
8241 *
8242 * @param other The other Intent to compare against.
8243 *
8244 * @return Returns true if action, data, type, class, and categories
8245 * are the same.
8246 */
8247 public boolean filterEquals(Intent other) {
8248 if (other == null) {
8249 return false;
8250 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008251 if (!Objects.equals(this.mAction, other.mAction)) return false;
8252 if (!Objects.equals(this.mData, other.mData)) return false;
8253 if (!Objects.equals(this.mType, other.mType)) return false;
8254 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8255 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8256 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008257
8258 return true;
8259 }
8260
8261 /**
8262 * Generate hash code that matches semantics of filterEquals().
8263 *
8264 * @return Returns the hash value of the action, data, type, class, and
8265 * categories.
8266 *
8267 * @see #filterEquals
8268 */
8269 public int filterHashCode() {
8270 int code = 0;
8271 if (mAction != null) {
8272 code += mAction.hashCode();
8273 }
8274 if (mData != null) {
8275 code += mData.hashCode();
8276 }
8277 if (mType != null) {
8278 code += mType.hashCode();
8279 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008280 if (mPackage != null) {
8281 code += mPackage.hashCode();
8282 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008283 if (mComponent != null) {
8284 code += mComponent.hashCode();
8285 }
8286 if (mCategories != null) {
8287 code += mCategories.hashCode();
8288 }
8289 return code;
8290 }
8291
8292 @Override
8293 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008294 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008295
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008296 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008297 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008298 b.append(" }");
8299
8300 return b.toString();
8301 }
8302
8303 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008304 public String toInsecureString() {
8305 StringBuilder b = new StringBuilder(128);
8306
8307 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008308 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008309 b.append(" }");
8310
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008311 return b.toString();
8312 }
Romain Guy4969af72009-06-17 10:53:19 -07008313
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008314 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008315 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008316 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008317
8318 b.append("Intent { ");
8319 toShortString(b, false, true, true, true);
8320 b.append(" }");
8321
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008322 return b.toString();
8323 }
8324
8325 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008326 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8327 StringBuilder b = new StringBuilder(128);
8328 toShortString(b, secure, comp, extras, clip);
8329 return b.toString();
8330 }
8331
8332 /** @hide */
8333 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8334 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008335 boolean first = true;
8336 if (mAction != null) {
8337 b.append("act=").append(mAction);
8338 first = false;
8339 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008340 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008341 if (!first) {
8342 b.append(' ');
8343 }
8344 first = false;
8345 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008346 for (int i=0; i<mCategories.size(); i++) {
8347 if (i > 0) b.append(',');
8348 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008349 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008350 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008351 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008352 if (mData != null) {
8353 if (!first) {
8354 b.append(' ');
8355 }
8356 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008357 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008358 if (secure) {
8359 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008360 } else {
8361 b.append(mData);
8362 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008363 }
8364 if (mType != null) {
8365 if (!first) {
8366 b.append(' ');
8367 }
8368 first = false;
8369 b.append("typ=").append(mType);
8370 }
8371 if (mFlags != 0) {
8372 if (!first) {
8373 b.append(' ');
8374 }
8375 first = false;
8376 b.append("flg=0x").append(Integer.toHexString(mFlags));
8377 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008378 if (mPackage != null) {
8379 if (!first) {
8380 b.append(' ');
8381 }
8382 first = false;
8383 b.append("pkg=").append(mPackage);
8384 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008385 if (comp && mComponent != null) {
8386 if (!first) {
8387 b.append(' ');
8388 }
8389 first = false;
8390 b.append("cmp=").append(mComponent.flattenToShortString());
8391 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008392 if (mSourceBounds != null) {
8393 if (!first) {
8394 b.append(' ');
8395 }
8396 first = false;
8397 b.append("bnds=").append(mSourceBounds.toShortString());
8398 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008399 if (mClipData != null) {
8400 if (!first) {
8401 b.append(' ');
8402 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008403 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008404 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008405 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008406 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008407 if (mClipData.getDescription() != null) {
8408 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8409 } else {
8410 first = true;
8411 }
8412 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008413 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008414 first = false;
8415 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008416 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008417 if (extras && mExtras != null) {
8418 if (!first) {
8419 b.append(' ');
8420 }
8421 first = false;
8422 b.append("(has extras)");
8423 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008424 if (mContentUserHint != UserHandle.USER_CURRENT) {
8425 if (!first) {
8426 b.append(' ');
8427 }
8428 first = false;
8429 b.append("u=").append(mContentUserHint);
8430 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008431 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008432 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008433 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008434 b.append("}");
8435 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008436 }
8437
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008438 /**
8439 * Call {@link #toUri} with 0 flags.
8440 * @deprecated Use {@link #toUri} instead.
8441 */
8442 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008443 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008444 return toUri(0);
8445 }
8446
8447 /**
8448 * Convert this Intent into a String holding a URI representation of it.
8449 * The returned URI string has been properly URI encoded, so it can be
8450 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8451 * Intent's data as the base URI, with an additional fragment describing
8452 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008453 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008454 * <p>You can convert the returned string back to an Intent with
8455 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008456 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008457 * @param flags Additional operating flags. Either 0,
8458 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008459 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008460 * @return Returns a URI encoding URI string describing the entire contents
8461 * of the Intent.
8462 */
8463 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008464 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008465 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8466 if (mPackage == null) {
8467 throw new IllegalArgumentException(
8468 "Intent must include an explicit package name to build an android-app: "
8469 + this);
8470 }
8471 uri.append("android-app://");
8472 uri.append(mPackage);
8473 String scheme = null;
8474 if (mData != null) {
8475 scheme = mData.getScheme();
8476 if (scheme != null) {
8477 uri.append('/');
8478 uri.append(scheme);
8479 String authority = mData.getEncodedAuthority();
8480 if (authority != null) {
8481 uri.append('/');
8482 uri.append(authority);
8483 String path = mData.getEncodedPath();
8484 if (path != null) {
8485 uri.append(path);
8486 }
8487 String queryParams = mData.getEncodedQuery();
8488 if (queryParams != null) {
8489 uri.append('?');
8490 uri.append(queryParams);
8491 }
8492 String fragment = mData.getEncodedFragment();
8493 if (fragment != null) {
8494 uri.append('#');
8495 uri.append(fragment);
8496 }
8497 }
8498 }
8499 }
8500 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8501 mPackage, flags);
8502 return uri.toString();
8503 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008504 String scheme = null;
8505 if (mData != null) {
8506 String data = mData.toString();
8507 if ((flags&URI_INTENT_SCHEME) != 0) {
8508 final int N = data.length();
8509 for (int i=0; i<N; i++) {
8510 char c = data.charAt(i);
8511 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8512 || c == '.' || c == '-') {
8513 continue;
8514 }
8515 if (c == ':' && i > 0) {
8516 // Valid scheme.
8517 scheme = data.substring(0, i);
8518 uri.append("intent:");
8519 data = data.substring(i+1);
8520 break;
8521 }
Tom Taylord4a47292009-12-21 13:59:18 -08008522
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008523 // No scheme.
8524 break;
8525 }
8526 }
8527 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008528
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008529 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8530 uri.append("intent:");
8531 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008532
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008533 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008534
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008535 return uri.toString();
8536 }
8537
8538 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8539 String defPackage, int flags) {
8540 StringBuilder frag = new StringBuilder(128);
8541
8542 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008543 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008544 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008545 // Note that for now we are not going to try to handle the
8546 // data part; not clear how to represent this as a URI, and
8547 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008548 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8549 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008550 }
8551
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008552 if (frag.length() > 0) {
8553 uri.append("#Intent;");
8554 uri.append(frag);
8555 uri.append("end");
8556 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008557 }
8558
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008559 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8560 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008561 if (scheme != null) {
8562 uri.append("scheme=").append(scheme).append(';');
8563 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008564 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008565 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008566 }
8567 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008568 for (int i=0; i<mCategories.size(); i++) {
8569 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008570 }
8571 }
8572 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008573 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008574 }
8575 if (mFlags != 0) {
8576 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8577 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008578 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008579 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8580 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008581 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008582 uri.append("component=").append(Uri.encode(
8583 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008584 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008585 if (mSourceBounds != null) {
8586 uri.append("sourceBounds=")
8587 .append(Uri.encode(mSourceBounds.flattenToString()))
8588 .append(';');
8589 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008590 if (mExtras != null) {
8591 for (String key : mExtras.keySet()) {
8592 final Object value = mExtras.get(key);
8593 char entryType =
8594 value instanceof String ? 'S' :
8595 value instanceof Boolean ? 'B' :
8596 value instanceof Byte ? 'b' :
8597 value instanceof Character ? 'c' :
8598 value instanceof Double ? 'd' :
8599 value instanceof Float ? 'f' :
8600 value instanceof Integer ? 'i' :
8601 value instanceof Long ? 'l' :
8602 value instanceof Short ? 's' :
8603 '\0';
8604
8605 if (entryType != '\0') {
8606 uri.append(entryType);
8607 uri.append('.');
8608 uri.append(Uri.encode(key));
8609 uri.append('=');
8610 uri.append(Uri.encode(value.toString()));
8611 uri.append(';');
8612 }
8613 }
8614 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008615 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008616
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008617 public int describeContents() {
8618 return (mExtras != null) ? mExtras.describeContents() : 0;
8619 }
8620
8621 public void writeToParcel(Parcel out, int flags) {
8622 out.writeString(mAction);
8623 Uri.writeToParcel(out, mData);
8624 out.writeString(mType);
8625 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008626 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008627 ComponentName.writeToParcel(mComponent, out);
8628
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008629 if (mSourceBounds != null) {
8630 out.writeInt(1);
8631 mSourceBounds.writeToParcel(out, flags);
8632 } else {
8633 out.writeInt(0);
8634 }
8635
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008636 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008637 final int N = mCategories.size();
8638 out.writeInt(N);
8639 for (int i=0; i<N; i++) {
8640 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008641 }
8642 } else {
8643 out.writeInt(0);
8644 }
8645
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008646 if (mSelector != null) {
8647 out.writeInt(1);
8648 mSelector.writeToParcel(out, flags);
8649 } else {
8650 out.writeInt(0);
8651 }
8652
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008653 if (mClipData != null) {
8654 out.writeInt(1);
8655 mClipData.writeToParcel(out, flags);
8656 } else {
8657 out.writeInt(0);
8658 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008659 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008660 out.writeBundle(mExtras);
8661 }
8662
8663 public static final Parcelable.Creator<Intent> CREATOR
8664 = new Parcelable.Creator<Intent>() {
8665 public Intent createFromParcel(Parcel in) {
8666 return new Intent(in);
8667 }
8668 public Intent[] newArray(int size) {
8669 return new Intent[size];
8670 }
8671 };
8672
Dianne Hackborneb034652009-09-07 00:49:58 -07008673 /** @hide */
8674 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008675 readFromParcel(in);
8676 }
8677
8678 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008679 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008680 mData = Uri.CREATOR.createFromParcel(in);
8681 mType = in.readString();
8682 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008683 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008684 mComponent = ComponentName.readFromParcel(in);
8685
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008686 if (in.readInt() != 0) {
8687 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8688 }
8689
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008690 int N = in.readInt();
8691 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008692 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008693 int i;
8694 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008695 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008696 }
8697 } else {
8698 mCategories = null;
8699 }
8700
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008701 if (in.readInt() != 0) {
8702 mSelector = new Intent(in);
8703 }
8704
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008705 if (in.readInt() != 0) {
8706 mClipData = new ClipData(in);
8707 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008708 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008709 mExtras = in.readBundle();
8710 }
8711
8712 /**
8713 * Parses the "intent" element (and its children) from XML and instantiates
8714 * an Intent object. The given XML parser should be located at the tag
8715 * where parsing should start (often named "intent"), from which the
8716 * basic action, data, type, and package and class name will be
8717 * retrieved. The function will then parse in to any child elements,
8718 * looking for <category android:name="xxx"> tags to add categories and
8719 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8720 * to the intent.
8721 *
8722 * @param resources The Resources to use when inflating resources.
8723 * @param parser The XML parser pointing at an "intent" tag.
8724 * @param attrs The AttributeSet interface for retrieving extended
8725 * attribute data at the current <var>parser</var> location.
8726 * @return An Intent object matching the XML data.
8727 * @throws XmlPullParserException If there was an XML parsing error.
8728 * @throws IOException If there was an I/O error.
8729 */
8730 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8731 throws XmlPullParserException, IOException {
8732 Intent intent = new Intent();
8733
8734 TypedArray sa = resources.obtainAttributes(attrs,
8735 com.android.internal.R.styleable.Intent);
8736
8737 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8738
8739 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8740 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8741 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8742
8743 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8744 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8745 if (packageName != null && className != null) {
8746 intent.setComponent(new ComponentName(packageName, className));
8747 }
8748
8749 sa.recycle();
8750
8751 int outerDepth = parser.getDepth();
8752 int type;
8753 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8754 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8755 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8756 continue;
8757 }
8758
8759 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008760 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008761 sa = resources.obtainAttributes(attrs,
8762 com.android.internal.R.styleable.IntentCategory);
8763 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8764 sa.recycle();
8765
8766 if (cat != null) {
8767 intent.addCategory(cat);
8768 }
8769 XmlUtils.skipCurrentTag(parser);
8770
Craig Mautner21d24a22014-04-23 11:45:37 -07008771 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008772 if (intent.mExtras == null) {
8773 intent.mExtras = new Bundle();
8774 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008775 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008776 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008777
8778 } else {
8779 XmlUtils.skipCurrentTag(parser);
8780 }
8781 }
8782
8783 return intent;
8784 }
Nick Pellyccae4122012-01-09 14:12:58 -08008785
Craig Mautner21d24a22014-04-23 11:45:37 -07008786 /** @hide */
8787 public void saveToXml(XmlSerializer out) throws IOException {
8788 if (mAction != null) {
8789 out.attribute(null, ATTR_ACTION, mAction);
8790 }
8791 if (mData != null) {
8792 out.attribute(null, ATTR_DATA, mData.toString());
8793 }
8794 if (mType != null) {
8795 out.attribute(null, ATTR_TYPE, mType);
8796 }
8797 if (mComponent != null) {
8798 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8799 }
8800 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8801
8802 if (mCategories != null) {
8803 out.startTag(null, TAG_CATEGORIES);
8804 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8805 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8806 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008807 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008808 }
8809 }
8810
8811 /** @hide */
8812 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8813 XmlPullParserException {
8814 Intent intent = new Intent();
8815 final int outerDepth = in.getDepth();
8816
8817 int attrCount = in.getAttributeCount();
8818 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8819 final String attrName = in.getAttributeName(attrNdx);
8820 final String attrValue = in.getAttributeValue(attrNdx);
8821 if (ATTR_ACTION.equals(attrName)) {
8822 intent.setAction(attrValue);
8823 } else if (ATTR_DATA.equals(attrName)) {
8824 intent.setData(Uri.parse(attrValue));
8825 } else if (ATTR_TYPE.equals(attrName)) {
8826 intent.setType(attrValue);
8827 } else if (ATTR_COMPONENT.equals(attrName)) {
8828 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8829 } else if (ATTR_FLAGS.equals(attrName)) {
8830 intent.setFlags(Integer.valueOf(attrValue, 16));
8831 } else {
8832 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8833 }
8834 }
8835
8836 int event;
8837 String name;
8838 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8839 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8840 if (event == XmlPullParser.START_TAG) {
8841 name = in.getName();
8842 if (TAG_CATEGORIES.equals(name)) {
8843 attrCount = in.getAttributeCount();
8844 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8845 intent.addCategory(in.getAttributeValue(attrNdx));
8846 }
8847 } else {
8848 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8849 XmlUtils.skipCurrentTag(in);
8850 }
8851 }
8852 }
8853
8854 return intent;
8855 }
8856
Nick Pellyccae4122012-01-09 14:12:58 -08008857 /**
8858 * Normalize a MIME data type.
8859 *
8860 * <p>A normalized MIME type has white-space trimmed,
8861 * content-type parameters removed, and is lower-case.
8862 * This aligns the type with Android best practices for
8863 * intent filtering.
8864 *
8865 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8866 * "text/x-vCard" becomes "text/x-vcard".
8867 *
8868 * <p>All MIME types received from outside Android (such as user input,
8869 * or external sources like Bluetooth, NFC, or the Internet) should
8870 * be normalized before they are used to create an Intent.
8871 *
8872 * @param type MIME data type to normalize
8873 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008874 * @see #setType
8875 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008876 */
8877 public static String normalizeMimeType(String type) {
8878 if (type == null) {
8879 return null;
8880 }
8881
Elliott Hughescb64d432013-08-02 10:00:44 -07008882 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008883
8884 final int semicolonIndex = type.indexOf(';');
8885 if (semicolonIndex != -1) {
8886 type = type.substring(0, semicolonIndex);
8887 }
8888 return type;
8889 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008890
8891 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008892 * Prepare this {@link Intent} to leave an app process.
8893 *
8894 * @hide
8895 */
8896 public void prepareToLeaveProcess() {
8897 setAllowFds(false);
8898
8899 if (mSelector != null) {
8900 mSelector.prepareToLeaveProcess();
8901 }
8902 if (mClipData != null) {
8903 mClipData.prepareToLeaveProcess();
8904 }
8905
8906 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
8907 // There are several ACTION_MEDIA_* broadcasts that send file://
8908 // Uris, so only check common actions.
8909 if (ACTION_VIEW.equals(mAction) ||
8910 ACTION_EDIT.equals(mAction) ||
8911 ACTION_ATTACH_DATA.equals(mAction)) {
8912 mData.checkFileUriExposed("Intent.getData()");
8913 }
8914 }
8915 }
8916
8917 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008918 * @hide
8919 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008920 public void prepareToEnterProcess() {
8921 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008922 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8923 fixUris(mContentUserHint);
8924 mContentUserHint = UserHandle.USER_CURRENT;
8925 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008926 }
8927 }
8928
8929 /**
8930 * @hide
8931 */
8932 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008933 Uri data = getData();
8934 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008935 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008936 }
8937 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008938 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008939 }
8940 String action = getAction();
8941 if (ACTION_SEND.equals(action)) {
8942 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8943 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008944 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008945 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008946 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008947 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8948 if (streams != null) {
8949 ArrayList<Uri> newStreams = new ArrayList<Uri>();
8950 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008951 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008952 }
8953 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
8954 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008955 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8956 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8957 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8958 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8959 if (output != null) {
8960 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
8961 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008962 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008963 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008964
8965 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008966 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008967 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
8968 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008969 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008970 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008971 * @hide
8972 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008973 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008974 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008975 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008976
8977 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008978 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008979
8980 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008981 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008982 // Inspect contained intents to see if we need to migrate extras. We
8983 // don't promote ClipData to the parent, since ChooserActivity will
8984 // already start the picked item as the caller, and we can't combine
8985 // the flags in a safe way.
8986
8987 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07008988 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008989 final Intent intent = getParcelableExtra(EXTRA_INTENT);
8990 if (intent != null) {
8991 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07008992 }
8993 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008994 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008995 try {
8996 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
8997 if (intents != null) {
8998 for (int i = 0; i < intents.length; i++) {
8999 final Intent intent = (Intent) intents[i];
9000 if (intent != null) {
9001 migrated |= intent.migrateExtraStreamToClipData();
9002 }
9003 }
9004 }
9005 } catch (ClassCastException e) {
9006 }
9007 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009008
9009 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009010 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009011 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9012 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9013 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9014 if (stream != null || text != null || htmlText != null) {
9015 final ClipData clipData = new ClipData(
9016 null, new String[] { getType() },
9017 new ClipData.Item(text, htmlText, null, stream));
9018 setClipData(clipData);
9019 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009020 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009021 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009022 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009023 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009024
9025 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009026 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009027 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9028 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9029 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9030 int num = -1;
9031 if (streams != null) {
9032 num = streams.size();
9033 }
9034 if (texts != null) {
9035 if (num >= 0 && num != texts.size()) {
9036 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009037 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009038 }
9039 num = texts.size();
9040 }
9041 if (htmlTexts != null) {
9042 if (num >= 0 && num != htmlTexts.size()) {
9043 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009044 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009045 }
9046 num = htmlTexts.size();
9047 }
9048 if (num > 0) {
9049 final ClipData clipData = new ClipData(
9050 null, new String[] { getType() },
9051 makeClipItem(streams, texts, htmlTexts, 0));
9052
9053 for (int i = 1; i < num; i++) {
9054 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9055 }
9056
9057 setClipData(clipData);
9058 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009059 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009060 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009061 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009062 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009063 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9064 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9065 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9066 final Uri output;
9067 try {
9068 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9069 } catch (ClassCastException e) {
9070 return false;
9071 }
9072 if (output != null) {
9073 setClipData(ClipData.newRawUri("", output));
9074 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9075 return true;
9076 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009077 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009078
9079 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009080 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009081
9082 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9083 ArrayList<String> htmlTexts, int which) {
9084 Uri uri = streams != null ? streams.get(which) : null;
9085 CharSequence text = texts != null ? texts.get(which) : null;
9086 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9087 return new ClipData.Item(text, htmlText, null, uri);
9088 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009089
9090 /** @hide */
9091 public boolean isDocument() {
9092 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9093 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009094}