blob: 381ea90974e2b6e19e6d6e2ce7c9bef5e1da672d [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 /**
Steve McKayc78bcb82015-07-31 14:35:22 -0700667 * Activity Action: Quick view the data.
668 * <p>Input: {@link #getData} is URI from which to retrieve data.
669 * <p>Output: nothing.
670 * @hide
671 */
672 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
673 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
674
675 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700676 * Used to indicate that some piece of data should be attached to some other
677 * place. For example, image data could be attached to a contact. It is up
678 * to the recipient to decide where the data should be attached; the intent
679 * does not specify the ultimate destination.
680 * <p>Input: {@link #getData} is URI of data to be attached.
681 * <p>Output: nothing.
682 */
683 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
684 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800685
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700686 /**
687 * Activity Action: Provide explicit editable access to the given data.
688 * <p>Input: {@link #getData} is URI of data to be edited.
689 * <p>Output: nothing.
690 */
691 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
692 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800693
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700694 /**
695 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
696 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
697 * The extras can contain type specific data to pass through to the editing/creating
698 * activity.
699 * <p>Output: The URI of the item that was picked. This must be a content:
700 * URI so that any receiver can access it.
701 */
702 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
703 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800704
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700705 /**
706 * Activity Action: Pick an item from the data, returning what was selected.
707 * <p>Input: {@link #getData} is URI containing a directory of data
708 * (vnd.android.cursor.dir/*) from which to pick an item.
709 * <p>Output: The URI of the item that was picked.
710 */
711 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
712 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800713
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700714 /**
715 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800716 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700717 * <p>Output: An Intent representing the shortcut. The intent must contain three
718 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
719 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800720 * (value: ShortcutIconResource).</p>
721 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700722 * @see #EXTRA_SHORTCUT_INTENT
723 * @see #EXTRA_SHORTCUT_NAME
724 * @see #EXTRA_SHORTCUT_ICON
725 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
726 * @see android.content.Intent.ShortcutIconResource
727 */
728 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
729 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
730
731 /**
732 * The name of the extra used to define the Intent of a shortcut.
733 *
734 * @see #ACTION_CREATE_SHORTCUT
735 */
736 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
737 /**
738 * The name of the extra used to define the name of a shortcut.
739 *
740 * @see #ACTION_CREATE_SHORTCUT
741 */
742 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
743 /**
744 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
745 *
746 * @see #ACTION_CREATE_SHORTCUT
747 */
748 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
749 /**
750 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
751 *
752 * @see #ACTION_CREATE_SHORTCUT
753 * @see android.content.Intent.ShortcutIconResource
754 */
755 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
756 "android.intent.extra.shortcut.ICON_RESOURCE";
757
758 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800759 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700760 *
761 * @see Intent#ACTION_CREATE_SHORTCUT
762 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800763 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
764 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700765 */
766 public static class ShortcutIconResource implements Parcelable {
767 /**
768 * The package name of the application containing the icon.
769 */
770 public String packageName;
771
772 /**
773 * The resource name of the icon, including package, name and type.
774 */
775 public String resourceName;
776
777 /**
778 * Creates a new ShortcutIconResource for the specified context and resource
779 * identifier.
780 *
781 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700782 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700783 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700784 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700785 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700786 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700787 ShortcutIconResource icon = new ShortcutIconResource();
788 icon.packageName = context.getPackageName();
789 icon.resourceName = context.getResources().getResourceName(resourceId);
790 return icon;
791 }
792
793 /**
794 * Used to read a ShortcutIconResource from a Parcel.
795 */
796 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
797 new Parcelable.Creator<ShortcutIconResource>() {
798
799 public ShortcutIconResource createFromParcel(Parcel source) {
800 ShortcutIconResource icon = new ShortcutIconResource();
801 icon.packageName = source.readString();
802 icon.resourceName = source.readString();
803 return icon;
804 }
805
806 public ShortcutIconResource[] newArray(int size) {
807 return new ShortcutIconResource[size];
808 }
809 };
810
811 /**
812 * No special parcel contents.
813 */
814 public int describeContents() {
815 return 0;
816 }
817
818 public void writeToParcel(Parcel dest, int flags) {
819 dest.writeString(packageName);
820 dest.writeString(resourceName);
821 }
822
823 @Override
824 public String toString() {
825 return resourceName;
826 }
827 }
828
829 /**
830 * Activity Action: Display an activity chooser, allowing the user to pick
831 * what they want to before proceeding. This can be used as an alternative
832 * to the standard activity picker that is displayed by the system when
833 * you try to start an activity with multiple possible matches, with these
834 * differences in behavior:
835 * <ul>
836 * <li>You can specify the title that will appear in the activity chooser.
837 * <li>The user does not have the option to make one of the matching
838 * activities a preferred activity, and all possible activities will
839 * always be shown even if one of them is currently marked as the
840 * preferred activity.
841 * </ul>
842 * <p>
843 * This action should be used when the user will naturally expect to
844 * select an activity in order to proceed. An example if when not to use
845 * it is when the user clicks on a "mailto:" link. They would naturally
846 * expect to go directly to their mail app, so startActivity() should be
847 * called directly: it will
848 * either launch the current preferred app, or put up a dialog allowing the
849 * user to pick an app to use and optionally marking that as preferred.
850 * <p>
851 * In contrast, if the user is selecting a menu item to send a picture
852 * they are viewing to someone else, there are many different things they
853 * may want to do at this point: send it through e-mail, upload it to a
854 * web service, etc. In this case the CHOOSER action should be used, to
855 * always present to the user a list of the things they can do, with a
856 * nice title given by the caller such as "Send this photo with:".
857 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700858 * If you need to grant URI permissions through a chooser, you must specify
859 * the permissions to be granted on the ACTION_CHOOSER Intent
860 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
861 * {@link #setClipData} to specify the URIs to be granted as well as
862 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
863 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
864 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700865 * As a convenience, an Intent of this form can be created with the
866 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700867 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700868 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700869 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
870 * and can optionally have a {@link #EXTRA_TITLE} field containing the
871 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700872 * <p>
873 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700874 */
875 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
876 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
877
878 /**
879 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
880 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700881 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
882 * target intent, also optionally supplying a title. If the target
883 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
884 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
885 * set in the returned chooser intent, with its ClipData set appropriately:
886 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500887 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700888 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700889 * @param target The Intent that the user will be selecting an activity
890 * to perform.
891 * @param title Optional title that will be displayed in the chooser.
892 * @return Return a new Intent object that you can hand to
893 * {@link Context#startActivity(Intent) Context.startActivity()} and
894 * related methods.
895 */
896 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700897 return createChooser(target, title, null);
898 }
899
900 /**
901 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
902 *
903 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
904 * target intent, also optionally supplying a title. If the target
905 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
906 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
907 * set in the returned chooser intent, with its ClipData set appropriately:
908 * either a direct reflection of {@link #getClipData()} if that is non-null,
909 * or a new ClipData built from {@link #getData()}.</p>
910 *
911 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
912 * when the user makes a choice. This can be useful if the calling application wants
913 * to remember the last chosen target and surface it as a more prominent or one-touch
914 * affordance elsewhere in the UI for next time.</p>
915 *
916 * @param target The Intent that the user will be selecting an activity
917 * to perform.
918 * @param title Optional title that will be displayed in the chooser.
919 * @param sender Optional IntentSender to be called when a choice is made.
920 * @return Return a new Intent object that you can hand to
921 * {@link Context#startActivity(Intent) Context.startActivity()} and
922 * related methods.
923 */
924 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700925 Intent intent = new Intent(ACTION_CHOOSER);
926 intent.putExtra(EXTRA_INTENT, target);
927 if (title != null) {
928 intent.putExtra(EXTRA_TITLE, title);
929 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700930
Adam Powell0b3c1122014-10-09 12:50:14 -0700931 if (sender != null) {
932 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
933 }
934
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700935 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700936 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
937 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
938 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700939 if (permFlags != 0) {
940 ClipData targetClipData = target.getClipData();
941 if (targetClipData == null && target.getData() != null) {
942 ClipData.Item item = new ClipData.Item(target.getData());
943 String[] mimeTypes;
944 if (target.getType() != null) {
945 mimeTypes = new String[] { target.getType() };
946 } else {
947 mimeTypes = new String[] { };
948 }
949 targetClipData = new ClipData(null, mimeTypes, item);
950 }
951 if (targetClipData != null) {
952 intent.setClipData(targetClipData);
953 intent.addFlags(permFlags);
954 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700955 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700956
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700957 return intent;
958 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700959
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700960 /**
961 * Activity Action: Allow the user to select a particular kind of data and
962 * return it. This is different than {@link #ACTION_PICK} in that here we
963 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800964 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700965 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900966 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700967 * etc.
968 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900969 * 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 -0700970 * of data, such as a person contact, you set the MIME type to the kind of
971 * data you want and launch it with {@link Context#startActivity(Intent)}.
972 * The system will then launch the best application to select that kind
973 * of data for you.
974 * <p>
975 * You may also be interested in any of a set of types of content the user
976 * can pick. For example, an e-mail application that wants to allow the
977 * user to add an attachment to an e-mail message can use this action to
978 * bring up a list of all of the types of content the user can attach.
979 * <p>
980 * In this case, you should wrap the GET_CONTENT intent with a chooser
981 * (through {@link #createChooser}), which will give the proper interface
982 * for the user to pick how to send your data and allow you to specify
983 * a prompt indicating what they are doing. You will usually specify a
984 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
985 * broad range of content types the user can select from.
986 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900987 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700988 * only pick from data that can be represented as a stream. This is
989 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
990 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800991 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900992 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800993 * is locally available on the device. For example, if this extra is set
994 * to true then an image picker should not show any pictures that are available
995 * from a remote server but not already on the local device (thus requiring
996 * they be downloaded when opened).
997 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800998 * If the caller can handle multiple returned items (the user performing
999 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1000 * to indicate this.
1001 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001002 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1003 * that no URI is supplied in the intent, as there are no constraints on
1004 * where the returned data originally comes from. You may also include the
1005 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001006 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001007 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1008 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001009 * <p>
1010 * Output: The URI of the item that was picked. This must be a content:
1011 * URI so that any receiver can access it.
1012 */
1013 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1014 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1015 /**
1016 * Activity Action: Dial a number as specified by the data. This shows a
1017 * UI with the number being dialed, allowing the user to explicitly
1018 * initiate the call.
1019 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1020 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1021 * number.
1022 * <p>Output: nothing.
1023 */
1024 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1025 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1026 /**
1027 * Activity Action: Perform a call to someone specified by the data.
1028 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1029 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1030 * number.
1031 * <p>Output: nothing.
1032 *
1033 * <p>Note: there will be restrictions on which applications can initiate a
1034 * call; most applications should use the {@link #ACTION_DIAL}.
1035 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1036 * numbers. Applications can <strong>dial</strong> emergency numbers using
1037 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001038 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001039 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001040 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001041 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001042 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001043 */
1044 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1045 public static final String ACTION_CALL = "android.intent.action.CALL";
1046 /**
1047 * Activity Action: Perform a call to an emergency number specified by the
1048 * data.
1049 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1050 * tel: URI of an explicit phone number.
1051 * <p>Output: nothing.
1052 * @hide
1053 */
1054 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1055 /**
1056 * Activity action: Perform a call to any number (emergency or not)
1057 * specified by the data.
1058 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1059 * tel: URI of an explicit phone number.
1060 * <p>Output: nothing.
1061 * @hide
1062 */
1063 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1064 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001065 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1066 * sending this intent is a no-op.
1067 * <p>Input: No data should be specified. get*Extra may have an optional
1068 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1069 * send the activation result.
1070 * <p>Output: nothing.
1071 * @hide
1072 */
1073 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1074 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1075 "android.intent.action.SIM_ACTIVATION_REQUEST";
1076 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001077 * Activity Action: Send a message to someone specified by the data.
1078 * <p>Input: {@link #getData} is URI describing the target.
1079 * <p>Output: nothing.
1080 */
1081 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1082 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1083 /**
1084 * Activity Action: Deliver some data to someone else. Who the data is
1085 * being delivered to is not specified; it is up to the receiver of this
1086 * action to ask the user where the data should be sent.
1087 * <p>
1088 * When launching a SEND intent, you should usually wrap it in a chooser
1089 * (through {@link #createChooser}), which will give the proper interface
1090 * for the user to pick how to send your data and allow you to specify
1091 * a prompt indicating what they are doing.
1092 * <p>
1093 * Input: {@link #getType} is the MIME type of the data being sent.
1094 * get*Extra can have either a {@link #EXTRA_TEXT}
1095 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1096 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1097 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1098 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001099 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1100 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1101 * your text with HTML formatting.
1102 * <p>
1103 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1104 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1105 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1106 * content: URIs and other advanced features of {@link ClipData}. If
1107 * using this approach, you still must supply the same data through the
1108 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1109 * for compatibility with old applications. If you don't set a ClipData,
1110 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001111 * <p>
1112 * Optional standard extras, which may be interpreted by some recipients as
1113 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1114 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1115 * <p>
1116 * Output: nothing.
1117 */
1118 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1119 public static final String ACTION_SEND = "android.intent.action.SEND";
1120 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001121 * Activity Action: Deliver multiple data to someone else.
1122 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001123 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001124 * <p>
1125 * Input: {@link #getType} is the MIME type of the data being sent.
1126 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001127 * #EXTRA_STREAM} field, containing the data to be sent. If using
1128 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1129 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001130 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001131 * Multiple types are supported, and receivers should handle mixed types
1132 * whenever possible. The right way for the receiver to check them is to
1133 * use the content resolver on each URI. The intent sender should try to
1134 * put the most concrete mime type in the intent type, but it can fall
1135 * back to {@literal <type>/*} or {@literal *}/* as needed.
1136 * <p>
1137 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1138 * be image/jpg, but if you are sending image/jpg and image/png, then the
1139 * intent's type should be image/*.
1140 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001141 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1142 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1143 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1144 * content: URIs and other advanced features of {@link ClipData}. If
1145 * using this approach, you still must supply the same data through the
1146 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1147 * for compatibility with old applications. If you don't set a ClipData,
1148 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1149 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001150 * Optional standard extras, which may be interpreted by some recipients as
1151 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1152 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1153 * <p>
1154 * Output: nothing.
1155 */
1156 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1157 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1158 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001159 * Activity Action: Handle an incoming phone call.
1160 * <p>Input: nothing.
1161 * <p>Output: nothing.
1162 */
1163 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1164 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1165 /**
1166 * Activity Action: Insert an empty item into the given container.
1167 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1168 * in which to place the data.
1169 * <p>Output: URI of the new data that was created.
1170 */
1171 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1172 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1173 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001174 * Activity Action: Create a new item in the given container, initializing it
1175 * from the current contents of the clipboard.
1176 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1177 * in which to place the data.
1178 * <p>Output: URI of the new data that was created.
1179 */
1180 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1181 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1182 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001183 * Activity Action: Delete the given data from its container.
1184 * <p>Input: {@link #getData} is URI of data to be deleted.
1185 * <p>Output: nothing.
1186 */
1187 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1188 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1189 /**
1190 * Activity Action: Run the data, whatever that means.
1191 * <p>Input: ? (Note: this is currently specific to the test harness.)
1192 * <p>Output: nothing.
1193 */
1194 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1195 public static final String ACTION_RUN = "android.intent.action.RUN";
1196 /**
1197 * Activity Action: Perform a data synchronization.
1198 * <p>Input: ?
1199 * <p>Output: ?
1200 */
1201 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1202 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1203 /**
1204 * Activity Action: Pick an activity given an intent, returning the class
1205 * selected.
1206 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1207 * used with {@link PackageManager#queryIntentActivities} to determine the
1208 * set of activities from which to pick.
1209 * <p>Output: Class name of the activity that was selected.
1210 */
1211 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1212 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1213 /**
1214 * Activity Action: Perform a search.
1215 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1216 * is the text to search for. If empty, simply
1217 * enter your search results Activity with the search UI activated.
1218 * <p>Output: nothing.
1219 */
1220 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1221 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1222 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001223 * Activity Action: Start the platform-defined tutorial
1224 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1225 * is the text to search for. If empty, simply
1226 * enter your search results Activity with the search UI activated.
1227 * <p>Output: nothing.
1228 */
1229 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1230 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1231 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001232 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001233 * <p>
1234 * Input: {@link android.app.SearchManager#QUERY
1235 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1236 * a url starts with http or https, the site will be opened. If it is plain
1237 * text, Google search will be applied.
1238 * <p>
1239 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001240 */
1241 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1242 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001243
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001244 /**
Jim Miller07994402012-05-02 14:22:27 -07001245 * Activity Action: Perform assist action.
1246 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001247 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1248 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001249 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1250 * information.
Jim Miller07994402012-05-02 14:22:27 -07001251 * Output: nothing.
1252 */
1253 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1254 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001255
1256 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001257 * Activity Action: Perform voice assist action.
1258 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001259 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1260 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001261 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001262 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001263 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001264 */
1265 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1266 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1267
1268 /**
Adam Skory7140a252013-09-11 12:04:58 +01001269 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1270 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001271 */
1272 public static final String EXTRA_ASSIST_PACKAGE
1273 = "android.intent.extra.ASSIST_PACKAGE";
1274
1275 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001276 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1277 * application package at the time the assist was invoked.
1278 */
1279 public static final String EXTRA_ASSIST_UID
1280 = "android.intent.extra.ASSIST_UID";
1281
1282 /**
Adam Skory7140a252013-09-11 12:04:58 +01001283 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1284 * information supplied by the current foreground app at the time of the assist request.
1285 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001286 */
1287 public static final String EXTRA_ASSIST_CONTEXT
1288 = "android.intent.extra.ASSIST_CONTEXT";
1289
Jim Miller07994402012-05-02 14:22:27 -07001290 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001291 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1292 * keyboard as the primary input device for assistance.
1293 */
1294 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1295 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1296
1297 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001298 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1299 * that was used to invoke the assist.
1300 */
1301 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1302 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1303
1304 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001305 * Activity Action: List all available applications
1306 * <p>Input: Nothing.
1307 * <p>Output: nothing.
1308 */
1309 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1310 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1311 /**
1312 * Activity Action: Show settings for choosing wallpaper
1313 * <p>Input: Nothing.
1314 * <p>Output: Nothing.
1315 */
1316 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1317 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1318
1319 /**
1320 * Activity Action: Show activity for reporting a bug.
1321 * <p>Input: Nothing.
1322 * <p>Output: Nothing.
1323 */
1324 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1325 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1326
1327 /**
1328 * Activity Action: Main entry point for factory tests. Only used when
1329 * the device is booting in factory test node. The implementing package
1330 * must be installed in the system image.
1331 * <p>Input: nothing
1332 * <p>Output: nothing
1333 */
1334 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1335
1336 /**
1337 * Activity Action: The user pressed the "call" button to go to the dialer
1338 * or other appropriate UI for placing a call.
1339 * <p>Input: Nothing.
1340 * <p>Output: Nothing.
1341 */
1342 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1343 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1344
1345 /**
1346 * Activity Action: Start Voice Command.
1347 * <p>Input: Nothing.
1348 * <p>Output: Nothing.
1349 */
1350 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1351 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001352
1353 /**
1354 * Activity Action: Start action associated with long pressing on the
1355 * search key.
1356 * <p>Input: Nothing.
1357 * <p>Output: Nothing.
1358 */
1359 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1360 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001361
Jacek Surazski86b6c532009-05-13 14:38:28 +02001362 /**
1363 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1364 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001365 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001366 * <p>Input: No data is specified. The bug report is passed in using
1367 * an {@link #EXTRA_BUG_REPORT} field.
1368 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001369 *
1370 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001371 */
1372 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1373 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001374
1375 /**
1376 * Activity Action: Show power usage information to the user.
1377 * <p>Input: Nothing.
1378 * <p>Output: Nothing.
1379 */
1380 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1381 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001382
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001383 /**
1384 * Activity Action: Setup wizard to launch after a platform update. This
1385 * activity should have a string meta-data field associated with it,
1386 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1387 * the platform for setup. The activity will be launched only if
1388 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1389 * same value.
1390 * <p>Input: Nothing.
1391 * <p>Output: Nothing.
1392 * @hide
1393 */
1394 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1395 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001396
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001397 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001398 * Activity Action: Show settings for managing network data usage of a
1399 * specific application. Applications should define an activity that offers
1400 * options to control data usage.
1401 */
1402 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1403 public static final String ACTION_MANAGE_NETWORK_USAGE =
1404 "android.intent.action.MANAGE_NETWORK_USAGE";
1405
1406 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001407 * Activity Action: Launch application installer.
1408 * <p>
1409 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001410 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1411 * you can also use "package:<package-name>" to install an application for the
1412 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001413 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1414 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1415 * <p>
1416 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1417 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001418 * <p>
1419 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1420 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1421 * in order to launch the application installer.
1422 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001423 *
1424 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1425 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1426 * @see #EXTRA_RETURN_RESULT
1427 */
1428 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1429 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1430
1431 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001432 * Activity Action: Launch ephemeral installer.
1433 * <p>
1434 * Input: The data must be a http: URI that the ephemeral application is registered
1435 * to handle.
1436 * <p class="note">
1437 * This is a protected intent that can only be sent by the system.
1438 * </p>
1439 *
1440 * @hide
1441 */
1442 @SystemApi
1443 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1444 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1445 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1446
1447 /**
1448 * Service Action: Resolve ephemeral application.
1449 * <p>
1450 * The system will have a persistent connection to this service.
1451 * This is a protected intent that can only be sent by the system.
1452 * </p>
1453 *
1454 * @hide
1455 */
1456 @SystemApi
1457 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1458 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1459 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1460
1461 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001462 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1463 * package. Specifies the installer package name; this package will receive the
1464 * {@link #ACTION_APP_ERROR} intent.
1465 */
1466 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1467 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1468
1469 /**
1470 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1471 * package. Specifies that the application being installed should not be
1472 * treated as coming from an unknown source, but as coming from the app
1473 * invoking the Intent. For this to work you must start the installer with
1474 * startActivityForResult().
1475 */
1476 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1477 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1478
1479 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001480 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1481 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001482 * data field originated from.
1483 */
rich cannings706e8ba2012-08-20 13:20:14 -07001484 public static final String EXTRA_ORIGINATING_URI
1485 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001486
1487 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001488 * This extra can be used with any Intent used to launch an activity, supplying information
1489 * about who is launching that activity. This field contains a {@link android.net.Uri}
1490 * object, typically an http: or https: URI of the web site that the referral came from;
1491 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1492 * a native application that it came from.
1493 *
1494 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1495 * instead of directly retrieving the extra. It is also valid for applications to
1496 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1497 * a string, not a Uri; the field here, if supplied, will always take precedence,
1498 * however.</p>
1499 *
1500 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001501 */
1502 public static final String EXTRA_REFERRER
1503 = "android.intent.extra.REFERRER";
1504
1505 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001506 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1507 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1508 * not be created, in particular when Intent extras are supplied through the
1509 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1510 * schemes.
1511 *
1512 * @see #EXTRA_REFERRER
1513 */
1514 public static final String EXTRA_REFERRER_NAME
1515 = "android.intent.extra.REFERRER_NAME";
1516
1517 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001518 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1519 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1520 * @hide
1521 */
1522 public static final String EXTRA_ORIGINATING_UID
1523 = "android.intent.extra.ORIGINATING_UID";
1524
1525 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001526 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1527 * package. Tells the installer UI to skip the confirmation with the user
1528 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001529 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1530 * will no longer show an interstitial message about updating existing
1531 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001532 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001533 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001534 public static final String EXTRA_ALLOW_REPLACE
1535 = "android.intent.extra.ALLOW_REPLACE";
1536
1537 /**
1538 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1539 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1540 * return to the application the result code of the install/uninstall. The returned result
1541 * code will be {@link android.app.Activity#RESULT_OK} on success or
1542 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1543 */
1544 public static final String EXTRA_RETURN_RESULT
1545 = "android.intent.extra.RETURN_RESULT";
1546
1547 /**
1548 * Package manager install result code. @hide because result codes are not
1549 * yet ready to be exposed.
1550 */
1551 public static final String EXTRA_INSTALL_RESULT
1552 = "android.intent.extra.INSTALL_RESULT";
1553
1554 /**
1555 * Activity Action: Launch application uninstaller.
1556 * <p>
1557 * Input: The data must be a package: URI whose scheme specific part is
1558 * the package name of the current installed package to be uninstalled.
1559 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1560 * <p>
1561 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1562 * succeeded.
1563 */
1564 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1565 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1566
1567 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001568 * Specify whether the package should be uninstalled for all users.
1569 * @hide because these should not be part of normal application flow.
1570 */
1571 public static final String EXTRA_UNINSTALL_ALL_USERS
1572 = "android.intent.extra.UNINSTALL_ALL_USERS";
1573
1574 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001575 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1576 * describing the last run version of the platform that was setup.
1577 * @hide
1578 */
1579 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1580
Svet Ganov3695b8a2015-03-24 16:30:25 -07001581 /**
1582 * Activity action: Launch UI to manage the permissions of an app.
1583 * <p>
1584 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1585 * will be managed by the launched UI.
1586 * </p>
1587 * <p>
1588 * Output: Nothing.
1589 * </p>
1590 *
1591 * @see #EXTRA_PACKAGE_NAME
1592 *
1593 * @hide
1594 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001595 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1596 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1597 "android.intent.action.MANAGE_APP_PERMISSIONS";
1598
1599 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001600 * Activity action: Launch UI to manage permissions.
1601 * <p>
1602 * Input: Nothing.
1603 * </p>
1604 * <p>
1605 * Output: Nothing.
1606 * </p>
1607 *
1608 * @hide
1609 */
Svet Ganov321f0152015-05-16 22:51:50 -07001610 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1611 public static final String ACTION_MANAGE_PERMISSIONS =
1612 "android.intent.action.MANAGE_PERMISSIONS";
1613
1614 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001615 * Activity action: Launch UI to review permissions for an app.
1616 * The system uses this intent if permission review for apps not
1617 * supporting the new runtime permissions model is enabled. In
1618 * this mode a permission review is required before any of the
1619 * app components can run.
1620 * <p>
1621 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1622 * permissions will be reviewed (mandatory).
1623 * </p>
1624 * <p>
1625 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1626 * be fired after the permission review (optional).
1627 * </p>
1628 * <p>
1629 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1630 * be invoked after the permission review (optional).
1631 * </p>
1632 * <p>
1633 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1634 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1635 * </p>
1636 * <p>
1637 * Output: Nothing.
1638 * </p>
1639 *
1640 * @see #EXTRA_PACKAGE_NAME
1641 * @see #EXTRA_INTENT
1642 * @see #EXTRA_REMOTE_CALLBACK
1643 * @see #EXTRA_RESULT_NEEDED
1644 *
1645 * @hide
1646 */
1647 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1648 public static final String ACTION_REVIEW_PERMISSIONS =
1649 "android.intent.action.REVIEW_PERMISSIONS";
1650
1651 /**
1652 * Intent extra: A callback for reporting remote result as a bundle.
1653 * <p>
1654 * Type: IRemoteCallback
1655 * </p>
1656 *
1657 * @hide
1658 */
1659 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1660
1661 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001662 * Intent extra: An app package name.
1663 * <p>
1664 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001665 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001666 *
1667 * @hide
1668 */
1669 @SystemApi
1670 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1671
1672 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001673 * Intent extra: An extra for specifying whether a result is needed.
1674 * <p>
1675 * Type: boolean
1676 * </p>
1677 *
1678 * @hide
1679 */
1680 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1681
1682 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001683 * Broadcast action that requests current permission granted information. It will respond
1684 * to the request by sending a broadcast with action defined by
1685 * {@link #EXTRA_GET_PERMISSIONS_RESPONSE_INTENT}. The response will contain
Makoto Onukibbb912a2015-06-05 16:27:23 -07001686 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}, as well as
1687 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}, with contents described below or
1688 * a null upon failure.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001689 *
Makoto Onukibbb912a2015-06-05 16:27:23 -07001690 * <p>If {@link #EXTRA_PACKAGE_NAME} is included then the number of permissions granted, the
1691 * number of permissions requested and the number of granted additional permissions
1692 * by that package will be calculated and included as the first
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001693 * and second elements respectively of an int[] in the response as
Makoto Onukibbb912a2015-06-05 16:27:23 -07001694 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}. The response will also deliver the list
1695 * of localized permission group names that are granted in
1696 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001697 *
1698 * <p>If {@link #EXTRA_PACKAGE_NAME} is not included then the number of apps granted any runtime
1699 * permissions and the total number of apps requesting runtime permissions will be the first
1700 * and second elements respectively of an int[] in the response as
1701 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1702 *
1703 * @hide
1704 */
1705 public static final String ACTION_GET_PERMISSIONS_COUNT
1706 = "android.intent.action.GET_PERMISSIONS_COUNT";
1707
1708 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001709 * Broadcast action that requests list of all apps that have runtime permissions. It will
1710 * respond to the request by sending a broadcast with action defined by
1711 * {@link #EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT}. The response will contain
1712 * {@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT}, as well as
1713 * {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}, with contents described below or
1714 * a null upon failure.
1715 *
1716 * <p>{@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT} will contain a list of package names of
1717 * apps that have runtime permissions. {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}
1718 * will contain the list of app labels corresponding ot the apps in the first list.
1719 *
1720 * @hide
1721 */
1722 public static final String ACTION_GET_PERMISSIONS_PACKAGES
1723 = "android.intent.action.GET_PERMISSIONS_PACKAGES";
1724
1725 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001726 * Extra included in response to {@link #ACTION_GET_PERMISSIONS_COUNT}.
1727 * @hide
1728 */
1729 public static final String EXTRA_GET_PERMISSIONS_COUNT_RESULT
1730 = "android.intent.extra.GET_PERMISSIONS_COUNT_RESULT";
1731
1732 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001733 * List of CharSequence of localized permission group labels.
1734 * @hide
1735 */
1736 public static final String EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT
1737 = "android.intent.extra.GET_PERMISSIONS_GROUP_LIST_RESULT";
1738
1739 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001740 * String list of apps that have one or more runtime permissions.
1741 * @hide
1742 */
1743 public static final String EXTRA_GET_PERMISSIONS_APP_LIST_RESULT
1744 = "android.intent.extra.GET_PERMISSIONS_APP_LIST_RESULT";
1745
1746 /**
1747 * String list of app labels for apps that have one or more runtime permissions.
1748 * @hide
1749 */
1750 public static final String EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT
1751 = "android.intent.extra.GET_PERMISSIONS_APP_LABEL_LIST_RESULT";
1752
1753 /**
Anthony Hugh3575a402015-10-26 17:47:05 -07001754 * Boolean list describing if the app is a system app for apps that have one or more runtime
1755 * permissions.
1756 * @hide
1757 */
1758 public static final String EXTRA_GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT
1759 = "android.intent.extra.GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT";
1760
1761 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001762 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_COUNT} broadcasts.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001763 * @hide
1764 */
1765 public static final String EXTRA_GET_PERMISSIONS_RESPONSE_INTENT
1766 = "android.intent.extra.GET_PERMISSIONS_RESONSE_INTENT";
1767
1768 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001769 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_PACKAGES} broadcasts.
1770 * @hide
1771 */
1772 public static final String EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT
1773 = "android.intent.extra.GET_PERMISSIONS_PACKAGES_RESONSE_INTENT";
1774
1775 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001776 * Activity action: Launch UI to manage which apps have a given permission.
1777 * <p>
1778 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1779 * to which will be managed by the launched UI.
1780 * </p>
1781 * <p>
1782 * Output: Nothing.
1783 * </p>
1784 *
1785 * @see #EXTRA_PERMISSION_NAME
1786 *
1787 * @hide
1788 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001789 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1790 public static final String ACTION_MANAGE_PERMISSION_APPS =
1791 "android.intent.action.MANAGE_PERMISSION_APPS";
1792
1793 /**
1794 * Intent extra: The name of a permission.
1795 * <p>
1796 * Type: String
1797 * </p>
1798 *
1799 * @hide
1800 */
1801 @SystemApi
1802 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1803
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001804 // ---------------------------------------------------------------------
1805 // ---------------------------------------------------------------------
1806 // Standard intent broadcast actions (see action variable).
1807
1808 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001809 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1810 * <p>
1811 * For historical reasons, the name of this broadcast action refers to the power
1812 * state of the screen but it is actually sent in response to changes in the
1813 * overall interactive state of the device.
1814 * </p><p>
1815 * This broadcast is sent when the device becomes non-interactive which may have
1816 * nothing to do with the screen turning off. To determine the
1817 * actual state of the screen, use {@link android.view.Display#getState}.
1818 * </p><p>
1819 * See {@link android.os.PowerManager#isInteractive} for details.
1820 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001821 * You <em>cannot</em> receive this through components declared in
1822 * manifests, only by explicitly registering for it with
1823 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1824 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001825 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001826 * <p class="note">This is a protected intent that can only be sent
1827 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001828 */
1829 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1830 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001831
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001832 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001833 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1834 * <p>
1835 * For historical reasons, the name of this broadcast action refers to the power
1836 * state of the screen but it is actually sent in response to changes in the
1837 * overall interactive state of the device.
1838 * </p><p>
1839 * This broadcast is sent when the device becomes interactive which may have
1840 * nothing to do with the screen turning on. To determine the
1841 * actual state of the screen, use {@link android.view.Display#getState}.
1842 * </p><p>
1843 * See {@link android.os.PowerManager#isInteractive} for details.
1844 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001845 * You <em>cannot</em> receive this through components declared in
1846 * manifests, only by explicitly registering for it with
1847 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1848 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001849 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001850 * <p class="note">This is a protected intent that can only be sent
1851 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001852 */
1853 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1854 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001855
1856 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001857 * Broadcast Action: Sent after the system stops dreaming.
1858 *
1859 * <p class="note">This is a protected intent that can only be sent by the system.
1860 * It is only sent to registered receivers.</p>
1861 */
1862 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1863 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1864
1865 /**
1866 * Broadcast Action: Sent after the system starts dreaming.
1867 *
1868 * <p class="note">This is a protected intent that can only be sent by the system.
1869 * It is only sent to registered receivers.</p>
1870 */
1871 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1872 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1873
1874 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001875 * 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 -07001876 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001877 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001878 * <p class="note">This is a protected intent that can only be sent
1879 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001880 */
1881 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001882 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001883
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001884 /**
1885 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001886 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001887 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001888 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1889 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001890 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001891 * <p class="note">This is a protected intent that can only be sent
1892 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001893 */
1894 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1895 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1896 /**
1897 * Broadcast Action: The time was set.
1898 */
1899 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1900 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1901 /**
1902 * Broadcast Action: The date has changed.
1903 */
1904 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1905 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1906 /**
1907 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1908 * <ul>
1909 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1910 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001911 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001912 * <p class="note">This is a protected intent that can only be sent
1913 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001914 */
1915 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1916 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1917 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001918 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1919 * DNS entries should be tossed.
1920 * @hide
1921 */
1922 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1923 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1924 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001925 * Alarm Changed Action: This is broadcast when the AlarmClock
1926 * application's alarm is set or unset. It is used by the
1927 * AlarmClock application and the StatusBar service.
1928 * @hide
1929 */
1930 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1931 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001932
1933 /**
1934 * Broadcast Action: This is broadcast once, after the system has finished
1935 * booting and the user is in a "locked" state. A user is locked when their
1936 * credential-encrypted private app data storage is unavailable. Once the
1937 * user has entered their credentials (such as a lock pattern or PIN) for
1938 * the first time, the {@link #ACTION_BOOT_COMPLETED} broadcast will be
1939 * sent.
1940 * <p>
1941 * You must hold the
1942 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1943 * order to receive this broadcast.
1944 * <p class="note">
1945 * This is a protected intent that can only be sent by the system.
1946 */
1947 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1948 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1949
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001950 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001951 * Broadcast Action: This is broadcast once, after the system has finished
1952 * booting. It can be used to perform application-specific initialization,
1953 * such as installing alarms. You must hold the
1954 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1955 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001956 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001957 * <p class="note">This is a protected intent that can only be sent
1958 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001959 */
1960 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1961 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001962
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001963 /**
1964 * Broadcast Action: This is broadcast when a user action should request a
1965 * temporary system dialog to dismiss. Some examples of temporary system
1966 * dialogs are the notification window-shade and the recent tasks dialog.
1967 */
1968 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1969 /**
1970 * Broadcast Action: Trigger the download and eventual installation
1971 * of a package.
1972 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001973 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001974 * <p class="note">This is a protected intent that can only be sent
1975 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001976 *
1977 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001978 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001979 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001980 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1981 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1982 /**
1983 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001984 * device. The data contains the name of the package. Note that the
1985 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001986 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001987 * <ul>
1988 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1989 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1990 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1991 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001992 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001993 * <p class="note">This is a protected intent that can only be sent
1994 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001995 */
1996 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1997 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1998 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001999 * Broadcast Action: A new version of an application package has been
2000 * installed, replacing an existing version that was previously installed.
2001 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002002 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002003 * <ul>
2004 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2005 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002006 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002007 * <p class="note">This is a protected intent that can only be sent
2008 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002009 */
2010 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2011 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2012 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002013 * Broadcast Action: A new version of your application has been installed
2014 * over an existing one. This is only sent to the application that was
2015 * replaced. It does not contain any additional data; to receive it, just
2016 * use an intent filter for this action.
2017 *
2018 * <p class="note">This is a protected intent that can only be sent
2019 * by the system.
2020 */
2021 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2022 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2023 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002024 * Broadcast Action: An existing application package has been removed from
2025 * the device. The data contains the name of the package. The package
2026 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002027 * <ul>
2028 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2029 * to the package.
2030 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2031 * application -- data and code -- is being removed.
2032 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2033 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2034 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002035 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002036 * <p class="note">This is a protected intent that can only be sent
2037 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002038 */
2039 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2040 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2041 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002042 * Broadcast Action: An existing application package has been completely
2043 * removed from the device. The data contains the name of the package.
2044 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2045 * {@link #EXTRA_DATA_REMOVED} is true and
2046 * {@link #EXTRA_REPLACING} is false of that broadcast.
2047 *
2048 * <ul>
2049 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2050 * to the package.
2051 * </ul>
2052 *
2053 * <p class="note">This is a protected intent that can only be sent
2054 * by the system.
2055 */
2056 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2057 public static final String ACTION_PACKAGE_FULLY_REMOVED
2058 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2059 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002060 * Broadcast Action: An existing application package has been changed (e.g.
2061 * a component has been enabled or disabled). The data contains the name of
2062 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002063 * <ul>
2064 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002065 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002066 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002067 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2068 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002069 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002070 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002071 * <p class="note">This is a protected intent that can only be sent
2072 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002073 */
2074 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2075 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2076 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002077 * @hide
2078 * Broadcast Action: Ask system services if there is any reason to
2079 * restart the given package. The data contains the name of the
2080 * package.
2081 * <ul>
2082 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2083 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2084 * </ul>
2085 *
2086 * <p class="note">This is a protected intent that can only be sent
2087 * by the system.
2088 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002089 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002090 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2091 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2092 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002093 * Broadcast Action: The user has restarted a package, and all of its
2094 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002095 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002096 * be removed. Note that the restarted package does <em>not</em>
2097 * receive this broadcast.
2098 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002099 * <ul>
2100 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2101 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002102 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002103 * <p class="note">This is a protected intent that can only be sent
2104 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002105 */
2106 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2107 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2108 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002109 * Broadcast Action: The user has cleared the data of a package. This should
2110 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002111 * its persistent data is erased and this broadcast sent.
2112 * Note that the cleared package does <em>not</em>
2113 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002114 * <ul>
2115 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2116 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002117 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002118 * <p class="note">This is a protected intent that can only be sent
2119 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002120 */
2121 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2122 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2123 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002124 * Broadcast Action: Packages have been suspended.
2125 * <p>Includes the following extras:
2126 * <ul>
2127 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2128 * </ul>
2129 *
2130 * <p class="note">This is a protected intent that can only be sent
2131 * by the system. It is only sent to registered receivers.
2132 */
2133 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2134 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2135 /**
2136 * Broadcast Action: Packages have been unsuspended.
2137 * <p>Includes the following extras:
2138 * <ul>
2139 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2140 * </ul>
2141 *
2142 * <p class="note">This is a protected intent that can only be sent
2143 * by the system. It is only sent to registered receivers.
2144 */
2145 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2146 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2147 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002148 * Broadcast Action: A user ID has been removed from the system. The user
2149 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002150 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002151 * <p class="note">This is a protected intent that can only be sent
2152 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002153 */
2154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2155 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002156
2157 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002158 * Broadcast Action: Sent to the installer package of an application
2159 * when that application is first launched (that is the first time it
2160 * is moved out of the stopped state). The data contains the name of the package.
2161 *
2162 * <p class="note">This is a protected intent that can only be sent
2163 * by the system.
2164 */
2165 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2166 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2167
2168 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002169 * Broadcast Action: Sent to the system package verifier when a package
2170 * needs to be verified. The data contains the package URI.
2171 * <p class="note">
2172 * This is a protected intent that can only be sent by the system.
2173 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002174 */
2175 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2176 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2177
2178 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002179 * Broadcast Action: Sent to the system package verifier when a package is
2180 * verified. The data contains the package URI.
2181 * <p class="note">
2182 * This is a protected intent that can only be sent by the system.
2183 */
2184 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2185 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2186
2187 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002188 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
2189 * needs to be verified. The data contains the filter data hosts to be verified against.
2190 * <p class="note">
2191 * This is a protected intent that can only be sent by the system.
2192 * </p>
2193 *
2194 * @hide
2195 */
2196 @SystemApi
2197 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2198 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2199
2200 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002201 * Broadcast Action: Resources for a set of packages (which were
2202 * previously unavailable) are currently
2203 * available since the media on which they exist is available.
2204 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2205 * list of packages whose availability changed.
2206 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2207 * list of uids of packages whose availability changed.
2208 * Note that the
2209 * packages in this list do <em>not</em> receive this broadcast.
2210 * The specified set of packages are now available on the system.
2211 * <p>Includes the following extras:
2212 * <ul>
2213 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2214 * whose resources(were previously unavailable) are currently available.
2215 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2216 * packages whose resources(were previously unavailable)
2217 * are currently available.
2218 * </ul>
2219 *
2220 * <p class="note">This is a protected intent that can only be sent
2221 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002222 */
2223 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002224 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2225 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002226
2227 /**
2228 * Broadcast Action: Resources for a set of packages are currently
2229 * unavailable since the media on which they exist is unavailable.
2230 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2231 * list of packages whose availability changed.
2232 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2233 * list of uids of packages whose availability changed.
2234 * The specified set of packages can no longer be
2235 * launched and are practically unavailable on the system.
2236 * <p>Inclues the following extras:
2237 * <ul>
2238 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2239 * whose resources are no longer available.
2240 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2241 * whose resources are no longer available.
2242 * </ul>
2243 *
2244 * <p class="note">This is a protected intent that can only be sent
2245 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002246 */
2247 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002248 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002249 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002250
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002251 /**
2252 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002253 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002254 * This should <em>only</em> be used to determine when the wallpaper
2255 * has changed to show the new wallpaper to the user. You should certainly
2256 * never, in response to this, change the wallpaper or other attributes of
2257 * it such as the suggested size. That would be crazy, right? You'd cause
2258 * all kinds of loops, especially if other apps are doing similar things,
2259 * right? Of course. So please don't do this.
2260 *
2261 * @deprecated Modern applications should use
2262 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2263 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2264 * shown behind their UI, rather than watching for this broadcast and
2265 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002266 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002267 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002268 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2269 /**
2270 * Broadcast Action: The current device {@link android.content.res.Configuration}
2271 * (orientation, locale, etc) has changed. When such a change happens, the
2272 * UIs (view hierarchy) will need to be rebuilt based on this new
2273 * information; for the most part, applications don't need to worry about
2274 * this, because the system will take care of stopping and restarting the
2275 * application to make sure it sees the new changes. Some system code that
2276 * can not be restarted will need to watch for this action and handle it
2277 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002278 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002279 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002280 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002281 * in manifests, only by explicitly registering for it with
2282 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2283 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002284 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002285 * <p class="note">This is a protected intent that can only be sent
2286 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002287 *
2288 * @see android.content.res.Configuration
2289 */
2290 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2291 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2292 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002293 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002294 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002295 * <p class="note">This is a protected intent that can only be sent
2296 * by the system.
2297 */
2298 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2299 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2300 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002301 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2302 * charging state, level, and other information about the battery.
2303 * See {@link android.os.BatteryManager} for documentation on the
2304 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002305 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002306 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002307 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002308 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002309 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002310 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2311 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2312 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2313 * broadcasts that are sent and can be received through manifest
2314 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002315 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002316 * <p class="note">This is a protected intent that can only be sent
2317 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002318 */
2319 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2320 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2321 /**
2322 * Broadcast Action: Indicates low battery condition on the device.
2323 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002324 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002325 * <p class="note">This is a protected intent that can only be sent
2326 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002327 */
2328 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2329 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2330 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002331 * Broadcast Action: Indicates the battery is now okay after being low.
2332 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2333 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002334 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002335 * <p class="note">This is a protected intent that can only be sent
2336 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002337 */
2338 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2339 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2340 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002341 * Broadcast Action: External power has been connected to the device.
2342 * This is intended for applications that wish to register specifically to this notification.
2343 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2344 * stay active to receive this notification. This action can be used to implement actions
2345 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002346 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002347 * <p class="note">This is a protected intent that can only be sent
2348 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002349 */
2350 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002351 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002352 /**
2353 * Broadcast Action: External power has been removed from the device.
2354 * This is intended for applications that wish to register specifically to this notification.
2355 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2356 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002357 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002358 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002359 * <p class="note">This is a protected intent that can only be sent
2360 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002361 */
2362 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002363 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002364 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002365 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002366 * Broadcast Action: Device is shutting down.
2367 * This is broadcast when the device is being shut down (completely turned
2368 * off, not sleeping). Once the broadcast is complete, the final shutdown
2369 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002370 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002371 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002372 * <p class="note">This is a protected intent that can only be sent
2373 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002374 * <p>May include the following extras:
2375 * <ul>
2376 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2377 * shutdown is only for userspace processes. If not set, assumed to be false.
2378 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002379 */
2380 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002381 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002382 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002383 * Activity Action: Start this activity to request system shutdown.
2384 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002385 * to request confirmation from the user before shutting down. The optional boolean
2386 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2387 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002388 *
2389 * <p class="note">This is a protected intent that can only be sent
2390 * by the system.
2391 *
2392 * {@hide}
2393 */
2394 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2395 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002396 * Broadcast Action: A sticky broadcast that indicates low memory
2397 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002398 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002399 * <p class="note">This is a protected intent that can only be sent
2400 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002401 */
2402 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2403 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2404 /**
2405 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002406 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002407 * <p class="note">This is a protected intent that can only be sent
2408 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002409 */
2410 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2411 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2412 /**
Jake Hambybb371632010-08-23 18:16:48 -07002413 * Broadcast Action: A sticky broadcast that indicates a memory full
2414 * condition on the device. This is intended for activities that want
2415 * to be able to fill the data partition completely, leaving only
2416 * enough free space to prevent system-wide SQLite failures.
2417 *
2418 * <p class="note">This is a protected intent that can only be sent
2419 * by the system.
2420 *
2421 * {@hide}
2422 */
2423 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2424 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2425 /**
2426 * Broadcast Action: Indicates memory full condition on the device
2427 * no longer exists.
2428 *
2429 * <p class="note">This is a protected intent that can only be sent
2430 * by the system.
2431 *
2432 * {@hide}
2433 */
2434 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2435 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2436 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002437 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2438 * and package management should be started.
2439 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2440 * notification.
2441 */
2442 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2443 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2444 /**
2445 * Broadcast Action: The device has entered USB Mass Storage mode.
2446 * This is used mainly for the USB Settings panel.
2447 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2448 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002449 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002450 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002451 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002452 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2453
2454 /**
2455 * Broadcast Action: The device has exited USB Mass Storage mode.
2456 * This is used mainly for the USB Settings panel.
2457 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2458 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002459 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002460 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002461 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002462 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2463
2464 /**
2465 * Broadcast Action: External media has been removed.
2466 * The path to the mount point for the removed media is contained in the Intent.mData field.
2467 */
2468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2469 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2470
2471 /**
2472 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002473 * 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 -07002474 */
2475 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2476 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2477
2478 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002479 * Broadcast Action: External media is present, and being disk-checked
2480 * 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 -08002481 */
2482 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2483 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2484
2485 /**
2486 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2487 * 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 -08002488 */
2489 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2490 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2491
2492 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002493 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002494 * 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 -07002495 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2496 * media was mounted read only.
2497 */
2498 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2499 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2500
2501 /**
2502 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002503 * 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 -07002504 */
2505 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2506 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2507
2508 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002509 * Broadcast Action: External media is no longer being shared via USB mass storage.
2510 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2511 *
2512 * @hide
2513 */
2514 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2515
2516 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002517 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2518 * The path to the mount point for the removed media is contained in the Intent.mData field.
2519 */
2520 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2521 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2522
2523 /**
2524 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002525 * 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 -07002526 */
2527 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2528 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2529
2530 /**
2531 * Broadcast Action: User has expressed the desire to remove the external storage media.
2532 * Applications should close all files they have open within the mount point when they receive this intent.
2533 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2534 */
2535 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2536 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2537
2538 /**
2539 * Broadcast Action: The media scanner has started scanning a directory.
2540 * The path to the directory being scanned is contained in the Intent.mData field.
2541 */
2542 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2543 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2544
2545 /**
2546 * Broadcast Action: The media scanner has finished scanning a directory.
2547 * The path to the scanned directory is contained in the Intent.mData field.
2548 */
2549 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2550 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2551
2552 /**
2553 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2554 * The path to the file is contained in the Intent.mData field.
2555 */
2556 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2557 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2558
2559 /**
2560 * Broadcast Action: The "Media Button" was pressed. Includes a single
2561 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2562 * caused the broadcast.
2563 */
2564 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2565 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2566
Jaewan Kim52632e22016-01-14 18:01:52 +09002567 /**
2568 * Broadcast Action: The "Picture-in-picture (PIP) Button" was pressed.
2569 * Includes a single extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2570 * caused the broadcast.
2571 * @hide
2572 */
2573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2574 public static final String ACTION_PICTURE_IN_PICTURE_BUTTON =
2575 "android.intent.action.PICTURE_IN_PICTURE_BUTTON";
2576
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002577 /**
2578 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2579 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2580 * caused the broadcast.
2581 */
2582 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2583 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2584
2585 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2586 // location; they are not general-purpose actions.
2587
2588 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002589 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002590 */
2591 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2592 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2593 "android.intent.action.GTALK_CONNECTED";
2594
2595 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002596 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002597 */
2598 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2599 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2600 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002601
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002602 /**
2603 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002604 */
2605 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2606 public static final String ACTION_INPUT_METHOD_CHANGED =
2607 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002608
2609 /**
2610 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2611 * more radios have been turned off or on. The intent will have the following extra value:</p>
2612 * <ul>
2613 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2614 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2615 * turned off</li>
2616 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002617 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002618 * <p class="note">This is a protected intent that can only be sent
2619 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002620 */
2621 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2622 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2623
2624 /**
2625 * Broadcast Action: Some content providers have parts of their namespace
2626 * where they publish new events or items that the user may be especially
2627 * interested in. For these things, they may broadcast this action when the
2628 * set of interesting items change.
2629 *
2630 * For example, GmailProvider sends this notification when the set of unread
2631 * mail in the inbox changes.
2632 *
2633 * <p>The data of the intent identifies which part of which provider
2634 * changed. When queried through the content resolver, the data URI will
2635 * return the data set in question.
2636 *
2637 * <p>The intent will have the following extra values:
2638 * <ul>
2639 * <li><em>count</em> - The number of items in the data set. This is the
2640 * same as the number of items in the cursor returned by querying the
2641 * data URI. </li>
2642 * </ul>
2643 *
2644 * This intent will be sent at boot (if the count is non-zero) and when the
2645 * data set changes. It is possible for the data set to change without the
2646 * count changing (for example, if a new unread message arrives in the same
2647 * sync operation in which a message is archived). The phone should still
2648 * ring/vibrate/etc as normal in this case.
2649 */
2650 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2651 public static final String ACTION_PROVIDER_CHANGED =
2652 "android.intent.action.PROVIDER_CHANGED";
2653
2654 /**
2655 * Broadcast Action: Wired Headset plugged in or unplugged.
2656 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002657 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2658 * and documentation.
2659 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002660 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002661 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002662 */
2663 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002664 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002665
2666 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002667 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2668 * <ul>
2669 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2670 * </ul>
2671 *
2672 * <p class="note">This is a protected intent that can only be sent
2673 * by the system.
2674 *
2675 * @hide
2676 */
2677 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2678 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2679 = "android.intent.action.ADVANCED_SETTINGS";
2680
2681 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002682 * Broadcast Action: Sent after application restrictions are changed.
2683 *
2684 * <p class="note">This is a protected intent that can only be sent
2685 * by the system.</p>
2686 */
2687 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2688 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2689 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2690
2691 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002692 * Broadcast Action: An outgoing call is about to be placed.
2693 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002694 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002695 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002696 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002697 * the phone number originally intended to be dialed.</li>
2698 * </ul>
2699 * <p>Once the broadcast is finished, the resultData is used as the actual
2700 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002701 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002702 * outgoing call in turn: for example, a parental control application
2703 * might verify that the user is authorized to place the call at that
2704 * time, then a number-rewriting application might add an area code if
2705 * one was not specified.</p>
2706 * <p>For consistency, any receiver whose purpose is to prohibit phone
2707 * calls should have a priority of 0, to ensure it will see the final
2708 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002709 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002710 * should have a positive priority.
2711 * Negative priorities are reserved for the system for this broadcast;
2712 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002713 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2714 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002715 * <p>Emergency calls cannot be intercepted using this mechanism, and
2716 * other calls cannot be modified to call emergency numbers using this
2717 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002718 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2719 * call to use their own service instead. Those apps should first prevent
2720 * the call from being placed by setting resultData to <code>null</code>
2721 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002722 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002723 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2724 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002725 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002726 * <p class="note">This is a protected intent that can only be sent
2727 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002728 */
2729 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2730 public static final String ACTION_NEW_OUTGOING_CALL =
2731 "android.intent.action.NEW_OUTGOING_CALL";
2732
2733 /**
2734 * Broadcast Action: Have the device reboot. This is only for use by
2735 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002736 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002737 * <p class="note">This is a protected intent that can only be sent
2738 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002739 */
2740 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2741 public static final String ACTION_REBOOT =
2742 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002743
Wei Huang97ecc9c2009-05-11 17:44:20 -07002744 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002745 * Broadcast Action: A sticky broadcast for changes in the physical
2746 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002747 *
2748 * <p>The intent will have the following extra values:
2749 * <ul>
2750 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002751 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002752 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002753 * <p>This is intended for monitoring the current physical dock state.
2754 * See {@link android.app.UiModeManager} for the normal API dealing with
2755 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002756 */
2757 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2758 public static final String ACTION_DOCK_EVENT =
2759 "android.intent.action.DOCK_EVENT";
2760
2761 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002762 * Broadcast Action: A broadcast when idle maintenance can be started.
2763 * This means that the user is not interacting with the device and is
2764 * not expected to do so soon. Typical use of the idle maintenance is
2765 * to perform somehow expensive tasks that can be postponed at a moment
2766 * when they will not degrade user experience.
2767 * <p>
2768 * <p class="note">In order to keep the device responsive in case of an
2769 * unexpected user interaction, implementations of a maintenance task
2770 * should be interruptible. In such a scenario a broadcast with action
2771 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2772 * should not do the maintenance work in
2773 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2774 * maintenance service by {@link Context#startService(Intent)}. Also
2775 * you should hold a wake lock while your maintenance service is running
2776 * to prevent the device going to sleep.
2777 * </p>
2778 * <p>
2779 * <p class="note">This is a protected intent that can only be sent by
2780 * the system.
2781 * </p>
2782 *
2783 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002784 *
2785 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002786 */
2787 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2788 public static final String ACTION_IDLE_MAINTENANCE_START =
2789 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2790
2791 /**
2792 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2793 * This means that the user was not interacting with the device as a result
2794 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2795 * was sent and now the user started interacting with the device. Typical
2796 * use of the idle maintenance is to perform somehow expensive tasks that
2797 * can be postponed at a moment when they will not degrade user experience.
2798 * <p>
2799 * <p class="note">In order to keep the device responsive in case of an
2800 * unexpected user interaction, implementations of a maintenance task
2801 * should be interruptible. Hence, on receiving a broadcast with this
2802 * action, the maintenance task should be interrupted as soon as possible.
2803 * In other words, you should not do the maintenance work in
2804 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2805 * maintenance service that was started on receiving of
2806 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2807 * lock you acquired when your maintenance service started.
2808 * </p>
2809 * <p class="note">This is a protected intent that can only be sent
2810 * by the system.
2811 *
2812 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002813 *
2814 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002815 */
2816 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2817 public static final String ACTION_IDLE_MAINTENANCE_END =
2818 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2819
2820 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002821 * Broadcast Action: a remote intent is to be broadcasted.
2822 *
2823 * A remote intent is used for remote RPC between devices. The remote intent
2824 * is serialized and sent from one device to another device. The receiving
2825 * device parses the remote intent and broadcasts it. Note that anyone can
2826 * broadcast a remote intent. However, if the intent receiver of the remote intent
2827 * does not trust intent broadcasts from arbitrary intent senders, it should require
2828 * the sender to hold certain permissions so only trusted sender's broadcast will be
2829 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002830 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002831 */
2832 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002833 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002834
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002835 /**
2836 * Broadcast Action: hook for permforming cleanup after a system update.
2837 *
2838 * The broadcast is sent when the system is booting, before the
2839 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2840 * image. A receiver for this should do its work and then disable itself
2841 * so that it does not get run again at the next boot.
2842 * @hide
2843 */
2844 public static final String ACTION_PRE_BOOT_COMPLETED =
2845 "android.intent.action.PRE_BOOT_COMPLETED";
2846
Amith Yamasani13593602012-03-22 16:16:17 -07002847 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002848 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002849 * on restricted users. The broadcast intent contains an extra
2850 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2851 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2852 * String[] depending on the restriction type.<p/>
2853 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002854 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2855 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2856 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002857 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2858 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002859 * @see RestrictionEntry
2860 */
2861 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2862 "android.intent.action.GET_RESTRICTION_ENTRIES";
2863
2864 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002865 * Sent the first time a user is starting, to allow system apps to
2866 * perform one time initialization. (This will not be seen by third
2867 * party applications because a newly initialized user does not have any
2868 * third party applications installed for it.) This is sent early in
2869 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002870 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2871 * broadcast, since it is part of a visible user interaction; be as quick
2872 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002873 */
2874 public static final String ACTION_USER_INITIALIZE =
2875 "android.intent.action.USER_INITIALIZE";
2876
2877 /**
2878 * Sent when a user switch is happening, causing the process's user to be
2879 * brought to the foreground. This is only sent to receivers registered
2880 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2881 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002882 * foreground. This is sent as a foreground
2883 * broadcast, since it is part of a visible user interaction; be as quick
2884 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002885 */
2886 public static final String ACTION_USER_FOREGROUND =
2887 "android.intent.action.USER_FOREGROUND";
2888
2889 /**
2890 * Sent when a user switch is happening, causing the process's user to be
2891 * sent to the background. This is only sent to receivers registered
2892 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2893 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002894 * background. This is sent as a foreground
2895 * broadcast, since it is part of a visible user interaction; be as quick
2896 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002897 */
2898 public static final String ACTION_USER_BACKGROUND =
2899 "android.intent.action.USER_BACKGROUND";
2900
2901 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002902 * Broadcast sent to the system when a user is added. Carries an extra
2903 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2904 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002905 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002906 * @hide
2907 */
2908 public static final String ACTION_USER_ADDED =
2909 "android.intent.action.USER_ADDED";
2910
2911 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002912 * Broadcast sent by the system when a user is started. Carries an extra
2913 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002914 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002915 * that has been started. This is sent as a foreground
2916 * broadcast, since it is part of a visible user interaction; be as quick
2917 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002918 * @hide
2919 */
2920 public static final String ACTION_USER_STARTED =
2921 "android.intent.action.USER_STARTED";
2922
2923 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002924 * Broadcast sent when a user is in the process of starting. Carries an extra
2925 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2926 * sent to registered receivers, not manifest receivers. It is sent to all
2927 * users (including the one that is being started). You must hold
2928 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2929 * this broadcast. This is sent as a background broadcast, since
2930 * its result is not part of the primary UX flow; to safely keep track of
2931 * started/stopped state of a user you can use this in conjunction with
2932 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2933 * other user state broadcasts since those are foreground broadcasts so can
2934 * execute in a different order.
2935 * @hide
2936 */
2937 public static final String ACTION_USER_STARTING =
2938 "android.intent.action.USER_STARTING";
2939
2940 /**
2941 * Broadcast sent when a user is going to be stopped. Carries an extra
2942 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2943 * sent to registered receivers, not manifest receivers. It is sent to all
2944 * users (including the one that is being stopped). You must hold
2945 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2946 * this broadcast. The user will not stop until all receivers have
2947 * handled the broadcast. This is sent as a background broadcast, since
2948 * its result is not part of the primary UX flow; to safely keep track of
2949 * started/stopped state of a user you can use this in conjunction with
2950 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2951 * other user state broadcasts since those are foreground broadcasts so can
2952 * execute in a different order.
2953 * @hide
2954 */
2955 public static final String ACTION_USER_STOPPING =
2956 "android.intent.action.USER_STOPPING";
2957
2958 /**
2959 * Broadcast sent to the system when a user is stopped. Carries an extra
2960 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2961 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2962 * specific package. This is only sent to registered receivers, not manifest
2963 * receivers. It is sent to all running users <em>except</em> the one that
2964 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002965 * @hide
2966 */
2967 public static final String ACTION_USER_STOPPED =
2968 "android.intent.action.USER_STOPPED";
2969
2970 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002971 * 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 -07002972 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002973 * one that has been removed. The user will not be completely removed until all receivers have
2974 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002975 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002976 * @hide
2977 */
2978 public static final String ACTION_USER_REMOVED =
2979 "android.intent.action.USER_REMOVED";
2980
2981 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002982 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002983 * the userHandle of the user to become the current one. This is only sent to
2984 * registered receivers, not manifest receivers. It is sent to all running users.
2985 * You must hold
2986 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002987 * @hide
2988 */
2989 public static final String ACTION_USER_SWITCHED =
2990 "android.intent.action.USER_SWITCHED";
2991
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002992 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07002993 * Broadcast Action: Sent when the credential-encrypted private storage has
2994 * become unlocked for the target user. This is only sent to registered
2995 * receivers, not manifest receivers.
2996 */
2997 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2998 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
2999
3000 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003001 * Broadcast sent to the system when a user's information changes. Carries an extra
3002 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003003 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003004 * @hide
3005 */
3006 public static final String ACTION_USER_INFO_CHANGED =
3007 "android.intent.action.USER_INFO_CHANGED";
3008
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003009 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003010 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3011 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003012 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3013 * that need to display merged content across both primary and managed profiles need to
3014 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003015 * not manifest receivers.
3016 */
3017 public static final String ACTION_MANAGED_PROFILE_ADDED =
3018 "android.intent.action.MANAGED_PROFILE_ADDED";
3019
3020 /**
3021 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003022 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3023 * Only applications (for example Launchers) that need to display merged content across both
3024 * primary and managed profiles need to worry about this broadcast. This is only sent to
3025 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003026 */
3027 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3028 "android.intent.action.MANAGED_PROFILE_REMOVED";
3029
3030 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003031 * Broadcast sent to the primary user when an associated managed profile's availability has
3032 * changed. This includes when the user toggles the profile's quiet mode, or when the profile
3033 * owner suspends the profile. Carries an extra {@link #EXTRA_USER} that specifies the
3034 * UserHandle of the profile. When quiet mode is changed, this broadcast will carry a boolean
3035 * extra {@link #EXTRA_QUIET_MODE} indicating the new state of quiet mode. This is only sent to
3036 * registered receivers, not manifest receivers.
3037 */
3038 public static final String ACTION_MANAGED_PROFILE_AVAILABILITY_CHANGED =
3039 "android.intent.action.MANAGED_PROFILE_AVAILABILITY_CHANGED";
3040
3041 /**
3042 * Broadcast sent to the managed profile when its availability has changed. This includes when
3043 * the user toggles the profile's quiet mode, or when the profile owner suspends the profile.
3044 * When quiet mode is changed, this broadcast will carry a boolean extra
3045 * {@link #EXTRA_QUIET_MODE} indicating the new state of quiet mode. This is only sent to
3046 * registered receivers, not manifest receivers. See also
3047 * {@link #ACTION_MANAGED_PROFILE_AVAILABILITY_CHANGED}
3048 */
3049 public static final String ACTION_AVAILABILITY_CHANGED =
3050 "android.intent.action.AVAILABILITY_CHANGED";
3051
3052 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003053 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3054 */
3055 public static final String ACTION_QUICK_CLOCK =
3056 "android.intent.action.QUICK_CLOCK";
3057
Michael Wright0087a142013-02-05 16:29:39 -08003058 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003059 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003060 * @hide
3061 */
3062 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3063 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3064
Justin Kohd378ad72013-04-01 12:18:26 -07003065 /**
3066 * Broadcast Action: A global button was pressed. Includes a single
3067 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3068 * caused the broadcast.
3069 * @hide
3070 */
3071 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3072
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003073 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003074 * Broadcast Action: Sent when media resource is granted.
3075 * <p>
3076 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3077 * granted.
3078 * </p>
3079 * <p class="note">
3080 * This is a protected intent that can only be sent by the system.
3081 * </p>
3082 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003083 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003084 * </p>
3085 *
3086 * @hide
3087 */
3088 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3089 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3090
3091 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003092 * Activity Action: Allow the user to select and return one or more existing
3093 * documents. When invoked, the system will display the various
3094 * {@link DocumentsProvider} instances installed on the device, letting the
3095 * user interactively navigate through them. These documents include local
3096 * media, such as photos and video, and documents provided by installed
3097 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003098 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003099 * Each document is represented as a {@code content://} URI backed by a
3100 * {@link DocumentsProvider}, which can be opened as a stream with
3101 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3102 * {@link android.provider.DocumentsContract.Document} metadata.
3103 * <p>
3104 * All selected documents are returned to the calling application with
3105 * persistable read and write permission grants. If you want to maintain
3106 * access to the documents across device reboots, you need to explicitly
3107 * take the persistable permissions using
3108 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3109 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003110 * Callers must indicate the acceptable document MIME types through
3111 * {@link #setType(String)}. For example, to select photos, use
3112 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3113 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3114 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003115 * <p>
3116 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003117 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3118 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003119 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003120 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3121 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003122 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003123 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003124 * Output: The URI of the item that was picked, returned in
3125 * {@link #getData()}. This must be a {@code content://} URI so that any
3126 * receiver can access it. If multiple documents were selected, they are
3127 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003128 *
3129 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003130 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003131 * @see #ACTION_CREATE_DOCUMENT
3132 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003133 */
3134 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3135 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3136
3137 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003138 * Activity Action: Allow the user to create a new document. When invoked,
3139 * the system will display the various {@link DocumentsProvider} instances
3140 * installed on the device, letting the user navigate through them. The
3141 * returned document may be a newly created document with no content, or it
3142 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003143 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003144 * Each document is represented as a {@code content://} URI backed by a
3145 * {@link DocumentsProvider}, which can be opened as a stream with
3146 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3147 * {@link android.provider.DocumentsContract.Document} metadata.
3148 * <p>
3149 * Callers must indicate the concrete MIME type of the document being
3150 * created by setting {@link #setType(String)}. This MIME type cannot be
3151 * changed after the document is created.
3152 * <p>
3153 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3154 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003155 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003156 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3157 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003158 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003159 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003160 * Output: The URI of the item that was created. This must be a
3161 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003162 *
3163 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003164 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003165 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003166 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003167 */
3168 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3169 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3170
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003171 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003172 * Activity Action: Allow the user to pick a directory subtree. When
3173 * invoked, the system will display the various {@link DocumentsProvider}
3174 * instances installed on the device, letting the user navigate through
3175 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003176 * <p>
3177 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003178 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3179 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3180 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003181 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003182 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003183 *
3184 * @see DocumentsContract
3185 */
3186 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003187 public static final String
3188 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003189
Felipe Lemec7b1f892016-01-15 15:02:31 -08003190 /**
3191 * Activity Action: Give access to a standard storage directory after obtaining the user's
3192 * approval.
3193 * <p>
3194 * When invoked, the system will ask the user to grant access to the requested directory (and
3195 * its descendants).
3196 * <p>
3197 * To gain access to descendant (child, grandchild, etc) documents, use
3198 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3199 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)} with the returned URI.
3200 * <p>
3201 * Input: full path to a standard directory, in the form of
3202 * {@code STORAGE_ROOT + STANDARD_DIRECTORY}, where {@code STORAGE_ROOT} is the physical path of
3203 * a storage container, and {@code STANDARD_DIRECTORY} is one of
3204 * {@link Environment#DIRECTORY_MUSIC}, {@link Environment#DIRECTORY_PODCASTS},
3205 * {@link Environment#DIRECTORY_RINGTONES}, {@link Environment#DIRECTORY_ALARMS},
3206 * {@link Environment#DIRECTORY_NOTIFICATIONS}, {@link Environment#DIRECTORY_PICTURES},
3207 * {@link Environment#DIRECTORY_MOVIES}, {@link Environment#DIRECTORY_DOWNLOADS},
3208 * {@link Environment#DIRECTORY_DCIM}, or {@link Environment#DIRECTORY_DOCUMENTS}
3209 * <p>
3210 * For example, to open the "Pictures" folder in the default external storage, the intent's data
3211 * would be: {@code Uri.fromFile(new File(Environment.getExternalStorageDirectory(),
3212 * Environment.DIRECTORY_PICTURES))}.
3213 * <p>
3214 * Output: The URI representing the requested directory tree.
3215 *
3216 * @see DocumentsContract
3217 */
3218 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3219 public static final String
3220 ACTION_OPEN_EXTERNAL_DIRECTORY = "android.intent.action.OPEN_EXTERNAL_DIRECTORY";
3221
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003222 /** {@hide} */
3223 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3224
Christopher Tate6597e342015-02-17 12:15:25 -08003225 /**
3226 * Broadcast action: report that a settings element is being restored from backup. The intent
3227 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3228 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3229 * is the value of that settings entry prior to the restore operation. All of these values are
3230 * represented as strings.
3231 *
3232 * <p>This broadcast is sent only for settings provider entries known to require special handling
3233 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3234 * the provider's backup agent implementation.
3235 *
3236 * @see #EXTRA_SETTING_NAME
3237 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3238 * @see #EXTRA_SETTING_NEW_VALUE
3239 * {@hide}
3240 */
3241 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3242
3243 /** {@hide} */
3244 public static final String EXTRA_SETTING_NAME = "setting_name";
3245 /** {@hide} */
3246 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3247 /** {@hide} */
3248 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3249
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003250 /**
3251 * Activity Action: Process a piece of text.
3252 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3253 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3254 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3255 */
3256 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3257 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3258 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003259 * The name of the extra used to define the text to be processed, as a
3260 * CharSequence. Note that this may be a styled CharSequence, so you must use
3261 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003262 */
3263 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3264 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003265 * 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 +00003266 */
3267 public static final String EXTRA_PROCESS_TEXT_READONLY =
3268 "android.intent.extra.PROCESS_TEXT_READONLY";
3269
Bryce Leebc58f592015-09-25 16:43:01 -07003270 /**
3271 * Broadcast action: reports when a new thermal event has been reached. When the device
3272 * is reaching its maximum temperatue, the thermal level reported
3273 * {@hide}
3274 */
3275 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3276 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3277
3278 /** {@hide} */
3279 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3280
3281 /**
3282 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003283 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003284 * {@hide}
3285 */
3286 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3287
3288 /**
3289 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003290 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003291 * {@hide}
3292 */
3293 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3294
3295 /**
3296 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003297 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003298 * {@hide}
3299 */
3300 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3301
3302
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003303 // ---------------------------------------------------------------------
3304 // ---------------------------------------------------------------------
3305 // Standard intent categories (see addCategory()).
3306
3307 /**
3308 * Set if the activity should be an option for the default action
3309 * (center press) to perform on a piece of data. Setting this will
3310 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003311 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003312 * Intent when initiating an action -- it is for use in intent filters
3313 * specified in packages.
3314 */
3315 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3316 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3317 /**
3318 * Activities that can be safely invoked from a browser must support this
3319 * category. For example, if the user is viewing a web page or an e-mail
3320 * and clicks on a link in the text, the Intent generated execute that
3321 * link will require the BROWSABLE category, so that only activities
3322 * supporting this category will be considered as possible actions. By
3323 * supporting this category, you are promising that there is nothing
3324 * damaging (without user intervention) that can happen by invoking any
3325 * matching Intent.
3326 */
3327 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3328 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3329 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003330 * Categories for activities that can participate in voice interaction.
3331 * An activity that supports this category must be prepared to run with
3332 * no UI shown at all (though in some case it may have a UI shown), and
3333 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3334 */
3335 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3336 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3337 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003338 * Set if the activity should be considered as an alternative action to
3339 * the data the user is currently viewing. See also
3340 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3341 * applies to the selection in a list of items.
3342 *
3343 * <p>Supporting this category means that you would like your activity to be
3344 * displayed in the set of alternative things the user can do, usually as
3345 * part of the current activity's options menu. You will usually want to
3346 * include a specific label in the &lt;intent-filter&gt; of this action
3347 * describing to the user what it does.
3348 *
3349 * <p>The action of IntentFilter with this category is important in that it
3350 * describes the specific action the target will perform. This generally
3351 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3352 * a specific name such as "com.android.camera.action.CROP. Only one
3353 * alternative of any particular action will be shown to the user, so using
3354 * a specific action like this makes sure that your alternative will be
3355 * displayed while also allowing other applications to provide their own
3356 * overrides of that particular action.
3357 */
3358 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3359 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3360 /**
3361 * Set if the activity should be considered as an alternative selection
3362 * action to the data the user has currently selected. This is like
3363 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3364 * of items from which the user can select, giving them alternatives to the
3365 * default action that will be performed on it.
3366 */
3367 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3368 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3369 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003370 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003371 */
3372 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3373 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3374 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003375 * Should be displayed in the top-level launcher.
3376 */
3377 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3378 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3379 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003380 * Indicates an activity optimized for Leanback mode, and that should
3381 * be displayed in the Leanback launcher.
3382 */
3383 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3384 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3385 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003386 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3387 * @hide
3388 */
3389 @SystemApi
3390 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3391 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003392 * Provides information about the package it is in; typically used if
3393 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3394 * a front-door to the user without having to be shown in the all apps list.
3395 */
3396 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3397 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3398 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003399 * This is the home activity, that is the first activity that is displayed
3400 * when the device boots.
3401 */
3402 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3403 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3404 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003405 * This is the home activity that is displayed when the device is finished setting up and ready
3406 * for use.
3407 * @hide
3408 */
3409 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3410 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3411 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003412 * This is the setup wizard activity, that is the first activity that is displayed
3413 * when the user sets up the device for the first time.
3414 * @hide
3415 */
3416 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3417 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3418 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003419 * This activity is a preference panel.
3420 */
3421 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3422 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3423 /**
3424 * This activity is a development preference panel.
3425 */
3426 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3427 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3428 /**
3429 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003430 */
3431 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3432 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3433 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003434 * This activity allows the user to browse and download new applications.
3435 */
3436 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3437 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3438 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003439 * This activity may be exercised by the monkey or other automated test tools.
3440 */
3441 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3442 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3443 /**
3444 * To be used as a test (not part of the normal user experience).
3445 */
3446 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3447 /**
3448 * To be used as a unit test (run through the Test Harness).
3449 */
3450 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3451 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003452 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003453 * experience).
3454 */
3455 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003456
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003457 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003458 * Used to indicate that an intent only wants URIs that can be opened with
3459 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3460 * must support at least the columns defined in {@link OpenableColumns} when
3461 * queried.
3462 *
3463 * @see #ACTION_GET_CONTENT
3464 * @see #ACTION_OPEN_DOCUMENT
3465 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003466 */
3467 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3468 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3469
3470 /**
3471 * To be used as code under test for framework instrumentation tests.
3472 */
3473 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3474 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003475 /**
3476 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003477 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3478 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003479 */
3480 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3481 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3482 /**
3483 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003484 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3485 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003486 */
3487 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3488 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003489 /**
3490 * An activity to run when device is inserted into a analog (low end) dock.
3491 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3492 * information, see {@link android.app.UiModeManager}.
3493 */
3494 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3495 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3496
3497 /**
3498 * An activity to run when device is inserted into a digital (high end) dock.
3499 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3500 * information, see {@link android.app.UiModeManager}.
3501 */
3502 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3503 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003504
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003505 /**
3506 * Used to indicate that the activity can be used in a car environment.
3507 */
3508 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3509 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3510
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003511 // ---------------------------------------------------------------------
3512 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003513 // Application launch intent categories (see addCategory()).
3514
3515 /**
3516 * Used with {@link #ACTION_MAIN} to launch the browser application.
3517 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003518 * <p>NOTE: This should not be used as the primary key of an Intent,
3519 * since it will not result in the app launching with the correct
3520 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003521 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003522 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003523 */
3524 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3525 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3526
3527 /**
3528 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3529 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003530 * <p>NOTE: This should not be used as the primary key of an Intent,
3531 * since it will not result in the app launching with the correct
3532 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003533 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003534 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003535 */
3536 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3537 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3538
3539 /**
3540 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3541 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003542 * <p>NOTE: This should not be used as the primary key of an Intent,
3543 * since it will not result in the app launching with the correct
3544 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003545 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003546 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003547 */
3548 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3549 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3550
3551 /**
3552 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3553 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003554 * <p>NOTE: This should not be used as the primary key of an Intent,
3555 * since it will not result in the app launching with the correct
3556 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003557 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003558 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003559 */
3560 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3561 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3562
3563 /**
3564 * Used with {@link #ACTION_MAIN} to launch the email application.
3565 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003566 * <p>NOTE: This should not be used as the primary key of an Intent,
3567 * since it will not result in the app launching with the correct
3568 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003569 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003570 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003571 */
3572 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3573 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3574
3575 /**
3576 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3577 * The activity should be able to view and manipulate image and video files
3578 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003579 * <p>NOTE: This should not be used as the primary key of an Intent,
3580 * since it will not result in the app launching with the correct
3581 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003582 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003583 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003584 */
3585 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3586 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3587
3588 /**
3589 * Used with {@link #ACTION_MAIN} to launch the maps application.
3590 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003591 * <p>NOTE: This should not be used as the primary key of an Intent,
3592 * since it will not result in the app launching with the correct
3593 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003594 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003595 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003596 */
3597 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3598 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3599
3600 /**
3601 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3602 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003603 * <p>NOTE: This should not be used as the primary key of an Intent,
3604 * since it will not result in the app launching with the correct
3605 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003606 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003607 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003608 */
3609 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3610 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3611
3612 /**
3613 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003614 * The activity should be able to play, browse, or manipulate music files
3615 * stored on the device.
3616 * <p>NOTE: This should not be used as the primary key of an Intent,
3617 * since it will not result in the app launching with the correct
3618 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003619 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003620 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003621 */
3622 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3623 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3624
3625 // ---------------------------------------------------------------------
3626 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003627 // Standard extra data keys.
3628
3629 /**
3630 * The initial data to place in a newly created record. Use with
3631 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3632 * fields as would be given to the underlying ContentProvider.insert()
3633 * call.
3634 */
3635 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3636
3637 /**
3638 * A constant CharSequence that is associated with the Intent, used with
3639 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3640 * this may be a styled CharSequence, so you must use
3641 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3642 * retrieve it.
3643 */
3644 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3645
3646 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003647 * A constant String that is associated with the Intent, used with
3648 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3649 * as HTML formatted text. Note that you <em>must</em> also supply
3650 * {@link #EXTRA_TEXT}.
3651 */
3652 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3653
3654 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003655 * A content: URI holding a stream of data associated with the Intent,
3656 * used with {@link #ACTION_SEND} to supply the data being sent.
3657 */
3658 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3659
3660 /**
3661 * A String[] holding e-mail addresses that should be delivered to.
3662 */
3663 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3664
3665 /**
3666 * A String[] holding e-mail addresses that should be carbon copied.
3667 */
3668 public static final String EXTRA_CC = "android.intent.extra.CC";
3669
3670 /**
3671 * A String[] holding e-mail addresses that should be blind carbon copied.
3672 */
3673 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3674
3675 /**
3676 * A constant string holding the desired subject line of a message.
3677 */
3678 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3679
3680 /**
3681 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003682 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003683 */
3684 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3685
3686 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003687 * An int representing the user id to be used.
3688 *
3689 * @hide
3690 */
3691 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3692
3693 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003694 * An int representing the task id to be retrieved. This is used when a launch from recents is
3695 * intercepted by another action such as credentials confirmation to remember which task should
3696 * be resumed when complete.
3697 *
3698 * @hide
3699 */
3700 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3701
3702 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003703 * An Intent[] describing additional, alternate choices you would like shown with
3704 * {@link #ACTION_CHOOSER}.
3705 *
3706 * <p>An app may be capable of providing several different payload types to complete a
3707 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3708 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3709 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3710 * photo data or a hosted link where the photos can be viewed.</p>
3711 *
3712 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3713 * first/primary/preferred intent in the set. Additional intents specified in
3714 * this extra are ordered; by default intents that appear earlier in the array will be
3715 * preferred over intents that appear later in the array as matches for the same
3716 * target component. To alter this preference, a calling app may also supply
3717 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3718 */
3719 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3720
3721 /**
3722 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3723 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3724 *
3725 * <p>An app preparing an action for another app to complete may wish to allow the user to
3726 * disambiguate between several options for completing the action based on the chosen target
3727 * or otherwise refine the action before it is invoked.
3728 * </p>
3729 *
3730 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3731 * <ul>
3732 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3733 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3734 * chosen target beyond the first</li>
3735 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3736 * should fill in and send once the disambiguation is complete</li>
3737 * </ul>
3738 */
3739 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3740 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3741
3742 /**
3743 * A {@link ResultReceiver} used to return data back to the sender.
3744 *
3745 * <p>Used to complete an app-specific
3746 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3747 *
3748 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3749 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3750 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3751 * when the user selects a target component from the chooser. It is up to the recipient
3752 * to send a result to this ResultReceiver to signal that disambiguation is complete
3753 * and that the chooser should invoke the user's choice.</p>
3754 *
3755 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3756 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3757 * to match and fill in the final Intent or ChooserTarget before starting it.
3758 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3759 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3760 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3761 *
3762 * <p>The result code passed to the ResultReceiver should be
3763 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3764 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3765 * the chooser should finish without starting a target.</p>
3766 */
3767 public static final String EXTRA_RESULT_RECEIVER
3768 = "android.intent.extra.RESULT_RECEIVER";
3769
3770 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003771 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003772 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003773 */
3774 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3775
3776 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003777 * A Parcelable[] of {@link Intent} or
3778 * {@link android.content.pm.LabeledIntent} objects as set with
3779 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3780 * a the front of the list of choices, when shown to the user with a
3781 * {@link #ACTION_CHOOSER}.
3782 */
3783 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3784
3785 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003786 * A {@link IntentSender} to start after ephemeral installation success.
3787 * @hide
3788 */
3789 @SystemApi
3790 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3791
3792 /**
3793 * A {@link IntentSender} to start after ephemeral installation failure.
3794 * @hide
3795 */
3796 @SystemApi
3797 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3798
3799 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003800 * A Bundle forming a mapping of potential target package names to different extras Bundles
3801 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3802 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3803 * be currently installed on the device.
3804 *
3805 * <p>An application may choose to provide alternate extras for the case where a user
3806 * selects an activity from a predetermined set of target packages. If the activity
3807 * the user selects from the chooser belongs to a package with its package name as
3808 * a key in this bundle, the corresponding extras for that package will be merged with
3809 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3810 * extra has the same key as an extra already present in the intent it will overwrite
3811 * the extra from the intent.</p>
3812 *
3813 * <p><em>Examples:</em>
3814 * <ul>
3815 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3816 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3817 * parameters for that target.</li>
3818 * <li>An application may offer additional metadata for known targets of a given intent
3819 * to pass along information only relevant to that target such as account or content
3820 * identifiers already known to that application.</li>
3821 * </ul></p>
3822 */
3823 public static final String EXTRA_REPLACEMENT_EXTRAS =
3824 "android.intent.extra.REPLACEMENT_EXTRAS";
3825
3826 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003827 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3828 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3829 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3830 * {@link ComponentName} of the chosen component.
3831 *
3832 * <p>In some situations this callback may never come, for example if the user abandons
3833 * the chooser, switches to another task or any number of other reasons. Apps should not
3834 * be written assuming that this callback will always occur.</p>
3835 */
3836 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3837 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3838
3839 /**
3840 * The {@link ComponentName} chosen by the user to complete an action.
3841 *
3842 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3843 */
3844 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3845
3846 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003847 * A {@link android.view.KeyEvent} object containing the event that
3848 * triggered the creation of the Intent it is in.
3849 */
3850 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3851
3852 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003853 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3854 * before shutting down.
3855 *
3856 * {@hide}
3857 */
3858 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3859
3860 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003861 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3862 * requested by the user.
3863 *
3864 * {@hide}
3865 */
3866 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3867 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3868
3869 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003870 * 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 -07003871 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3872 * of restarting the application.
3873 */
3874 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3875
3876 /**
3877 * A String holding the phone number originally entered in
3878 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3879 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3880 */
3881 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003882
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003883 /**
3884 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3885 * intents to supply the uid the package had been assigned. Also an optional
3886 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3887 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3888 * purpose.
3889 */
3890 public static final String EXTRA_UID = "android.intent.extra.UID";
3891
3892 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003893 * @hide String array of package names.
3894 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003895 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003896 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3897
3898 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003899 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3900 * intents to indicate whether this represents a full uninstall (removing
3901 * both the code and its data) or a partial uninstall (leaving its data,
3902 * implying that this is an update).
3903 */
3904 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003905
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003906 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003907 * @hide
3908 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3909 * intents to indicate that at this point the package has been removed for
3910 * all users on the device.
3911 */
3912 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3913 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3914
3915 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003916 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3917 * intents to indicate that this is a replacement of the package, so this
3918 * broadcast will immediately be followed by an add broadcast for a
3919 * different version of the same package.
3920 */
3921 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003922
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003923 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003924 * Used as an int extra field in {@link android.app.AlarmManager} intents
3925 * to tell the application being invoked how many pending alarms are being
3926 * delievered with the intent. For one-shot alarms this will always be 1.
3927 * For recurring alarms, this might be greater than 1 if the device was
3928 * asleep or powered off at the time an earlier alarm would have been
3929 * delivered.
3930 */
3931 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003932
Jacek Surazski86b6c532009-05-13 14:38:28 +02003933 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003934 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3935 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003936 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3937 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003938 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3939 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3940 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003941 */
3942 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3943
3944 /**
3945 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3946 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003947 */
3948 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3949
3950 /**
3951 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3952 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003953 */
3954 public static final int EXTRA_DOCK_STATE_DESK = 1;
3955
3956 /**
3957 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3958 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003959 */
3960 public static final int EXTRA_DOCK_STATE_CAR = 2;
3961
3962 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003963 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3964 * to represent that the phone is in a analog (low end) dock.
3965 */
3966 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3967
3968 /**
3969 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3970 * to represent that the phone is in a digital (high end) dock.
3971 */
3972 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3973
3974 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003975 * Boolean that can be supplied as meta-data with a dock activity, to
3976 * indicate that the dock should take over the home key when it is active.
3977 */
3978 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003979
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003980 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003981 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3982 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003983 */
3984 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3985
3986 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003987 * Used in the extra field in the remote intent. It's astring token passed with the
3988 * remote intent.
3989 */
3990 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3991 "android.intent.extra.remote_intent_token";
3992
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003993 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003994 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003995 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003996 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003997 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003998 "android.intent.extra.changed_component_name";
3999
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004000 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004001 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004002 * and contains a string array of all of the components that have changed. If
4003 * the state of the overall package has changed, then it will contain an entry
4004 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004005 */
4006 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4007 "android.intent.extra.changed_component_name_list";
4008
4009 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004010 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004011 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004012 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4013 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4014 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004015 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004016 */
4017 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4018 "android.intent.extra.changed_package_list";
4019
4020 /**
4021 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004022 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4023 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004024 * and contains an integer array of uids of all of the components
4025 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004026 */
4027 public static final String EXTRA_CHANGED_UID_LIST =
4028 "android.intent.extra.changed_uid_list";
4029
4030 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004031 * @hide
4032 * Magic extra system code can use when binding, to give a label for
4033 * who it is that has bound to a service. This is an integer giving
4034 * a framework string resource that can be displayed to the user.
4035 */
4036 public static final String EXTRA_CLIENT_LABEL =
4037 "android.intent.extra.client_label";
4038
4039 /**
4040 * @hide
4041 * Magic extra system code can use when binding, to give a PendingIntent object
4042 * that can be launched for the user to disable the system's use of this
4043 * service.
4044 */
4045 public static final String EXTRA_CLIENT_INTENT =
4046 "android.intent.extra.client_intent";
4047
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004048 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004049 * Extra used to indicate that an intent should only return data that is on
4050 * the local device. This is a boolean extra; the default is false. If true,
4051 * an implementation should only allow the user to select data that is
4052 * already on the device, not requiring it be downloaded from a remote
4053 * service when opened.
4054 *
4055 * @see #ACTION_GET_CONTENT
4056 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004057 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004058 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004059 */
4060 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004061 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004062
Amith Yamasani13593602012-03-22 16:16:17 -07004063 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004064 * Extra used to indicate that an intent can allow the user to select and
4065 * return multiple items. This is a boolean extra; the default is false. If
4066 * true, an implementation is allowed to present the user with a UI where
4067 * they can pick multiple items that are all returned to the caller. When
4068 * this happens, they should be returned as the {@link #getClipData()} part
4069 * of the result Intent.
4070 *
4071 * @see #ACTION_GET_CONTENT
4072 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004073 */
4074 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004075 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004076
4077 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004078 * The integer userHandle carried with broadcast intents related to addition, removal and
4079 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4080 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4081 *
Amith Yamasani13593602012-03-22 16:16:17 -07004082 * @hide
4083 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004084 public static final String EXTRA_USER_HANDLE =
4085 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004086
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004087 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004088 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4089 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4090 */
4091 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004092 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004093
4094 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004095 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004096 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4097 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004098 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004099 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4100
4101 /**
4102 * Extra sent in the intent to the BroadcastReceiver that handles
4103 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4104 * the restrictions as key/value pairs.
4105 */
4106 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4107 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004108
Amith Yamasani86118ba2013-03-28 14:33:16 -07004109 /**
4110 * Extra used in the response from a BroadcastReceiver that handles
4111 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4112 */
4113 public static final String EXTRA_RESTRICTIONS_INTENT =
4114 "android.intent.extra.restrictions_intent";
4115
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004116 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004117 * Extra used to communicate a set of acceptable MIME types. The type of the
4118 * extra is {@code String[]}. Values may be a combination of concrete MIME
4119 * types (such as "image/png") and/or partial MIME types (such as
4120 * "audio/*").
4121 *
4122 * @see #ACTION_GET_CONTENT
4123 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004124 */
4125 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4126
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004127 /**
4128 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4129 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004130 * When this is true, hardware devices can use this information to determine that
4131 * they shouldn't do a complete shutdown of their device since this is not a
4132 * complete shutdown down to the kernel, but only user space restarting.
4133 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004134 */
4135 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4136 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4137
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004138 /**
4139 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4140 * user has set their time format preferences to the 24 hour format.
4141 *
4142 * @hide for internal use only.
4143 */
4144 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4145 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4146
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004147 /** {@hide} */
4148 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4149
Rubin Xue8490f12015-06-25 12:17:48 +01004150 /** {@hide} */
4151 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4152
Santos Cordon15a13782015-03-31 18:32:31 -07004153 /**
4154 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4155 * activation request.
4156 * TODO: Add information about the structure and response data used with the pending intent.
4157 * @hide
4158 */
4159 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4160 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4161
Steve McKay6eaf38632015-08-04 10:11:01 -07004162 /** {@hide} */
4163 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4164
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004165 /**
4166 * Optional boolean extra indicating whether quiet mode has been switched on or off.
4167 */
4168 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004169
4170 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004171 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004172 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004173 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4174 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004175 *
4176 * @hide
4177 */
4178 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4179 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4180
4181 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004182 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004183 * to represent that a video codec is allowed to use.
4184 *
4185 * @hide
4186 */
4187 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4188
4189 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004190 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004191 * to represent that a audio codec is allowed to use.
4192 *
4193 * @hide
4194 */
4195 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4196
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004197 // ---------------------------------------------------------------------
4198 // ---------------------------------------------------------------------
4199 // Intent flags (see mFlags variable).
4200
Tor Norbyed9273d62013-05-30 15:59:53 -07004201 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004202 @IntDef(flag = true, value = {
4203 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4204 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004205 @Retention(RetentionPolicy.SOURCE)
4206 public @interface GrantUriMode {}
4207
Jeff Sharkey846318a2014-04-04 12:12:41 -07004208 /** @hide */
4209 @IntDef(flag = true, value = {
4210 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4211 @Retention(RetentionPolicy.SOURCE)
4212 public @interface AccessUriMode {}
4213
4214 /**
4215 * Test if given mode flags specify an access mode, which must be at least
4216 * read and/or write.
4217 *
4218 * @hide
4219 */
4220 public static boolean isAccessUriMode(int modeFlags) {
4221 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4222 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4223 }
4224
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004225 /**
4226 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004227 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004228 * specified in its ClipData. When applying to an Intent's ClipData,
4229 * all URIs as well as recursive traversals through data or other ClipData
4230 * in Intent items will be granted; only the grant flags of the top-level
4231 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004232 */
4233 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4234 /**
4235 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004236 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004237 * specified in its ClipData. When applying to an Intent's ClipData,
4238 * all URIs as well as recursive traversals through data or other ClipData
4239 * in Intent items will be granted; only the grant flags of the top-level
4240 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004241 */
4242 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4243 /**
4244 * Can be set by the caller to indicate that this Intent is coming from
4245 * a background operation, not from direct user interaction.
4246 */
4247 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4248 /**
4249 * A flag you can enable for debugging: when set, log messages will be
4250 * printed during the resolution of this intent to show you what has
4251 * been found to create the final resolved list.
4252 */
4253 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004254 /**
4255 * If set, this intent will not match any components in packages that
4256 * are currently stopped. If this is not set, then the default behavior
4257 * is to include such applications in the result.
4258 */
4259 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4260 /**
4261 * If set, this intent will always match any components in packages that
4262 * are currently stopped. This is the default behavior when
4263 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4264 * flags are set, this one wins (it allows overriding of exclude for
4265 * places where the framework may automatically set the exclude flag).
4266 */
4267 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004268
4269 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004270 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004271 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004272 * persisted across device reboots until explicitly revoked with
4273 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4274 * grant for possible persisting; the receiving application must call
4275 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4276 * actually persist.
4277 *
4278 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4279 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4280 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004281 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004282 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004283 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004284
4285 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004286 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4287 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4288 * applies to any URI that is a prefix match against the original granted
4289 * URI. (Without this flag, the URI must match exactly for access to be
4290 * granted.) Another URI is considered a prefix match only when scheme,
4291 * authority, and all path segments defined by the prefix are an exact
4292 * match.
4293 */
4294 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4295
4296 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004297 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004298 * homework and verified that they correctly handle packages and components
4299 * that come and go over time. In particular:
4300 * <ul>
4301 * <li>Apps installed on external storage, which will appear to be
4302 * uninstalled while the the device is ejected.
4303 * <li>Apps with encryption unaware components, which will appear to not
4304 * exist while the device is locked.
4305 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004306 *
4307 * @hide
4308 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004309 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004310
4311 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004312 * If set, the new activity is not kept in the history stack. As soon as
4313 * the user navigates away from it, the activity is finished. This may also
4314 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4315 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004316 *
4317 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4318 * is never invoked when the current activity starts a new activity which
4319 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004320 */
4321 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4322 /**
4323 * If set, the activity will not be launched if it is already running
4324 * at the top of the history stack.
4325 */
4326 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4327 /**
4328 * If set, this activity will become the start of a new task on this
4329 * history stack. A task (from the activity that started it to the
4330 * next task activity) defines an atomic group of activities that the
4331 * user can move to. Tasks can be moved to the foreground and background;
4332 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004333 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004334 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4335 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004336 *
4337 * <p>This flag is generally used by activities that want
4338 * to present a "launcher" style behavior: they give the user a list of
4339 * separate things that can be done, which otherwise run completely
4340 * independently of the activity launching them.
4341 *
4342 * <p>When using this flag, if a task is already running for the activity
4343 * you are now starting, then a new activity will not be started; instead,
4344 * the current task will simply be brought to the front of the screen with
4345 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4346 * to disable this behavior.
4347 *
4348 * <p>This flag can not be used when the caller is requesting a result from
4349 * the activity being launched.
4350 */
4351 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4352 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004353 * This flag is used to create a new task and launch an activity into it.
4354 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4355 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4356 * search through existing tasks for ones matching this Intent. Only if no such
4357 * task is found would a new task be created. When paired with
4358 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4359 * the search for a matching task and unconditionally start a new task.
4360 *
4361 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4362 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004363 * top-level application launcher.</strong> Used in conjunction with
4364 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4365 * behavior of bringing an existing task to the foreground. When set,
4366 * a new task is <em>always</em> started to host the Activity for the
4367 * Intent, regardless of whether there is already an existing task running
4368 * the same thing.
4369 *
4370 * <p><strong>Because the default system does not include graphical task management,
4371 * you should not use this flag unless you provide some way for a user to
4372 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004373 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004374 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4375 * creating new document tasks.
4376 *
4377 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004378 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004379 *
Scott Main7aee61f2011-02-08 11:25:01 -08004380 * <p>See
4381 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4382 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004383 *
4384 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4385 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004386 */
4387 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4388 /**
4389 * If set, and the activity being launched is already running in the
4390 * current task, then instead of launching a new instance of that activity,
4391 * all of the other activities on top of it will be closed and this Intent
4392 * will be delivered to the (now on top) old activity as a new Intent.
4393 *
4394 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4395 * If D calls startActivity() with an Intent that resolves to the component
4396 * of activity B, then C and D will be finished and B receive the given
4397 * Intent, resulting in the stack now being: A, B.
4398 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004399 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004400 * either receive the new intent you are starting here in its
4401 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004402 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004403 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4404 * the same intent, then it will be finished and re-created; for all other
4405 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4406 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004407 *
4408 * <p>This launch mode can also be used to good effect in conjunction with
4409 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4410 * of a task, it will bring any currently running instance of that task
4411 * to the foreground, and then clear it to its root state. This is
4412 * especially useful, for example, when launching an activity from the
4413 * notification manager.
4414 *
Scott Main7aee61f2011-02-08 11:25:01 -08004415 * <p>See
4416 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4417 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004418 */
4419 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4420 /**
4421 * If set and this intent is being used to launch a new activity from an
4422 * existing one, then the reply target of the existing activity will be
4423 * transfered to the new activity. This way the new activity can call
4424 * {@link android.app.Activity#setResult} and have that result sent back to
4425 * the reply target of the original activity.
4426 */
4427 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4428 /**
4429 * If set and this intent is being used to launch a new activity from an
4430 * existing one, the current activity will not be counted as the top
4431 * activity for deciding whether the new intent should be delivered to
4432 * the top instead of starting a new one. The previous activity will
4433 * be used as the top, with the assumption being that the current activity
4434 * will finish itself immediately.
4435 */
4436 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4437 /**
4438 * If set, the new activity is not kept in the list of recently launched
4439 * activities.
4440 */
4441 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4442 /**
4443 * This flag is not normally set by application code, but set for you by
4444 * the system as described in the
4445 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4446 * launchMode} documentation for the singleTask mode.
4447 */
4448 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4449 /**
4450 * If set, and this activity is either being started in a new task or
4451 * bringing to the top an existing task, then it will be launched as
4452 * the front door of the task. This will result in the application of
4453 * any affinities needed to have that task in the proper state (either
4454 * moving activities to or from it), or simply resetting that task to
4455 * its initial state if needed.
4456 */
4457 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4458 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004459 * This flag is not normally set by application code, but set for you by
4460 * the system if this activity is being launched from history
4461 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004462 */
4463 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004464 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004465 * @deprecated As of API 21 this performs identically to
4466 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004467 */
4468 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004469 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004470 * This flag is used to open a document into a new task rooted at the activity launched
4471 * by this Intent. Through the use of this flag, or its equivalent attribute,
4472 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004473 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004474 *
Craig Mautner026596b2014-05-21 15:35:44 -07004475 * <p>The use of the activity attribute form of this,
4476 * {@link android.R.attr#documentLaunchMode}, is
4477 * preferred over the Intent flag described here. The attribute form allows the
4478 * Activity to specify multiple document behavior for all launchers of the Activity
4479 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004480 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004481 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4482 * it is kept after the activity is finished is different than the use of
4483 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4484 * this flag is being used to create a new recents entry, then by default that entry
4485 * will be removed once the activity is finished. You can modify this behavior with
4486 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4487 *
Craig Mautner026596b2014-05-21 15:35:44 -07004488 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4489 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4490 * equivalent of the Activity manifest specifying {@link
4491 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4492 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4493 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004494 *
Craig Mautner026596b2014-05-21 15:35:44 -07004495 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004496 *
Craig Mautner026596b2014-05-21 15:35:44 -07004497 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004498 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4499 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004500 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004501 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004502 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004503 * callback from occurring on the current frontmost activity before it is
4504 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004505 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004506 * <p>Typically, an activity can rely on that callback to indicate that an
4507 * explicit user action has caused their activity to be moved out of the
4508 * foreground. The callback marks an appropriate point in the activity's
4509 * lifecycle for it to dismiss any notifications that it intends to display
4510 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004511 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004512 * <p>If an activity is ever started via any non-user-driven events such as
4513 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4514 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004515 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004516 */
4517 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004518 /**
4519 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4520 * this flag will cause the launched activity to be brought to the front of its
4521 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004522 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004523 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4524 * If D calls startActivity() with an Intent that resolves to the component
4525 * of activity B, then B will be brought to the front of the history stack,
4526 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004527 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004528 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004529 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004530 */
4531 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004532 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004533 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4534 * this flag will prevent the system from applying an activity transition
4535 * animation to go to the next activity state. This doesn't mean an
4536 * animation will never run -- if another activity change happens that doesn't
4537 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004538 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004539 * when you are going to do a series of activity operations but the
4540 * animation seen by the user shouldn't be driven by the first activity
4541 * change but rather a later one.
4542 */
4543 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4544 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004545 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4546 * this flag will cause any existing task that would be associated with the
4547 * activity to be cleared before the activity is started. That is, the activity
4548 * becomes the new root of an otherwise empty task, and any old activities
4549 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4550 */
4551 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4552 /**
4553 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4554 * this flag will cause a newly launching task to be placed on top of the current
4555 * home activity task (if there is one). That is, pressing back from the task
4556 * will always return the user to home even if that was not the last activity they
4557 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4558 */
4559 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4560 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004561 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4562 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004563 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004564 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004565 * this flag. When set and the task's activity is finished, the recents
4566 * entry will remain in the interface for the user to re-launch it, like a
4567 * recents entry for a top-level application.
4568 * <p>
4569 * The receiving activity can override this request with
4570 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4571 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004572 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004573 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004574 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004575
4576 /**
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004577 * This flag is only used in the multi-window mode. The new activity will be displayed on
4578 * the other side than the one that is launching it. This can only be used in conjunction with
4579 * {@link #FLAG_ACTIVITY_NEW_TASK}.
4580 */
4581 public static final int FLAG_ACTIVITY_LAUNCH_TO_SIDE = 0x00001000;
4582
4583 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004584 * If set, when sending a broadcast only registered receivers will be
4585 * called -- no BroadcastReceiver components will be launched.
4586 */
4587 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004588 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004589 * If set, when sending a broadcast the new broadcast will replace
4590 * any existing pending broadcast that matches it. Matching is defined
4591 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4592 * true for the intents of the two broadcasts. When a match is found,
4593 * the new broadcast (and receivers associated with it) will replace the
4594 * existing one in the pending broadcast list, remaining at the same
4595 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004596 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004597 * <p>This flag is most typically used with sticky broadcasts, which
4598 * only care about delivering the most recent values of the broadcast
4599 * to their receivers.
4600 */
4601 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4602 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004603 * If set, when sending a broadcast the recipient is allowed to run at
4604 * foreground priority, with a shorter timeout interval. During normal
4605 * broadcasts the receivers are not automatically hoisted out of the
4606 * background priority class.
4607 */
4608 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4609 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004610 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4611 * They can still propagate results through to later receivers, but they can not prevent
4612 * later receivers from seeing the broadcast.
4613 */
4614 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4615 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004616 * If set, when sending a broadcast <i>before boot has completed</i> only
4617 * registered receivers will be called -- no BroadcastReceiver components
4618 * will be launched. Sticky intent state will be recorded properly even
4619 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4620 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004621 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004622 * <p>This flag is only for use by system sevices as a convenience to
4623 * avoid having to implement a more complex mechanism around detection
4624 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004625 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004626 * @hide
4627 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004628 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004629 /**
4630 * Set when this broadcast is for a boot upgrade, a special mode that
4631 * allows the broadcast to be sent before the system is ready and launches
4632 * the app process with no providers running in it.
4633 * @hide
4634 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004635 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004636 /**
4637 * If set, the broadcast will always go to manifest receivers in background (cached
4638 * or not running) apps, regardless of whether that would be done by default. By
4639 * default they will only receive broadcasts if the broadcast has specified an
4640 * explicit component or package name.
4641 * @hide
4642 */
4643 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4644 /**
4645 * If set, the broadcast will never go to manifest receivers in background (cached
4646 * or not running) apps, regardless of whether that would be done by default. By
4647 * default they will receive broadcasts if the broadcast has specified an
4648 * explicit component or package name.
4649 * @hide
4650 */
4651 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004652
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004653 /**
4654 * @hide Flags that can't be changed with PendingIntent.
4655 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004656 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4657 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4658 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004660 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004661 // ---------------------------------------------------------------------
4662 // toUri() and parseUri() options.
4663
4664 /**
4665 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4666 * always has the "intent:" scheme. This syntax can be used when you want
4667 * to later disambiguate between URIs that are intended to describe an
4668 * Intent vs. all others that should be treated as raw URIs. When used
4669 * with {@link #parseUri}, any other scheme will result in a generic
4670 * VIEW action for that raw URI.
4671 */
4672 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004673
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004674 /**
4675 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4676 * always has the "android-app:" scheme. This is a variation of
4677 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4678 * http/https URI being delivered to a specific package name. The format
4679 * is:
4680 *
4681 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004682 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004683 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004684 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4685 * you must also include a scheme; including a path also requires both a host and a scheme.
4686 * The final #Intent; fragment can be used without a scheme, host, or path.
4687 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004688 * used with intents that have a {@link #setSelector}, since the base intent
4689 * will always have an explicit package name.</p>
4690 *
4691 * <p>Some examples of how this scheme maps to Intent objects:</p>
4692 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4693 * <colgroup align="left" />
4694 * <colgroup align="left" />
4695 * <thead>
4696 * <tr><th>URI</th> <th>Intent</th></tr>
4697 * </thead>
4698 *
4699 * <tbody>
4700 * <tr><td><code>android-app://com.example.app</code></td>
4701 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4702 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4703 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4704 * </table></td>
4705 * </tr>
4706 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4707 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4708 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4709 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4710 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4711 * </table></td>
4712 * </tr>
4713 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4714 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4715 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4716 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</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/<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>Package: </td><td><code>com.example.app</code></td></tr>
4724 * </table></td>
4725 * </tr>
4726 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4727 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4728 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4729 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4730 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4731 * </table></td>
4732 * </tr>
4733 * <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>
4734 * <td><table border="" style="margin:0" >
4735 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4736 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4737 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4738 * </table></td>
4739 * </tr>
4740 * </tbody>
4741 * </table>
4742 */
4743 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4744
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004745 /**
4746 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4747 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4748 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4749 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4750 * generated Intent can not cause unexpected data access to happen.
4751 *
4752 * <p>If you do not trust the source of the URI being parsed, you should still do further
4753 * processing to protect yourself from it. In particular, when using it to start an
4754 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4755 * that can handle it.</p>
4756 */
4757 public static final int URI_ALLOW_UNSAFE = 1<<2;
4758
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004759 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004760
4761 private String mAction;
4762 private Uri mData;
4763 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004764 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004765 private ComponentName mComponent;
4766 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004767 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004768 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004769 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004770 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004771 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004772 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004773
4774 // ---------------------------------------------------------------------
4775
4776 /**
4777 * Create an empty intent.
4778 */
4779 public Intent() {
4780 }
4781
4782 /**
4783 * Copy constructor.
4784 */
4785 public Intent(Intent o) {
4786 this.mAction = o.mAction;
4787 this.mData = o.mData;
4788 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004789 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004790 this.mComponent = o.mComponent;
4791 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004792 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004793 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004794 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004795 }
4796 if (o.mExtras != null) {
4797 this.mExtras = new Bundle(o.mExtras);
4798 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004799 if (o.mSourceBounds != null) {
4800 this.mSourceBounds = new Rect(o.mSourceBounds);
4801 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004802 if (o.mSelector != null) {
4803 this.mSelector = new Intent(o.mSelector);
4804 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004805 if (o.mClipData != null) {
4806 this.mClipData = new ClipData(o.mClipData);
4807 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004808 }
4809
4810 @Override
4811 public Object clone() {
4812 return new Intent(this);
4813 }
4814
4815 private Intent(Intent o, boolean all) {
4816 this.mAction = o.mAction;
4817 this.mData = o.mData;
4818 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004819 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004820 this.mComponent = o.mComponent;
4821 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004822 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004823 }
4824 }
4825
4826 /**
4827 * Make a clone of only the parts of the Intent that are relevant for
4828 * filter matching: the action, data, type, component, and categories.
4829 */
4830 public Intent cloneFilter() {
4831 return new Intent(this, false);
4832 }
4833
4834 /**
4835 * Create an intent with a given action. All other fields (data, type,
4836 * class) are null. Note that the action <em>must</em> be in a
4837 * namespace because Intents are used globally in the system -- for
4838 * example the system VIEW action is android.intent.action.VIEW; an
4839 * application's custom action would be something like
4840 * com.google.app.myapp.CUSTOM_ACTION.
4841 *
4842 * @param action The Intent action, such as ACTION_VIEW.
4843 */
4844 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004845 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004846 }
4847
4848 /**
4849 * Create an intent with a given action and for a given data url. Note
4850 * that the action <em>must</em> be in a namespace because Intents are
4851 * used globally in the system -- for example the system VIEW action is
4852 * android.intent.action.VIEW; an application's custom action would be
4853 * something like com.google.app.myapp.CUSTOM_ACTION.
4854 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004855 * <p><em>Note: scheme and host name matching in the Android framework is
4856 * case-sensitive, unlike the formal RFC. As a result,
4857 * you should always ensure that you write your Uri with these elements
4858 * using lower case letters, and normalize any Uris you receive from
4859 * outside of Android to ensure the scheme and host is lower case.</em></p>
4860 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004861 * @param action The Intent action, such as ACTION_VIEW.
4862 * @param uri The Intent data URI.
4863 */
4864 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004865 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004866 mData = uri;
4867 }
4868
4869 /**
4870 * Create an intent for a specific component. All other fields (action, data,
4871 * type, class) are null, though they can be modified later with explicit
4872 * calls. This provides a convenient way to create an intent that is
4873 * intended to execute a hard-coded class name, rather than relying on the
4874 * system to find an appropriate class for you; see {@link #setComponent}
4875 * for more information on the repercussions of this.
4876 *
4877 * @param packageContext A Context of the application package implementing
4878 * this class.
4879 * @param cls The component class that is to be used for the intent.
4880 *
4881 * @see #setClass
4882 * @see #setComponent
4883 * @see #Intent(String, android.net.Uri , Context, Class)
4884 */
4885 public Intent(Context packageContext, Class<?> cls) {
4886 mComponent = new ComponentName(packageContext, cls);
4887 }
4888
4889 /**
4890 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004891 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004892 * construct the Intent and then calling {@link #setClass} to set its
4893 * class.
4894 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004895 * <p><em>Note: scheme and host name matching in the Android framework is
4896 * case-sensitive, unlike the formal RFC. As a result,
4897 * you should always ensure that you write your Uri with these elements
4898 * using lower case letters, and normalize any Uris you receive from
4899 * outside of Android to ensure the scheme and host is lower case.</em></p>
4900 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004901 * @param action The Intent action, such as ACTION_VIEW.
4902 * @param uri The Intent data URI.
4903 * @param packageContext A Context of the application package implementing
4904 * this class.
4905 * @param cls The component class that is to be used for the intent.
4906 *
4907 * @see #Intent(String, android.net.Uri)
4908 * @see #Intent(Context, Class)
4909 * @see #setClass
4910 * @see #setComponent
4911 */
4912 public Intent(String action, Uri uri,
4913 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004914 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004915 mData = uri;
4916 mComponent = new ComponentName(packageContext, cls);
4917 }
4918
4919 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004920 * Create an intent to launch the main (root) activity of a task. This
4921 * is the Intent that is started when the application's is launched from
4922 * Home. For anything else that wants to launch an application in the
4923 * same way, it is important that they use an Intent structured the same
4924 * way, and can use this function to ensure this is the case.
4925 *
4926 * <p>The returned Intent has the given Activity component as its explicit
4927 * component, {@link #ACTION_MAIN} as its action, and includes the
4928 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4929 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4930 * to do that through {@link #addFlags(int)} on the returned Intent.
4931 *
4932 * @param mainActivity The main activity component that this Intent will
4933 * launch.
4934 * @return Returns a newly created Intent that can be used to launch the
4935 * activity as a main application entry.
4936 *
4937 * @see #setClass
4938 * @see #setComponent
4939 */
4940 public static Intent makeMainActivity(ComponentName mainActivity) {
4941 Intent intent = new Intent(ACTION_MAIN);
4942 intent.setComponent(mainActivity);
4943 intent.addCategory(CATEGORY_LAUNCHER);
4944 return intent;
4945 }
4946
4947 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004948 * Make an Intent for the main activity of an application, without
4949 * specifying a specific activity to run but giving a selector to find
4950 * the activity. This results in a final Intent that is structured
4951 * the same as when the application is launched from
4952 * Home. For anything else that wants to launch an application in the
4953 * same way, it is important that they use an Intent structured the same
4954 * way, and can use this function to ensure this is the case.
4955 *
4956 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4957 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4958 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4959 * to do that through {@link #addFlags(int)} on the returned Intent.
4960 *
4961 * @param selectorAction The action name of the Intent's selector.
4962 * @param selectorCategory The name of a category to add to the Intent's
4963 * selector.
4964 * @return Returns a newly created Intent that can be used to launch the
4965 * activity as a main application entry.
4966 *
4967 * @see #setSelector(Intent)
4968 */
4969 public static Intent makeMainSelectorActivity(String selectorAction,
4970 String selectorCategory) {
4971 Intent intent = new Intent(ACTION_MAIN);
4972 intent.addCategory(CATEGORY_LAUNCHER);
4973 Intent selector = new Intent();
4974 selector.setAction(selectorAction);
4975 selector.addCategory(selectorCategory);
4976 intent.setSelector(selector);
4977 return intent;
4978 }
4979
4980 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004981 * Make an Intent that can be used to re-launch an application's task
4982 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4983 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4984 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4985 *
4986 * @param mainActivity The activity component that is the root of the
4987 * task; this is the activity that has been published in the application's
4988 * manifest as the main launcher icon.
4989 *
4990 * @return Returns a newly created Intent that can be used to relaunch the
4991 * activity's task in its root state.
4992 */
4993 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4994 Intent intent = makeMainActivity(mainActivity);
4995 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4996 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4997 return intent;
4998 }
4999
5000 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005001 * Call {@link #parseUri} with 0 flags.
5002 * @deprecated Use {@link #parseUri} instead.
5003 */
5004 @Deprecated
5005 public static Intent getIntent(String uri) throws URISyntaxException {
5006 return parseUri(uri, 0);
5007 }
Tom Taylord4a47292009-12-21 13:59:18 -08005008
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005009 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005010 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005011 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005012 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005013 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005014 *
5015 * <p>The URI given here must not be relative -- that is, it must include
5016 * the scheme and full path.
5017 *
5018 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005019 * @param flags Additional processing flags. Either 0,
5020 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005021 *
5022 * @return Intent The newly created Intent object.
5023 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005024 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5025 * it bad (as parsed by the Uri class) or the Intent data within the
5026 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005027 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005028 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005029 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005030 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005031 int i = 0;
5032 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005033 final boolean androidApp = uri.startsWith("android-app:");
5034
5035 // Validate intent scheme if requested.
5036 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5037 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005038 Intent intent = new Intent(ACTION_VIEW);
5039 try {
5040 intent.setData(Uri.parse(uri));
5041 } catch (IllegalArgumentException e) {
5042 throw new URISyntaxException(uri, e.getMessage());
5043 }
5044 return intent;
5045 }
5046 }
Tom Taylord4a47292009-12-21 13:59:18 -08005047
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005048 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005049 // simple case
5050 if (i == -1) {
5051 if (!androidApp) {
5052 return new Intent(ACTION_VIEW, Uri.parse(uri));
5053 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005054
5055 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005056 } else if (!uri.startsWith("#Intent;", i)) {
5057 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005058 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005059 } else {
5060 i = -1;
5061 }
5062 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005063
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005064 // new format
5065 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005066 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005067 boolean explicitAction = false;
5068 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005069
5070 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005071 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005072 String data;
5073 if (i >= 0) {
5074 data = uri.substring(0, i);
5075 i += 8; // length of "#Intent;"
5076 } else {
5077 data = uri;
5078 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005079
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005080 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005081 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005082 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005083 if (eq < 0) eq = i-1;
5084 int semi = uri.indexOf(';', i);
5085 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005086
5087 // action
5088 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005089 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005090 if (!inSelector) {
5091 explicitAction = true;
5092 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005093 }
5094
5095 // categories
5096 else if (uri.startsWith("category=", i)) {
5097 intent.addCategory(value);
5098 }
5099
5100 // type
5101 else if (uri.startsWith("type=", i)) {
5102 intent.mType = value;
5103 }
5104
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005105 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005106 else if (uri.startsWith("launchFlags=", i)) {
5107 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005108 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5109 intent.mFlags &= ~IMMUTABLE_FLAGS;
5110 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005111 }
5112
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005113 // package
5114 else if (uri.startsWith("package=", i)) {
5115 intent.mPackage = value;
5116 }
5117
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005118 // component
5119 else if (uri.startsWith("component=", i)) {
5120 intent.mComponent = ComponentName.unflattenFromString(value);
5121 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005122
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005123 // scheme
5124 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005125 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005126 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005127 } else {
5128 scheme = value;
5129 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005130 }
5131
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005132 // source bounds
5133 else if (uri.startsWith("sourceBounds=", i)) {
5134 intent.mSourceBounds = Rect.unflattenFromString(value);
5135 }
5136
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005137 // selector
5138 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5139 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005140 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005141 }
5142
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005143 // extra
5144 else {
5145 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005146 // create Bundle if it doesn't already exist
5147 if (intent.mExtras == null) intent.mExtras = new Bundle();
5148 Bundle b = intent.mExtras;
5149 // add EXTRA
5150 if (uri.startsWith("S.", i)) b.putString(key, value);
5151 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5152 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5153 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5154 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5155 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5156 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5157 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5158 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5159 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5160 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005161
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005162 // move to the next item
5163 i = semi + 1;
5164 }
5165
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005166 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005167 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005168 if (baseIntent.mPackage == null) {
5169 baseIntent.setSelector(intent);
5170 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005171 intent = baseIntent;
5172 }
5173
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005174 if (data != null) {
5175 if (data.startsWith("intent:")) {
5176 data = data.substring(7);
5177 if (scheme != null) {
5178 data = scheme + ':' + data;
5179 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005180 } else if (data.startsWith("android-app:")) {
5181 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5182 // Correctly formed android-app, first part is package name.
5183 int end = data.indexOf('/', 14);
5184 if (end < 0) {
5185 // All we have is a package name.
5186 intent.mPackage = data.substring(14);
5187 if (!explicitAction) {
5188 intent.setAction(ACTION_MAIN);
5189 }
5190 data = "";
5191 } else {
5192 // Target the Intent at the given package name always.
5193 String authority = null;
5194 intent.mPackage = data.substring(14, end);
5195 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005196 if ((end+1) < data.length()) {
5197 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5198 // Found a scheme, remember it.
5199 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005200 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005201 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5202 // Found a authority, remember it.
5203 authority = data.substring(end+1, newEnd);
5204 end = newEnd;
5205 }
5206 } else {
5207 // All we have is a scheme.
5208 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005209 }
5210 }
5211 if (scheme == null) {
5212 // If there was no scheme, then this just targets the package.
5213 if (!explicitAction) {
5214 intent.setAction(ACTION_MAIN);
5215 }
5216 data = "";
5217 } else if (authority == null) {
5218 data = scheme + ":";
5219 } else {
5220 data = scheme + "://" + authority + data.substring(end);
5221 }
5222 }
5223 } else {
5224 data = "";
5225 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005226 }
Tom Taylord4a47292009-12-21 13:59:18 -08005227
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005228 if (data.length() > 0) {
5229 try {
5230 intent.mData = Uri.parse(data);
5231 } catch (IllegalArgumentException e) {
5232 throw new URISyntaxException(uri, e.getMessage());
5233 }
5234 }
5235 }
Tom Taylord4a47292009-12-21 13:59:18 -08005236
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005237 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005238
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005239 } catch (IndexOutOfBoundsException e) {
5240 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5241 }
5242 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005243
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005244 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005245 return getIntentOld(uri, 0);
5246 }
5247
5248 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005249 Intent intent;
5250
5251 int i = uri.lastIndexOf('#');
5252 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005253 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005254 final int intentFragmentStart = i;
5255 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005256
5257 i++;
5258
5259 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005260 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005261 i += 7;
5262 int j = uri.indexOf(')', i);
5263 action = uri.substring(i, j);
5264 i = j + 1;
5265 }
5266
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005267 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005268
5269 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005270 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005271 i += 11;
5272 int j = uri.indexOf(')', i);
5273 while (i < j) {
5274 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005275 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005276 if (i < sep) {
5277 intent.addCategory(uri.substring(i, sep));
5278 }
5279 i = sep + 1;
5280 }
5281 i = j + 1;
5282 }
5283
5284 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005285 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005286 i += 5;
5287 int j = uri.indexOf(')', i);
5288 intent.mType = uri.substring(i, j);
5289 i = j + 1;
5290 }
5291
5292 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005293 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005294 i += 12;
5295 int j = uri.indexOf(')', i);
5296 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005297 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5298 intent.mFlags &= ~IMMUTABLE_FLAGS;
5299 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005300 i = j + 1;
5301 }
5302
5303 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005304 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005305 i += 10;
5306 int j = uri.indexOf(')', i);
5307 int sep = uri.indexOf('!', i);
5308 if (sep >= 0 && sep < j) {
5309 String pkg = uri.substring(i, sep);
5310 String cls = uri.substring(sep + 1, j);
5311 intent.mComponent = new ComponentName(pkg, cls);
5312 }
5313 i = j + 1;
5314 }
5315
5316 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005317 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005318 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005319
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005320 final int closeParen = uri.indexOf(')', i);
5321 if (closeParen == -1) throw new URISyntaxException(uri,
5322 "EXTRA missing trailing ')'", i);
5323
5324 while (i < closeParen) {
5325 // fetch the key value
5326 int j = uri.indexOf('=', i);
5327 if (j <= i + 1 || i >= closeParen) {
5328 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5329 }
5330 char type = uri.charAt(i);
5331 i++;
5332 String key = uri.substring(i, j);
5333 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005334
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005335 // get type-value
5336 j = uri.indexOf('!', i);
5337 if (j == -1 || j >= closeParen) j = closeParen;
5338 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5339 String value = uri.substring(i, j);
5340 i = j;
5341
5342 // create Bundle if it doesn't already exist
5343 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005344
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005345 // add item to bundle
5346 try {
5347 switch (type) {
5348 case 'S':
5349 intent.mExtras.putString(key, Uri.decode(value));
5350 break;
5351 case 'B':
5352 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5353 break;
5354 case 'b':
5355 intent.mExtras.putByte(key, Byte.parseByte(value));
5356 break;
5357 case 'c':
5358 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5359 break;
5360 case 'd':
5361 intent.mExtras.putDouble(key, Double.parseDouble(value));
5362 break;
5363 case 'f':
5364 intent.mExtras.putFloat(key, Float.parseFloat(value));
5365 break;
5366 case 'i':
5367 intent.mExtras.putInt(key, Integer.parseInt(value));
5368 break;
5369 case 'l':
5370 intent.mExtras.putLong(key, Long.parseLong(value));
5371 break;
5372 case 's':
5373 intent.mExtras.putShort(key, Short.parseShort(value));
5374 break;
5375 default:
5376 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5377 }
5378 } catch (NumberFormatException e) {
5379 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5380 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005381
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005382 char ch = uri.charAt(i);
5383 if (ch == ')') break;
5384 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5385 i++;
5386 }
5387 }
5388
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005389 if (isIntentFragment) {
5390 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5391 } else {
5392 intent.mData = Uri.parse(uri);
5393 }
Tom Taylord4a47292009-12-21 13:59:18 -08005394
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005395 if (intent.mAction == null) {
5396 // By default, if no action is specified, then use VIEW.
5397 intent.mAction = ACTION_VIEW;
5398 }
5399
5400 } else {
5401 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5402 }
5403
5404 return intent;
5405 }
5406
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005407 /** @hide */
5408 public interface CommandOptionHandler {
5409 boolean handleOption(String opt, ShellCommand cmd);
5410 }
5411
5412 /** @hide */
5413 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5414 throws URISyntaxException {
5415 Intent intent = new Intent();
5416 Intent baseIntent = intent;
5417 boolean hasIntentInfo = false;
5418
5419 Uri data = null;
5420 String type = null;
5421
5422 String opt;
5423 while ((opt=cmd.getNextOption()) != null) {
5424 switch (opt) {
5425 case "-a":
5426 intent.setAction(cmd.getNextArgRequired());
5427 if (intent == baseIntent) {
5428 hasIntentInfo = true;
5429 }
5430 break;
5431 case "-d":
5432 data = Uri.parse(cmd.getNextArgRequired());
5433 if (intent == baseIntent) {
5434 hasIntentInfo = true;
5435 }
5436 break;
5437 case "-t":
5438 type = cmd.getNextArgRequired();
5439 if (intent == baseIntent) {
5440 hasIntentInfo = true;
5441 }
5442 break;
5443 case "-c":
5444 intent.addCategory(cmd.getNextArgRequired());
5445 if (intent == baseIntent) {
5446 hasIntentInfo = true;
5447 }
5448 break;
5449 case "-e":
5450 case "--es": {
5451 String key = cmd.getNextArgRequired();
5452 String value = cmd.getNextArgRequired();
5453 intent.putExtra(key, value);
5454 }
5455 break;
5456 case "--esn": {
5457 String key = cmd.getNextArgRequired();
5458 intent.putExtra(key, (String) null);
5459 }
5460 break;
5461 case "--ei": {
5462 String key = cmd.getNextArgRequired();
5463 String value = cmd.getNextArgRequired();
5464 intent.putExtra(key, Integer.decode(value));
5465 }
5466 break;
5467 case "--eu": {
5468 String key = cmd.getNextArgRequired();
5469 String value = cmd.getNextArgRequired();
5470 intent.putExtra(key, Uri.parse(value));
5471 }
5472 break;
5473 case "--ecn": {
5474 String key = cmd.getNextArgRequired();
5475 String value = cmd.getNextArgRequired();
5476 ComponentName cn = ComponentName.unflattenFromString(value);
5477 if (cn == null)
5478 throw new IllegalArgumentException("Bad component name: " + value);
5479 intent.putExtra(key, cn);
5480 }
5481 break;
5482 case "--eia": {
5483 String key = cmd.getNextArgRequired();
5484 String value = cmd.getNextArgRequired();
5485 String[] strings = value.split(",");
5486 int[] list = new int[strings.length];
5487 for (int i = 0; i < strings.length; i++) {
5488 list[i] = Integer.decode(strings[i]);
5489 }
5490 intent.putExtra(key, list);
5491 }
5492 break;
5493 case "--eial": {
5494 String key = cmd.getNextArgRequired();
5495 String value = cmd.getNextArgRequired();
5496 String[] strings = value.split(",");
5497 ArrayList<Integer> list = new ArrayList<>(strings.length);
5498 for (int i = 0; i < strings.length; i++) {
5499 list.add(Integer.decode(strings[i]));
5500 }
5501 intent.putExtra(key, list);
5502 }
5503 break;
5504 case "--el": {
5505 String key = cmd.getNextArgRequired();
5506 String value = cmd.getNextArgRequired();
5507 intent.putExtra(key, Long.valueOf(value));
5508 }
5509 break;
5510 case "--ela": {
5511 String key = cmd.getNextArgRequired();
5512 String value = cmd.getNextArgRequired();
5513 String[] strings = value.split(",");
5514 long[] list = new long[strings.length];
5515 for (int i = 0; i < strings.length; i++) {
5516 list[i] = Long.valueOf(strings[i]);
5517 }
5518 intent.putExtra(key, list);
5519 hasIntentInfo = true;
5520 }
5521 break;
5522 case "--elal": {
5523 String key = cmd.getNextArgRequired();
5524 String value = cmd.getNextArgRequired();
5525 String[] strings = value.split(",");
5526 ArrayList<Long> list = new ArrayList<>(strings.length);
5527 for (int i = 0; i < strings.length; i++) {
5528 list.add(Long.valueOf(strings[i]));
5529 }
5530 intent.putExtra(key, list);
5531 hasIntentInfo = true;
5532 }
5533 break;
5534 case "--ef": {
5535 String key = cmd.getNextArgRequired();
5536 String value = cmd.getNextArgRequired();
5537 intent.putExtra(key, Float.valueOf(value));
5538 hasIntentInfo = true;
5539 }
5540 break;
5541 case "--efa": {
5542 String key = cmd.getNextArgRequired();
5543 String value = cmd.getNextArgRequired();
5544 String[] strings = value.split(",");
5545 float[] list = new float[strings.length];
5546 for (int i = 0; i < strings.length; i++) {
5547 list[i] = Float.valueOf(strings[i]);
5548 }
5549 intent.putExtra(key, list);
5550 hasIntentInfo = true;
5551 }
5552 break;
5553 case "--efal": {
5554 String key = cmd.getNextArgRequired();
5555 String value = cmd.getNextArgRequired();
5556 String[] strings = value.split(",");
5557 ArrayList<Float> list = new ArrayList<>(strings.length);
5558 for (int i = 0; i < strings.length; i++) {
5559 list.add(Float.valueOf(strings[i]));
5560 }
5561 intent.putExtra(key, list);
5562 hasIntentInfo = true;
5563 }
5564 break;
5565 case "--esa": {
5566 String key = cmd.getNextArgRequired();
5567 String value = cmd.getNextArgRequired();
5568 // Split on commas unless they are preceeded by an escape.
5569 // The escape character must be escaped for the string and
5570 // again for the regex, thus four escape characters become one.
5571 String[] strings = value.split("(?<!\\\\),");
5572 intent.putExtra(key, strings);
5573 hasIntentInfo = true;
5574 }
5575 break;
5576 case "--esal": {
5577 String key = cmd.getNextArgRequired();
5578 String value = cmd.getNextArgRequired();
5579 // Split on commas unless they are preceeded by an escape.
5580 // The escape character must be escaped for the string and
5581 // again for the regex, thus four escape characters become one.
5582 String[] strings = value.split("(?<!\\\\),");
5583 ArrayList<String> list = new ArrayList<>(strings.length);
5584 for (int i = 0; i < strings.length; i++) {
5585 list.add(strings[i]);
5586 }
5587 intent.putExtra(key, list);
5588 hasIntentInfo = true;
5589 }
5590 break;
5591 case "--ez": {
5592 String key = cmd.getNextArgRequired();
5593 String value = cmd.getNextArgRequired().toLowerCase();
5594 // Boolean.valueOf() results in false for anything that is not "true", which is
5595 // error-prone in shell commands
5596 boolean arg;
5597 if ("true".equals(value) || "t".equals(value)) {
5598 arg = true;
5599 } else if ("false".equals(value) || "f".equals(value)) {
5600 arg = false;
5601 } else {
5602 try {
5603 arg = Integer.decode(value) != 0;
5604 } catch (NumberFormatException ex) {
5605 throw new IllegalArgumentException("Invalid boolean value: " + value);
5606 }
5607 }
5608
5609 intent.putExtra(key, arg);
5610 }
5611 break;
5612 case "-n": {
5613 String str = cmd.getNextArgRequired();
5614 ComponentName cn = ComponentName.unflattenFromString(str);
5615 if (cn == null)
5616 throw new IllegalArgumentException("Bad component name: " + str);
5617 intent.setComponent(cn);
5618 if (intent == baseIntent) {
5619 hasIntentInfo = true;
5620 }
5621 }
5622 break;
5623 case "-p": {
5624 String str = cmd.getNextArgRequired();
5625 intent.setPackage(str);
5626 if (intent == baseIntent) {
5627 hasIntentInfo = true;
5628 }
5629 }
5630 break;
5631 case "-f":
5632 String str = cmd.getNextArgRequired();
5633 intent.setFlags(Integer.decode(str).intValue());
5634 break;
5635 case "--grant-read-uri-permission":
5636 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5637 break;
5638 case "--grant-write-uri-permission":
5639 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5640 break;
5641 case "--grant-persistable-uri-permission":
5642 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5643 break;
5644 case "--grant-prefix-uri-permission":
5645 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5646 break;
5647 case "--exclude-stopped-packages":
5648 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5649 break;
5650 case "--include-stopped-packages":
5651 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5652 break;
5653 case "--debug-log-resolution":
5654 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5655 break;
5656 case "--activity-brought-to-front":
5657 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5658 break;
5659 case "--activity-clear-top":
5660 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5661 break;
5662 case "--activity-clear-when-task-reset":
5663 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5664 break;
5665 case "--activity-exclude-from-recents":
5666 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5667 break;
5668 case "--activity-launched-from-history":
5669 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5670 break;
5671 case "--activity-multiple-task":
5672 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5673 break;
5674 case "--activity-no-animation":
5675 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5676 break;
5677 case "--activity-no-history":
5678 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5679 break;
5680 case "--activity-no-user-action":
5681 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5682 break;
5683 case "--activity-previous-is-top":
5684 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5685 break;
5686 case "--activity-reorder-to-front":
5687 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5688 break;
5689 case "--activity-reset-task-if-needed":
5690 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5691 break;
5692 case "--activity-single-top":
5693 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5694 break;
5695 case "--activity-clear-task":
5696 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5697 break;
5698 case "--activity-task-on-home":
5699 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5700 break;
5701 case "--receiver-registered-only":
5702 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5703 break;
5704 case "--receiver-replace-pending":
5705 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5706 break;
5707 case "--selector":
5708 intent.setDataAndType(data, type);
5709 intent = new Intent();
5710 break;
5711 default:
5712 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5713 // Okay, caller handled this option.
5714 } else {
5715 throw new IllegalArgumentException("Unknown option: " + opt);
5716 }
5717 break;
5718 }
5719 }
5720 intent.setDataAndType(data, type);
5721
5722 final boolean hasSelector = intent != baseIntent;
5723 if (hasSelector) {
5724 // A selector was specified; fix up.
5725 baseIntent.setSelector(intent);
5726 intent = baseIntent;
5727 }
5728
5729 String arg = cmd.getNextArg();
5730 baseIntent = null;
5731 if (arg == null) {
5732 if (hasSelector) {
5733 // If a selector has been specified, and no arguments
5734 // have been supplied for the main Intent, then we can
5735 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5736 // need to have a component name specified yet, the
5737 // selector will take care of that.
5738 baseIntent = new Intent(Intent.ACTION_MAIN);
5739 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5740 }
5741 } else if (arg.indexOf(':') >= 0) {
5742 // The argument is a URI. Fully parse it, and use that result
5743 // to fill in any data not specified so far.
5744 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5745 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5746 } else if (arg.indexOf('/') >= 0) {
5747 // The argument is a component name. Build an Intent to launch
5748 // it.
5749 baseIntent = new Intent(Intent.ACTION_MAIN);
5750 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5751 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5752 } else {
5753 // Assume the argument is a package name.
5754 baseIntent = new Intent(Intent.ACTION_MAIN);
5755 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5756 baseIntent.setPackage(arg);
5757 }
5758 if (baseIntent != null) {
5759 Bundle extras = intent.getExtras();
5760 intent.replaceExtras((Bundle)null);
5761 Bundle uriExtras = baseIntent.getExtras();
5762 baseIntent.replaceExtras((Bundle)null);
5763 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5764 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5765 for (String c : cats) {
5766 baseIntent.removeCategory(c);
5767 }
5768 }
5769 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5770 if (extras == null) {
5771 extras = uriExtras;
5772 } else if (uriExtras != null) {
5773 uriExtras.putAll(extras);
5774 extras = uriExtras;
5775 }
5776 intent.replaceExtras(extras);
5777 hasIntentInfo = true;
5778 }
5779
5780 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5781 return intent;
5782 }
5783
5784 /** @hide */
5785 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5786 final String[] lines = new String[] {
5787 "<INTENT> specifications include these flags and arguments:",
5788 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5789 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5790 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5791 " [--esn <EXTRA_KEY> ...]",
5792 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5793 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5794 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5795 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5796 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5797 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5798 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5799 " (mutiple extras passed as Integer[])",
5800 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5801 " (mutiple extras passed as List<Integer>)",
5802 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5803 " (mutiple extras passed as Long[])",
5804 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5805 " (mutiple extras passed as List<Long>)",
5806 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5807 " (mutiple extras passed as Float[])",
5808 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5809 " (mutiple extras passed as List<Float>)",
5810 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5811 " (mutiple extras passed as String[]; to embed a comma into a string,",
5812 " escape it using \"\\,\")",
5813 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5814 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5815 " escape it using \"\\,\")",
5816 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5817 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5818 " [--debug-log-resolution] [--exclude-stopped-packages]",
5819 " [--include-stopped-packages]",
5820 " [--activity-brought-to-front] [--activity-clear-top]",
5821 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5822 " [--activity-launched-from-history] [--activity-multiple-task]",
5823 " [--activity-no-animation] [--activity-no-history]",
5824 " [--activity-no-user-action] [--activity-previous-is-top]",
5825 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5826 " [--activity-single-top] [--activity-clear-task]",
5827 " [--activity-task-on-home]",
5828 " [--receiver-registered-only] [--receiver-replace-pending]",
5829 " [--selector]",
5830 " [<URI> | <PACKAGE> | <COMPONENT>]"
5831 };
5832 for (String line : lines) {
5833 pw.print(prefix);
5834 pw.println(line);
5835 }
5836 }
5837
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005838 /**
5839 * Retrieve the general action to be performed, such as
5840 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5841 * the information in the intent should be interpreted -- most importantly,
5842 * what to do with the data returned by {@link #getData}.
5843 *
5844 * @return The action of this intent or null if none is specified.
5845 *
5846 * @see #setAction
5847 */
5848 public String getAction() {
5849 return mAction;
5850 }
5851
5852 /**
5853 * Retrieve data this intent is operating on. This URI specifies the name
5854 * of the data; often it uses the content: scheme, specifying data in a
5855 * content provider. Other schemes may be handled by specific activities,
5856 * such as http: by the web browser.
5857 *
5858 * @return The URI of the data this intent is targeting or null.
5859 *
5860 * @see #getScheme
5861 * @see #setData
5862 */
5863 public Uri getData() {
5864 return mData;
5865 }
5866
5867 /**
5868 * The same as {@link #getData()}, but returns the URI as an encoded
5869 * String.
5870 */
5871 public String getDataString() {
5872 return mData != null ? mData.toString() : null;
5873 }
5874
5875 /**
5876 * Return the scheme portion of the intent's data. If the data is null or
5877 * does not include a scheme, null is returned. Otherwise, the scheme
5878 * prefix without the final ':' is returned, i.e. "http".
5879 *
5880 * <p>This is the same as calling getData().getScheme() (and checking for
5881 * null data).
5882 *
5883 * @return The scheme of this intent.
5884 *
5885 * @see #getData
5886 */
5887 public String getScheme() {
5888 return mData != null ? mData.getScheme() : null;
5889 }
5890
5891 /**
5892 * Retrieve any explicit MIME type included in the intent. This is usually
5893 * null, as the type is determined by the intent data.
5894 *
5895 * @return If a type was manually set, it is returned; else null is
5896 * returned.
5897 *
5898 * @see #resolveType(ContentResolver)
5899 * @see #setType
5900 */
5901 public String getType() {
5902 return mType;
5903 }
5904
5905 /**
5906 * Return the MIME data type of this intent. If the type field is
5907 * explicitly set, that is simply returned. Otherwise, if the data is set,
5908 * the type of that data is returned. If neither fields are set, a null is
5909 * returned.
5910 *
5911 * @return The MIME type of this intent.
5912 *
5913 * @see #getType
5914 * @see #resolveType(ContentResolver)
5915 */
5916 public String resolveType(Context context) {
5917 return resolveType(context.getContentResolver());
5918 }
5919
5920 /**
5921 * Return the MIME data type of this intent. If the type field is
5922 * explicitly set, that is simply returned. Otherwise, if the data is set,
5923 * the type of that data is returned. If neither fields are set, a null is
5924 * returned.
5925 *
5926 * @param resolver A ContentResolver that can be used to determine the MIME
5927 * type of the intent's data.
5928 *
5929 * @return The MIME type of this intent.
5930 *
5931 * @see #getType
5932 * @see #resolveType(Context)
5933 */
5934 public String resolveType(ContentResolver resolver) {
5935 if (mType != null) {
5936 return mType;
5937 }
5938 if (mData != null) {
5939 if ("content".equals(mData.getScheme())) {
5940 return resolver.getType(mData);
5941 }
5942 }
5943 return null;
5944 }
5945
5946 /**
5947 * Return the MIME data type of this intent, only if it will be needed for
5948 * intent resolution. This is not generally useful for application code;
5949 * it is used by the frameworks for communicating with back-end system
5950 * services.
5951 *
5952 * @param resolver A ContentResolver that can be used to determine the MIME
5953 * type of the intent's data.
5954 *
5955 * @return The MIME type of this intent, or null if it is unknown or not
5956 * needed.
5957 */
5958 public String resolveTypeIfNeeded(ContentResolver resolver) {
5959 if (mComponent != null) {
5960 return mType;
5961 }
5962 return resolveType(resolver);
5963 }
5964
5965 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005966 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005967 *
5968 * @param category The category to check.
5969 *
5970 * @return boolean True if the intent contains the category, else false.
5971 *
5972 * @see #getCategories
5973 * @see #addCategory
5974 */
5975 public boolean hasCategory(String category) {
5976 return mCategories != null && mCategories.contains(category);
5977 }
5978
5979 /**
5980 * Return the set of all categories in the intent. If there are no categories,
5981 * returns NULL.
5982 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005983 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005984 *
5985 * @see #hasCategory
5986 * @see #addCategory
5987 */
5988 public Set<String> getCategories() {
5989 return mCategories;
5990 }
5991
5992 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005993 * Return the specific selector associated with this Intent. If there is
5994 * none, returns null. See {@link #setSelector} for more information.
5995 *
5996 * @see #setSelector
5997 */
5998 public Intent getSelector() {
5999 return mSelector;
6000 }
6001
6002 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006003 * Return the {@link ClipData} associated with this Intent. If there is
6004 * none, returns null. See {@link #setClipData} for more information.
6005 *
John Spurlock125d1332013-11-25 11:58:37 -05006006 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006007 */
6008 public ClipData getClipData() {
6009 return mClipData;
6010 }
6011
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006012 /** @hide */
6013 public int getContentUserHint() {
6014 return mContentUserHint;
6015 }
6016
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006017 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006018 * Sets the ClassLoader that will be used when unmarshalling
6019 * any Parcelable values from the extras of this Intent.
6020 *
6021 * @param loader a ClassLoader, or null to use the default loader
6022 * at the time of unmarshalling.
6023 */
6024 public void setExtrasClassLoader(ClassLoader loader) {
6025 if (mExtras != null) {
6026 mExtras.setClassLoader(loader);
6027 }
6028 }
6029
6030 /**
6031 * Returns true if an extra value is associated with the given name.
6032 * @param name the extra's name
6033 * @return true if the given extra is present.
6034 */
6035 public boolean hasExtra(String name) {
6036 return mExtras != null && mExtras.containsKey(name);
6037 }
6038
6039 /**
6040 * Returns true if the Intent's extras contain a parcelled file descriptor.
6041 * @return true if the Intent contains a parcelled file descriptor.
6042 */
6043 public boolean hasFileDescriptors() {
6044 return mExtras != null && mExtras.hasFileDescriptors();
6045 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006046
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006047 /** @hide */
6048 public void setAllowFds(boolean allowFds) {
6049 if (mExtras != null) {
6050 mExtras.setAllowFds(allowFds);
6051 }
6052 }
6053
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006054 /**
6055 * Retrieve extended data from the intent.
6056 *
6057 * @param name The name of the desired item.
6058 *
6059 * @return the value of an item that previously added with putExtra()
6060 * or null if none was found.
6061 *
6062 * @deprecated
6063 * @hide
6064 */
6065 @Deprecated
6066 public Object getExtra(String name) {
6067 return getExtra(name, null);
6068 }
6069
6070 /**
6071 * Retrieve extended data from the intent.
6072 *
6073 * @param name The name of the desired item.
6074 * @param defaultValue the value to be returned if no value of the desired
6075 * type is stored with the given name.
6076 *
6077 * @return the value of an item that previously added with putExtra()
6078 * or the default value if none was found.
6079 *
6080 * @see #putExtra(String, boolean)
6081 */
6082 public boolean getBooleanExtra(String name, boolean defaultValue) {
6083 return mExtras == null ? defaultValue :
6084 mExtras.getBoolean(name, defaultValue);
6085 }
6086
6087 /**
6088 * Retrieve extended data from the intent.
6089 *
6090 * @param name The name of the desired item.
6091 * @param defaultValue the value to be returned if no value of the desired
6092 * type is stored with the given name.
6093 *
6094 * @return the value of an item that previously added with putExtra()
6095 * or the default value if none was found.
6096 *
6097 * @see #putExtra(String, byte)
6098 */
6099 public byte getByteExtra(String name, byte defaultValue) {
6100 return mExtras == null ? defaultValue :
6101 mExtras.getByte(name, defaultValue);
6102 }
6103
6104 /**
6105 * Retrieve extended data from the intent.
6106 *
6107 * @param name The name of the desired item.
6108 * @param defaultValue the value to be returned if no value of the desired
6109 * type is stored with the given name.
6110 *
6111 * @return the value of an item that previously added with putExtra()
6112 * or the default value if none was found.
6113 *
6114 * @see #putExtra(String, short)
6115 */
6116 public short getShortExtra(String name, short defaultValue) {
6117 return mExtras == null ? defaultValue :
6118 mExtras.getShort(name, defaultValue);
6119 }
6120
6121 /**
6122 * Retrieve extended data from the intent.
6123 *
6124 * @param name The name of the desired item.
6125 * @param defaultValue the value to be returned if no value of the desired
6126 * type is stored with the given name.
6127 *
6128 * @return the value of an item that previously added with putExtra()
6129 * or the default value if none was found.
6130 *
6131 * @see #putExtra(String, char)
6132 */
6133 public char getCharExtra(String name, char defaultValue) {
6134 return mExtras == null ? defaultValue :
6135 mExtras.getChar(name, defaultValue);
6136 }
6137
6138 /**
6139 * Retrieve extended data from the intent.
6140 *
6141 * @param name The name of the desired item.
6142 * @param defaultValue the value to be returned if no value of the desired
6143 * type is stored with the given name.
6144 *
6145 * @return the value of an item that previously added with putExtra()
6146 * or the default value if none was found.
6147 *
6148 * @see #putExtra(String, int)
6149 */
6150 public int getIntExtra(String name, int defaultValue) {
6151 return mExtras == null ? defaultValue :
6152 mExtras.getInt(name, defaultValue);
6153 }
6154
6155 /**
6156 * Retrieve extended data from the intent.
6157 *
6158 * @param name The name of the desired item.
6159 * @param defaultValue the value to be returned if no value of the desired
6160 * type is stored with the given name.
6161 *
6162 * @return the value of an item that previously added with putExtra()
6163 * or the default value if none was found.
6164 *
6165 * @see #putExtra(String, long)
6166 */
6167 public long getLongExtra(String name, long defaultValue) {
6168 return mExtras == null ? defaultValue :
6169 mExtras.getLong(name, defaultValue);
6170 }
6171
6172 /**
6173 * Retrieve extended data from the intent.
6174 *
6175 * @param name The name of the desired item.
6176 * @param defaultValue the value to be returned if no value of the desired
6177 * type is stored with the given name.
6178 *
6179 * @return the value of an item that previously added with putExtra(),
6180 * or the default value if no such item is present
6181 *
6182 * @see #putExtra(String, float)
6183 */
6184 public float getFloatExtra(String name, float defaultValue) {
6185 return mExtras == null ? defaultValue :
6186 mExtras.getFloat(name, defaultValue);
6187 }
6188
6189 /**
6190 * Retrieve extended data from the intent.
6191 *
6192 * @param name The name of the desired item.
6193 * @param defaultValue the value to be returned if no value of the desired
6194 * type is stored with the given name.
6195 *
6196 * @return the value of an item that previously added with putExtra()
6197 * or the default value if none was found.
6198 *
6199 * @see #putExtra(String, double)
6200 */
6201 public double getDoubleExtra(String name, double defaultValue) {
6202 return mExtras == null ? defaultValue :
6203 mExtras.getDouble(name, defaultValue);
6204 }
6205
6206 /**
6207 * Retrieve extended data from the intent.
6208 *
6209 * @param name The name of the desired item.
6210 *
6211 * @return the value of an item that previously added with putExtra()
6212 * or null if no String value was found.
6213 *
6214 * @see #putExtra(String, String)
6215 */
6216 public String getStringExtra(String name) {
6217 return mExtras == null ? null : mExtras.getString(name);
6218 }
6219
6220 /**
6221 * Retrieve extended data from the intent.
6222 *
6223 * @param name The name of the desired item.
6224 *
6225 * @return the value of an item that previously added with putExtra()
6226 * or null if no CharSequence value was found.
6227 *
6228 * @see #putExtra(String, CharSequence)
6229 */
6230 public CharSequence getCharSequenceExtra(String name) {
6231 return mExtras == null ? null : mExtras.getCharSequence(name);
6232 }
6233
6234 /**
6235 * Retrieve extended data from the intent.
6236 *
6237 * @param name The name of the desired item.
6238 *
6239 * @return the value of an item that previously added with putExtra()
6240 * or null if no Parcelable value was found.
6241 *
6242 * @see #putExtra(String, Parcelable)
6243 */
6244 public <T extends Parcelable> T getParcelableExtra(String name) {
6245 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6246 }
6247
6248 /**
6249 * Retrieve extended data from the intent.
6250 *
6251 * @param name The name of the desired item.
6252 *
6253 * @return the value of an item that previously added with putExtra()
6254 * or null if no Parcelable[] value was found.
6255 *
6256 * @see #putExtra(String, Parcelable[])
6257 */
6258 public Parcelable[] getParcelableArrayExtra(String name) {
6259 return mExtras == null ? null : mExtras.getParcelableArray(name);
6260 }
6261
6262 /**
6263 * Retrieve extended data from the intent.
6264 *
6265 * @param name The name of the desired item.
6266 *
6267 * @return the value of an item that previously added with putExtra()
6268 * or null if no ArrayList<Parcelable> value was found.
6269 *
6270 * @see #putParcelableArrayListExtra(String, ArrayList)
6271 */
6272 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6273 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6274 }
6275
6276 /**
6277 * Retrieve extended data from the intent.
6278 *
6279 * @param name The name of the desired item.
6280 *
6281 * @return the value of an item that previously added with putExtra()
6282 * or null if no Serializable value was found.
6283 *
6284 * @see #putExtra(String, Serializable)
6285 */
6286 public Serializable getSerializableExtra(String name) {
6287 return mExtras == null ? null : mExtras.getSerializable(name);
6288 }
6289
6290 /**
6291 * Retrieve extended data from the intent.
6292 *
6293 * @param name The name of the desired item.
6294 *
6295 * @return the value of an item that previously added with putExtra()
6296 * or null if no ArrayList<Integer> value was found.
6297 *
6298 * @see #putIntegerArrayListExtra(String, ArrayList)
6299 */
6300 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6301 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6302 }
6303
6304 /**
6305 * Retrieve extended data from the intent.
6306 *
6307 * @param name The name of the desired item.
6308 *
6309 * @return the value of an item that previously added with putExtra()
6310 * or null if no ArrayList<String> value was found.
6311 *
6312 * @see #putStringArrayListExtra(String, ArrayList)
6313 */
6314 public ArrayList<String> getStringArrayListExtra(String name) {
6315 return mExtras == null ? null : mExtras.getStringArrayList(name);
6316 }
6317
6318 /**
6319 * Retrieve extended data from the intent.
6320 *
6321 * @param name The name of the desired item.
6322 *
6323 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006324 * or null if no ArrayList<CharSequence> value was found.
6325 *
6326 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6327 */
6328 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6329 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6330 }
6331
6332 /**
6333 * Retrieve extended data from the intent.
6334 *
6335 * @param name The name of the desired item.
6336 *
6337 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006338 * or null if no boolean array value was found.
6339 *
6340 * @see #putExtra(String, boolean[])
6341 */
6342 public boolean[] getBooleanArrayExtra(String name) {
6343 return mExtras == null ? null : mExtras.getBooleanArray(name);
6344 }
6345
6346 /**
6347 * Retrieve extended data from the intent.
6348 *
6349 * @param name The name of the desired item.
6350 *
6351 * @return the value of an item that previously added with putExtra()
6352 * or null if no byte array value was found.
6353 *
6354 * @see #putExtra(String, byte[])
6355 */
6356 public byte[] getByteArrayExtra(String name) {
6357 return mExtras == null ? null : mExtras.getByteArray(name);
6358 }
6359
6360 /**
6361 * Retrieve extended data from the intent.
6362 *
6363 * @param name The name of the desired item.
6364 *
6365 * @return the value of an item that previously added with putExtra()
6366 * or null if no short array value was found.
6367 *
6368 * @see #putExtra(String, short[])
6369 */
6370 public short[] getShortArrayExtra(String name) {
6371 return mExtras == null ? null : mExtras.getShortArray(name);
6372 }
6373
6374 /**
6375 * Retrieve extended data from the intent.
6376 *
6377 * @param name The name of the desired item.
6378 *
6379 * @return the value of an item that previously added with putExtra()
6380 * or null if no char array value was found.
6381 *
6382 * @see #putExtra(String, char[])
6383 */
6384 public char[] getCharArrayExtra(String name) {
6385 return mExtras == null ? null : mExtras.getCharArray(name);
6386 }
6387
6388 /**
6389 * Retrieve extended data from the intent.
6390 *
6391 * @param name The name of the desired item.
6392 *
6393 * @return the value of an item that previously added with putExtra()
6394 * or null if no int array value was found.
6395 *
6396 * @see #putExtra(String, int[])
6397 */
6398 public int[] getIntArrayExtra(String name) {
6399 return mExtras == null ? null : mExtras.getIntArray(name);
6400 }
6401
6402 /**
6403 * Retrieve extended data from the intent.
6404 *
6405 * @param name The name of the desired item.
6406 *
6407 * @return the value of an item that previously added with putExtra()
6408 * or null if no long array value was found.
6409 *
6410 * @see #putExtra(String, long[])
6411 */
6412 public long[] getLongArrayExtra(String name) {
6413 return mExtras == null ? null : mExtras.getLongArray(name);
6414 }
6415
6416 /**
6417 * Retrieve extended data from the intent.
6418 *
6419 * @param name The name of the desired item.
6420 *
6421 * @return the value of an item that previously added with putExtra()
6422 * or null if no float array value was found.
6423 *
6424 * @see #putExtra(String, float[])
6425 */
6426 public float[] getFloatArrayExtra(String name) {
6427 return mExtras == null ? null : mExtras.getFloatArray(name);
6428 }
6429
6430 /**
6431 * Retrieve extended data from the intent.
6432 *
6433 * @param name The name of the desired item.
6434 *
6435 * @return the value of an item that previously added with putExtra()
6436 * or null if no double array value was found.
6437 *
6438 * @see #putExtra(String, double[])
6439 */
6440 public double[] getDoubleArrayExtra(String name) {
6441 return mExtras == null ? null : mExtras.getDoubleArray(name);
6442 }
6443
6444 /**
6445 * Retrieve extended data from the intent.
6446 *
6447 * @param name The name of the desired item.
6448 *
6449 * @return the value of an item that previously added with putExtra()
6450 * or null if no String array value was found.
6451 *
6452 * @see #putExtra(String, String[])
6453 */
6454 public String[] getStringArrayExtra(String name) {
6455 return mExtras == null ? null : mExtras.getStringArray(name);
6456 }
6457
6458 /**
6459 * Retrieve extended data from the intent.
6460 *
6461 * @param name The name of the desired item.
6462 *
6463 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006464 * or null if no CharSequence array value was found.
6465 *
6466 * @see #putExtra(String, CharSequence[])
6467 */
6468 public CharSequence[] getCharSequenceArrayExtra(String name) {
6469 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6470 }
6471
6472 /**
6473 * Retrieve extended data from the intent.
6474 *
6475 * @param name The name of the desired item.
6476 *
6477 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006478 * or null if no Bundle value was found.
6479 *
6480 * @see #putExtra(String, Bundle)
6481 */
6482 public Bundle getBundleExtra(String name) {
6483 return mExtras == null ? null : mExtras.getBundle(name);
6484 }
6485
6486 /**
6487 * Retrieve extended data from the intent.
6488 *
6489 * @param name The name of the desired item.
6490 *
6491 * @return the value of an item that previously added with putExtra()
6492 * or null if no IBinder value was found.
6493 *
6494 * @see #putExtra(String, IBinder)
6495 *
6496 * @deprecated
6497 * @hide
6498 */
6499 @Deprecated
6500 public IBinder getIBinderExtra(String name) {
6501 return mExtras == null ? null : mExtras.getIBinder(name);
6502 }
6503
6504 /**
6505 * Retrieve extended data from the intent.
6506 *
6507 * @param name The name of the desired item.
6508 * @param defaultValue The default value to return in case no item is
6509 * associated with the key 'name'
6510 *
6511 * @return the value of an item that previously added with putExtra()
6512 * or defaultValue if none was found.
6513 *
6514 * @see #putExtra
6515 *
6516 * @deprecated
6517 * @hide
6518 */
6519 @Deprecated
6520 public Object getExtra(String name, Object defaultValue) {
6521 Object result = defaultValue;
6522 if (mExtras != null) {
6523 Object result2 = mExtras.get(name);
6524 if (result2 != null) {
6525 result = result2;
6526 }
6527 }
6528
6529 return result;
6530 }
6531
6532 /**
6533 * Retrieves a map of extended data from the intent.
6534 *
6535 * @return the map of all extras previously added with putExtra(),
6536 * or null if none have been added.
6537 */
6538 public Bundle getExtras() {
6539 return (mExtras != null)
6540 ? new Bundle(mExtras)
6541 : null;
6542 }
6543
6544 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006545 * Filter extras to only basic types.
6546 * @hide
6547 */
6548 public void removeUnsafeExtras() {
6549 if (mExtras != null) {
6550 mExtras.filterValues();
6551 }
6552 }
6553
6554 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006555 * Retrieve any special flags associated with this intent. You will
6556 * normally just set them with {@link #setFlags} and let the system
6557 * take the appropriate action with them.
6558 *
6559 * @return int The currently set flags.
6560 *
6561 * @see #setFlags
6562 */
6563 public int getFlags() {
6564 return mFlags;
6565 }
6566
Dianne Hackborne7f97212011-02-24 14:40:20 -08006567 /** @hide */
6568 public boolean isExcludingStopped() {
6569 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6570 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6571 }
6572
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006573 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006574 * Retrieve the application package name this Intent is limited to. When
6575 * resolving an Intent, if non-null this limits the resolution to only
6576 * components in the given application package.
6577 *
6578 * @return The name of the application package for the Intent.
6579 *
6580 * @see #resolveActivity
6581 * @see #setPackage
6582 */
6583 public String getPackage() {
6584 return mPackage;
6585 }
6586
6587 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006588 * Retrieve the concrete component associated with the intent. When receiving
6589 * an intent, this is the component that was found to best handle it (that is,
6590 * yourself) and will always be non-null; in all other cases it will be
6591 * null unless explicitly set.
6592 *
6593 * @return The name of the application component to handle the intent.
6594 *
6595 * @see #resolveActivity
6596 * @see #setComponent
6597 */
6598 public ComponentName getComponent() {
6599 return mComponent;
6600 }
6601
6602 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006603 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6604 * used as a hint to the receiver for animations and the like. Null means that there
6605 * is no source bounds.
6606 */
6607 public Rect getSourceBounds() {
6608 return mSourceBounds;
6609 }
6610
6611 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006612 * Return the Activity component that should be used to handle this intent.
6613 * The appropriate component is determined based on the information in the
6614 * intent, evaluated as follows:
6615 *
6616 * <p>If {@link #getComponent} returns an explicit class, that is returned
6617 * without any further consideration.
6618 *
6619 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6620 * category to be considered.
6621 *
6622 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6623 * action.
6624 *
6625 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6626 * this type.
6627 *
6628 * <p>If {@link #addCategory} has added any categories, the activity must
6629 * handle ALL of the categories specified.
6630 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006631 * <p>If {@link #getPackage} is non-NULL, only activity components in
6632 * that application package will be considered.
6633 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006634 * <p>If there are no activities that satisfy all of these conditions, a
6635 * null string is returned.
6636 *
6637 * <p>If multiple activities are found to satisfy the intent, the one with
6638 * the highest priority will be used. If there are multiple activities
6639 * with the same priority, the system will either pick the best activity
6640 * based on user preference, or resolve to a system class that will allow
6641 * the user to pick an activity and forward from there.
6642 *
6643 * <p>This method is implemented simply by calling
6644 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6645 * true.</p>
6646 * <p> This API is called for you as part of starting an activity from an
6647 * intent. You do not normally need to call it yourself.</p>
6648 *
6649 * @param pm The package manager with which to resolve the Intent.
6650 *
6651 * @return Name of the component implementing an activity that can
6652 * display the intent.
6653 *
6654 * @see #setComponent
6655 * @see #getComponent
6656 * @see #resolveActivityInfo
6657 */
6658 public ComponentName resolveActivity(PackageManager pm) {
6659 if (mComponent != null) {
6660 return mComponent;
6661 }
6662
6663 ResolveInfo info = pm.resolveActivity(
6664 this, PackageManager.MATCH_DEFAULT_ONLY);
6665 if (info != null) {
6666 return new ComponentName(
6667 info.activityInfo.applicationInfo.packageName,
6668 info.activityInfo.name);
6669 }
6670
6671 return null;
6672 }
6673
6674 /**
6675 * Resolve the Intent into an {@link ActivityInfo}
6676 * describing the activity that should execute the intent. Resolution
6677 * follows the same rules as described for {@link #resolveActivity}, but
6678 * you get back the completely information about the resolved activity
6679 * instead of just its class name.
6680 *
6681 * @param pm The package manager with which to resolve the Intent.
6682 * @param flags Addition information to retrieve as per
6683 * {@link PackageManager#getActivityInfo(ComponentName, int)
6684 * PackageManager.getActivityInfo()}.
6685 *
6686 * @return PackageManager.ActivityInfo
6687 *
6688 * @see #resolveActivity
6689 */
6690 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6691 ActivityInfo ai = null;
6692 if (mComponent != null) {
6693 try {
6694 ai = pm.getActivityInfo(mComponent, flags);
6695 } catch (PackageManager.NameNotFoundException e) {
6696 // ignore
6697 }
6698 } else {
6699 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006700 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006701 if (info != null) {
6702 ai = info.activityInfo;
6703 }
6704 }
6705
6706 return ai;
6707 }
6708
6709 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006710 * Special function for use by the system to resolve service
6711 * intents to system apps. Throws an exception if there are
6712 * multiple potential matches to the Intent. Returns null if
6713 * there are no matches.
6714 * @hide
6715 */
6716 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6717 if (mComponent != null) {
6718 return mComponent;
6719 }
6720
6721 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6722 if (results == null) {
6723 return null;
6724 }
6725 ComponentName comp = null;
6726 for (int i=0; i<results.size(); i++) {
6727 ResolveInfo ri = results.get(i);
6728 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6729 continue;
6730 }
6731 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6732 ri.serviceInfo.name);
6733 if (comp != null) {
6734 throw new IllegalStateException("Multiple system services handle " + this
6735 + ": " + comp + ", " + foundComp);
6736 }
6737 comp = foundComp;
6738 }
6739 return comp;
6740 }
6741
6742 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006743 * Set the general action to be performed.
6744 *
6745 * @param action An action name, such as ACTION_VIEW. Application-specific
6746 * actions should be prefixed with the vendor's package name.
6747 *
6748 * @return Returns the same Intent object, for chaining multiple calls
6749 * into a single statement.
6750 *
6751 * @see #getAction
6752 */
6753 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006754 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006755 return this;
6756 }
6757
6758 /**
6759 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006760 * clears any type that was previously set by {@link #setType} or
6761 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006762 *
Nick Pellyccae4122012-01-09 14:12:58 -08006763 * <p><em>Note: scheme matching in the Android framework is
6764 * case-sensitive, unlike the formal RFC. As a result,
6765 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006766 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006767 * {@link #setDataAndNormalize}
6768 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006769 *
Nick Pellyccae4122012-01-09 14:12:58 -08006770 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006771 *
6772 * @return Returns the same Intent object, for chaining multiple calls
6773 * into a single statement.
6774 *
6775 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006776 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006777 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006778 */
6779 public Intent setData(Uri data) {
6780 mData = data;
6781 mType = null;
6782 return this;
6783 }
6784
6785 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006786 * Normalize and set the data this intent is operating on.
6787 *
6788 * <p>This method automatically clears any type that was
6789 * previously set (for example, by {@link #setType}).
6790 *
6791 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006792 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006793 * so really this is just a convenience method for
6794 * <pre>
6795 * setData(data.normalize())
6796 * </pre>
6797 *
6798 * @param data The Uri of the data this intent is now targeting.
6799 *
6800 * @return Returns the same Intent object, for chaining multiple calls
6801 * into a single statement.
6802 *
6803 * @see #getData
6804 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006805 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006806 */
6807 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006808 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006809 }
6810
6811 /**
6812 * Set an explicit MIME data type.
6813 *
6814 * <p>This is used to create intents that only specify a type and not data,
6815 * for example to indicate the type of data to return.
6816 *
6817 * <p>This method automatically clears any data that was
6818 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006819 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006820 * <p><em>Note: MIME type matching in the Android framework is
6821 * case-sensitive, unlike formal RFC MIME types. As a result,
6822 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006823 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6824 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006825 *
6826 * @param type The MIME type of the data being handled by this intent.
6827 *
6828 * @return Returns the same Intent object, for chaining multiple calls
6829 * into a single statement.
6830 *
6831 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006832 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006833 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006834 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006835 */
6836 public Intent setType(String type) {
6837 mData = null;
6838 mType = type;
6839 return this;
6840 }
6841
6842 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006843 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006844 *
Nick Pellyccae4122012-01-09 14:12:58 -08006845 * <p>This is used to create intents that only specify a type and not data,
6846 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006847 *
Nick Pellyccae4122012-01-09 14:12:58 -08006848 * <p>This method automatically clears any data that was
6849 * previously set (for example by {@link #setData}).
6850 *
6851 * <p>The MIME type is normalized using
6852 * {@link #normalizeMimeType} before it is set,
6853 * so really this is just a convenience method for
6854 * <pre>
6855 * setType(Intent.normalizeMimeType(type))
6856 * </pre>
6857 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006858 * @param type The MIME type of the data being handled by this intent.
6859 *
6860 * @return Returns the same Intent object, for chaining multiple calls
6861 * into a single statement.
6862 *
Nick Pellyccae4122012-01-09 14:12:58 -08006863 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006864 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006865 * @see #normalizeMimeType
6866 */
6867 public Intent setTypeAndNormalize(String type) {
6868 return setType(normalizeMimeType(type));
6869 }
6870
6871 /**
6872 * (Usually optional) Set the data for the intent along with an explicit
6873 * MIME data type. This method should very rarely be used -- it allows you
6874 * to override the MIME type that would ordinarily be inferred from the
6875 * data with your own type given here.
6876 *
6877 * <p><em>Note: MIME type and Uri scheme matching in the
6878 * Android framework is case-sensitive, unlike the formal RFC definitions.
6879 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006880 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006881 * {@link #setDataAndTypeAndNormalize}
6882 * to ensure that they are converted to lower case.</em>
6883 *
6884 * @param data The Uri of the data this intent is now targeting.
6885 * @param type The MIME type of the data being handled by this intent.
6886 *
6887 * @return Returns the same Intent object, for chaining multiple calls
6888 * into a single statement.
6889 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006890 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006891 * @see #setData
6892 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006893 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006894 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006895 */
6896 public Intent setDataAndType(Uri data, String type) {
6897 mData = data;
6898 mType = type;
6899 return this;
6900 }
6901
6902 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006903 * (Usually optional) Normalize and set both the data Uri and an explicit
6904 * MIME data type. This method should very rarely be used -- it allows you
6905 * to override the MIME type that would ordinarily be inferred from the
6906 * data with your own type given here.
6907 *
6908 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006909 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006910 * before they are set, so really this is just a convenience method for
6911 * <pre>
6912 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6913 * </pre>
6914 *
6915 * @param data The Uri of the data this intent is now targeting.
6916 * @param type The MIME type of the data being handled by this intent.
6917 *
6918 * @return Returns the same Intent object, for chaining multiple calls
6919 * into a single statement.
6920 *
6921 * @see #setType
6922 * @see #setData
6923 * @see #setDataAndType
6924 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006925 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006926 */
6927 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006928 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006929 }
6930
6931 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006932 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006933 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006934 * activities that provide <em>all</em> of the requested categories will be
6935 * used.
6936 *
6937 * @param category The desired category. This can be either one of the
6938 * predefined Intent categories, or a custom category in your own
6939 * namespace.
6940 *
6941 * @return Returns the same Intent object, for chaining multiple calls
6942 * into a single statement.
6943 *
6944 * @see #hasCategory
6945 * @see #removeCategory
6946 */
6947 public Intent addCategory(String category) {
6948 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006949 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006950 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006951 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006952 return this;
6953 }
6954
6955 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006956 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006957 *
6958 * @param category The category to remove.
6959 *
6960 * @see #addCategory
6961 */
6962 public void removeCategory(String category) {
6963 if (mCategories != null) {
6964 mCategories.remove(category);
6965 if (mCategories.size() == 0) {
6966 mCategories = null;
6967 }
6968 }
6969 }
6970
6971 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006972 * Set a selector for this Intent. This is a modification to the kinds of
6973 * things the Intent will match. If the selector is set, it will be used
6974 * when trying to find entities that can handle the Intent, instead of the
6975 * main contents of the Intent. This allows you build an Intent containing
6976 * a generic protocol while targeting it more specifically.
6977 *
6978 * <p>An example of where this may be used is with things like
6979 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6980 * Intent that will launch the Browser application. However, the correct
6981 * main entry point of an application is actually {@link #ACTION_MAIN}
6982 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
6983 * used to specify the actual Activity to launch. If you launch the browser
6984 * with something different, undesired behavior may happen if the user has
6985 * previously or later launches it the normal way, since they do not match.
6986 * Instead, you can build an Intent with the MAIN action (but no ComponentName
6987 * yet specified) and set a selector with {@link #ACTION_MAIN} and
6988 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
6989 *
6990 * <p>Setting a selector does not impact the behavior of
6991 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
6992 * desired behavior of a selector -- it does not impact the base meaning
6993 * of the Intent, just what kinds of things will be matched against it
6994 * when determining who can handle it.</p>
6995 *
6996 * <p>You can not use both a selector and {@link #setPackage(String)} on
6997 * the same base Intent.</p>
6998 *
6999 * @param selector The desired selector Intent; set to null to not use
7000 * a special selector.
7001 */
7002 public void setSelector(Intent selector) {
7003 if (selector == this) {
7004 throw new IllegalArgumentException(
7005 "Intent being set as a selector of itself");
7006 }
7007 if (selector != null && mPackage != null) {
7008 throw new IllegalArgumentException(
7009 "Can't set selector when package name is already set");
7010 }
7011 mSelector = selector;
7012 }
7013
7014 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007015 * Set a {@link ClipData} associated with this Intent. This replaces any
7016 * previously set ClipData.
7017 *
7018 * <p>The ClipData in an intent is not used for Intent matching or other
7019 * such operations. Semantically it is like extras, used to transmit
7020 * additional data with the Intent. The main feature of using this over
7021 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7022 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7023 * items included in the clip data. This is useful, in particular, if
7024 * you want to transmit an Intent containing multiple <code>content:</code>
7025 * URIs for which the recipient may not have global permission to access the
7026 * content provider.
7027 *
7028 * <p>If the ClipData contains items that are themselves Intents, any
7029 * grant flags in those Intents will be ignored. Only the top-level flags
7030 * of the main Intent are respected, and will be applied to all Uri or
7031 * Intent items in the clip (or sub-items of the clip).
7032 *
7033 * <p>The MIME type, label, and icon in the ClipData object are not
7034 * directly used by Intent. Applications should generally rely on the
7035 * MIME type of the Intent itself, not what it may find in the ClipData.
7036 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007037 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007038 *
7039 * @param clip The new clip to set. May be null to clear the current clip.
7040 */
7041 public void setClipData(ClipData clip) {
7042 mClipData = clip;
7043 }
7044
7045 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007046 * This is NOT a secure mechanism to identify the user who sent the intent.
7047 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7048 * who sent the intent.
7049 * @hide
7050 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007051 public void prepareToLeaveUser(int userId) {
7052 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7053 // We want mContentUserHint to refer to the original user, so don't do anything.
7054 if (mContentUserHint == UserHandle.USER_CURRENT) {
7055 mContentUserHint = userId;
7056 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007057 }
7058
7059 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007060 * Add extended data to the intent. The name must include a package
7061 * prefix, for example the app com.android.contacts would use names
7062 * like "com.android.contacts.ShowAll".
7063 *
7064 * @param name The name of the extra data, with package prefix.
7065 * @param value The boolean data value.
7066 *
7067 * @return Returns the same Intent object, for chaining multiple calls
7068 * into a single statement.
7069 *
7070 * @see #putExtras
7071 * @see #removeExtra
7072 * @see #getBooleanExtra(String, boolean)
7073 */
7074 public Intent putExtra(String name, boolean value) {
7075 if (mExtras == null) {
7076 mExtras = new Bundle();
7077 }
7078 mExtras.putBoolean(name, value);
7079 return this;
7080 }
7081
7082 /**
7083 * Add extended data to the intent. The name must include a package
7084 * prefix, for example the app com.android.contacts would use names
7085 * like "com.android.contacts.ShowAll".
7086 *
7087 * @param name The name of the extra data, with package prefix.
7088 * @param value The byte data value.
7089 *
7090 * @return Returns the same Intent object, for chaining multiple calls
7091 * into a single statement.
7092 *
7093 * @see #putExtras
7094 * @see #removeExtra
7095 * @see #getByteExtra(String, byte)
7096 */
7097 public Intent putExtra(String name, byte value) {
7098 if (mExtras == null) {
7099 mExtras = new Bundle();
7100 }
7101 mExtras.putByte(name, value);
7102 return this;
7103 }
7104
7105 /**
7106 * Add extended data to the intent. The name must include a package
7107 * prefix, for example the app com.android.contacts would use names
7108 * like "com.android.contacts.ShowAll".
7109 *
7110 * @param name The name of the extra data, with package prefix.
7111 * @param value The char data value.
7112 *
7113 * @return Returns the same Intent object, for chaining multiple calls
7114 * into a single statement.
7115 *
7116 * @see #putExtras
7117 * @see #removeExtra
7118 * @see #getCharExtra(String, char)
7119 */
7120 public Intent putExtra(String name, char value) {
7121 if (mExtras == null) {
7122 mExtras = new Bundle();
7123 }
7124 mExtras.putChar(name, value);
7125 return this;
7126 }
7127
7128 /**
7129 * Add extended data to the intent. The name must include a package
7130 * prefix, for example the app com.android.contacts would use names
7131 * like "com.android.contacts.ShowAll".
7132 *
7133 * @param name The name of the extra data, with package prefix.
7134 * @param value The short data value.
7135 *
7136 * @return Returns the same Intent object, for chaining multiple calls
7137 * into a single statement.
7138 *
7139 * @see #putExtras
7140 * @see #removeExtra
7141 * @see #getShortExtra(String, short)
7142 */
7143 public Intent putExtra(String name, short value) {
7144 if (mExtras == null) {
7145 mExtras = new Bundle();
7146 }
7147 mExtras.putShort(name, value);
7148 return this;
7149 }
7150
7151 /**
7152 * Add extended data to the intent. The name must include a package
7153 * prefix, for example the app com.android.contacts would use names
7154 * like "com.android.contacts.ShowAll".
7155 *
7156 * @param name The name of the extra data, with package prefix.
7157 * @param value The integer data value.
7158 *
7159 * @return Returns the same Intent object, for chaining multiple calls
7160 * into a single statement.
7161 *
7162 * @see #putExtras
7163 * @see #removeExtra
7164 * @see #getIntExtra(String, int)
7165 */
7166 public Intent putExtra(String name, int value) {
7167 if (mExtras == null) {
7168 mExtras = new Bundle();
7169 }
7170 mExtras.putInt(name, value);
7171 return this;
7172 }
7173
7174 /**
7175 * Add extended data to the intent. The name must include a package
7176 * prefix, for example the app com.android.contacts would use names
7177 * like "com.android.contacts.ShowAll".
7178 *
7179 * @param name The name of the extra data, with package prefix.
7180 * @param value The long data value.
7181 *
7182 * @return Returns the same Intent object, for chaining multiple calls
7183 * into a single statement.
7184 *
7185 * @see #putExtras
7186 * @see #removeExtra
7187 * @see #getLongExtra(String, long)
7188 */
7189 public Intent putExtra(String name, long value) {
7190 if (mExtras == null) {
7191 mExtras = new Bundle();
7192 }
7193 mExtras.putLong(name, value);
7194 return this;
7195 }
7196
7197 /**
7198 * Add extended data to the intent. The name must include a package
7199 * prefix, for example the app com.android.contacts would use names
7200 * like "com.android.contacts.ShowAll".
7201 *
7202 * @param name The name of the extra data, with package prefix.
7203 * @param value The float data value.
7204 *
7205 * @return Returns the same Intent object, for chaining multiple calls
7206 * into a single statement.
7207 *
7208 * @see #putExtras
7209 * @see #removeExtra
7210 * @see #getFloatExtra(String, float)
7211 */
7212 public Intent putExtra(String name, float value) {
7213 if (mExtras == null) {
7214 mExtras = new Bundle();
7215 }
7216 mExtras.putFloat(name, value);
7217 return this;
7218 }
7219
7220 /**
7221 * Add extended data to the intent. The name must include a package
7222 * prefix, for example the app com.android.contacts would use names
7223 * like "com.android.contacts.ShowAll".
7224 *
7225 * @param name The name of the extra data, with package prefix.
7226 * @param value The double data value.
7227 *
7228 * @return Returns the same Intent object, for chaining multiple calls
7229 * into a single statement.
7230 *
7231 * @see #putExtras
7232 * @see #removeExtra
7233 * @see #getDoubleExtra(String, double)
7234 */
7235 public Intent putExtra(String name, double value) {
7236 if (mExtras == null) {
7237 mExtras = new Bundle();
7238 }
7239 mExtras.putDouble(name, value);
7240 return this;
7241 }
7242
7243 /**
7244 * Add extended data to the intent. The name must include a package
7245 * prefix, for example the app com.android.contacts would use names
7246 * like "com.android.contacts.ShowAll".
7247 *
7248 * @param name The name of the extra data, with package prefix.
7249 * @param value The String data value.
7250 *
7251 * @return Returns the same Intent object, for chaining multiple calls
7252 * into a single statement.
7253 *
7254 * @see #putExtras
7255 * @see #removeExtra
7256 * @see #getStringExtra(String)
7257 */
7258 public Intent putExtra(String name, String value) {
7259 if (mExtras == null) {
7260 mExtras = new Bundle();
7261 }
7262 mExtras.putString(name, value);
7263 return this;
7264 }
7265
7266 /**
7267 * Add extended data to the intent. The name must include a package
7268 * prefix, for example the app com.android.contacts would use names
7269 * like "com.android.contacts.ShowAll".
7270 *
7271 * @param name The name of the extra data, with package prefix.
7272 * @param value The CharSequence data value.
7273 *
7274 * @return Returns the same Intent object, for chaining multiple calls
7275 * into a single statement.
7276 *
7277 * @see #putExtras
7278 * @see #removeExtra
7279 * @see #getCharSequenceExtra(String)
7280 */
7281 public Intent putExtra(String name, CharSequence value) {
7282 if (mExtras == null) {
7283 mExtras = new Bundle();
7284 }
7285 mExtras.putCharSequence(name, value);
7286 return this;
7287 }
7288
7289 /**
7290 * Add extended data to the intent. The name must include a package
7291 * prefix, for example the app com.android.contacts would use names
7292 * like "com.android.contacts.ShowAll".
7293 *
7294 * @param name The name of the extra data, with package prefix.
7295 * @param value The Parcelable data value.
7296 *
7297 * @return Returns the same Intent object, for chaining multiple calls
7298 * into a single statement.
7299 *
7300 * @see #putExtras
7301 * @see #removeExtra
7302 * @see #getParcelableExtra(String)
7303 */
7304 public Intent putExtra(String name, Parcelable value) {
7305 if (mExtras == null) {
7306 mExtras = new Bundle();
7307 }
7308 mExtras.putParcelable(name, value);
7309 return this;
7310 }
7311
7312 /**
7313 * Add extended data to the intent. The name must include a package
7314 * prefix, for example the app com.android.contacts would use names
7315 * like "com.android.contacts.ShowAll".
7316 *
7317 * @param name The name of the extra data, with package prefix.
7318 * @param value The Parcelable[] data value.
7319 *
7320 * @return Returns the same Intent object, for chaining multiple calls
7321 * into a single statement.
7322 *
7323 * @see #putExtras
7324 * @see #removeExtra
7325 * @see #getParcelableArrayExtra(String)
7326 */
7327 public Intent putExtra(String name, Parcelable[] value) {
7328 if (mExtras == null) {
7329 mExtras = new Bundle();
7330 }
7331 mExtras.putParcelableArray(name, value);
7332 return this;
7333 }
7334
7335 /**
7336 * Add extended data to the intent. The name must include a package
7337 * prefix, for example the app com.android.contacts would use names
7338 * like "com.android.contacts.ShowAll".
7339 *
7340 * @param name The name of the extra data, with package prefix.
7341 * @param value The ArrayList<Parcelable> data value.
7342 *
7343 * @return Returns the same Intent object, for chaining multiple calls
7344 * into a single statement.
7345 *
7346 * @see #putExtras
7347 * @see #removeExtra
7348 * @see #getParcelableArrayListExtra(String)
7349 */
7350 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7351 if (mExtras == null) {
7352 mExtras = new Bundle();
7353 }
7354 mExtras.putParcelableArrayList(name, value);
7355 return this;
7356 }
7357
7358 /**
7359 * Add extended data to the intent. The name must include a package
7360 * prefix, for example the app com.android.contacts would use names
7361 * like "com.android.contacts.ShowAll".
7362 *
7363 * @param name The name of the extra data, with package prefix.
7364 * @param value The ArrayList<Integer> data value.
7365 *
7366 * @return Returns the same Intent object, for chaining multiple calls
7367 * into a single statement.
7368 *
7369 * @see #putExtras
7370 * @see #removeExtra
7371 * @see #getIntegerArrayListExtra(String)
7372 */
7373 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7374 if (mExtras == null) {
7375 mExtras = new Bundle();
7376 }
7377 mExtras.putIntegerArrayList(name, value);
7378 return this;
7379 }
7380
7381 /**
7382 * Add extended data to the intent. The name must include a package
7383 * prefix, for example the app com.android.contacts would use names
7384 * like "com.android.contacts.ShowAll".
7385 *
7386 * @param name The name of the extra data, with package prefix.
7387 * @param value The ArrayList<String> data value.
7388 *
7389 * @return Returns the same Intent object, for chaining multiple calls
7390 * into a single statement.
7391 *
7392 * @see #putExtras
7393 * @see #removeExtra
7394 * @see #getStringArrayListExtra(String)
7395 */
7396 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7397 if (mExtras == null) {
7398 mExtras = new Bundle();
7399 }
7400 mExtras.putStringArrayList(name, value);
7401 return this;
7402 }
7403
7404 /**
7405 * Add extended data to the intent. The name must include a package
7406 * prefix, for example the app com.android.contacts would use names
7407 * like "com.android.contacts.ShowAll".
7408 *
7409 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007410 * @param value The ArrayList<CharSequence> data value.
7411 *
7412 * @return Returns the same Intent object, for chaining multiple calls
7413 * into a single statement.
7414 *
7415 * @see #putExtras
7416 * @see #removeExtra
7417 * @see #getCharSequenceArrayListExtra(String)
7418 */
7419 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7420 if (mExtras == null) {
7421 mExtras = new Bundle();
7422 }
7423 mExtras.putCharSequenceArrayList(name, value);
7424 return this;
7425 }
7426
7427 /**
7428 * Add extended data to the intent. The name must include a package
7429 * prefix, for example the app com.android.contacts would use names
7430 * like "com.android.contacts.ShowAll".
7431 *
7432 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007433 * @param value The Serializable data value.
7434 *
7435 * @return Returns the same Intent object, for chaining multiple calls
7436 * into a single statement.
7437 *
7438 * @see #putExtras
7439 * @see #removeExtra
7440 * @see #getSerializableExtra(String)
7441 */
7442 public Intent putExtra(String name, Serializable value) {
7443 if (mExtras == null) {
7444 mExtras = new Bundle();
7445 }
7446 mExtras.putSerializable(name, value);
7447 return this;
7448 }
7449
7450 /**
7451 * Add extended data to the intent. The name must include a package
7452 * prefix, for example the app com.android.contacts would use names
7453 * like "com.android.contacts.ShowAll".
7454 *
7455 * @param name The name of the extra data, with package prefix.
7456 * @param value The boolean array data value.
7457 *
7458 * @return Returns the same Intent object, for chaining multiple calls
7459 * into a single statement.
7460 *
7461 * @see #putExtras
7462 * @see #removeExtra
7463 * @see #getBooleanArrayExtra(String)
7464 */
7465 public Intent putExtra(String name, boolean[] value) {
7466 if (mExtras == null) {
7467 mExtras = new Bundle();
7468 }
7469 mExtras.putBooleanArray(name, value);
7470 return this;
7471 }
7472
7473 /**
7474 * Add extended data to the intent. The name must include a package
7475 * prefix, for example the app com.android.contacts would use names
7476 * like "com.android.contacts.ShowAll".
7477 *
7478 * @param name The name of the extra data, with package prefix.
7479 * @param value The byte array data value.
7480 *
7481 * @return Returns the same Intent object, for chaining multiple calls
7482 * into a single statement.
7483 *
7484 * @see #putExtras
7485 * @see #removeExtra
7486 * @see #getByteArrayExtra(String)
7487 */
7488 public Intent putExtra(String name, byte[] value) {
7489 if (mExtras == null) {
7490 mExtras = new Bundle();
7491 }
7492 mExtras.putByteArray(name, value);
7493 return this;
7494 }
7495
7496 /**
7497 * Add extended data to the intent. The name must include a package
7498 * prefix, for example the app com.android.contacts would use names
7499 * like "com.android.contacts.ShowAll".
7500 *
7501 * @param name The name of the extra data, with package prefix.
7502 * @param value The short array data value.
7503 *
7504 * @return Returns the same Intent object, for chaining multiple calls
7505 * into a single statement.
7506 *
7507 * @see #putExtras
7508 * @see #removeExtra
7509 * @see #getShortArrayExtra(String)
7510 */
7511 public Intent putExtra(String name, short[] value) {
7512 if (mExtras == null) {
7513 mExtras = new Bundle();
7514 }
7515 mExtras.putShortArray(name, value);
7516 return this;
7517 }
7518
7519 /**
7520 * Add extended data to the intent. The name must include a package
7521 * prefix, for example the app com.android.contacts would use names
7522 * like "com.android.contacts.ShowAll".
7523 *
7524 * @param name The name of the extra data, with package prefix.
7525 * @param value The char array data value.
7526 *
7527 * @return Returns the same Intent object, for chaining multiple calls
7528 * into a single statement.
7529 *
7530 * @see #putExtras
7531 * @see #removeExtra
7532 * @see #getCharArrayExtra(String)
7533 */
7534 public Intent putExtra(String name, char[] value) {
7535 if (mExtras == null) {
7536 mExtras = new Bundle();
7537 }
7538 mExtras.putCharArray(name, value);
7539 return this;
7540 }
7541
7542 /**
7543 * Add extended data to the intent. The name must include a package
7544 * prefix, for example the app com.android.contacts would use names
7545 * like "com.android.contacts.ShowAll".
7546 *
7547 * @param name The name of the extra data, with package prefix.
7548 * @param value The int array data value.
7549 *
7550 * @return Returns the same Intent object, for chaining multiple calls
7551 * into a single statement.
7552 *
7553 * @see #putExtras
7554 * @see #removeExtra
7555 * @see #getIntArrayExtra(String)
7556 */
7557 public Intent putExtra(String name, int[] value) {
7558 if (mExtras == null) {
7559 mExtras = new Bundle();
7560 }
7561 mExtras.putIntArray(name, value);
7562 return this;
7563 }
7564
7565 /**
7566 * Add extended data to the intent. The name must include a package
7567 * prefix, for example the app com.android.contacts would use names
7568 * like "com.android.contacts.ShowAll".
7569 *
7570 * @param name The name of the extra data, with package prefix.
7571 * @param value The byte array data value.
7572 *
7573 * @return Returns the same Intent object, for chaining multiple calls
7574 * into a single statement.
7575 *
7576 * @see #putExtras
7577 * @see #removeExtra
7578 * @see #getLongArrayExtra(String)
7579 */
7580 public Intent putExtra(String name, long[] value) {
7581 if (mExtras == null) {
7582 mExtras = new Bundle();
7583 }
7584 mExtras.putLongArray(name, value);
7585 return this;
7586 }
7587
7588 /**
7589 * Add extended data to the intent. The name must include a package
7590 * prefix, for example the app com.android.contacts would use names
7591 * like "com.android.contacts.ShowAll".
7592 *
7593 * @param name The name of the extra data, with package prefix.
7594 * @param value The float array data value.
7595 *
7596 * @return Returns the same Intent object, for chaining multiple calls
7597 * into a single statement.
7598 *
7599 * @see #putExtras
7600 * @see #removeExtra
7601 * @see #getFloatArrayExtra(String)
7602 */
7603 public Intent putExtra(String name, float[] value) {
7604 if (mExtras == null) {
7605 mExtras = new Bundle();
7606 }
7607 mExtras.putFloatArray(name, value);
7608 return this;
7609 }
7610
7611 /**
7612 * Add extended data to the intent. The name must include a package
7613 * prefix, for example the app com.android.contacts would use names
7614 * like "com.android.contacts.ShowAll".
7615 *
7616 * @param name The name of the extra data, with package prefix.
7617 * @param value The double array data value.
7618 *
7619 * @return Returns the same Intent object, for chaining multiple calls
7620 * into a single statement.
7621 *
7622 * @see #putExtras
7623 * @see #removeExtra
7624 * @see #getDoubleArrayExtra(String)
7625 */
7626 public Intent putExtra(String name, double[] value) {
7627 if (mExtras == null) {
7628 mExtras = new Bundle();
7629 }
7630 mExtras.putDoubleArray(name, value);
7631 return this;
7632 }
7633
7634 /**
7635 * Add extended data to the intent. The name must include a package
7636 * prefix, for example the app com.android.contacts would use names
7637 * like "com.android.contacts.ShowAll".
7638 *
7639 * @param name The name of the extra data, with package prefix.
7640 * @param value The String array data value.
7641 *
7642 * @return Returns the same Intent object, for chaining multiple calls
7643 * into a single statement.
7644 *
7645 * @see #putExtras
7646 * @see #removeExtra
7647 * @see #getStringArrayExtra(String)
7648 */
7649 public Intent putExtra(String name, String[] value) {
7650 if (mExtras == null) {
7651 mExtras = new Bundle();
7652 }
7653 mExtras.putStringArray(name, value);
7654 return this;
7655 }
7656
7657 /**
7658 * Add extended data to the intent. The name must include a package
7659 * prefix, for example the app com.android.contacts would use names
7660 * like "com.android.contacts.ShowAll".
7661 *
7662 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007663 * @param value The CharSequence array data value.
7664 *
7665 * @return Returns the same Intent object, for chaining multiple calls
7666 * into a single statement.
7667 *
7668 * @see #putExtras
7669 * @see #removeExtra
7670 * @see #getCharSequenceArrayExtra(String)
7671 */
7672 public Intent putExtra(String name, CharSequence[] value) {
7673 if (mExtras == null) {
7674 mExtras = new Bundle();
7675 }
7676 mExtras.putCharSequenceArray(name, value);
7677 return this;
7678 }
7679
7680 /**
7681 * Add extended data to the intent. The name must include a package
7682 * prefix, for example the app com.android.contacts would use names
7683 * like "com.android.contacts.ShowAll".
7684 *
7685 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007686 * @param value The Bundle data value.
7687 *
7688 * @return Returns the same Intent object, for chaining multiple calls
7689 * into a single statement.
7690 *
7691 * @see #putExtras
7692 * @see #removeExtra
7693 * @see #getBundleExtra(String)
7694 */
7695 public Intent putExtra(String name, Bundle value) {
7696 if (mExtras == null) {
7697 mExtras = new Bundle();
7698 }
7699 mExtras.putBundle(name, value);
7700 return this;
7701 }
7702
7703 /**
7704 * Add extended data to the intent. The name must include a package
7705 * prefix, for example the app com.android.contacts would use names
7706 * like "com.android.contacts.ShowAll".
7707 *
7708 * @param name The name of the extra data, with package prefix.
7709 * @param value The IBinder data value.
7710 *
7711 * @return Returns the same Intent object, for chaining multiple calls
7712 * into a single statement.
7713 *
7714 * @see #putExtras
7715 * @see #removeExtra
7716 * @see #getIBinderExtra(String)
7717 *
7718 * @deprecated
7719 * @hide
7720 */
7721 @Deprecated
7722 public Intent putExtra(String name, IBinder value) {
7723 if (mExtras == null) {
7724 mExtras = new Bundle();
7725 }
7726 mExtras.putIBinder(name, value);
7727 return this;
7728 }
7729
7730 /**
7731 * Copy all extras in 'src' in to this intent.
7732 *
7733 * @param src Contains the extras to copy.
7734 *
7735 * @see #putExtra
7736 */
7737 public Intent putExtras(Intent src) {
7738 if (src.mExtras != null) {
7739 if (mExtras == null) {
7740 mExtras = new Bundle(src.mExtras);
7741 } else {
7742 mExtras.putAll(src.mExtras);
7743 }
7744 }
7745 return this;
7746 }
7747
7748 /**
7749 * Add a set of extended data to the intent. The keys must include a package
7750 * prefix, for example the app com.android.contacts would use names
7751 * like "com.android.contacts.ShowAll".
7752 *
7753 * @param extras The Bundle of extras to add to this intent.
7754 *
7755 * @see #putExtra
7756 * @see #removeExtra
7757 */
7758 public Intent putExtras(Bundle extras) {
7759 if (mExtras == null) {
7760 mExtras = new Bundle();
7761 }
7762 mExtras.putAll(extras);
7763 return this;
7764 }
7765
7766 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007767 * Completely replace the extras in the Intent with the extras in the
7768 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007769 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007770 * @param src The exact extras contained in this Intent are copied
7771 * into the target intent, replacing any that were previously there.
7772 */
7773 public Intent replaceExtras(Intent src) {
7774 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7775 return this;
7776 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007777
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007778 /**
7779 * Completely replace the extras in the Intent with the given Bundle of
7780 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007781 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007782 * @param extras The new set of extras in the Intent, or null to erase
7783 * all extras.
7784 */
7785 public Intent replaceExtras(Bundle extras) {
7786 mExtras = extras != null ? new Bundle(extras) : null;
7787 return this;
7788 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007789
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007790 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007791 * Remove extended data from the intent.
7792 *
7793 * @see #putExtra
7794 */
7795 public void removeExtra(String name) {
7796 if (mExtras != null) {
7797 mExtras.remove(name);
7798 if (mExtras.size() == 0) {
7799 mExtras = null;
7800 }
7801 }
7802 }
7803
7804 /**
7805 * Set special flags controlling how this intent is handled. Most values
7806 * here depend on the type of component being executed by the Intent,
7807 * specifically the FLAG_ACTIVITY_* flags are all for use with
7808 * {@link Context#startActivity Context.startActivity()} and the
7809 * FLAG_RECEIVER_* flags are all for use with
7810 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7811 *
Scott Main7aee61f2011-02-08 11:25:01 -08007812 * <p>See the
7813 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7814 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007815 * the behavior of your application.
7816 *
7817 * @param flags The desired flags.
7818 *
7819 * @return Returns the same Intent object, for chaining multiple calls
7820 * into a single statement.
7821 *
7822 * @see #getFlags
7823 * @see #addFlags
7824 *
7825 * @see #FLAG_GRANT_READ_URI_PERMISSION
7826 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007827 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7828 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007829 * @see #FLAG_DEBUG_LOG_RESOLUTION
7830 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007831 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007832 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007833 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007834 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007835 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7836 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007837 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007838 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007839 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007840 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007841 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007842 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007843 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007844 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7845 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007846 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007847 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007848 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007849 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7850 */
7851 public Intent setFlags(int flags) {
7852 mFlags = flags;
7853 return this;
7854 }
7855
7856 /**
7857 * Add additional flags to the intent (or with existing flags
7858 * value).
7859 *
7860 * @param flags The new flags to set.
7861 *
7862 * @return Returns the same Intent object, for chaining multiple calls
7863 * into a single statement.
7864 *
7865 * @see #setFlags
7866 */
7867 public Intent addFlags(int flags) {
7868 mFlags |= flags;
7869 return this;
7870 }
7871
7872 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007873 * (Usually optional) Set an explicit application package name that limits
7874 * the components this Intent will resolve to. If left to the default
7875 * value of null, all components in all applications will considered.
7876 * If non-null, the Intent can only match the components in the given
7877 * application package.
7878 *
7879 * @param packageName The name of the application package to handle the
7880 * intent, or null to allow any application package.
7881 *
7882 * @return Returns the same Intent object, for chaining multiple calls
7883 * into a single statement.
7884 *
7885 * @see #getPackage
7886 * @see #resolveActivity
7887 */
7888 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007889 if (packageName != null && mSelector != null) {
7890 throw new IllegalArgumentException(
7891 "Can't set package name when selector is already set");
7892 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007893 mPackage = packageName;
7894 return this;
7895 }
7896
7897 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007898 * (Usually optional) Explicitly set the component to handle the intent.
7899 * If left with the default value of null, the system will determine the
7900 * appropriate class to use based on the other fields (action, data,
7901 * type, categories) in the Intent. If this class is defined, the
7902 * specified class will always be used regardless of the other fields. You
7903 * should only set this value when you know you absolutely want a specific
7904 * class to be used; otherwise it is better to let the system find the
7905 * appropriate class so that you will respect the installed applications
7906 * and user preferences.
7907 *
7908 * @param component The name of the application component to handle the
7909 * intent, or null to let the system find one for you.
7910 *
7911 * @return Returns the same Intent object, for chaining multiple calls
7912 * into a single statement.
7913 *
7914 * @see #setClass
7915 * @see #setClassName(Context, String)
7916 * @see #setClassName(String, String)
7917 * @see #getComponent
7918 * @see #resolveActivity
7919 */
7920 public Intent setComponent(ComponentName component) {
7921 mComponent = component;
7922 return this;
7923 }
7924
7925 /**
7926 * Convenience for calling {@link #setComponent} with an
7927 * explicit class name.
7928 *
7929 * @param packageContext A Context of the application package implementing
7930 * this class.
7931 * @param className The name of a class inside of the application package
7932 * that will be used as the component for this Intent.
7933 *
7934 * @return Returns the same Intent object, for chaining multiple calls
7935 * into a single statement.
7936 *
7937 * @see #setComponent
7938 * @see #setClass
7939 */
7940 public Intent setClassName(Context packageContext, String className) {
7941 mComponent = new ComponentName(packageContext, className);
7942 return this;
7943 }
7944
7945 /**
7946 * Convenience for calling {@link #setComponent} with an
7947 * explicit application package name and class name.
7948 *
7949 * @param packageName The name of the package implementing the desired
7950 * component.
7951 * @param className The name of a class inside of the application package
7952 * that will be used as the component for this Intent.
7953 *
7954 * @return Returns the same Intent object, for chaining multiple calls
7955 * into a single statement.
7956 *
7957 * @see #setComponent
7958 * @see #setClass
7959 */
7960 public Intent setClassName(String packageName, String className) {
7961 mComponent = new ComponentName(packageName, className);
7962 return this;
7963 }
7964
7965 /**
7966 * Convenience for calling {@link #setComponent(ComponentName)} with the
7967 * name returned by a {@link Class} object.
7968 *
7969 * @param packageContext A Context of the application package implementing
7970 * this class.
7971 * @param cls The class name to set, equivalent to
7972 * <code>setClassName(context, cls.getName())</code>.
7973 *
7974 * @return Returns the same Intent object, for chaining multiple calls
7975 * into a single statement.
7976 *
7977 * @see #setComponent
7978 */
7979 public Intent setClass(Context packageContext, Class<?> cls) {
7980 mComponent = new ComponentName(packageContext, cls);
7981 return this;
7982 }
7983
7984 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007985 * Set the bounds of the sender of this intent, in screen coordinates. This can be
7986 * used as a hint to the receiver for animations and the like. Null means that there
7987 * is no source bounds.
7988 */
7989 public void setSourceBounds(Rect r) {
7990 if (r != null) {
7991 mSourceBounds = new Rect(r);
7992 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07007993 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007994 }
7995 }
7996
Tor Norbyed9273d62013-05-30 15:59:53 -07007997 /** @hide */
7998 @IntDef(flag = true,
7999 value = {
8000 FILL_IN_ACTION,
8001 FILL_IN_DATA,
8002 FILL_IN_CATEGORIES,
8003 FILL_IN_COMPONENT,
8004 FILL_IN_PACKAGE,
8005 FILL_IN_SOURCE_BOUNDS,
8006 FILL_IN_SELECTOR,
8007 FILL_IN_CLIP_DATA
8008 })
8009 @Retention(RetentionPolicy.SOURCE)
8010 public @interface FillInFlags {}
8011
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008012 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008013 * Use with {@link #fillIn} to allow the current action value to be
8014 * overwritten, even if it is already set.
8015 */
8016 public static final int FILL_IN_ACTION = 1<<0;
8017
8018 /**
8019 * Use with {@link #fillIn} to allow the current data or type value
8020 * overwritten, even if it is already set.
8021 */
8022 public static final int FILL_IN_DATA = 1<<1;
8023
8024 /**
8025 * Use with {@link #fillIn} to allow the current categories to be
8026 * overwritten, even if they are already set.
8027 */
8028 public static final int FILL_IN_CATEGORIES = 1<<2;
8029
8030 /**
8031 * Use with {@link #fillIn} to allow the current component value to be
8032 * overwritten, even if it is already set.
8033 */
8034 public static final int FILL_IN_COMPONENT = 1<<3;
8035
8036 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008037 * Use with {@link #fillIn} to allow the current package value to be
8038 * overwritten, even if it is already set.
8039 */
8040 public static final int FILL_IN_PACKAGE = 1<<4;
8041
8042 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008043 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008044 * overwritten, even if it is already set.
8045 */
8046 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8047
8048 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008049 * Use with {@link #fillIn} to allow the current selector to be
8050 * overwritten, even if it is already set.
8051 */
8052 public static final int FILL_IN_SELECTOR = 1<<6;
8053
8054 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008055 * Use with {@link #fillIn} to allow the current ClipData to be
8056 * overwritten, even if it is already set.
8057 */
8058 public static final int FILL_IN_CLIP_DATA = 1<<7;
8059
8060 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008061 * Copy the contents of <var>other</var> in to this object, but only
8062 * where fields are not defined by this object. For purposes of a field
8063 * being defined, the following pieces of data in the Intent are
8064 * considered to be separate fields:
8065 *
8066 * <ul>
8067 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008068 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008069 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8070 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008071 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008072 * <li> component, as set by {@link #setComponent(ComponentName)} or
8073 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008074 * <li> source bounds, as set by {@link #setSourceBounds}.
8075 * <li> selector, as set by {@link #setSelector(Intent)}.
8076 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008077 * <li> each top-level name in the associated extras.
8078 * </ul>
8079 *
8080 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008081 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008082 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8083 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8084 * the restriction where the corresponding field will not be replaced if
8085 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008086 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008087 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8088 * is explicitly specified. The selector will only be copied if
8089 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008090 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008091 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8092 * and Intent B with {action="gotit", data-type="some/thing",
8093 * categories="one","two"}.
8094 *
8095 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8096 * containing: {action="gotit", data-type="some/thing",
8097 * categories="bar"}.
8098 *
8099 * @param other Another Intent whose values are to be used to fill in
8100 * the current one.
8101 * @param flags Options to control which fields can be filled in.
8102 *
8103 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008104 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008105 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8106 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8107 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008108 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008109 @FillInFlags
8110 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008111 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008112 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008113 if (other.mAction != null
8114 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008115 mAction = other.mAction;
8116 changes |= FILL_IN_ACTION;
8117 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008118 if ((other.mData != null || other.mType != null)
8119 && ((mData == null && mType == null)
8120 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008121 mData = other.mData;
8122 mType = other.mType;
8123 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008124 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008125 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008126 if (other.mCategories != null
8127 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008128 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008129 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008130 }
8131 changes |= FILL_IN_CATEGORIES;
8132 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008133 if (other.mPackage != null
8134 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008135 // Only do this if mSelector is not set.
8136 if (mSelector == null) {
8137 mPackage = other.mPackage;
8138 changes |= FILL_IN_PACKAGE;
8139 }
8140 }
8141 // Selector is special: it can only be set if explicitly allowed,
8142 // for the same reason as the component name.
8143 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8144 if (mPackage == null) {
8145 mSelector = new Intent(other.mSelector);
8146 mPackage = null;
8147 changes |= FILL_IN_SELECTOR;
8148 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008149 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008150 if (other.mClipData != null
8151 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8152 mClipData = other.mClipData;
8153 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008154 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008155 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008156 // Component is special: it can -only- be set if explicitly allowed,
8157 // since otherwise the sender could force the intent somewhere the
8158 // originator didn't intend.
8159 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008160 mComponent = other.mComponent;
8161 changes |= FILL_IN_COMPONENT;
8162 }
8163 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008164 if (other.mSourceBounds != null
8165 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8166 mSourceBounds = new Rect(other.mSourceBounds);
8167 changes |= FILL_IN_SOURCE_BOUNDS;
8168 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008169 if (mExtras == null) {
8170 if (other.mExtras != null) {
8171 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008172 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008173 }
8174 } else if (other.mExtras != null) {
8175 try {
8176 Bundle newb = new Bundle(other.mExtras);
8177 newb.putAll(mExtras);
8178 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008179 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008180 } catch (RuntimeException e) {
8181 // Modifying the extras can cause us to unparcel the contents
8182 // of the bundle, and if we do this in the system process that
8183 // may fail. We really should handle this (i.e., the Bundle
8184 // impl shouldn't be on top of a plain map), but for now just
8185 // ignore it and keep the original contents. :(
8186 Log.w("Intent", "Failure filling in extras", e);
8187 }
8188 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008189 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8190 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8191 mContentUserHint = other.mContentUserHint;
8192 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008193 return changes;
8194 }
8195
8196 /**
8197 * Wrapper class holding an Intent and implementing comparisons on it for
8198 * the purpose of filtering. The class implements its
8199 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8200 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8201 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8202 * on the wrapped Intent.
8203 */
8204 public static final class FilterComparison {
8205 private final Intent mIntent;
8206 private final int mHashCode;
8207
8208 public FilterComparison(Intent intent) {
8209 mIntent = intent;
8210 mHashCode = intent.filterHashCode();
8211 }
8212
8213 /**
8214 * Return the Intent that this FilterComparison represents.
8215 * @return Returns the Intent held by the FilterComparison. Do
8216 * not modify!
8217 */
8218 public Intent getIntent() {
8219 return mIntent;
8220 }
8221
8222 @Override
8223 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008224 if (obj instanceof FilterComparison) {
8225 Intent other = ((FilterComparison)obj).mIntent;
8226 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008227 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008228 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008229 }
8230
8231 @Override
8232 public int hashCode() {
8233 return mHashCode;
8234 }
8235 }
8236
8237 /**
8238 * Determine if two intents are the same for the purposes of intent
8239 * resolution (filtering). That is, if their action, data, type,
8240 * class, and categories are the same. This does <em>not</em> compare
8241 * any extra data included in the intents.
8242 *
8243 * @param other The other Intent to compare against.
8244 *
8245 * @return Returns true if action, data, type, class, and categories
8246 * are the same.
8247 */
8248 public boolean filterEquals(Intent other) {
8249 if (other == null) {
8250 return false;
8251 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008252 if (!Objects.equals(this.mAction, other.mAction)) return false;
8253 if (!Objects.equals(this.mData, other.mData)) return false;
8254 if (!Objects.equals(this.mType, other.mType)) return false;
8255 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8256 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8257 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008258
8259 return true;
8260 }
8261
8262 /**
8263 * Generate hash code that matches semantics of filterEquals().
8264 *
8265 * @return Returns the hash value of the action, data, type, class, and
8266 * categories.
8267 *
8268 * @see #filterEquals
8269 */
8270 public int filterHashCode() {
8271 int code = 0;
8272 if (mAction != null) {
8273 code += mAction.hashCode();
8274 }
8275 if (mData != null) {
8276 code += mData.hashCode();
8277 }
8278 if (mType != null) {
8279 code += mType.hashCode();
8280 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008281 if (mPackage != null) {
8282 code += mPackage.hashCode();
8283 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008284 if (mComponent != null) {
8285 code += mComponent.hashCode();
8286 }
8287 if (mCategories != null) {
8288 code += mCategories.hashCode();
8289 }
8290 return code;
8291 }
8292
8293 @Override
8294 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008295 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008296
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008297 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008298 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008299 b.append(" }");
8300
8301 return b.toString();
8302 }
8303
8304 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008305 public String toInsecureString() {
8306 StringBuilder b = new StringBuilder(128);
8307
8308 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008309 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008310 b.append(" }");
8311
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008312 return b.toString();
8313 }
Romain Guy4969af72009-06-17 10:53:19 -07008314
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008315 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008316 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008317 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008318
8319 b.append("Intent { ");
8320 toShortString(b, false, true, true, true);
8321 b.append(" }");
8322
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008323 return b.toString();
8324 }
8325
8326 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008327 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8328 StringBuilder b = new StringBuilder(128);
8329 toShortString(b, secure, comp, extras, clip);
8330 return b.toString();
8331 }
8332
8333 /** @hide */
8334 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8335 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008336 boolean first = true;
8337 if (mAction != null) {
8338 b.append("act=").append(mAction);
8339 first = false;
8340 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008341 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008342 if (!first) {
8343 b.append(' ');
8344 }
8345 first = false;
8346 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008347 for (int i=0; i<mCategories.size(); i++) {
8348 if (i > 0) b.append(',');
8349 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008350 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008351 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008352 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008353 if (mData != null) {
8354 if (!first) {
8355 b.append(' ');
8356 }
8357 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008358 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008359 if (secure) {
8360 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008361 } else {
8362 b.append(mData);
8363 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008364 }
8365 if (mType != null) {
8366 if (!first) {
8367 b.append(' ');
8368 }
8369 first = false;
8370 b.append("typ=").append(mType);
8371 }
8372 if (mFlags != 0) {
8373 if (!first) {
8374 b.append(' ');
8375 }
8376 first = false;
8377 b.append("flg=0x").append(Integer.toHexString(mFlags));
8378 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008379 if (mPackage != null) {
8380 if (!first) {
8381 b.append(' ');
8382 }
8383 first = false;
8384 b.append("pkg=").append(mPackage);
8385 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008386 if (comp && mComponent != null) {
8387 if (!first) {
8388 b.append(' ');
8389 }
8390 first = false;
8391 b.append("cmp=").append(mComponent.flattenToShortString());
8392 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008393 if (mSourceBounds != null) {
8394 if (!first) {
8395 b.append(' ');
8396 }
8397 first = false;
8398 b.append("bnds=").append(mSourceBounds.toShortString());
8399 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008400 if (mClipData != null) {
8401 if (!first) {
8402 b.append(' ');
8403 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008404 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008405 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008406 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008407 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008408 if (mClipData.getDescription() != null) {
8409 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8410 } else {
8411 first = true;
8412 }
8413 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008414 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008415 first = false;
8416 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008417 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008418 if (extras && mExtras != null) {
8419 if (!first) {
8420 b.append(' ');
8421 }
8422 first = false;
8423 b.append("(has extras)");
8424 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008425 if (mContentUserHint != UserHandle.USER_CURRENT) {
8426 if (!first) {
8427 b.append(' ');
8428 }
8429 first = false;
8430 b.append("u=").append(mContentUserHint);
8431 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008432 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008433 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008434 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008435 b.append("}");
8436 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008437 }
8438
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008439 /**
8440 * Call {@link #toUri} with 0 flags.
8441 * @deprecated Use {@link #toUri} instead.
8442 */
8443 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008444 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008445 return toUri(0);
8446 }
8447
8448 /**
8449 * Convert this Intent into a String holding a URI representation of it.
8450 * The returned URI string has been properly URI encoded, so it can be
8451 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8452 * Intent's data as the base URI, with an additional fragment describing
8453 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008454 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008455 * <p>You can convert the returned string back to an Intent with
8456 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008457 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008458 * @param flags Additional operating flags. Either 0,
8459 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008460 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008461 * @return Returns a URI encoding URI string describing the entire contents
8462 * of the Intent.
8463 */
8464 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008465 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008466 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8467 if (mPackage == null) {
8468 throw new IllegalArgumentException(
8469 "Intent must include an explicit package name to build an android-app: "
8470 + this);
8471 }
8472 uri.append("android-app://");
8473 uri.append(mPackage);
8474 String scheme = null;
8475 if (mData != null) {
8476 scheme = mData.getScheme();
8477 if (scheme != null) {
8478 uri.append('/');
8479 uri.append(scheme);
8480 String authority = mData.getEncodedAuthority();
8481 if (authority != null) {
8482 uri.append('/');
8483 uri.append(authority);
8484 String path = mData.getEncodedPath();
8485 if (path != null) {
8486 uri.append(path);
8487 }
8488 String queryParams = mData.getEncodedQuery();
8489 if (queryParams != null) {
8490 uri.append('?');
8491 uri.append(queryParams);
8492 }
8493 String fragment = mData.getEncodedFragment();
8494 if (fragment != null) {
8495 uri.append('#');
8496 uri.append(fragment);
8497 }
8498 }
8499 }
8500 }
8501 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8502 mPackage, flags);
8503 return uri.toString();
8504 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008505 String scheme = null;
8506 if (mData != null) {
8507 String data = mData.toString();
8508 if ((flags&URI_INTENT_SCHEME) != 0) {
8509 final int N = data.length();
8510 for (int i=0; i<N; i++) {
8511 char c = data.charAt(i);
8512 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8513 || c == '.' || c == '-') {
8514 continue;
8515 }
8516 if (c == ':' && i > 0) {
8517 // Valid scheme.
8518 scheme = data.substring(0, i);
8519 uri.append("intent:");
8520 data = data.substring(i+1);
8521 break;
8522 }
Tom Taylord4a47292009-12-21 13:59:18 -08008523
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008524 // No scheme.
8525 break;
8526 }
8527 }
8528 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008529
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008530 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8531 uri.append("intent:");
8532 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008533
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008534 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008535
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008536 return uri.toString();
8537 }
8538
8539 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8540 String defPackage, int flags) {
8541 StringBuilder frag = new StringBuilder(128);
8542
8543 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008544 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008545 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008546 // Note that for now we are not going to try to handle the
8547 // data part; not clear how to represent this as a URI, and
8548 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008549 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8550 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008551 }
8552
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008553 if (frag.length() > 0) {
8554 uri.append("#Intent;");
8555 uri.append(frag);
8556 uri.append("end");
8557 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008558 }
8559
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008560 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8561 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008562 if (scheme != null) {
8563 uri.append("scheme=").append(scheme).append(';');
8564 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008565 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008566 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008567 }
8568 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008569 for (int i=0; i<mCategories.size(); i++) {
8570 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008571 }
8572 }
8573 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008574 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008575 }
8576 if (mFlags != 0) {
8577 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8578 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008579 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008580 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8581 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008582 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008583 uri.append("component=").append(Uri.encode(
8584 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008585 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008586 if (mSourceBounds != null) {
8587 uri.append("sourceBounds=")
8588 .append(Uri.encode(mSourceBounds.flattenToString()))
8589 .append(';');
8590 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008591 if (mExtras != null) {
8592 for (String key : mExtras.keySet()) {
8593 final Object value = mExtras.get(key);
8594 char entryType =
8595 value instanceof String ? 'S' :
8596 value instanceof Boolean ? 'B' :
8597 value instanceof Byte ? 'b' :
8598 value instanceof Character ? 'c' :
8599 value instanceof Double ? 'd' :
8600 value instanceof Float ? 'f' :
8601 value instanceof Integer ? 'i' :
8602 value instanceof Long ? 'l' :
8603 value instanceof Short ? 's' :
8604 '\0';
8605
8606 if (entryType != '\0') {
8607 uri.append(entryType);
8608 uri.append('.');
8609 uri.append(Uri.encode(key));
8610 uri.append('=');
8611 uri.append(Uri.encode(value.toString()));
8612 uri.append(';');
8613 }
8614 }
8615 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008616 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008617
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008618 public int describeContents() {
8619 return (mExtras != null) ? mExtras.describeContents() : 0;
8620 }
8621
8622 public void writeToParcel(Parcel out, int flags) {
8623 out.writeString(mAction);
8624 Uri.writeToParcel(out, mData);
8625 out.writeString(mType);
8626 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008627 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008628 ComponentName.writeToParcel(mComponent, out);
8629
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008630 if (mSourceBounds != null) {
8631 out.writeInt(1);
8632 mSourceBounds.writeToParcel(out, flags);
8633 } else {
8634 out.writeInt(0);
8635 }
8636
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008637 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008638 final int N = mCategories.size();
8639 out.writeInt(N);
8640 for (int i=0; i<N; i++) {
8641 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008642 }
8643 } else {
8644 out.writeInt(0);
8645 }
8646
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008647 if (mSelector != null) {
8648 out.writeInt(1);
8649 mSelector.writeToParcel(out, flags);
8650 } else {
8651 out.writeInt(0);
8652 }
8653
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008654 if (mClipData != null) {
8655 out.writeInt(1);
8656 mClipData.writeToParcel(out, flags);
8657 } else {
8658 out.writeInt(0);
8659 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008660 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008661 out.writeBundle(mExtras);
8662 }
8663
8664 public static final Parcelable.Creator<Intent> CREATOR
8665 = new Parcelable.Creator<Intent>() {
8666 public Intent createFromParcel(Parcel in) {
8667 return new Intent(in);
8668 }
8669 public Intent[] newArray(int size) {
8670 return new Intent[size];
8671 }
8672 };
8673
Dianne Hackborneb034652009-09-07 00:49:58 -07008674 /** @hide */
8675 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008676 readFromParcel(in);
8677 }
8678
8679 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008680 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008681 mData = Uri.CREATOR.createFromParcel(in);
8682 mType = in.readString();
8683 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008684 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008685 mComponent = ComponentName.readFromParcel(in);
8686
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008687 if (in.readInt() != 0) {
8688 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8689 }
8690
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008691 int N = in.readInt();
8692 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008693 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008694 int i;
8695 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008696 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008697 }
8698 } else {
8699 mCategories = null;
8700 }
8701
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008702 if (in.readInt() != 0) {
8703 mSelector = new Intent(in);
8704 }
8705
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008706 if (in.readInt() != 0) {
8707 mClipData = new ClipData(in);
8708 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008709 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008710 mExtras = in.readBundle();
8711 }
8712
8713 /**
8714 * Parses the "intent" element (and its children) from XML and instantiates
8715 * an Intent object. The given XML parser should be located at the tag
8716 * where parsing should start (often named "intent"), from which the
8717 * basic action, data, type, and package and class name will be
8718 * retrieved. The function will then parse in to any child elements,
8719 * looking for <category android:name="xxx"> tags to add categories and
8720 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8721 * to the intent.
8722 *
8723 * @param resources The Resources to use when inflating resources.
8724 * @param parser The XML parser pointing at an "intent" tag.
8725 * @param attrs The AttributeSet interface for retrieving extended
8726 * attribute data at the current <var>parser</var> location.
8727 * @return An Intent object matching the XML data.
8728 * @throws XmlPullParserException If there was an XML parsing error.
8729 * @throws IOException If there was an I/O error.
8730 */
8731 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8732 throws XmlPullParserException, IOException {
8733 Intent intent = new Intent();
8734
8735 TypedArray sa = resources.obtainAttributes(attrs,
8736 com.android.internal.R.styleable.Intent);
8737
8738 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8739
8740 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8741 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8742 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8743
8744 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8745 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8746 if (packageName != null && className != null) {
8747 intent.setComponent(new ComponentName(packageName, className));
8748 }
8749
8750 sa.recycle();
8751
8752 int outerDepth = parser.getDepth();
8753 int type;
8754 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8755 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8756 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8757 continue;
8758 }
8759
8760 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008761 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008762 sa = resources.obtainAttributes(attrs,
8763 com.android.internal.R.styleable.IntentCategory);
8764 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8765 sa.recycle();
8766
8767 if (cat != null) {
8768 intent.addCategory(cat);
8769 }
8770 XmlUtils.skipCurrentTag(parser);
8771
Craig Mautner21d24a22014-04-23 11:45:37 -07008772 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008773 if (intent.mExtras == null) {
8774 intent.mExtras = new Bundle();
8775 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008776 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008777 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008778
8779 } else {
8780 XmlUtils.skipCurrentTag(parser);
8781 }
8782 }
8783
8784 return intent;
8785 }
Nick Pellyccae4122012-01-09 14:12:58 -08008786
Craig Mautner21d24a22014-04-23 11:45:37 -07008787 /** @hide */
8788 public void saveToXml(XmlSerializer out) throws IOException {
8789 if (mAction != null) {
8790 out.attribute(null, ATTR_ACTION, mAction);
8791 }
8792 if (mData != null) {
8793 out.attribute(null, ATTR_DATA, mData.toString());
8794 }
8795 if (mType != null) {
8796 out.attribute(null, ATTR_TYPE, mType);
8797 }
8798 if (mComponent != null) {
8799 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8800 }
8801 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8802
8803 if (mCategories != null) {
8804 out.startTag(null, TAG_CATEGORIES);
8805 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8806 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8807 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008808 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008809 }
8810 }
8811
8812 /** @hide */
8813 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8814 XmlPullParserException {
8815 Intent intent = new Intent();
8816 final int outerDepth = in.getDepth();
8817
8818 int attrCount = in.getAttributeCount();
8819 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8820 final String attrName = in.getAttributeName(attrNdx);
8821 final String attrValue = in.getAttributeValue(attrNdx);
8822 if (ATTR_ACTION.equals(attrName)) {
8823 intent.setAction(attrValue);
8824 } else if (ATTR_DATA.equals(attrName)) {
8825 intent.setData(Uri.parse(attrValue));
8826 } else if (ATTR_TYPE.equals(attrName)) {
8827 intent.setType(attrValue);
8828 } else if (ATTR_COMPONENT.equals(attrName)) {
8829 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8830 } else if (ATTR_FLAGS.equals(attrName)) {
8831 intent.setFlags(Integer.valueOf(attrValue, 16));
8832 } else {
8833 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8834 }
8835 }
8836
8837 int event;
8838 String name;
8839 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8840 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8841 if (event == XmlPullParser.START_TAG) {
8842 name = in.getName();
8843 if (TAG_CATEGORIES.equals(name)) {
8844 attrCount = in.getAttributeCount();
8845 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8846 intent.addCategory(in.getAttributeValue(attrNdx));
8847 }
8848 } else {
8849 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8850 XmlUtils.skipCurrentTag(in);
8851 }
8852 }
8853 }
8854
8855 return intent;
8856 }
8857
Nick Pellyccae4122012-01-09 14:12:58 -08008858 /**
8859 * Normalize a MIME data type.
8860 *
8861 * <p>A normalized MIME type has white-space trimmed,
8862 * content-type parameters removed, and is lower-case.
8863 * This aligns the type with Android best practices for
8864 * intent filtering.
8865 *
8866 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8867 * "text/x-vCard" becomes "text/x-vcard".
8868 *
8869 * <p>All MIME types received from outside Android (such as user input,
8870 * or external sources like Bluetooth, NFC, or the Internet) should
8871 * be normalized before they are used to create an Intent.
8872 *
8873 * @param type MIME data type to normalize
8874 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008875 * @see #setType
8876 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008877 */
8878 public static String normalizeMimeType(String type) {
8879 if (type == null) {
8880 return null;
8881 }
8882
Elliott Hughescb64d432013-08-02 10:00:44 -07008883 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008884
8885 final int semicolonIndex = type.indexOf(';');
8886 if (semicolonIndex != -1) {
8887 type = type.substring(0, semicolonIndex);
8888 }
8889 return type;
8890 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008891
8892 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008893 * Prepare this {@link Intent} to leave an app process.
8894 *
8895 * @hide
8896 */
8897 public void prepareToLeaveProcess() {
8898 setAllowFds(false);
8899
8900 if (mSelector != null) {
8901 mSelector.prepareToLeaveProcess();
8902 }
8903 if (mClipData != null) {
8904 mClipData.prepareToLeaveProcess();
8905 }
8906
8907 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
8908 // There are several ACTION_MEDIA_* broadcasts that send file://
8909 // Uris, so only check common actions.
8910 if (ACTION_VIEW.equals(mAction) ||
8911 ACTION_EDIT.equals(mAction) ||
8912 ACTION_ATTACH_DATA.equals(mAction)) {
8913 mData.checkFileUriExposed("Intent.getData()");
8914 }
8915 }
8916 }
8917
8918 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008919 * @hide
8920 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008921 public void prepareToEnterProcess() {
8922 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008923 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8924 fixUris(mContentUserHint);
8925 mContentUserHint = UserHandle.USER_CURRENT;
8926 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008927 }
8928 }
8929
8930 /**
8931 * @hide
8932 */
8933 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008934 Uri data = getData();
8935 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008936 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008937 }
8938 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008939 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008940 }
8941 String action = getAction();
8942 if (ACTION_SEND.equals(action)) {
8943 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8944 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008945 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008946 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008947 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008948 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8949 if (streams != null) {
8950 ArrayList<Uri> newStreams = new ArrayList<Uri>();
8951 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008952 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008953 }
8954 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
8955 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008956 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8957 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8958 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8959 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8960 if (output != null) {
8961 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
8962 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008963 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008964 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008965
8966 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008967 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008968 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
8969 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008970 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008971 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008972 * @hide
8973 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008974 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008975 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008976 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008977
8978 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008979 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008980
8981 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008982 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008983 // Inspect contained intents to see if we need to migrate extras. We
8984 // don't promote ClipData to the parent, since ChooserActivity will
8985 // already start the picked item as the caller, and we can't combine
8986 // the flags in a safe way.
8987
8988 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07008989 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008990 final Intent intent = getParcelableExtra(EXTRA_INTENT);
8991 if (intent != null) {
8992 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07008993 }
8994 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008995 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008996 try {
8997 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
8998 if (intents != null) {
8999 for (int i = 0; i < intents.length; i++) {
9000 final Intent intent = (Intent) intents[i];
9001 if (intent != null) {
9002 migrated |= intent.migrateExtraStreamToClipData();
9003 }
9004 }
9005 }
9006 } catch (ClassCastException e) {
9007 }
9008 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009009
9010 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009011 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009012 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9013 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9014 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9015 if (stream != null || text != null || htmlText != null) {
9016 final ClipData clipData = new ClipData(
9017 null, new String[] { getType() },
9018 new ClipData.Item(text, htmlText, null, stream));
9019 setClipData(clipData);
9020 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009021 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009022 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009023 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009024 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009025
9026 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009027 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009028 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9029 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9030 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9031 int num = -1;
9032 if (streams != null) {
9033 num = streams.size();
9034 }
9035 if (texts != null) {
9036 if (num >= 0 && num != texts.size()) {
9037 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009038 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009039 }
9040 num = texts.size();
9041 }
9042 if (htmlTexts != null) {
9043 if (num >= 0 && num != htmlTexts.size()) {
9044 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009045 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009046 }
9047 num = htmlTexts.size();
9048 }
9049 if (num > 0) {
9050 final ClipData clipData = new ClipData(
9051 null, new String[] { getType() },
9052 makeClipItem(streams, texts, htmlTexts, 0));
9053
9054 for (int i = 1; i < num; i++) {
9055 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9056 }
9057
9058 setClipData(clipData);
9059 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009060 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009061 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009062 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009063 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009064 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9065 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9066 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9067 final Uri output;
9068 try {
9069 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9070 } catch (ClassCastException e) {
9071 return false;
9072 }
9073 if (output != null) {
9074 setClipData(ClipData.newRawUri("", output));
9075 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9076 return true;
9077 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009078 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009079
9080 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009081 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009082
9083 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9084 ArrayList<String> htmlTexts, int which) {
9085 Uri uri = streams != null ? streams.get(which) : null;
9086 CharSequence text = texts != null ? texts.get(which) : null;
9087 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9088 return new ClipData.Item(text, htmlText, null, uri);
9089 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009090
9091 /** @hide */
9092 public boolean isDocument() {
9093 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9094 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009095}