blob: 2178c38efd44173d28562f7d1dc122bf0c532239 [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;
44import android.os.IBinder;
45import android.os.Parcel;
46import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000047import android.os.Process;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070048import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010049import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070050import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070051import android.provider.DocumentsProvider;
52import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070053import android.util.AttributeSet;
54import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080055
56import com.android.internal.util.XmlUtils;
Jose Lima73915cf2014-07-29 17:16:31 -070057
Craig Mautner21d24a22014-04-23 11:45:37 -070058import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070059
60import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080061import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070062import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070063import java.lang.annotation.Retention;
64import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070065import java.net.URISyntaxException;
66import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080067import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070068import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080069import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070070import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070071import java.util.Set;
72
73/**
74 * An intent is an abstract description of an operation to be performed. It
75 * can be used with {@link Context#startActivity(Intent) startActivity} to
76 * launch an {@link android.app.Activity},
77 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
78 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
79 * and {@link android.content.Context#startService} or
80 * {@link android.content.Context#bindService} to communicate with a
81 * background {@link android.app.Service}.
82 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070083 * <p>An Intent provides a facility for performing late runtime binding between the code in
84 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070085 * can be thought of as the glue between activities. It is basically a passive data structure
86 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070087 *
88 * <div class="special reference">
89 * <h3>Developer Guides</h3>
90 * <p>For information about how to create and resolve intents, read the
91 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
92 * developer guide.</p>
93 * </div>
94 *
95 * <a name="IntentStructure"></a>
96 * <h3>Intent Structure</h3>
97 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070098 *
99 * <ul>
100 * <li> <p><b>action</b> -- The general action to be performed, such as
101 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
102 * etc.</p>
103 * </li>
104 * <li> <p><b>data</b> -- The data to operate on, such as a person record
105 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
106 * </li>
107 * </ul>
108 *
109 *
110 * <p>Some examples of action/data pairs are:</p>
111 *
112 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700113 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700114 * information about the person whose identifier is "1".</p>
115 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700116 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700117 * the phone dialer with the person filled in.</p>
118 * </li>
119 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
120 * the phone dialer with the given number filled in. Note how the
121 * VIEW action does what what is considered the most reasonable thing for
122 * a particular URI.</p>
123 * </li>
124 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
125 * the phone dialer with the given number filled in.</p>
126 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700127 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700128 * information about the person whose identifier is "1".</p>
129 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700130 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700131 * a list of people, which the user can browse through. This example is a
132 * typical top-level entry into the Contacts application, showing you the
133 * list of people. Selecting a particular person to view would result in a
134 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
135 * being used to start an activity to display that person.</p>
136 * </li>
137 * </ul>
138 *
139 * <p>In addition to these primary attributes, there are a number of secondary
140 * attributes that you can also include with an intent:</p>
141 *
142 * <ul>
143 * <li> <p><b>category</b> -- Gives additional information about the action
144 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
145 * appear in the Launcher as a top-level application, while
146 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
147 * of alternative actions the user can perform on a piece of data.</p>
148 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
149 * intent data. Normally the type is inferred from the data itself.
150 * By setting this attribute, you disable that evaluation and force
151 * an explicit type.</p>
152 * <li> <p><b>component</b> -- Specifies an explicit name of a component
153 * class to use for the intent. Normally this is determined by looking
154 * at the other information in the intent (the action, data/type, and
155 * categories) and matching that with a component that can handle it.
156 * If this attribute is set then none of the evaluation is performed,
157 * and this component is used exactly as is. By specifying this attribute,
158 * all of the other Intent attributes become optional.</p>
159 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
160 * This can be used to provide extended information to the component.
161 * For example, if we have a action to send an e-mail message, we could
162 * also include extra pieces of data here to supply a subject, body,
163 * etc.</p>
164 * </ul>
165 *
166 * <p>Here are some examples of other operations you can specify as intents
167 * using these additional parameters:</p>
168 *
169 * <ul>
170 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
171 * Launch the home screen.</p>
172 * </li>
173 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
174 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
175 * vnd.android.cursor.item/phone}</i></b>
176 * -- Display the list of people's phone numbers, allowing the user to
177 * browse through them and pick one and return it to the parent activity.</p>
178 * </li>
179 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
180 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
181 * -- Display all pickers for data that can be opened with
182 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
183 * allowing the user to pick one of them and then some data inside of it
184 * and returning the resulting URI to the caller. This can be used,
185 * for example, in an e-mail application to allow the user to pick some
186 * data to include as an attachment.</p>
187 * </li>
188 * </ul>
189 *
190 * <p>There are a variety of standard Intent action and category constants
191 * defined in the Intent class, but applications can also define their own.
192 * These strings use java style scoping, to ensure they are unique -- for
193 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700194 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700195 *
196 * <p>Put together, the set of actions, data types, categories, and extra data
197 * defines a language for the system allowing for the expression of phrases
198 * such as "call john smith's cell". As applications are added to the system,
199 * they can extend this language by adding new actions, types, and categories, or
200 * they can modify the behavior of existing phrases by supplying their own
201 * activities that handle them.</p>
202 *
203 * <a name="IntentResolution"></a>
204 * <h3>Intent Resolution</h3>
205 *
206 * <p>There are two primary forms of intents you will use.
207 *
208 * <ul>
209 * <li> <p><b>Explicit Intents</b> have specified a component (via
210 * {@link #setComponent} or {@link #setClass}), which provides the exact
211 * class to be run. Often these will not include any other information,
212 * simply being a way for an application to launch various internal
213 * activities it has as the user interacts with the application.
214 *
215 * <li> <p><b>Implicit Intents</b> have not specified a component;
216 * instead, they must include enough information for the system to
217 * determine which of the available components is best to run for that
218 * intent.
219 * </ul>
220 *
221 * <p>When using implicit intents, given such an arbitrary intent we need to
222 * know what to do with it. This is handled by the process of <em>Intent
223 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
224 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
225 * more activities/receivers) that can handle it.</p>
226 *
227 * <p>The intent resolution mechanism basically revolves around matching an
228 * Intent against all of the &lt;intent-filter&gt; descriptions in the
229 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
230 * objects explicitly registered with {@link Context#registerReceiver}.) More
231 * details on this can be found in the documentation on the {@link
232 * IntentFilter} class.</p>
233 *
234 * <p>There are three pieces of information in the Intent that are used for
235 * resolution: the action, type, and category. Using this information, a query
236 * is done on the {@link PackageManager} for a component that can handle the
237 * intent. The appropriate component is determined based on the intent
238 * information supplied in the <code>AndroidManifest.xml</code> file as
239 * follows:</p>
240 *
241 * <ul>
242 * <li> <p>The <b>action</b>, if given, must be listed by the component as
243 * one it handles.</p>
244 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
245 * already supplied in the Intent. Like the action, if a type is
246 * included in the intent (either explicitly or implicitly in its
247 * data), then this must be listed by the component as one it handles.</p>
248 * <li> For data that is not a <code>content:</code> URI and where no explicit
249 * type is included in the Intent, instead the <b>scheme</b> of the
250 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
251 * considered. Again like the action, if we are matching a scheme it
252 * must be listed by the component as one it can handle.
253 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
254 * by the activity as categories it handles. That is, if you include
255 * the categories {@link #CATEGORY_LAUNCHER} and
256 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
257 * with an intent that lists <em>both</em> of those categories.
258 * Activities will very often need to support the
259 * {@link #CATEGORY_DEFAULT} so that they can be found by
260 * {@link Context#startActivity Context.startActivity()}.</p>
261 * </ul>
262 *
263 * <p>For example, consider the Note Pad sample application that
264 * allows user to browse through a list of notes data and view details about
265 * individual items. Text in italics indicate places were you would replace a
266 * name with one specific to your own package.</p>
267 *
268 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
269 * package="<i>com.android.notepad</i>"&gt;
270 * &lt;application android:icon="@drawable/app_notes"
271 * android:label="@string/app_name"&gt;
272 *
273 * &lt;provider class=".NotePadProvider"
274 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
275 *
276 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
277 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700278 * &lt;action android:name="android.intent.action.MAIN" /&gt;
279 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700280 * &lt;/intent-filter&gt;
281 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700282 * &lt;action android:name="android.intent.action.VIEW" /&gt;
283 * &lt;action android:name="android.intent.action.EDIT" /&gt;
284 * &lt;action android:name="android.intent.action.PICK" /&gt;
285 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
286 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700287 * &lt;/intent-filter&gt;
288 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700289 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
290 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
291 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700292 * &lt;/intent-filter&gt;
293 * &lt;/activity&gt;
294 *
295 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
296 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700297 * &lt;action android:name="android.intent.action.VIEW" /&gt;
298 * &lt;action android:name="android.intent.action.EDIT" /&gt;
299 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
300 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700301 * &lt;/intent-filter&gt;
302 *
303 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700304 * &lt;action android:name="android.intent.action.INSERT" /&gt;
305 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
306 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700307 * &lt;/intent-filter&gt;
308 *
309 * &lt;/activity&gt;
310 *
311 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
312 * android:theme="@android:style/Theme.Dialog"&gt;
313 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700314 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
315 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
316 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
317 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
318 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700319 * &lt;/intent-filter&gt;
320 * &lt;/activity&gt;
321 *
322 * &lt;/application&gt;
323 * &lt;/manifest&gt;</pre>
324 *
325 * <p>The first activity,
326 * <code>com.android.notepad.NotesList</code>, serves as our main
327 * entry into the app. It can do three things as described by its three intent
328 * templates:
329 * <ol>
330 * <li><pre>
331 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700332 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
333 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700334 * &lt;/intent-filter&gt;</pre>
335 * <p>This provides a top-level entry into the NotePad application: the standard
336 * MAIN action is a main entry point (not requiring any other information in
337 * the Intent), and the LAUNCHER category says that this entry point should be
338 * listed in the application launcher.</p>
339 * <li><pre>
340 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700341 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
342 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
343 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
344 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
345 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700346 * &lt;/intent-filter&gt;</pre>
347 * <p>This declares the things that the activity can do on a directory of
348 * notes. The type being supported is given with the &lt;type&gt; tag, where
349 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
350 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
351 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
352 * The activity allows the user to view or edit the directory of data (via
353 * the VIEW and EDIT actions), or to pick a particular note and return it
354 * to the caller (via the PICK action). Note also the DEFAULT category
355 * supplied here: this is <em>required</em> for the
356 * {@link Context#startActivity Context.startActivity} method to resolve your
357 * activity when its component name is not explicitly specified.</p>
358 * <li><pre>
359 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700360 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
361 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
362 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700363 * &lt;/intent-filter&gt;</pre>
364 * <p>This filter describes the ability return to the caller a note selected by
365 * the user without needing to know where it came from. The data type
366 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
367 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
368 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
369 * The GET_CONTENT action is similar to the PICK action, where the activity
370 * will return to its caller a piece of data selected by the user. Here,
371 * however, the caller specifies the type of data they desire instead of
372 * the type of data the user will be picking from.</p>
373 * </ol>
374 *
375 * <p>Given these capabilities, the following intents will resolve to the
376 * NotesList activity:</p>
377 *
378 * <ul>
379 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
380 * activities that can be used as top-level entry points into an
381 * application.</p>
382 * <li> <p><b>{ action=android.app.action.MAIN,
383 * category=android.app.category.LAUNCHER }</b> is the actual intent
384 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700385 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700386 * data=content://com.google.provider.NotePad/notes }</b>
387 * displays a list of all the notes under
388 * "content://com.google.provider.NotePad/notes", which
389 * the user can browse through and see the details on.</p>
390 * <li> <p><b>{ action=android.app.action.PICK
391 * data=content://com.google.provider.NotePad/notes }</b>
392 * provides a list of the notes under
393 * "content://com.google.provider.NotePad/notes", from which
394 * the user can pick a note whose data URL is returned back to the caller.</p>
395 * <li> <p><b>{ action=android.app.action.GET_CONTENT
396 * type=vnd.android.cursor.item/vnd.google.note }</b>
397 * is similar to the pick action, but allows the caller to specify the
398 * kind of data they want back so that the system can find the appropriate
399 * activity to pick something of that data type.</p>
400 * </ul>
401 *
402 * <p>The second activity,
403 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
404 * note entry and allows them to edit it. It can do two things as described
405 * by its two intent templates:
406 * <ol>
407 * <li><pre>
408 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700409 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
410 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
411 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
412 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700413 * &lt;/intent-filter&gt;</pre>
414 * <p>The first, primary, purpose of this activity is to let the user interact
415 * with a single note, as decribed by the MIME type
416 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
417 * either VIEW a note or allow the user to EDIT it. Again we support the
418 * DEFAULT category to allow the activity to be launched without explicitly
419 * specifying its component.</p>
420 * <li><pre>
421 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700422 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
423 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
424 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700425 * &lt;/intent-filter&gt;</pre>
426 * <p>The secondary use of this activity is to insert a new note entry into
427 * an existing directory of notes. This is used when the user creates a new
428 * note: the INSERT action is executed on the directory of notes, causing
429 * this activity to run and have the user create the new note data which
430 * it then adds to the content provider.</p>
431 * </ol>
432 *
433 * <p>Given these capabilities, the following intents will resolve to the
434 * NoteEditor activity:</p>
435 *
436 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700437 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700438 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
439 * shows the user the content of note <var>{ID}</var>.</p>
440 * <li> <p><b>{ action=android.app.action.EDIT
441 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
442 * allows the user to edit the content of note <var>{ID}</var>.</p>
443 * <li> <p><b>{ action=android.app.action.INSERT
444 * data=content://com.google.provider.NotePad/notes }</b>
445 * creates a new, empty note in the notes list at
446 * "content://com.google.provider.NotePad/notes"
447 * and allows the user to edit it. If they keep their changes, the URI
448 * of the newly created note is returned to the caller.</p>
449 * </ul>
450 *
451 * <p>The last activity,
452 * <code>com.android.notepad.TitleEditor</code>, allows the user to
453 * edit the title of a note. This could be implemented as a class that the
454 * application directly invokes (by explicitly setting its component in
455 * the Intent), but here we show a way you can publish alternative
456 * operations on existing data:</p>
457 *
458 * <pre>
459 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700460 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
461 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
462 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
463 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
464 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700465 * &lt;/intent-filter&gt;</pre>
466 *
467 * <p>In the single intent template here, we
468 * have created our own private action called
469 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
470 * edit the title of a note. It must be invoked on a specific note
471 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
472 * view and edit actions, but here displays and edits the title contained
473 * in the note data.
474 *
475 * <p>In addition to supporting the default category as usual, our title editor
476 * also supports two other standard categories: ALTERNATIVE and
477 * SELECTED_ALTERNATIVE. Implementing
478 * these categories allows others to find the special action it provides
479 * without directly knowing about it, through the
480 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
481 * more often to build dynamic menu items with
482 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
483 * template here was also supply an explicit name for the template
484 * (via <code>android:label="@string/resolve_title"</code>) to better control
485 * what the user sees when presented with this activity as an alternative
486 * action to the data they are viewing.
487 *
488 * <p>Given these capabilities, the following intent will resolve to the
489 * TitleEditor activity:</p>
490 *
491 * <ul>
492 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
493 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
494 * displays and allows the user to edit the title associated
495 * with note <var>{ID}</var>.</p>
496 * </ul>
497 *
498 * <h3>Standard Activity Actions</h3>
499 *
500 * <p>These are the current standard actions that Intent defines for launching
501 * activities (usually through {@link Context#startActivity}. The most
502 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
503 * {@link #ACTION_EDIT}.
504 *
505 * <ul>
506 * <li> {@link #ACTION_MAIN}
507 * <li> {@link #ACTION_VIEW}
508 * <li> {@link #ACTION_ATTACH_DATA}
509 * <li> {@link #ACTION_EDIT}
510 * <li> {@link #ACTION_PICK}
511 * <li> {@link #ACTION_CHOOSER}
512 * <li> {@link #ACTION_GET_CONTENT}
513 * <li> {@link #ACTION_DIAL}
514 * <li> {@link #ACTION_CALL}
515 * <li> {@link #ACTION_SEND}
516 * <li> {@link #ACTION_SENDTO}
517 * <li> {@link #ACTION_ANSWER}
518 * <li> {@link #ACTION_INSERT}
519 * <li> {@link #ACTION_DELETE}
520 * <li> {@link #ACTION_RUN}
521 * <li> {@link #ACTION_SYNC}
522 * <li> {@link #ACTION_PICK_ACTIVITY}
523 * <li> {@link #ACTION_SEARCH}
524 * <li> {@link #ACTION_WEB_SEARCH}
525 * <li> {@link #ACTION_FACTORY_TEST}
526 * </ul>
527 *
528 * <h3>Standard Broadcast Actions</h3>
529 *
530 * <p>These are the current standard actions that Intent defines for receiving
531 * broadcasts (usually through {@link Context#registerReceiver} or a
532 * &lt;receiver&gt; tag in a manifest).
533 *
534 * <ul>
535 * <li> {@link #ACTION_TIME_TICK}
536 * <li> {@link #ACTION_TIME_CHANGED}
537 * <li> {@link #ACTION_TIMEZONE_CHANGED}
538 * <li> {@link #ACTION_BOOT_COMPLETED}
539 * <li> {@link #ACTION_PACKAGE_ADDED}
540 * <li> {@link #ACTION_PACKAGE_CHANGED}
541 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800542 * <li> {@link #ACTION_PACKAGE_RESTARTED}
543 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700544 * <li> {@link #ACTION_UID_REMOVED}
545 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700546 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700547 * <li> {@link #ACTION_POWER_DISCONNECTED}
548 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * </ul>
550 *
551 * <h3>Standard Categories</h3>
552 *
553 * <p>These are the current standard categories that can be used to further
554 * clarify an Intent via {@link #addCategory}.
555 *
556 * <ul>
557 * <li> {@link #CATEGORY_DEFAULT}
558 * <li> {@link #CATEGORY_BROWSABLE}
559 * <li> {@link #CATEGORY_TAB}
560 * <li> {@link #CATEGORY_ALTERNATIVE}
561 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
562 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800563 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700564 * <li> {@link #CATEGORY_HOME}
565 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700566 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400567 * <li> {@link #CATEGORY_CAR_DOCK}
568 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500569 * <li> {@link #CATEGORY_LE_DESK_DOCK}
570 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200571 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700572 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700573 * </ul>
574 *
575 * <h3>Standard Extra Data</h3>
576 *
577 * <p>These are the current standard fields that can be used as extra data via
578 * {@link #putExtra}.
579 *
580 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800581 * <li> {@link #EXTRA_ALARM_COUNT}
582 * <li> {@link #EXTRA_BCC}
583 * <li> {@link #EXTRA_CC}
584 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
585 * <li> {@link #EXTRA_DATA_REMOVED}
586 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500587 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
588 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800589 * <li> {@link #EXTRA_DOCK_STATE_CAR}
590 * <li> {@link #EXTRA_DOCK_STATE_DESK}
591 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
592 * <li> {@link #EXTRA_DONT_KILL_APP}
593 * <li> {@link #EXTRA_EMAIL}
594 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800596 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700597 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800598 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700599 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800600 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
601 * <li> {@link #EXTRA_REPLACING}
602 * <li> {@link #EXTRA_SHORTCUT_ICON}
603 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
604 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700605 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800606 * <li> {@link #EXTRA_SHORTCUT_NAME}
607 * <li> {@link #EXTRA_SUBJECT}
608 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700609 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800610 * <li> {@link #EXTRA_TITLE}
611 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700612 * </ul>
613 *
614 * <h3>Flags</h3>
615 *
616 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800617 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
618 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700619 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800620public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700621 private static final String ATTR_ACTION = "action";
622 private static final String TAG_CATEGORIES = "categories";
623 private static final String ATTR_CATEGORY = "category";
624 private static final String TAG_EXTRA = "extra";
625 private static final String ATTR_TYPE = "type";
626 private static final String ATTR_COMPONENT = "component";
627 private static final String ATTR_DATA = "data";
628 private static final String ATTR_FLAGS = "flags";
629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 // ---------------------------------------------------------------------
631 // ---------------------------------------------------------------------
632 // Standard intent activity actions (see action variable).
633
634 /**
635 * Activity Action: Start as a main entry point, does not expect to
636 * receive data.
637 * <p>Input: nothing
638 * <p>Output: nothing
639 */
640 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
641 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800642
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700643 /**
644 * Activity Action: Display the data to the user. This is the most common
645 * action performed on data -- it is the generic action you can use on
646 * a piece of data to get the most reasonable thing to occur. For example,
647 * when used on a contacts entry it will view the entry; when used on a
648 * mailto: URI it will bring up a compose window filled with the information
649 * supplied by the URI; when used with a tel: URI it will invoke the
650 * dialer.
651 * <p>Input: {@link #getData} is URI from which to retrieve data.
652 * <p>Output: nothing.
653 */
654 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
655 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800656
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700657 /**
658 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
659 * performed on a piece of data.
660 */
661 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800662
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700663 /**
Steve McKayc78bcb82015-07-31 14:35:22 -0700664 * Activity Action: Quick view the data.
665 * <p>Input: {@link #getData} is URI from which to retrieve data.
666 * <p>Output: nothing.
667 * @hide
668 */
669 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
670 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
671
672 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700673 * Used to indicate that some piece of data should be attached to some other
674 * place. For example, image data could be attached to a contact. It is up
675 * to the recipient to decide where the data should be attached; the intent
676 * does not specify the ultimate destination.
677 * <p>Input: {@link #getData} is URI of data to be attached.
678 * <p>Output: nothing.
679 */
680 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
681 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800682
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700683 /**
684 * Activity Action: Provide explicit editable access to the given data.
685 * <p>Input: {@link #getData} is URI of data to be edited.
686 * <p>Output: nothing.
687 */
688 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
689 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800690
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700691 /**
692 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
693 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
694 * The extras can contain type specific data to pass through to the editing/creating
695 * activity.
696 * <p>Output: The URI of the item that was picked. This must be a content:
697 * URI so that any receiver can access it.
698 */
699 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
700 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800701
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700702 /**
703 * Activity Action: Pick an item from the data, returning what was selected.
704 * <p>Input: {@link #getData} is URI containing a directory of data
705 * (vnd.android.cursor.dir/*) from which to pick an item.
706 * <p>Output: The URI of the item that was picked.
707 */
708 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
709 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800710
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700711 /**
712 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800713 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700714 * <p>Output: An Intent representing the shortcut. The intent must contain three
715 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
716 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800717 * (value: ShortcutIconResource).</p>
718 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700719 * @see #EXTRA_SHORTCUT_INTENT
720 * @see #EXTRA_SHORTCUT_NAME
721 * @see #EXTRA_SHORTCUT_ICON
722 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
723 * @see android.content.Intent.ShortcutIconResource
724 */
725 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
726 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
727
728 /**
729 * The name of the extra used to define the Intent of a shortcut.
730 *
731 * @see #ACTION_CREATE_SHORTCUT
732 */
733 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
734 /**
735 * The name of the extra used to define the name of a shortcut.
736 *
737 * @see #ACTION_CREATE_SHORTCUT
738 */
739 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
740 /**
741 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
742 *
743 * @see #ACTION_CREATE_SHORTCUT
744 */
745 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
746 /**
747 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
748 *
749 * @see #ACTION_CREATE_SHORTCUT
750 * @see android.content.Intent.ShortcutIconResource
751 */
752 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
753 "android.intent.extra.shortcut.ICON_RESOURCE";
754
755 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800756 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700757 *
758 * @see Intent#ACTION_CREATE_SHORTCUT
759 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800760 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
761 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700762 */
763 public static class ShortcutIconResource implements Parcelable {
764 /**
765 * The package name of the application containing the icon.
766 */
767 public String packageName;
768
769 /**
770 * The resource name of the icon, including package, name and type.
771 */
772 public String resourceName;
773
774 /**
775 * Creates a new ShortcutIconResource for the specified context and resource
776 * identifier.
777 *
778 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700779 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700780 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700781 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700782 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700783 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700784 ShortcutIconResource icon = new ShortcutIconResource();
785 icon.packageName = context.getPackageName();
786 icon.resourceName = context.getResources().getResourceName(resourceId);
787 return icon;
788 }
789
790 /**
791 * Used to read a ShortcutIconResource from a Parcel.
792 */
793 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
794 new Parcelable.Creator<ShortcutIconResource>() {
795
796 public ShortcutIconResource createFromParcel(Parcel source) {
797 ShortcutIconResource icon = new ShortcutIconResource();
798 icon.packageName = source.readString();
799 icon.resourceName = source.readString();
800 return icon;
801 }
802
803 public ShortcutIconResource[] newArray(int size) {
804 return new ShortcutIconResource[size];
805 }
806 };
807
808 /**
809 * No special parcel contents.
810 */
811 public int describeContents() {
812 return 0;
813 }
814
815 public void writeToParcel(Parcel dest, int flags) {
816 dest.writeString(packageName);
817 dest.writeString(resourceName);
818 }
819
820 @Override
821 public String toString() {
822 return resourceName;
823 }
824 }
825
826 /**
827 * Activity Action: Display an activity chooser, allowing the user to pick
828 * what they want to before proceeding. This can be used as an alternative
829 * to the standard activity picker that is displayed by the system when
830 * you try to start an activity with multiple possible matches, with these
831 * differences in behavior:
832 * <ul>
833 * <li>You can specify the title that will appear in the activity chooser.
834 * <li>The user does not have the option to make one of the matching
835 * activities a preferred activity, and all possible activities will
836 * always be shown even if one of them is currently marked as the
837 * preferred activity.
838 * </ul>
839 * <p>
840 * This action should be used when the user will naturally expect to
841 * select an activity in order to proceed. An example if when not to use
842 * it is when the user clicks on a "mailto:" link. They would naturally
843 * expect to go directly to their mail app, so startActivity() should be
844 * called directly: it will
845 * either launch the current preferred app, or put up a dialog allowing the
846 * user to pick an app to use and optionally marking that as preferred.
847 * <p>
848 * In contrast, if the user is selecting a menu item to send a picture
849 * they are viewing to someone else, there are many different things they
850 * may want to do at this point: send it through e-mail, upload it to a
851 * web service, etc. In this case the CHOOSER action should be used, to
852 * always present to the user a list of the things they can do, with a
853 * nice title given by the caller such as "Send this photo with:".
854 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700855 * If you need to grant URI permissions through a chooser, you must specify
856 * the permissions to be granted on the ACTION_CHOOSER Intent
857 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
858 * {@link #setClipData} to specify the URIs to be granted as well as
859 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
860 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
861 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700862 * As a convenience, an Intent of this form can be created with the
863 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700864 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700865 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700866 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
867 * and can optionally have a {@link #EXTRA_TITLE} field containing the
868 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700869 * <p>
870 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700871 */
872 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
873 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
874
875 /**
876 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
877 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700878 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
879 * target intent, also optionally supplying a title. If the target
880 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
881 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
882 * set in the returned chooser intent, with its ClipData set appropriately:
883 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500884 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700885 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700886 * @param target The Intent that the user will be selecting an activity
887 * to perform.
888 * @param title Optional title that will be displayed in the chooser.
889 * @return Return a new Intent object that you can hand to
890 * {@link Context#startActivity(Intent) Context.startActivity()} and
891 * related methods.
892 */
893 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700894 return createChooser(target, title, null);
895 }
896
897 /**
898 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
899 *
900 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
901 * target intent, also optionally supplying a title. If the target
902 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
903 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
904 * set in the returned chooser intent, with its ClipData set appropriately:
905 * either a direct reflection of {@link #getClipData()} if that is non-null,
906 * or a new ClipData built from {@link #getData()}.</p>
907 *
908 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
909 * when the user makes a choice. This can be useful if the calling application wants
910 * to remember the last chosen target and surface it as a more prominent or one-touch
911 * affordance elsewhere in the UI for next time.</p>
912 *
913 * @param target The Intent that the user will be selecting an activity
914 * to perform.
915 * @param title Optional title that will be displayed in the chooser.
916 * @param sender Optional IntentSender to be called when a choice is made.
917 * @return Return a new Intent object that you can hand to
918 * {@link Context#startActivity(Intent) Context.startActivity()} and
919 * related methods.
920 */
921 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700922 Intent intent = new Intent(ACTION_CHOOSER);
923 intent.putExtra(EXTRA_INTENT, target);
924 if (title != null) {
925 intent.putExtra(EXTRA_TITLE, title);
926 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700927
Adam Powell0b3c1122014-10-09 12:50:14 -0700928 if (sender != null) {
929 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
930 }
931
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700932 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700933 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
934 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
935 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700936 if (permFlags != 0) {
937 ClipData targetClipData = target.getClipData();
938 if (targetClipData == null && target.getData() != null) {
939 ClipData.Item item = new ClipData.Item(target.getData());
940 String[] mimeTypes;
941 if (target.getType() != null) {
942 mimeTypes = new String[] { target.getType() };
943 } else {
944 mimeTypes = new String[] { };
945 }
946 targetClipData = new ClipData(null, mimeTypes, item);
947 }
948 if (targetClipData != null) {
949 intent.setClipData(targetClipData);
950 intent.addFlags(permFlags);
951 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700952 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700953
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700954 return intent;
955 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700956
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700957 /**
958 * Activity Action: Allow the user to select a particular kind of data and
959 * return it. This is different than {@link #ACTION_PICK} in that here we
960 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800961 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700962 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900963 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700964 * etc.
965 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900966 * 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 -0700967 * of data, such as a person contact, you set the MIME type to the kind of
968 * data you want and launch it with {@link Context#startActivity(Intent)}.
969 * The system will then launch the best application to select that kind
970 * of data for you.
971 * <p>
972 * You may also be interested in any of a set of types of content the user
973 * can pick. For example, an e-mail application that wants to allow the
974 * user to add an attachment to an e-mail message can use this action to
975 * bring up a list of all of the types of content the user can attach.
976 * <p>
977 * In this case, you should wrap the GET_CONTENT intent with a chooser
978 * (through {@link #createChooser}), which will give the proper interface
979 * for the user to pick how to send your data and allow you to specify
980 * a prompt indicating what they are doing. You will usually specify a
981 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
982 * broad range of content types the user can select from.
983 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900984 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700985 * only pick from data that can be represented as a stream. This is
986 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
987 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800988 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900989 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800990 * is locally available on the device. For example, if this extra is set
991 * to true then an image picker should not show any pictures that are available
992 * from a remote server but not already on the local device (thus requiring
993 * they be downloaded when opened).
994 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800995 * If the caller can handle multiple returned items (the user performing
996 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
997 * to indicate this.
998 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700999 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1000 * that no URI is supplied in the intent, as there are no constraints on
1001 * where the returned data originally comes from. You may also include the
1002 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001003 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001004 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1005 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001006 * <p>
1007 * Output: The URI of the item that was picked. This must be a content:
1008 * URI so that any receiver can access it.
1009 */
1010 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1011 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1012 /**
1013 * Activity Action: Dial a number as specified by the data. This shows a
1014 * UI with the number being dialed, allowing the user to explicitly
1015 * initiate the call.
1016 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1017 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1018 * number.
1019 * <p>Output: nothing.
1020 */
1021 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1022 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1023 /**
1024 * Activity Action: Perform a call to someone specified by the data.
1025 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1026 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1027 * number.
1028 * <p>Output: nothing.
1029 *
1030 * <p>Note: there will be restrictions on which applications can initiate a
1031 * call; most applications should use the {@link #ACTION_DIAL}.
1032 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1033 * numbers. Applications can <strong>dial</strong> emergency numbers using
1034 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001035 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001036 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001037 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001038 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001039 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001040 */
1041 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1042 public static final String ACTION_CALL = "android.intent.action.CALL";
1043 /**
1044 * Activity Action: Perform a call to an emergency number specified by the
1045 * data.
1046 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1047 * tel: URI of an explicit phone number.
1048 * <p>Output: nothing.
1049 * @hide
1050 */
1051 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1052 /**
1053 * Activity action: Perform a call to any number (emergency or not)
1054 * specified by the data.
1055 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1056 * tel: URI of an explicit phone number.
1057 * <p>Output: nothing.
1058 * @hide
1059 */
1060 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1061 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001062 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1063 * sending this intent is a no-op.
1064 * <p>Input: No data should be specified. get*Extra may have an optional
1065 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1066 * send the activation result.
1067 * <p>Output: nothing.
1068 * @hide
1069 */
1070 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1071 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1072 "android.intent.action.SIM_ACTIVATION_REQUEST";
1073 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001074 * Activity Action: Send a message to someone specified by the data.
1075 * <p>Input: {@link #getData} is URI describing the target.
1076 * <p>Output: nothing.
1077 */
1078 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1079 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1080 /**
1081 * Activity Action: Deliver some data to someone else. Who the data is
1082 * being delivered to is not specified; it is up to the receiver of this
1083 * action to ask the user where the data should be sent.
1084 * <p>
1085 * When launching a SEND intent, you should usually wrap it in a chooser
1086 * (through {@link #createChooser}), which will give the proper interface
1087 * for the user to pick how to send your data and allow you to specify
1088 * a prompt indicating what they are doing.
1089 * <p>
1090 * Input: {@link #getType} is the MIME type of the data being sent.
1091 * get*Extra can have either a {@link #EXTRA_TEXT}
1092 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1093 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1094 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1095 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001096 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1097 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1098 * your text with HTML formatting.
1099 * <p>
1100 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1101 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1102 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1103 * content: URIs and other advanced features of {@link ClipData}. If
1104 * using this approach, you still must supply the same data through the
1105 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1106 * for compatibility with old applications. If you don't set a ClipData,
1107 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001108 * <p>
1109 * Optional standard extras, which may be interpreted by some recipients as
1110 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1111 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1112 * <p>
1113 * Output: nothing.
1114 */
1115 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1116 public static final String ACTION_SEND = "android.intent.action.SEND";
1117 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001118 * Activity Action: Deliver multiple data to someone else.
1119 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001120 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001121 * <p>
1122 * Input: {@link #getType} is the MIME type of the data being sent.
1123 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001124 * #EXTRA_STREAM} field, containing the data to be sent. If using
1125 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1126 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001127 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001128 * Multiple types are supported, and receivers should handle mixed types
1129 * whenever possible. The right way for the receiver to check them is to
1130 * use the content resolver on each URI. The intent sender should try to
1131 * put the most concrete mime type in the intent type, but it can fall
1132 * back to {@literal <type>/*} or {@literal *}/* as needed.
1133 * <p>
1134 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1135 * be image/jpg, but if you are sending image/jpg and image/png, then the
1136 * intent's type should be image/*.
1137 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001138 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1139 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1140 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1141 * content: URIs and other advanced features of {@link ClipData}. If
1142 * using this approach, you still must supply the same data through the
1143 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1144 * for compatibility with old applications. If you don't set a ClipData,
1145 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1146 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001147 * Optional standard extras, which may be interpreted by some recipients as
1148 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1149 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1150 * <p>
1151 * Output: nothing.
1152 */
1153 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1154 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1155 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001156 * Activity Action: Handle an incoming phone call.
1157 * <p>Input: nothing.
1158 * <p>Output: nothing.
1159 */
1160 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1161 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1162 /**
1163 * Activity Action: Insert an empty item into the given container.
1164 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1165 * in which to place the data.
1166 * <p>Output: URI of the new data that was created.
1167 */
1168 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1169 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1170 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001171 * Activity Action: Create a new item in the given container, initializing it
1172 * from the current contents of the clipboard.
1173 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1174 * in which to place the data.
1175 * <p>Output: URI of the new data that was created.
1176 */
1177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1178 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1179 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001180 * Activity Action: Delete the given data from its container.
1181 * <p>Input: {@link #getData} is URI of data to be deleted.
1182 * <p>Output: nothing.
1183 */
1184 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1185 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1186 /**
1187 * Activity Action: Run the data, whatever that means.
1188 * <p>Input: ? (Note: this is currently specific to the test harness.)
1189 * <p>Output: nothing.
1190 */
1191 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1192 public static final String ACTION_RUN = "android.intent.action.RUN";
1193 /**
1194 * Activity Action: Perform a data synchronization.
1195 * <p>Input: ?
1196 * <p>Output: ?
1197 */
1198 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1199 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1200 /**
1201 * Activity Action: Pick an activity given an intent, returning the class
1202 * selected.
1203 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1204 * used with {@link PackageManager#queryIntentActivities} to determine the
1205 * set of activities from which to pick.
1206 * <p>Output: Class name of the activity that was selected.
1207 */
1208 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1209 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1210 /**
1211 * Activity Action: Perform a search.
1212 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1213 * is the text to search for. If empty, simply
1214 * enter your search results Activity with the search UI activated.
1215 * <p>Output: nothing.
1216 */
1217 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1218 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1219 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001220 * Activity Action: Start the platform-defined tutorial
1221 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1222 * is the text to search for. If empty, simply
1223 * enter your search results Activity with the search UI activated.
1224 * <p>Output: nothing.
1225 */
1226 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1227 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1228 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001229 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001230 * <p>
1231 * Input: {@link android.app.SearchManager#QUERY
1232 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1233 * a url starts with http or https, the site will be opened. If it is plain
1234 * text, Google search will be applied.
1235 * <p>
1236 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001237 */
1238 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1239 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001240
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001241 /**
Jim Miller07994402012-05-02 14:22:27 -07001242 * Activity Action: Perform assist action.
1243 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001244 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1245 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001246 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1247 * information.
Jim Miller07994402012-05-02 14:22:27 -07001248 * Output: nothing.
1249 */
1250 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1251 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001252
1253 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001254 * Activity Action: Perform voice assist action.
1255 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001256 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1257 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001258 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001259 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001260 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001261 */
1262 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1263 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1264
1265 /**
Adam Skory7140a252013-09-11 12:04:58 +01001266 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1267 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001268 */
1269 public static final String EXTRA_ASSIST_PACKAGE
1270 = "android.intent.extra.ASSIST_PACKAGE";
1271
1272 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001273 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1274 * application package at the time the assist was invoked.
1275 */
1276 public static final String EXTRA_ASSIST_UID
1277 = "android.intent.extra.ASSIST_UID";
1278
1279 /**
Adam Skory7140a252013-09-11 12:04:58 +01001280 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1281 * information supplied by the current foreground app at the time of the assist request.
1282 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001283 */
1284 public static final String EXTRA_ASSIST_CONTEXT
1285 = "android.intent.extra.ASSIST_CONTEXT";
1286
Jim Miller07994402012-05-02 14:22:27 -07001287 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001288 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1289 * keyboard as the primary input device for assistance.
1290 */
1291 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1292 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1293
1294 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001295 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1296 * that was used to invoke the assist.
1297 */
1298 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1299 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1300
1301 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001302 * Activity Action: List all available applications
1303 * <p>Input: Nothing.
1304 * <p>Output: nothing.
1305 */
1306 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1307 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1308 /**
1309 * Activity Action: Show settings for choosing wallpaper
1310 * <p>Input: Nothing.
1311 * <p>Output: Nothing.
1312 */
1313 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1314 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1315
1316 /**
1317 * Activity Action: Show activity for reporting a bug.
1318 * <p>Input: Nothing.
1319 * <p>Output: Nothing.
1320 */
1321 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1322 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1323
1324 /**
1325 * Activity Action: Main entry point for factory tests. Only used when
1326 * the device is booting in factory test node. The implementing package
1327 * must be installed in the system image.
1328 * <p>Input: nothing
1329 * <p>Output: nothing
1330 */
1331 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1332
1333 /**
1334 * Activity Action: The user pressed the "call" button to go to the dialer
1335 * or other appropriate UI for placing a call.
1336 * <p>Input: Nothing.
1337 * <p>Output: Nothing.
1338 */
1339 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1340 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1341
1342 /**
1343 * Activity Action: Start Voice Command.
1344 * <p>Input: Nothing.
1345 * <p>Output: Nothing.
1346 */
1347 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1348 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001349
1350 /**
1351 * Activity Action: Start action associated with long pressing on the
1352 * search key.
1353 * <p>Input: Nothing.
1354 * <p>Output: Nothing.
1355 */
1356 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1357 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001358
Jacek Surazski86b6c532009-05-13 14:38:28 +02001359 /**
1360 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1361 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001362 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001363 * <p>Input: No data is specified. The bug report is passed in using
1364 * an {@link #EXTRA_BUG_REPORT} field.
1365 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001366 *
1367 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001368 */
1369 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1370 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001371
1372 /**
1373 * Activity Action: Show power usage information to the user.
1374 * <p>Input: Nothing.
1375 * <p>Output: Nothing.
1376 */
1377 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1378 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001379
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001380 /**
1381 * Activity Action: Setup wizard to launch after a platform update. This
1382 * activity should have a string meta-data field associated with it,
1383 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1384 * the platform for setup. The activity will be launched only if
1385 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1386 * same value.
1387 * <p>Input: Nothing.
1388 * <p>Output: Nothing.
1389 * @hide
1390 */
1391 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1392 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001393
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001394 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001395 * Activity Action: Show settings for managing network data usage of a
1396 * specific application. Applications should define an activity that offers
1397 * options to control data usage.
1398 */
1399 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1400 public static final String ACTION_MANAGE_NETWORK_USAGE =
1401 "android.intent.action.MANAGE_NETWORK_USAGE";
1402
1403 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001404 * Activity Action: Launch application installer.
1405 * <p>
1406 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001407 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1408 * you can also use "package:<package-name>" to install an application for the
1409 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001410 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1411 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1412 * <p>
1413 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1414 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001415 * <p>
1416 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1417 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1418 * in order to launch the application installer.
1419 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001420 *
1421 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1422 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1423 * @see #EXTRA_RETURN_RESULT
1424 */
1425 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1426 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1427
1428 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001429 * Activity Action: Launch ephemeral installer.
1430 * <p>
1431 * Input: The data must be a http: URI that the ephemeral application is registered
1432 * to handle.
1433 * <p class="note">
1434 * This is a protected intent that can only be sent by the system.
1435 * </p>
1436 *
1437 * @hide
1438 */
1439 @SystemApi
1440 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1441 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1442 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1443
1444 /**
1445 * Service Action: Resolve ephemeral application.
1446 * <p>
1447 * The system will have a persistent connection to this service.
1448 * This is a protected intent that can only be sent by the system.
1449 * </p>
1450 *
1451 * @hide
1452 */
1453 @SystemApi
1454 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1455 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1456 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1457
1458 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001459 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1460 * package. Specifies the installer package name; this package will receive the
1461 * {@link #ACTION_APP_ERROR} intent.
1462 */
1463 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1464 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1465
1466 /**
1467 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1468 * package. Specifies that the application being installed should not be
1469 * treated as coming from an unknown source, but as coming from the app
1470 * invoking the Intent. For this to work you must start the installer with
1471 * startActivityForResult().
1472 */
1473 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1474 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1475
1476 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001477 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1478 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001479 * data field originated from.
1480 */
rich cannings706e8ba2012-08-20 13:20:14 -07001481 public static final String EXTRA_ORIGINATING_URI
1482 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001483
1484 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001485 * This extra can be used with any Intent used to launch an activity, supplying information
1486 * about who is launching that activity. This field contains a {@link android.net.Uri}
1487 * object, typically an http: or https: URI of the web site that the referral came from;
1488 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1489 * a native application that it came from.
1490 *
1491 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1492 * instead of directly retrieving the extra. It is also valid for applications to
1493 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1494 * a string, not a Uri; the field here, if supplied, will always take precedence,
1495 * however.</p>
1496 *
1497 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001498 */
1499 public static final String EXTRA_REFERRER
1500 = "android.intent.extra.REFERRER";
1501
1502 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001503 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1504 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1505 * not be created, in particular when Intent extras are supplied through the
1506 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1507 * schemes.
1508 *
1509 * @see #EXTRA_REFERRER
1510 */
1511 public static final String EXTRA_REFERRER_NAME
1512 = "android.intent.extra.REFERRER_NAME";
1513
1514 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001515 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1516 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1517 * @hide
1518 */
1519 public static final String EXTRA_ORIGINATING_UID
1520 = "android.intent.extra.ORIGINATING_UID";
1521
1522 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001523 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1524 * package. Tells the installer UI to skip the confirmation with the user
1525 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001526 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1527 * will no longer show an interstitial message about updating existing
1528 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001529 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001530 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001531 public static final String EXTRA_ALLOW_REPLACE
1532 = "android.intent.extra.ALLOW_REPLACE";
1533
1534 /**
1535 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1536 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1537 * return to the application the result code of the install/uninstall. The returned result
1538 * code will be {@link android.app.Activity#RESULT_OK} on success or
1539 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1540 */
1541 public static final String EXTRA_RETURN_RESULT
1542 = "android.intent.extra.RETURN_RESULT";
1543
1544 /**
1545 * Package manager install result code. @hide because result codes are not
1546 * yet ready to be exposed.
1547 */
1548 public static final String EXTRA_INSTALL_RESULT
1549 = "android.intent.extra.INSTALL_RESULT";
1550
1551 /**
1552 * Activity Action: Launch application uninstaller.
1553 * <p>
1554 * Input: The data must be a package: URI whose scheme specific part is
1555 * the package name of the current installed package to be uninstalled.
1556 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1557 * <p>
1558 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1559 * succeeded.
1560 */
1561 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1562 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1563
1564 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001565 * Specify whether the package should be uninstalled for all users.
1566 * @hide because these should not be part of normal application flow.
1567 */
1568 public static final String EXTRA_UNINSTALL_ALL_USERS
1569 = "android.intent.extra.UNINSTALL_ALL_USERS";
1570
1571 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001572 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1573 * describing the last run version of the platform that was setup.
1574 * @hide
1575 */
1576 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1577
Svet Ganov3695b8a2015-03-24 16:30:25 -07001578 /**
1579 * Activity action: Launch UI to manage the permissions of an app.
1580 * <p>
1581 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1582 * will be managed by the launched UI.
1583 * </p>
1584 * <p>
1585 * Output: Nothing.
1586 * </p>
1587 *
1588 * @see #EXTRA_PACKAGE_NAME
1589 *
1590 * @hide
1591 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001592 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1593 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1594 "android.intent.action.MANAGE_APP_PERMISSIONS";
1595
1596 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001597 * Activity action: Launch UI to manage permissions.
1598 * <p>
1599 * Input: Nothing.
1600 * </p>
1601 * <p>
1602 * Output: Nothing.
1603 * </p>
1604 *
1605 * @hide
1606 */
Svet Ganov321f0152015-05-16 22:51:50 -07001607 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1608 public static final String ACTION_MANAGE_PERMISSIONS =
1609 "android.intent.action.MANAGE_PERMISSIONS";
1610
1611 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001612 * Activity action: Launch UI to review permissions for an app.
1613 * The system uses this intent if permission review for apps not
1614 * supporting the new runtime permissions model is enabled. In
1615 * this mode a permission review is required before any of the
1616 * app components can run.
1617 * <p>
1618 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1619 * permissions will be reviewed (mandatory).
1620 * </p>
1621 * <p>
1622 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1623 * be fired after the permission review (optional).
1624 * </p>
1625 * <p>
1626 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1627 * be invoked after the permission review (optional).
1628 * </p>
1629 * <p>
1630 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1631 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1632 * </p>
1633 * <p>
1634 * Output: Nothing.
1635 * </p>
1636 *
1637 * @see #EXTRA_PACKAGE_NAME
1638 * @see #EXTRA_INTENT
1639 * @see #EXTRA_REMOTE_CALLBACK
1640 * @see #EXTRA_RESULT_NEEDED
1641 *
1642 * @hide
1643 */
1644 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1645 public static final String ACTION_REVIEW_PERMISSIONS =
1646 "android.intent.action.REVIEW_PERMISSIONS";
1647
1648 /**
1649 * Intent extra: A callback for reporting remote result as a bundle.
1650 * <p>
1651 * Type: IRemoteCallback
1652 * </p>
1653 *
1654 * @hide
1655 */
1656 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1657
1658 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001659 * Intent extra: An app package name.
1660 * <p>
1661 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001662 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001663 *
1664 * @hide
1665 */
1666 @SystemApi
1667 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1668
1669 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001670 * Intent extra: An extra for specifying whether a result is needed.
1671 * <p>
1672 * Type: boolean
1673 * </p>
1674 *
1675 * @hide
1676 */
1677 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1678
1679 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001680 * Broadcast action that requests current permission granted information. It will respond
1681 * to the request by sending a broadcast with action defined by
1682 * {@link #EXTRA_GET_PERMISSIONS_RESPONSE_INTENT}. The response will contain
Makoto Onukibbb912a2015-06-05 16:27:23 -07001683 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}, as well as
1684 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}, with contents described below or
1685 * a null upon failure.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001686 *
Makoto Onukibbb912a2015-06-05 16:27:23 -07001687 * <p>If {@link #EXTRA_PACKAGE_NAME} is included then the number of permissions granted, the
1688 * number of permissions requested and the number of granted additional permissions
1689 * by that package will be calculated and included as the first
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001690 * and second elements respectively of an int[] in the response as
Makoto Onukibbb912a2015-06-05 16:27:23 -07001691 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}. The response will also deliver the list
1692 * of localized permission group names that are granted in
1693 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001694 *
1695 * <p>If {@link #EXTRA_PACKAGE_NAME} is not included then the number of apps granted any runtime
1696 * permissions and the total number of apps requesting runtime permissions will be the first
1697 * and second elements respectively of an int[] in the response as
1698 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1699 *
1700 * @hide
1701 */
1702 public static final String ACTION_GET_PERMISSIONS_COUNT
1703 = "android.intent.action.GET_PERMISSIONS_COUNT";
1704
1705 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001706 * Broadcast action that requests list of all apps that have runtime permissions. It will
1707 * respond to the request by sending a broadcast with action defined by
1708 * {@link #EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT}. The response will contain
1709 * {@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT}, as well as
1710 * {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}, with contents described below or
1711 * a null upon failure.
1712 *
1713 * <p>{@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT} will contain a list of package names of
1714 * apps that have runtime permissions. {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}
1715 * will contain the list of app labels corresponding ot the apps in the first list.
1716 *
1717 * @hide
1718 */
1719 public static final String ACTION_GET_PERMISSIONS_PACKAGES
1720 = "android.intent.action.GET_PERMISSIONS_PACKAGES";
1721
1722 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001723 * Extra included in response to {@link #ACTION_GET_PERMISSIONS_COUNT}.
1724 * @hide
1725 */
1726 public static final String EXTRA_GET_PERMISSIONS_COUNT_RESULT
1727 = "android.intent.extra.GET_PERMISSIONS_COUNT_RESULT";
1728
1729 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001730 * List of CharSequence of localized permission group labels.
1731 * @hide
1732 */
1733 public static final String EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT
1734 = "android.intent.extra.GET_PERMISSIONS_GROUP_LIST_RESULT";
1735
1736 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001737 * String list of apps that have one or more runtime permissions.
1738 * @hide
1739 */
1740 public static final String EXTRA_GET_PERMISSIONS_APP_LIST_RESULT
1741 = "android.intent.extra.GET_PERMISSIONS_APP_LIST_RESULT";
1742
1743 /**
1744 * String list of app labels for apps that have one or more runtime permissions.
1745 * @hide
1746 */
1747 public static final String EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT
1748 = "android.intent.extra.GET_PERMISSIONS_APP_LABEL_LIST_RESULT";
1749
1750 /**
Anthony Hugh3575a402015-10-26 17:47:05 -07001751 * Boolean list describing if the app is a system app for apps that have one or more runtime
1752 * permissions.
1753 * @hide
1754 */
1755 public static final String EXTRA_GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT
1756 = "android.intent.extra.GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT";
1757
1758 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001759 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_COUNT} broadcasts.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001760 * @hide
1761 */
1762 public static final String EXTRA_GET_PERMISSIONS_RESPONSE_INTENT
1763 = "android.intent.extra.GET_PERMISSIONS_RESONSE_INTENT";
1764
1765 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001766 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_PACKAGES} broadcasts.
1767 * @hide
1768 */
1769 public static final String EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT
1770 = "android.intent.extra.GET_PERMISSIONS_PACKAGES_RESONSE_INTENT";
1771
1772 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001773 * Activity action: Launch UI to manage which apps have a given permission.
1774 * <p>
1775 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1776 * to which will be managed by the launched UI.
1777 * </p>
1778 * <p>
1779 * Output: Nothing.
1780 * </p>
1781 *
1782 * @see #EXTRA_PERMISSION_NAME
1783 *
1784 * @hide
1785 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001786 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1787 public static final String ACTION_MANAGE_PERMISSION_APPS =
1788 "android.intent.action.MANAGE_PERMISSION_APPS";
1789
1790 /**
1791 * Intent extra: The name of a permission.
1792 * <p>
1793 * Type: String
1794 * </p>
1795 *
1796 * @hide
1797 */
1798 @SystemApi
1799 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1800
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001801 // ---------------------------------------------------------------------
1802 // ---------------------------------------------------------------------
1803 // Standard intent broadcast actions (see action variable).
1804
1805 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001806 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1807 * <p>
1808 * For historical reasons, the name of this broadcast action refers to the power
1809 * state of the screen but it is actually sent in response to changes in the
1810 * overall interactive state of the device.
1811 * </p><p>
1812 * This broadcast is sent when the device becomes non-interactive which may have
1813 * nothing to do with the screen turning off. To determine the
1814 * actual state of the screen, use {@link android.view.Display#getState}.
1815 * </p><p>
1816 * See {@link android.os.PowerManager#isInteractive} for details.
1817 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001818 * You <em>cannot</em> receive this through components declared in
1819 * manifests, only by explicitly registering for it with
1820 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1821 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001822 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001823 * <p class="note">This is a protected intent that can only be sent
1824 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001825 */
1826 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1827 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001828
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001829 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001830 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1831 * <p>
1832 * For historical reasons, the name of this broadcast action refers to the power
1833 * state of the screen but it is actually sent in response to changes in the
1834 * overall interactive state of the device.
1835 * </p><p>
1836 * This broadcast is sent when the device becomes interactive which may have
1837 * nothing to do with the screen turning on. To determine the
1838 * actual state of the screen, use {@link android.view.Display#getState}.
1839 * </p><p>
1840 * See {@link android.os.PowerManager#isInteractive} for details.
1841 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001842 * You <em>cannot</em> receive this through components declared in
1843 * manifests, only by explicitly registering for it with
1844 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1845 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001846 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001847 * <p class="note">This is a protected intent that can only be sent
1848 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001849 */
1850 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1851 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001852
1853 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001854 * Broadcast Action: Sent after the system stops dreaming.
1855 *
1856 * <p class="note">This is a protected intent that can only be sent by the system.
1857 * It is only sent to registered receivers.</p>
1858 */
1859 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1860 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1861
1862 /**
1863 * Broadcast Action: Sent after the system starts dreaming.
1864 *
1865 * <p class="note">This is a protected intent that can only be sent by the system.
1866 * It is only sent to registered receivers.</p>
1867 */
1868 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1869 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1870
1871 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001872 * 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 -07001873 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001874 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001875 * <p class="note">This is a protected intent that can only be sent
1876 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001877 */
1878 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001879 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001880
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001881 /**
1882 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001883 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001884 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001885 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1886 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001887 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001888 * <p class="note">This is a protected intent that can only be sent
1889 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001890 */
1891 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1892 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1893 /**
1894 * Broadcast Action: The time was set.
1895 */
1896 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1897 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1898 /**
1899 * Broadcast Action: The date has changed.
1900 */
1901 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1902 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1903 /**
1904 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1905 * <ul>
1906 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1907 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001908 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001909 * <p class="note">This is a protected intent that can only be sent
1910 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001911 */
1912 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1913 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1914 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001915 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1916 * DNS entries should be tossed.
1917 * @hide
1918 */
1919 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1920 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1921 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001922 * Alarm Changed Action: This is broadcast when the AlarmClock
1923 * application's alarm is set or unset. It is used by the
1924 * AlarmClock application and the StatusBar service.
1925 * @hide
1926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1929 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001930 * Broadcast Action: This is broadcast once, after the system has finished
1931 * booting. It can be used to perform application-specific initialization,
1932 * such as installing alarms. You must hold the
1933 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1934 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001935 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001936 * <p class="note">This is a protected intent that can only be sent
1937 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001938 */
1939 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1940 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1941 /**
1942 * Broadcast Action: This is broadcast when a user action should request a
1943 * temporary system dialog to dismiss. Some examples of temporary system
1944 * dialogs are the notification window-shade and the recent tasks dialog.
1945 */
1946 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1947 /**
1948 * Broadcast Action: Trigger the download and eventual installation
1949 * of a package.
1950 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001951 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001952 * <p class="note">This is a protected intent that can only be sent
1953 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001954 *
1955 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001956 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001957 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001958 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1959 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1960 /**
1961 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001962 * device. The data contains the name of the package. Note that the
1963 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001964 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001965 * <ul>
1966 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1967 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1968 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1969 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001970 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001971 * <p class="note">This is a protected intent that can only be sent
1972 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001973 */
1974 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1975 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1976 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001977 * Broadcast Action: A new version of an application package has been
1978 * installed, replacing an existing version that was previously installed.
1979 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001980 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001981 * <ul>
1982 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1983 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001984 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001985 * <p class="note">This is a protected intent that can only be sent
1986 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001987 */
1988 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1989 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1990 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001991 * Broadcast Action: A new version of your application has been installed
1992 * over an existing one. This is only sent to the application that was
1993 * replaced. It does not contain any additional data; to receive it, just
1994 * use an intent filter for this action.
1995 *
1996 * <p class="note">This is a protected intent that can only be sent
1997 * by the system.
1998 */
1999 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2000 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2001 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002002 * Broadcast Action: An existing application package has been removed from
2003 * the device. The data contains the name of the package. The package
2004 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002005 * <ul>
2006 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2007 * to the package.
2008 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2009 * application -- data and code -- is being removed.
2010 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2011 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2012 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002013 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002014 * <p class="note">This is a protected intent that can only be sent
2015 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002016 */
2017 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2018 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2019 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002020 * Broadcast Action: An existing application package has been completely
2021 * removed from the device. The data contains the name of the package.
2022 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2023 * {@link #EXTRA_DATA_REMOVED} is true and
2024 * {@link #EXTRA_REPLACING} is false of that broadcast.
2025 *
2026 * <ul>
2027 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2028 * to the package.
2029 * </ul>
2030 *
2031 * <p class="note">This is a protected intent that can only be sent
2032 * by the system.
2033 */
2034 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2035 public static final String ACTION_PACKAGE_FULLY_REMOVED
2036 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2037 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002038 * Broadcast Action: An existing application package has been changed (e.g.
2039 * a component has been enabled or disabled). The data contains the name of
2040 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002041 * <ul>
2042 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002043 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002044 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002045 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2046 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002047 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002048 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002049 * <p class="note">This is a protected intent that can only be sent
2050 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002051 */
2052 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2053 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2054 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002055 * @hide
2056 * Broadcast Action: Ask system services if there is any reason to
2057 * restart the given package. The data contains the name of the
2058 * package.
2059 * <ul>
2060 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2061 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2062 * </ul>
2063 *
2064 * <p class="note">This is a protected intent that can only be sent
2065 * by the system.
2066 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002067 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002068 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2069 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2070 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002071 * Broadcast Action: The user has restarted a package, and all of its
2072 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002073 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002074 * be removed. Note that the restarted package does <em>not</em>
2075 * receive this broadcast.
2076 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002077 * <ul>
2078 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2079 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002080 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002081 * <p class="note">This is a protected intent that can only be sent
2082 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002083 */
2084 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2085 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2086 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002087 * Broadcast Action: The user has cleared the data of a package. This should
2088 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002089 * its persistent data is erased and this broadcast sent.
2090 * Note that the cleared package does <em>not</em>
2091 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002092 * <ul>
2093 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2094 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002095 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002096 * <p class="note">This is a protected intent that can only be sent
2097 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002098 */
2099 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2100 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2101 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002102 * Broadcast Action: A user ID has been removed from the system. The user
2103 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002104 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002105 * <p class="note">This is a protected intent that can only be sent
2106 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002107 */
2108 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2109 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002110
2111 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002112 * Broadcast Action: Sent to the installer package of an application
2113 * when that application is first launched (that is the first time it
2114 * is moved out of the stopped state). The data contains the name of the package.
2115 *
2116 * <p class="note">This is a protected intent that can only be sent
2117 * by the system.
2118 */
2119 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2120 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2121
2122 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002123 * Broadcast Action: Sent to the system package verifier when a package
2124 * needs to be verified. The data contains the package URI.
2125 * <p class="note">
2126 * This is a protected intent that can only be sent by the system.
2127 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002128 */
2129 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2130 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2131
2132 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002133 * Broadcast Action: Sent to the system package verifier when a package is
2134 * verified. The data contains the package URI.
2135 * <p class="note">
2136 * This is a protected intent that can only be sent by the system.
2137 */
2138 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2139 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2140
2141 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002142 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
2143 * needs to be verified. The data contains the filter data hosts to be verified against.
2144 * <p class="note">
2145 * This is a protected intent that can only be sent by the system.
2146 * </p>
2147 *
2148 * @hide
2149 */
2150 @SystemApi
2151 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2152 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2153
2154 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002155 * Broadcast Action: Resources for a set of packages (which were
2156 * previously unavailable) are currently
2157 * available since the media on which they exist is available.
2158 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2159 * list of packages whose availability changed.
2160 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2161 * list of uids of packages whose availability changed.
2162 * Note that the
2163 * packages in this list do <em>not</em> receive this broadcast.
2164 * The specified set of packages are now available on the system.
2165 * <p>Includes the following extras:
2166 * <ul>
2167 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2168 * whose resources(were previously unavailable) are currently available.
2169 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2170 * packages whose resources(were previously unavailable)
2171 * are currently available.
2172 * </ul>
2173 *
2174 * <p class="note">This is a protected intent that can only be sent
2175 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002176 */
2177 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002178 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2179 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002180
2181 /**
2182 * Broadcast Action: Resources for a set of packages are currently
2183 * unavailable since the media on which they exist is unavailable.
2184 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2185 * list of packages whose availability changed.
2186 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2187 * list of uids of packages whose availability changed.
2188 * The specified set of packages can no longer be
2189 * launched and are practically unavailable on the system.
2190 * <p>Inclues the following extras:
2191 * <ul>
2192 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2193 * whose resources are no longer available.
2194 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2195 * whose resources are no longer available.
2196 * </ul>
2197 *
2198 * <p class="note">This is a protected intent that can only be sent
2199 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002200 */
2201 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002202 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002203 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002204
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002205 /**
2206 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002207 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002208 * This should <em>only</em> be used to determine when the wallpaper
2209 * has changed to show the new wallpaper to the user. You should certainly
2210 * never, in response to this, change the wallpaper or other attributes of
2211 * it such as the suggested size. That would be crazy, right? You'd cause
2212 * all kinds of loops, especially if other apps are doing similar things,
2213 * right? Of course. So please don't do this.
2214 *
2215 * @deprecated Modern applications should use
2216 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2217 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2218 * shown behind their UI, rather than watching for this broadcast and
2219 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002220 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002221 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002222 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2223 /**
2224 * Broadcast Action: The current device {@link android.content.res.Configuration}
2225 * (orientation, locale, etc) has changed. When such a change happens, the
2226 * UIs (view hierarchy) will need to be rebuilt based on this new
2227 * information; for the most part, applications don't need to worry about
2228 * this, because the system will take care of stopping and restarting the
2229 * application to make sure it sees the new changes. Some system code that
2230 * can not be restarted will need to watch for this action and handle it
2231 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002232 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002233 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002234 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002235 * in manifests, only by explicitly registering for it with
2236 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2237 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002238 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002239 * <p class="note">This is a protected intent that can only be sent
2240 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002241 *
2242 * @see android.content.res.Configuration
2243 */
2244 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2245 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2246 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002247 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002248 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002249 * <p class="note">This is a protected intent that can only be sent
2250 * by the system.
2251 */
2252 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2253 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2254 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002255 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2256 * charging state, level, and other information about the battery.
2257 * See {@link android.os.BatteryManager} for documentation on the
2258 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002259 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002260 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002261 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002262 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002263 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002264 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2265 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2266 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2267 * broadcasts that are sent and can be received through manifest
2268 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002269 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002270 * <p class="note">This is a protected intent that can only be sent
2271 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002272 */
2273 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2274 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2275 /**
2276 * Broadcast Action: Indicates low battery condition on the device.
2277 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002278 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002279 * <p class="note">This is a protected intent that can only be sent
2280 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002281 */
2282 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2283 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2284 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002285 * Broadcast Action: Indicates the battery is now okay after being low.
2286 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2287 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002288 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002289 * <p class="note">This is a protected intent that can only be sent
2290 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002291 */
2292 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2293 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2294 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002295 * Broadcast Action: External power has been connected to the device.
2296 * This is intended for applications that wish to register specifically to this notification.
2297 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2298 * stay active to receive this notification. This action can be used to implement actions
2299 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002300 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002301 * <p class="note">This is a protected intent that can only be sent
2302 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002303 */
2304 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002305 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002306 /**
2307 * Broadcast Action: External power has been removed from the device.
2308 * This is intended for applications that wish to register specifically to this notification.
2309 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2310 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002311 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002312 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002313 * <p class="note">This is a protected intent that can only be sent
2314 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002315 */
2316 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002317 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002318 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002319 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002320 * Broadcast Action: Device is shutting down.
2321 * This is broadcast when the device is being shut down (completely turned
2322 * off, not sleeping). Once the broadcast is complete, the final shutdown
2323 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002324 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002325 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002326 * <p class="note">This is a protected intent that can only be sent
2327 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002328 * <p>May include the following extras:
2329 * <ul>
2330 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2331 * shutdown is only for userspace processes. If not set, assumed to be false.
2332 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002333 */
2334 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002335 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002336 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002337 * Activity Action: Start this activity to request system shutdown.
2338 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002339 * to request confirmation from the user before shutting down. The optional boolean
2340 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2341 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002342 *
2343 * <p class="note">This is a protected intent that can only be sent
2344 * by the system.
2345 *
2346 * {@hide}
2347 */
2348 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2349 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002350 * Broadcast Action: A sticky broadcast that indicates low memory
2351 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002352 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002353 * <p class="note">This is a protected intent that can only be sent
2354 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002355 */
2356 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2357 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2358 /**
2359 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002360 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002361 * <p class="note">This is a protected intent that can only be sent
2362 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002363 */
2364 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2365 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2366 /**
Jake Hambybb371632010-08-23 18:16:48 -07002367 * Broadcast Action: A sticky broadcast that indicates a memory full
2368 * condition on the device. This is intended for activities that want
2369 * to be able to fill the data partition completely, leaving only
2370 * enough free space to prevent system-wide SQLite failures.
2371 *
2372 * <p class="note">This is a protected intent that can only be sent
2373 * by the system.
2374 *
2375 * {@hide}
2376 */
2377 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2378 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2379 /**
2380 * Broadcast Action: Indicates memory full condition on the device
2381 * no longer exists.
2382 *
2383 * <p class="note">This is a protected intent that can only be sent
2384 * by the system.
2385 *
2386 * {@hide}
2387 */
2388 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2389 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2390 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002391 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2392 * and package management should be started.
2393 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2394 * notification.
2395 */
2396 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2397 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2398 /**
2399 * Broadcast Action: The device has entered USB Mass Storage mode.
2400 * This is used mainly for the USB Settings panel.
2401 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2402 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002403 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002404 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002405 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002406 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2407
2408 /**
2409 * Broadcast Action: The device has exited USB Mass Storage mode.
2410 * This is used mainly for the USB Settings panel.
2411 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2412 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002413 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002414 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002415 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002416 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2417
2418 /**
2419 * Broadcast Action: External media has been removed.
2420 * The path to the mount point for the removed media is contained in the Intent.mData field.
2421 */
2422 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2423 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2424
2425 /**
2426 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002427 * 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 -07002428 */
2429 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2430 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2431
2432 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002433 * Broadcast Action: External media is present, and being disk-checked
2434 * 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 -08002435 */
2436 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2437 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2438
2439 /**
2440 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2441 * 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 -08002442 */
2443 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2444 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2445
2446 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002447 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002448 * 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 -07002449 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2450 * media was mounted read only.
2451 */
2452 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2453 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2454
2455 /**
2456 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002457 * 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 -07002458 */
2459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2460 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2461
2462 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002463 * Broadcast Action: External media is no longer being shared via USB mass storage.
2464 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2465 *
2466 * @hide
2467 */
2468 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2469
2470 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002471 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2472 * The path to the mount point for the removed media is contained in the Intent.mData field.
2473 */
2474 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2475 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2476
2477 /**
2478 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002479 * 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 -07002480 */
2481 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2482 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2483
2484 /**
2485 * Broadcast Action: User has expressed the desire to remove the external storage media.
2486 * Applications should close all files they have open within the mount point when they receive this intent.
2487 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2488 */
2489 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2490 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2491
2492 /**
2493 * Broadcast Action: The media scanner has started scanning a directory.
2494 * The path to the directory being scanned is contained in the Intent.mData field.
2495 */
2496 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2497 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2498
2499 /**
2500 * Broadcast Action: The media scanner has finished scanning a directory.
2501 * The path to the scanned directory is contained in the Intent.mData field.
2502 */
2503 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2504 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2505
2506 /**
2507 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2508 * The path to the file is contained in the Intent.mData field.
2509 */
2510 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2511 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2512
2513 /**
2514 * Broadcast Action: The "Media Button" was pressed. Includes a single
2515 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2516 * caused the broadcast.
2517 */
2518 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2519 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2520
2521 /**
2522 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2523 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2524 * caused the broadcast.
2525 */
2526 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2527 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2528
2529 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2530 // location; they are not general-purpose actions.
2531
2532 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002533 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002534 */
2535 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2536 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2537 "android.intent.action.GTALK_CONNECTED";
2538
2539 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002540 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002541 */
2542 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2543 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2544 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002545
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002546 /**
2547 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002548 */
2549 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2550 public static final String ACTION_INPUT_METHOD_CHANGED =
2551 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002552
2553 /**
2554 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2555 * more radios have been turned off or on. The intent will have the following extra value:</p>
2556 * <ul>
2557 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2558 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2559 * turned off</li>
2560 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002561 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002562 * <p class="note">This is a protected intent that can only be sent
2563 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002564 */
2565 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2566 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2567
2568 /**
2569 * Broadcast Action: Some content providers have parts of their namespace
2570 * where they publish new events or items that the user may be especially
2571 * interested in. For these things, they may broadcast this action when the
2572 * set of interesting items change.
2573 *
2574 * For example, GmailProvider sends this notification when the set of unread
2575 * mail in the inbox changes.
2576 *
2577 * <p>The data of the intent identifies which part of which provider
2578 * changed. When queried through the content resolver, the data URI will
2579 * return the data set in question.
2580 *
2581 * <p>The intent will have the following extra values:
2582 * <ul>
2583 * <li><em>count</em> - The number of items in the data set. This is the
2584 * same as the number of items in the cursor returned by querying the
2585 * data URI. </li>
2586 * </ul>
2587 *
2588 * This intent will be sent at boot (if the count is non-zero) and when the
2589 * data set changes. It is possible for the data set to change without the
2590 * count changing (for example, if a new unread message arrives in the same
2591 * sync operation in which a message is archived). The phone should still
2592 * ring/vibrate/etc as normal in this case.
2593 */
2594 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2595 public static final String ACTION_PROVIDER_CHANGED =
2596 "android.intent.action.PROVIDER_CHANGED";
2597
2598 /**
2599 * Broadcast Action: Wired Headset plugged in or unplugged.
2600 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002601 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2602 * and documentation.
2603 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002604 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002605 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002606 */
2607 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002608 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002609
2610 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002611 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2612 * <ul>
2613 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2614 * </ul>
2615 *
2616 * <p class="note">This is a protected intent that can only be sent
2617 * by the system.
2618 *
2619 * @hide
2620 */
2621 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2622 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2623 = "android.intent.action.ADVANCED_SETTINGS";
2624
2625 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002626 * Broadcast Action: Sent after application restrictions are changed.
2627 *
2628 * <p class="note">This is a protected intent that can only be sent
2629 * by the system.</p>
2630 */
2631 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2632 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2633 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2634
2635 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002636 * Broadcast Action: An outgoing call is about to be placed.
2637 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002638 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002639 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002640 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002641 * the phone number originally intended to be dialed.</li>
2642 * </ul>
2643 * <p>Once the broadcast is finished, the resultData is used as the actual
2644 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002645 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002646 * outgoing call in turn: for example, a parental control application
2647 * might verify that the user is authorized to place the call at that
2648 * time, then a number-rewriting application might add an area code if
2649 * one was not specified.</p>
2650 * <p>For consistency, any receiver whose purpose is to prohibit phone
2651 * calls should have a priority of 0, to ensure it will see the final
2652 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002653 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002654 * should have a positive priority.
2655 * Negative priorities are reserved for the system for this broadcast;
2656 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002657 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2658 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002659 * <p>Emergency calls cannot be intercepted using this mechanism, and
2660 * other calls cannot be modified to call emergency numbers using this
2661 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002662 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2663 * call to use their own service instead. Those apps should first prevent
2664 * the call from being placed by setting resultData to <code>null</code>
2665 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002666 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002667 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2668 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002669 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002670 * <p class="note">This is a protected intent that can only be sent
2671 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002672 */
2673 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2674 public static final String ACTION_NEW_OUTGOING_CALL =
2675 "android.intent.action.NEW_OUTGOING_CALL";
2676
2677 /**
2678 * Broadcast Action: Have the device reboot. This is only for use by
2679 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002680 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002681 * <p class="note">This is a protected intent that can only be sent
2682 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002683 */
2684 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2685 public static final String ACTION_REBOOT =
2686 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002687
Wei Huang97ecc9c2009-05-11 17:44:20 -07002688 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002689 * Broadcast Action: A sticky broadcast for changes in the physical
2690 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002691 *
2692 * <p>The intent will have the following extra values:
2693 * <ul>
2694 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002695 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002696 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002697 * <p>This is intended for monitoring the current physical dock state.
2698 * See {@link android.app.UiModeManager} for the normal API dealing with
2699 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002700 */
2701 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2702 public static final String ACTION_DOCK_EVENT =
2703 "android.intent.action.DOCK_EVENT";
2704
2705 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002706 * Broadcast Action: A broadcast when idle maintenance can be started.
2707 * This means that the user is not interacting with the device and is
2708 * not expected to do so soon. Typical use of the idle maintenance is
2709 * to perform somehow expensive tasks that can be postponed at a moment
2710 * when they will not degrade user experience.
2711 * <p>
2712 * <p class="note">In order to keep the device responsive in case of an
2713 * unexpected user interaction, implementations of a maintenance task
2714 * should be interruptible. In such a scenario a broadcast with action
2715 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2716 * should not do the maintenance work in
2717 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2718 * maintenance service by {@link Context#startService(Intent)}. Also
2719 * you should hold a wake lock while your maintenance service is running
2720 * to prevent the device going to sleep.
2721 * </p>
2722 * <p>
2723 * <p class="note">This is a protected intent that can only be sent by
2724 * the system.
2725 * </p>
2726 *
2727 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002728 *
2729 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002730 */
2731 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2732 public static final String ACTION_IDLE_MAINTENANCE_START =
2733 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2734
2735 /**
2736 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2737 * This means that the user was not interacting with the device as a result
2738 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2739 * was sent and now the user started interacting with the device. Typical
2740 * use of the idle maintenance is to perform somehow expensive tasks that
2741 * can be postponed at a moment when they will not degrade user experience.
2742 * <p>
2743 * <p class="note">In order to keep the device responsive in case of an
2744 * unexpected user interaction, implementations of a maintenance task
2745 * should be interruptible. Hence, on receiving a broadcast with this
2746 * action, the maintenance task should be interrupted as soon as possible.
2747 * In other words, you should not do the maintenance work in
2748 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2749 * maintenance service that was started on receiving of
2750 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2751 * lock you acquired when your maintenance service started.
2752 * </p>
2753 * <p class="note">This is a protected intent that can only be sent
2754 * by the system.
2755 *
2756 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002757 *
2758 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002759 */
2760 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2761 public static final String ACTION_IDLE_MAINTENANCE_END =
2762 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2763
2764 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002765 * Broadcast Action: a remote intent is to be broadcasted.
2766 *
2767 * A remote intent is used for remote RPC between devices. The remote intent
2768 * is serialized and sent from one device to another device. The receiving
2769 * device parses the remote intent and broadcasts it. Note that anyone can
2770 * broadcast a remote intent. However, if the intent receiver of the remote intent
2771 * does not trust intent broadcasts from arbitrary intent senders, it should require
2772 * the sender to hold certain permissions so only trusted sender's broadcast will be
2773 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002774 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002775 */
2776 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002777 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002778
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002779 /**
2780 * Broadcast Action: hook for permforming cleanup after a system update.
2781 *
2782 * The broadcast is sent when the system is booting, before the
2783 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2784 * image. A receiver for this should do its work and then disable itself
2785 * so that it does not get run again at the next boot.
2786 * @hide
2787 */
2788 public static final String ACTION_PRE_BOOT_COMPLETED =
2789 "android.intent.action.PRE_BOOT_COMPLETED";
2790
Amith Yamasani13593602012-03-22 16:16:17 -07002791 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002792 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002793 * on restricted users. The broadcast intent contains an extra
2794 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2795 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2796 * String[] depending on the restriction type.<p/>
2797 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002798 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2799 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2800 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002801 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2802 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002803 * @see RestrictionEntry
2804 */
2805 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2806 "android.intent.action.GET_RESTRICTION_ENTRIES";
2807
2808 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002809 * Sent the first time a user is starting, to allow system apps to
2810 * perform one time initialization. (This will not be seen by third
2811 * party applications because a newly initialized user does not have any
2812 * third party applications installed for it.) This is sent early in
2813 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002814 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2815 * broadcast, since it is part of a visible user interaction; be as quick
2816 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002817 */
2818 public static final String ACTION_USER_INITIALIZE =
2819 "android.intent.action.USER_INITIALIZE";
2820
2821 /**
2822 * Sent when a user switch is happening, causing the process's user to be
2823 * brought to the foreground. This is only sent to receivers registered
2824 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2825 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002826 * foreground. This is sent as a foreground
2827 * broadcast, since it is part of a visible user interaction; be as quick
2828 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002829 */
2830 public static final String ACTION_USER_FOREGROUND =
2831 "android.intent.action.USER_FOREGROUND";
2832
2833 /**
2834 * Sent when a user switch is happening, causing the process's user to be
2835 * sent to the background. This is only sent to receivers registered
2836 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2837 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002838 * background. This is sent as a foreground
2839 * broadcast, since it is part of a visible user interaction; be as quick
2840 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002841 */
2842 public static final String ACTION_USER_BACKGROUND =
2843 "android.intent.action.USER_BACKGROUND";
2844
2845 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002846 * Broadcast sent to the system when a user is added. Carries an extra
2847 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2848 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002849 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002850 * @hide
2851 */
2852 public static final String ACTION_USER_ADDED =
2853 "android.intent.action.USER_ADDED";
2854
2855 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002856 * Broadcast sent by the system when a user is started. Carries an extra
2857 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002858 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002859 * that has been started. This is sent as a foreground
2860 * broadcast, since it is part of a visible user interaction; be as quick
2861 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002862 * @hide
2863 */
2864 public static final String ACTION_USER_STARTED =
2865 "android.intent.action.USER_STARTED";
2866
2867 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002868 * Broadcast sent when a user is in the process of starting. Carries an extra
2869 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2870 * sent to registered receivers, not manifest receivers. It is sent to all
2871 * users (including the one that is being started). You must hold
2872 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2873 * this broadcast. This is sent as a background broadcast, since
2874 * its result is not part of the primary UX flow; to safely keep track of
2875 * started/stopped state of a user you can use this in conjunction with
2876 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2877 * other user state broadcasts since those are foreground broadcasts so can
2878 * execute in a different order.
2879 * @hide
2880 */
2881 public static final String ACTION_USER_STARTING =
2882 "android.intent.action.USER_STARTING";
2883
2884 /**
2885 * Broadcast sent when a user is going to be stopped. Carries an extra
2886 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2887 * sent to registered receivers, not manifest receivers. It is sent to all
2888 * users (including the one that is being stopped). You must hold
2889 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2890 * this broadcast. The user will not stop until all receivers have
2891 * handled the broadcast. This is sent as a background broadcast, since
2892 * its result is not part of the primary UX flow; to safely keep track of
2893 * started/stopped state of a user you can use this in conjunction with
2894 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2895 * other user state broadcasts since those are foreground broadcasts so can
2896 * execute in a different order.
2897 * @hide
2898 */
2899 public static final String ACTION_USER_STOPPING =
2900 "android.intent.action.USER_STOPPING";
2901
2902 /**
2903 * Broadcast sent to the system when a user is stopped. Carries an extra
2904 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2905 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2906 * specific package. This is only sent to registered receivers, not manifest
2907 * receivers. It is sent to all running users <em>except</em> the one that
2908 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002909 * @hide
2910 */
2911 public static final String ACTION_USER_STOPPED =
2912 "android.intent.action.USER_STOPPED";
2913
2914 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002915 * 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 -07002916 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002917 * one that has been removed. The user will not be completely removed until all receivers have
2918 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002919 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002920 * @hide
2921 */
2922 public static final String ACTION_USER_REMOVED =
2923 "android.intent.action.USER_REMOVED";
2924
2925 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002926 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002927 * the userHandle of the user to become the current one. This is only sent to
2928 * registered receivers, not manifest receivers. It is sent to all running users.
2929 * You must hold
2930 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002931 * @hide
2932 */
2933 public static final String ACTION_USER_SWITCHED =
2934 "android.intent.action.USER_SWITCHED";
2935
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002936 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07002937 * Broadcast Action: Sent when the credential-encrypted private storage has
2938 * become unlocked for the target user. This is only sent to registered
2939 * receivers, not manifest receivers.
2940 */
2941 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2942 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
2943
2944 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002945 * Broadcast sent to the system when a user's information changes. Carries an extra
2946 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002947 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002948 * @hide
2949 */
2950 public static final String ACTION_USER_INFO_CHANGED =
2951 "android.intent.action.USER_INFO_CHANGED";
2952
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002953 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002954 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2955 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002956 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2957 * that need to display merged content across both primary and managed profiles need to
2958 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002959 * not manifest receivers.
2960 */
2961 public static final String ACTION_MANAGED_PROFILE_ADDED =
2962 "android.intent.action.MANAGED_PROFILE_ADDED";
2963
2964 /**
2965 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002966 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2967 * Only applications (for example Launchers) that need to display merged content across both
2968 * primary and managed profiles need to worry about this broadcast. This is only sent to
2969 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002970 */
2971 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2972 "android.intent.action.MANAGED_PROFILE_REMOVED";
2973
2974 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002975 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2976 */
2977 public static final String ACTION_QUICK_CLOCK =
2978 "android.intent.action.QUICK_CLOCK";
2979
Michael Wright0087a142013-02-05 16:29:39 -08002980 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002981 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002982 * @hide
2983 */
2984 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2985 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2986
Justin Kohd378ad72013-04-01 12:18:26 -07002987 /**
2988 * Broadcast Action: A global button was pressed. Includes a single
2989 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2990 * caused the broadcast.
2991 * @hide
2992 */
2993 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2994
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002995 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002996 * Activity Action: Allow the user to select and return one or more existing
2997 * documents. When invoked, the system will display the various
2998 * {@link DocumentsProvider} instances installed on the device, letting the
2999 * user interactively navigate through them. These documents include local
3000 * media, such as photos and video, and documents provided by installed
3001 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003002 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003003 * Each document is represented as a {@code content://} URI backed by a
3004 * {@link DocumentsProvider}, which can be opened as a stream with
3005 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3006 * {@link android.provider.DocumentsContract.Document} metadata.
3007 * <p>
3008 * All selected documents are returned to the calling application with
3009 * persistable read and write permission grants. If you want to maintain
3010 * access to the documents across device reboots, you need to explicitly
3011 * take the persistable permissions using
3012 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3013 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003014 * Callers must indicate the acceptable document MIME types through
3015 * {@link #setType(String)}. For example, to select photos, use
3016 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3017 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3018 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003019 * <p>
3020 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003021 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3022 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003023 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003024 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3025 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003026 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003027 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003028 * Output: The URI of the item that was picked, returned in
3029 * {@link #getData()}. This must be a {@code content://} URI so that any
3030 * receiver can access it. If multiple documents were selected, they are
3031 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003032 *
3033 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003034 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003035 * @see #ACTION_CREATE_DOCUMENT
3036 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003037 */
3038 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3039 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3040
3041 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003042 * Activity Action: Allow the user to create a new document. When invoked,
3043 * the system will display the various {@link DocumentsProvider} instances
3044 * installed on the device, letting the user navigate through them. The
3045 * returned document may be a newly created document with no content, or it
3046 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003047 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003048 * Each document is represented as a {@code content://} URI backed by a
3049 * {@link DocumentsProvider}, which can be opened as a stream with
3050 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3051 * {@link android.provider.DocumentsContract.Document} metadata.
3052 * <p>
3053 * Callers must indicate the concrete MIME type of the document being
3054 * created by setting {@link #setType(String)}. This MIME type cannot be
3055 * changed after the document is created.
3056 * <p>
3057 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3058 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003059 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003060 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3061 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003062 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003063 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003064 * Output: The URI of the item that was created. This must be a
3065 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003066 *
3067 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003068 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003069 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003070 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003071 */
3072 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3073 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3074
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003075 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003076 * Activity Action: Allow the user to pick a directory subtree. When
3077 * invoked, the system will display the various {@link DocumentsProvider}
3078 * instances installed on the device, letting the user navigate through
3079 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003080 * <p>
3081 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003082 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3083 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3084 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003085 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003086 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003087 *
3088 * @see DocumentsContract
3089 */
3090 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003091 public static final String
3092 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003093
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003094 /** {@hide} */
3095 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3096
Christopher Tate6597e342015-02-17 12:15:25 -08003097 /**
3098 * Broadcast action: report that a settings element is being restored from backup. The intent
3099 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3100 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3101 * is the value of that settings entry prior to the restore operation. All of these values are
3102 * represented as strings.
3103 *
3104 * <p>This broadcast is sent only for settings provider entries known to require special handling
3105 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3106 * the provider's backup agent implementation.
3107 *
3108 * @see #EXTRA_SETTING_NAME
3109 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3110 * @see #EXTRA_SETTING_NEW_VALUE
3111 * {@hide}
3112 */
3113 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3114
3115 /** {@hide} */
3116 public static final String EXTRA_SETTING_NAME = "setting_name";
3117 /** {@hide} */
3118 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3119 /** {@hide} */
3120 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3121
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003122 /**
3123 * Activity Action: Process a piece of text.
3124 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3125 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3126 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3127 */
3128 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3129 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3130 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003131 * The name of the extra used to define the text to be processed, as a
3132 * CharSequence. Note that this may be a styled CharSequence, so you must use
3133 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003134 */
3135 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3136 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003137 * 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 +00003138 */
3139 public static final String EXTRA_PROCESS_TEXT_READONLY =
3140 "android.intent.extra.PROCESS_TEXT_READONLY";
3141
Bryce Leebc58f592015-09-25 16:43:01 -07003142 /**
3143 * Broadcast action: reports when a new thermal event has been reached. When the device
3144 * is reaching its maximum temperatue, the thermal level reported
3145 * {@hide}
3146 */
3147 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3148 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3149
3150 /** {@hide} */
3151 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3152
3153 /**
3154 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003155 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003156 * {@hide}
3157 */
3158 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3159
3160 /**
3161 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003162 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003163 * {@hide}
3164 */
3165 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3166
3167 /**
3168 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003169 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003170 * {@hide}
3171 */
3172 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3173
3174
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003175 // ---------------------------------------------------------------------
3176 // ---------------------------------------------------------------------
3177 // Standard intent categories (see addCategory()).
3178
3179 /**
3180 * Set if the activity should be an option for the default action
3181 * (center press) to perform on a piece of data. Setting this will
3182 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003183 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003184 * Intent when initiating an action -- it is for use in intent filters
3185 * specified in packages.
3186 */
3187 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3188 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3189 /**
3190 * Activities that can be safely invoked from a browser must support this
3191 * category. For example, if the user is viewing a web page or an e-mail
3192 * and clicks on a link in the text, the Intent generated execute that
3193 * link will require the BROWSABLE category, so that only activities
3194 * supporting this category will be considered as possible actions. By
3195 * supporting this category, you are promising that there is nothing
3196 * damaging (without user intervention) that can happen by invoking any
3197 * matching Intent.
3198 */
3199 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3200 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3201 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003202 * Categories for activities that can participate in voice interaction.
3203 * An activity that supports this category must be prepared to run with
3204 * no UI shown at all (though in some case it may have a UI shown), and
3205 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3206 */
3207 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3208 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3209 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003210 * Set if the activity should be considered as an alternative action to
3211 * the data the user is currently viewing. See also
3212 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3213 * applies to the selection in a list of items.
3214 *
3215 * <p>Supporting this category means that you would like your activity to be
3216 * displayed in the set of alternative things the user can do, usually as
3217 * part of the current activity's options menu. You will usually want to
3218 * include a specific label in the &lt;intent-filter&gt; of this action
3219 * describing to the user what it does.
3220 *
3221 * <p>The action of IntentFilter with this category is important in that it
3222 * describes the specific action the target will perform. This generally
3223 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3224 * a specific name such as "com.android.camera.action.CROP. Only one
3225 * alternative of any particular action will be shown to the user, so using
3226 * a specific action like this makes sure that your alternative will be
3227 * displayed while also allowing other applications to provide their own
3228 * overrides of that particular action.
3229 */
3230 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3231 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3232 /**
3233 * Set if the activity should be considered as an alternative selection
3234 * action to the data the user has currently selected. This is like
3235 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3236 * of items from which the user can select, giving them alternatives to the
3237 * default action that will be performed on it.
3238 */
3239 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3240 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3241 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003242 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003243 */
3244 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3245 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3246 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003247 * Should be displayed in the top-level launcher.
3248 */
3249 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3250 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3251 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003252 * Indicates an activity optimized for Leanback mode, and that should
3253 * be displayed in the Leanback launcher.
3254 */
3255 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3256 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3257 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003258 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3259 * @hide
3260 */
3261 @SystemApi
3262 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3263 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003264 * Provides information about the package it is in; typically used if
3265 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3266 * a front-door to the user without having to be shown in the all apps list.
3267 */
3268 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3269 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3270 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003271 * This is the home activity, that is the first activity that is displayed
3272 * when the device boots.
3273 */
3274 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3275 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3276 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003277 * This is the home activity that is displayed when the device is finished setting up and ready
3278 * for use.
3279 * @hide
3280 */
3281 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3282 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3283 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003284 * This is the setup wizard activity, that is the first activity that is displayed
3285 * when the user sets up the device for the first time.
3286 * @hide
3287 */
3288 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3289 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3290 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003291 * This activity is a preference panel.
3292 */
3293 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3294 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3295 /**
3296 * This activity is a development preference panel.
3297 */
3298 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3299 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3300 /**
3301 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003302 */
3303 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3304 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3305 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003306 * This activity allows the user to browse and download new applications.
3307 */
3308 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3309 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3310 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003311 * This activity may be exercised by the monkey or other automated test tools.
3312 */
3313 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3314 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3315 /**
3316 * To be used as a test (not part of the normal user experience).
3317 */
3318 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3319 /**
3320 * To be used as a unit test (run through the Test Harness).
3321 */
3322 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3323 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003324 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003325 * experience).
3326 */
3327 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003328
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003329 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003330 * Used to indicate that an intent only wants URIs that can be opened with
3331 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3332 * must support at least the columns defined in {@link OpenableColumns} when
3333 * queried.
3334 *
3335 * @see #ACTION_GET_CONTENT
3336 * @see #ACTION_OPEN_DOCUMENT
3337 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003338 */
3339 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3340 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3341
3342 /**
3343 * To be used as code under test for framework instrumentation tests.
3344 */
3345 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3346 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003347 /**
3348 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003349 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3350 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003351 */
3352 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3353 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3354 /**
3355 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003356 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3357 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003358 */
3359 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3360 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003361 /**
3362 * An activity to run when device is inserted into a analog (low end) dock.
3363 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3364 * information, see {@link android.app.UiModeManager}.
3365 */
3366 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3367 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3368
3369 /**
3370 * An activity to run when device is inserted into a digital (high end) dock.
3371 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3372 * information, see {@link android.app.UiModeManager}.
3373 */
3374 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3375 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003376
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003377 /**
3378 * Used to indicate that the activity can be used in a car environment.
3379 */
3380 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3381 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3382
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003383 // ---------------------------------------------------------------------
3384 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003385 // Application launch intent categories (see addCategory()).
3386
3387 /**
3388 * Used with {@link #ACTION_MAIN} to launch the browser application.
3389 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003390 * <p>NOTE: This should not be used as the primary key of an Intent,
3391 * since it will not result in the app launching with the correct
3392 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003393 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003394 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003395 */
3396 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3397 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3398
3399 /**
3400 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3401 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003402 * <p>NOTE: This should not be used as the primary key of an Intent,
3403 * since it will not result in the app launching with the correct
3404 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003405 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003406 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003407 */
3408 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3409 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3410
3411 /**
3412 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3413 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003414 * <p>NOTE: This should not be used as the primary key of an Intent,
3415 * since it will not result in the app launching with the correct
3416 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003417 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003418 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003419 */
3420 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3421 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3422
3423 /**
3424 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3425 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003426 * <p>NOTE: This should not be used as the primary key of an Intent,
3427 * since it will not result in the app launching with the correct
3428 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003429 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003430 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003431 */
3432 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3433 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3434
3435 /**
3436 * Used with {@link #ACTION_MAIN} to launch the email application.
3437 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003438 * <p>NOTE: This should not be used as the primary key of an Intent,
3439 * since it will not result in the app launching with the correct
3440 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003441 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003442 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003443 */
3444 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3445 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3446
3447 /**
3448 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3449 * The activity should be able to view and manipulate image and video files
3450 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003451 * <p>NOTE: This should not be used as the primary key of an Intent,
3452 * since it will not result in the app launching with the correct
3453 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003454 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003455 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003456 */
3457 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3458 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3459
3460 /**
3461 * Used with {@link #ACTION_MAIN} to launch the maps application.
3462 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003463 * <p>NOTE: This should not be used as the primary key of an Intent,
3464 * since it will not result in the app launching with the correct
3465 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003466 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003467 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003468 */
3469 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3470 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3471
3472 /**
3473 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3474 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003475 * <p>NOTE: This should not be used as the primary key of an Intent,
3476 * since it will not result in the app launching with the correct
3477 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003478 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003479 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003480 */
3481 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3482 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3483
3484 /**
3485 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003486 * The activity should be able to play, browse, or manipulate music files
3487 * stored on the device.
3488 * <p>NOTE: This should not be used as the primary key of an Intent,
3489 * since it will not result in the app launching with the correct
3490 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003491 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003492 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003493 */
3494 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3495 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3496
3497 // ---------------------------------------------------------------------
3498 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003499 // Standard extra data keys.
3500
3501 /**
3502 * The initial data to place in a newly created record. Use with
3503 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3504 * fields as would be given to the underlying ContentProvider.insert()
3505 * call.
3506 */
3507 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3508
3509 /**
3510 * A constant CharSequence that is associated with the Intent, used with
3511 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3512 * this may be a styled CharSequence, so you must use
3513 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3514 * retrieve it.
3515 */
3516 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3517
3518 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003519 * A constant String that is associated with the Intent, used with
3520 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3521 * as HTML formatted text. Note that you <em>must</em> also supply
3522 * {@link #EXTRA_TEXT}.
3523 */
3524 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3525
3526 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003527 * A content: URI holding a stream of data associated with the Intent,
3528 * used with {@link #ACTION_SEND} to supply the data being sent.
3529 */
3530 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3531
3532 /**
3533 * A String[] holding e-mail addresses that should be delivered to.
3534 */
3535 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3536
3537 /**
3538 * A String[] holding e-mail addresses that should be carbon copied.
3539 */
3540 public static final String EXTRA_CC = "android.intent.extra.CC";
3541
3542 /**
3543 * A String[] holding e-mail addresses that should be blind carbon copied.
3544 */
3545 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3546
3547 /**
3548 * A constant string holding the desired subject line of a message.
3549 */
3550 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3551
3552 /**
3553 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003554 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003555 */
3556 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3557
3558 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003559 * An int representing the user id to be used.
3560 *
3561 * @hide
3562 */
3563 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3564
3565 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003566 * An Intent[] describing additional, alternate choices you would like shown with
3567 * {@link #ACTION_CHOOSER}.
3568 *
3569 * <p>An app may be capable of providing several different payload types to complete a
3570 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3571 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3572 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3573 * photo data or a hosted link where the photos can be viewed.</p>
3574 *
3575 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3576 * first/primary/preferred intent in the set. Additional intents specified in
3577 * this extra are ordered; by default intents that appear earlier in the array will be
3578 * preferred over intents that appear later in the array as matches for the same
3579 * target component. To alter this preference, a calling app may also supply
3580 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3581 */
3582 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3583
3584 /**
3585 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3586 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3587 *
3588 * <p>An app preparing an action for another app to complete may wish to allow the user to
3589 * disambiguate between several options for completing the action based on the chosen target
3590 * or otherwise refine the action before it is invoked.
3591 * </p>
3592 *
3593 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3594 * <ul>
3595 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3596 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3597 * chosen target beyond the first</li>
3598 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3599 * should fill in and send once the disambiguation is complete</li>
3600 * </ul>
3601 */
3602 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3603 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3604
3605 /**
3606 * A {@link ResultReceiver} used to return data back to the sender.
3607 *
3608 * <p>Used to complete an app-specific
3609 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3610 *
3611 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3612 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3613 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3614 * when the user selects a target component from the chooser. It is up to the recipient
3615 * to send a result to this ResultReceiver to signal that disambiguation is complete
3616 * and that the chooser should invoke the user's choice.</p>
3617 *
3618 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3619 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3620 * to match and fill in the final Intent or ChooserTarget before starting it.
3621 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3622 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3623 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3624 *
3625 * <p>The result code passed to the ResultReceiver should be
3626 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3627 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3628 * the chooser should finish without starting a target.</p>
3629 */
3630 public static final String EXTRA_RESULT_RECEIVER
3631 = "android.intent.extra.RESULT_RECEIVER";
3632
3633 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003634 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003635 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003636 */
3637 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3638
3639 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003640 * A Parcelable[] of {@link Intent} or
3641 * {@link android.content.pm.LabeledIntent} objects as set with
3642 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3643 * a the front of the list of choices, when shown to the user with a
3644 * {@link #ACTION_CHOOSER}.
3645 */
3646 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3647
3648 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003649 * A Bundle forming a mapping of potential target package names to different extras Bundles
3650 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3651 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3652 * be currently installed on the device.
3653 *
3654 * <p>An application may choose to provide alternate extras for the case where a user
3655 * selects an activity from a predetermined set of target packages. If the activity
3656 * the user selects from the chooser belongs to a package with its package name as
3657 * a key in this bundle, the corresponding extras for that package will be merged with
3658 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3659 * extra has the same key as an extra already present in the intent it will overwrite
3660 * the extra from the intent.</p>
3661 *
3662 * <p><em>Examples:</em>
3663 * <ul>
3664 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3665 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3666 * parameters for that target.</li>
3667 * <li>An application may offer additional metadata for known targets of a given intent
3668 * to pass along information only relevant to that target such as account or content
3669 * identifiers already known to that application.</li>
3670 * </ul></p>
3671 */
3672 public static final String EXTRA_REPLACEMENT_EXTRAS =
3673 "android.intent.extra.REPLACEMENT_EXTRAS";
3674
3675 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003676 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3677 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3678 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3679 * {@link ComponentName} of the chosen component.
3680 *
3681 * <p>In some situations this callback may never come, for example if the user abandons
3682 * the chooser, switches to another task or any number of other reasons. Apps should not
3683 * be written assuming that this callback will always occur.</p>
3684 */
3685 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3686 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3687
3688 /**
3689 * The {@link ComponentName} chosen by the user to complete an action.
3690 *
3691 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3692 */
3693 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3694
3695 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003696 * A {@link android.view.KeyEvent} object containing the event that
3697 * triggered the creation of the Intent it is in.
3698 */
3699 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3700
3701 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003702 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3703 * before shutting down.
3704 *
3705 * {@hide}
3706 */
3707 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3708
3709 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003710 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3711 * requested by the user.
3712 *
3713 * {@hide}
3714 */
3715 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3716 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3717
3718 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003719 * 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 -07003720 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3721 * of restarting the application.
3722 */
3723 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3724
3725 /**
3726 * A String holding the phone number originally entered in
3727 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3728 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3729 */
3730 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003731
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003732 /**
3733 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3734 * intents to supply the uid the package had been assigned. Also an optional
3735 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3736 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3737 * purpose.
3738 */
3739 public static final String EXTRA_UID = "android.intent.extra.UID";
3740
3741 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003742 * @hide String array of package names.
3743 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003744 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003745 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3746
3747 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003748 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3749 * intents to indicate whether this represents a full uninstall (removing
3750 * both the code and its data) or a partial uninstall (leaving its data,
3751 * implying that this is an update).
3752 */
3753 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003754
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003755 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003756 * @hide
3757 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3758 * intents to indicate that at this point the package has been removed for
3759 * all users on the device.
3760 */
3761 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3762 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3763
3764 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003765 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3766 * intents to indicate that this is a replacement of the package, so this
3767 * broadcast will immediately be followed by an add broadcast for a
3768 * different version of the same package.
3769 */
3770 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003771
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003772 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003773 * Used as an int extra field in {@link android.app.AlarmManager} intents
3774 * to tell the application being invoked how many pending alarms are being
3775 * delievered with the intent. For one-shot alarms this will always be 1.
3776 * For recurring alarms, this might be greater than 1 if the device was
3777 * asleep or powered off at the time an earlier alarm would have been
3778 * delivered.
3779 */
3780 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003781
Jacek Surazski86b6c532009-05-13 14:38:28 +02003782 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003783 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3784 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003785 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3786 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003787 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3788 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3789 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003790 */
3791 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3792
3793 /**
3794 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3795 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003796 */
3797 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3798
3799 /**
3800 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3801 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003802 */
3803 public static final int EXTRA_DOCK_STATE_DESK = 1;
3804
3805 /**
3806 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3807 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003808 */
3809 public static final int EXTRA_DOCK_STATE_CAR = 2;
3810
3811 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003812 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3813 * to represent that the phone is in a analog (low end) dock.
3814 */
3815 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3816
3817 /**
3818 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3819 * to represent that the phone is in a digital (high end) dock.
3820 */
3821 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3822
3823 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003824 * Boolean that can be supplied as meta-data with a dock activity, to
3825 * indicate that the dock should take over the home key when it is active.
3826 */
3827 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003828
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003829 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003830 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3831 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003832 */
3833 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3834
3835 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003836 * Used in the extra field in the remote intent. It's astring token passed with the
3837 * remote intent.
3838 */
3839 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3840 "android.intent.extra.remote_intent_token";
3841
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003842 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003843 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003844 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003845 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003846 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003847 "android.intent.extra.changed_component_name";
3848
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003849 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003850 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003851 * and contains a string array of all of the components that have changed. If
3852 * the state of the overall package has changed, then it will contain an entry
3853 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003854 */
3855 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3856 "android.intent.extra.changed_component_name_list";
3857
3858 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003859 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003860 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3861 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003862 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003863 */
3864 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3865 "android.intent.extra.changed_package_list";
3866
3867 /**
3868 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003869 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3870 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003871 * and contains an integer array of uids of all of the components
3872 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003873 */
3874 public static final String EXTRA_CHANGED_UID_LIST =
3875 "android.intent.extra.changed_uid_list";
3876
3877 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003878 * @hide
3879 * Magic extra system code can use when binding, to give a label for
3880 * who it is that has bound to a service. This is an integer giving
3881 * a framework string resource that can be displayed to the user.
3882 */
3883 public static final String EXTRA_CLIENT_LABEL =
3884 "android.intent.extra.client_label";
3885
3886 /**
3887 * @hide
3888 * Magic extra system code can use when binding, to give a PendingIntent object
3889 * that can be launched for the user to disable the system's use of this
3890 * service.
3891 */
3892 public static final String EXTRA_CLIENT_INTENT =
3893 "android.intent.extra.client_intent";
3894
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003895 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003896 * Extra used to indicate that an intent should only return data that is on
3897 * the local device. This is a boolean extra; the default is false. If true,
3898 * an implementation should only allow the user to select data that is
3899 * already on the device, not requiring it be downloaded from a remote
3900 * service when opened.
3901 *
3902 * @see #ACTION_GET_CONTENT
3903 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003904 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003905 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003906 */
3907 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003908 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003909
Amith Yamasani13593602012-03-22 16:16:17 -07003910 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003911 * Extra used to indicate that an intent can allow the user to select and
3912 * return multiple items. This is a boolean extra; the default is false. If
3913 * true, an implementation is allowed to present the user with a UI where
3914 * they can pick multiple items that are all returned to the caller. When
3915 * this happens, they should be returned as the {@link #getClipData()} part
3916 * of the result Intent.
3917 *
3918 * @see #ACTION_GET_CONTENT
3919 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003920 */
3921 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003922 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003923
3924 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003925 * The integer userHandle carried with broadcast intents related to addition, removal and
3926 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3927 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3928 *
Amith Yamasani13593602012-03-22 16:16:17 -07003929 * @hide
3930 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003931 public static final String EXTRA_USER_HANDLE =
3932 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003933
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003934 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003935 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3936 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3937 */
3938 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01003939 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003940
3941 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003942 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003943 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3944 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003945 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003946 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3947
3948 /**
3949 * Extra sent in the intent to the BroadcastReceiver that handles
3950 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3951 * the restrictions as key/value pairs.
3952 */
3953 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3954 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003955
Amith Yamasani86118ba2013-03-28 14:33:16 -07003956 /**
3957 * Extra used in the response from a BroadcastReceiver that handles
3958 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3959 */
3960 public static final String EXTRA_RESTRICTIONS_INTENT =
3961 "android.intent.extra.restrictions_intent";
3962
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003963 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003964 * Extra used to communicate a set of acceptable MIME types. The type of the
3965 * extra is {@code String[]}. Values may be a combination of concrete MIME
3966 * types (such as "image/png") and/or partial MIME types (such as
3967 * "audio/*").
3968 *
3969 * @see #ACTION_GET_CONTENT
3970 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003971 */
3972 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3973
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003974 /**
3975 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3976 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003977 * When this is true, hardware devices can use this information to determine that
3978 * they shouldn't do a complete shutdown of their device since this is not a
3979 * complete shutdown down to the kernel, but only user space restarting.
3980 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003981 */
3982 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3983 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3984
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003985 /**
3986 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3987 * user has set their time format preferences to the 24 hour format.
3988 *
3989 * @hide for internal use only.
3990 */
3991 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3992 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3993
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003994 /** {@hide} */
3995 public static final String EXTRA_REASON = "android.intent.extra.REASON";
3996
Rubin Xue8490f12015-06-25 12:17:48 +01003997 /** {@hide} */
3998 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
3999
Santos Cordon15a13782015-03-31 18:32:31 -07004000 /**
4001 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4002 * activation request.
4003 * TODO: Add information about the structure and response data used with the pending intent.
4004 * @hide
4005 */
4006 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4007 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4008
Steve McKay6eaf38632015-08-04 10:11:01 -07004009 /** {@hide} */
4010 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4011
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004012 // ---------------------------------------------------------------------
4013 // ---------------------------------------------------------------------
4014 // Intent flags (see mFlags variable).
4015
Tor Norbyed9273d62013-05-30 15:59:53 -07004016 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004017 @IntDef(flag = true, value = {
4018 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4019 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004020 @Retention(RetentionPolicy.SOURCE)
4021 public @interface GrantUriMode {}
4022
Jeff Sharkey846318a2014-04-04 12:12:41 -07004023 /** @hide */
4024 @IntDef(flag = true, value = {
4025 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4026 @Retention(RetentionPolicy.SOURCE)
4027 public @interface AccessUriMode {}
4028
4029 /**
4030 * Test if given mode flags specify an access mode, which must be at least
4031 * read and/or write.
4032 *
4033 * @hide
4034 */
4035 public static boolean isAccessUriMode(int modeFlags) {
4036 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4037 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4038 }
4039
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004040 /**
4041 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004042 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004043 * specified in its ClipData. When applying to an Intent's ClipData,
4044 * all URIs as well as recursive traversals through data or other ClipData
4045 * in Intent items will be granted; only the grant flags of the top-level
4046 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004047 */
4048 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4049 /**
4050 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004051 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004052 * specified in its ClipData. When applying to an Intent's ClipData,
4053 * all URIs as well as recursive traversals through data or other ClipData
4054 * in Intent items will be granted; only the grant flags of the top-level
4055 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004056 */
4057 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4058 /**
4059 * Can be set by the caller to indicate that this Intent is coming from
4060 * a background operation, not from direct user interaction.
4061 */
4062 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4063 /**
4064 * A flag you can enable for debugging: when set, log messages will be
4065 * printed during the resolution of this intent to show you what has
4066 * been found to create the final resolved list.
4067 */
4068 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004069 /**
4070 * If set, this intent will not match any components in packages that
4071 * are currently stopped. If this is not set, then the default behavior
4072 * is to include such applications in the result.
4073 */
4074 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4075 /**
4076 * If set, this intent will always match any components in packages that
4077 * are currently stopped. This is the default behavior when
4078 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4079 * flags are set, this one wins (it allows overriding of exclude for
4080 * places where the framework may automatically set the exclude flag).
4081 */
4082 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004083
4084 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004085 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004086 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004087 * persisted across device reboots until explicitly revoked with
4088 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4089 * grant for possible persisting; the receiving application must call
4090 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4091 * actually persist.
4092 *
4093 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4094 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4095 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004096 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004097 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004098 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004099
4100 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004101 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4102 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4103 * applies to any URI that is a prefix match against the original granted
4104 * URI. (Without this flag, the URI must match exactly for access to be
4105 * granted.) Another URI is considered a prefix match only when scheme,
4106 * authority, and all path segments defined by the prefix are an exact
4107 * match.
4108 */
4109 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4110
4111 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004112 * If set, the new activity is not kept in the history stack. As soon as
4113 * the user navigates away from it, the activity is finished. This may also
4114 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4115 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004116 *
4117 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4118 * is never invoked when the current activity starts a new activity which
4119 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004120 */
4121 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4122 /**
4123 * If set, the activity will not be launched if it is already running
4124 * at the top of the history stack.
4125 */
4126 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4127 /**
4128 * If set, this activity will become the start of a new task on this
4129 * history stack. A task (from the activity that started it to the
4130 * next task activity) defines an atomic group of activities that the
4131 * user can move to. Tasks can be moved to the foreground and background;
4132 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004133 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004134 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4135 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004136 *
4137 * <p>This flag is generally used by activities that want
4138 * to present a "launcher" style behavior: they give the user a list of
4139 * separate things that can be done, which otherwise run completely
4140 * independently of the activity launching them.
4141 *
4142 * <p>When using this flag, if a task is already running for the activity
4143 * you are now starting, then a new activity will not be started; instead,
4144 * the current task will simply be brought to the front of the screen with
4145 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4146 * to disable this behavior.
4147 *
4148 * <p>This flag can not be used when the caller is requesting a result from
4149 * the activity being launched.
4150 */
4151 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4152 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004153 * This flag is used to create a new task and launch an activity into it.
4154 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4155 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4156 * search through existing tasks for ones matching this Intent. Only if no such
4157 * task is found would a new task be created. When paired with
4158 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4159 * the search for a matching task and unconditionally start a new task.
4160 *
4161 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4162 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004163 * top-level application launcher.</strong> Used in conjunction with
4164 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4165 * behavior of bringing an existing task to the foreground. When set,
4166 * a new task is <em>always</em> started to host the Activity for the
4167 * Intent, regardless of whether there is already an existing task running
4168 * the same thing.
4169 *
4170 * <p><strong>Because the default system does not include graphical task management,
4171 * you should not use this flag unless you provide some way for a user to
4172 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004173 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004174 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4175 * creating new document tasks.
4176 *
4177 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004178 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004179 *
Scott Main7aee61f2011-02-08 11:25:01 -08004180 * <p>See
4181 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4182 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004183 *
4184 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4185 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004186 */
4187 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4188 /**
4189 * If set, and the activity being launched is already running in the
4190 * current task, then instead of launching a new instance of that activity,
4191 * all of the other activities on top of it will be closed and this Intent
4192 * will be delivered to the (now on top) old activity as a new Intent.
4193 *
4194 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4195 * If D calls startActivity() with an Intent that resolves to the component
4196 * of activity B, then C and D will be finished and B receive the given
4197 * Intent, resulting in the stack now being: A, B.
4198 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004199 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004200 * either receive the new intent you are starting here in its
4201 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004202 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004203 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4204 * the same intent, then it will be finished and re-created; for all other
4205 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4206 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004207 *
4208 * <p>This launch mode can also be used to good effect in conjunction with
4209 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4210 * of a task, it will bring any currently running instance of that task
4211 * to the foreground, and then clear it to its root state. This is
4212 * especially useful, for example, when launching an activity from the
4213 * notification manager.
4214 *
Scott Main7aee61f2011-02-08 11:25:01 -08004215 * <p>See
4216 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4217 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004218 */
4219 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4220 /**
4221 * If set and this intent is being used to launch a new activity from an
4222 * existing one, then the reply target of the existing activity will be
4223 * transfered to the new activity. This way the new activity can call
4224 * {@link android.app.Activity#setResult} and have that result sent back to
4225 * the reply target of the original activity.
4226 */
4227 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4228 /**
4229 * If set and this intent is being used to launch a new activity from an
4230 * existing one, the current activity will not be counted as the top
4231 * activity for deciding whether the new intent should be delivered to
4232 * the top instead of starting a new one. The previous activity will
4233 * be used as the top, with the assumption being that the current activity
4234 * will finish itself immediately.
4235 */
4236 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4237 /**
4238 * If set, the new activity is not kept in the list of recently launched
4239 * activities.
4240 */
4241 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4242 /**
4243 * This flag is not normally set by application code, but set for you by
4244 * the system as described in the
4245 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4246 * launchMode} documentation for the singleTask mode.
4247 */
4248 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4249 /**
4250 * If set, and this activity is either being started in a new task or
4251 * bringing to the top an existing task, then it will be launched as
4252 * the front door of the task. This will result in the application of
4253 * any affinities needed to have that task in the proper state (either
4254 * moving activities to or from it), or simply resetting that task to
4255 * its initial state if needed.
4256 */
4257 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4258 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004259 * This flag is not normally set by application code, but set for you by
4260 * the system if this activity is being launched from history
4261 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004262 */
4263 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004264 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004265 * @deprecated As of API 21 this performs identically to
4266 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004267 */
4268 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004269 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004270 * This flag is used to open a document into a new task rooted at the activity launched
4271 * by this Intent. Through the use of this flag, or its equivalent attribute,
4272 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004273 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004274 *
Craig Mautner026596b2014-05-21 15:35:44 -07004275 * <p>The use of the activity attribute form of this,
4276 * {@link android.R.attr#documentLaunchMode}, is
4277 * preferred over the Intent flag described here. The attribute form allows the
4278 * Activity to specify multiple document behavior for all launchers of the Activity
4279 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004280 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004281 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4282 * it is kept after the activity is finished is different than the use of
4283 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4284 * this flag is being used to create a new recents entry, then by default that entry
4285 * will be removed once the activity is finished. You can modify this behavior with
4286 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4287 *
Craig Mautner026596b2014-05-21 15:35:44 -07004288 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4289 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4290 * equivalent of the Activity manifest specifying {@link
4291 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4292 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4293 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004294 *
Craig Mautner026596b2014-05-21 15:35:44 -07004295 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004296 *
Craig Mautner026596b2014-05-21 15:35:44 -07004297 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004298 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4299 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004300 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004301 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004302 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004303 * callback from occurring on the current frontmost activity before it is
4304 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004305 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004306 * <p>Typically, an activity can rely on that callback to indicate that an
4307 * explicit user action has caused their activity to be moved out of the
4308 * foreground. The callback marks an appropriate point in the activity's
4309 * lifecycle for it to dismiss any notifications that it intends to display
4310 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004311 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004312 * <p>If an activity is ever started via any non-user-driven events such as
4313 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4314 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004315 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004316 */
4317 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004318 /**
4319 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4320 * this flag will cause the launched activity to be brought to the front of its
4321 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004322 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004323 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4324 * If D calls startActivity() with an Intent that resolves to the component
4325 * of activity B, then B will be brought to the front of the history stack,
4326 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004327 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004328 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004329 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004330 */
4331 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004332 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004333 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4334 * this flag will prevent the system from applying an activity transition
4335 * animation to go to the next activity state. This doesn't mean an
4336 * animation will never run -- if another activity change happens that doesn't
4337 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004338 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004339 * when you are going to do a series of activity operations but the
4340 * animation seen by the user shouldn't be driven by the first activity
4341 * change but rather a later one.
4342 */
4343 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4344 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004345 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4346 * this flag will cause any existing task that would be associated with the
4347 * activity to be cleared before the activity is started. That is, the activity
4348 * becomes the new root of an otherwise empty task, and any old activities
4349 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4350 */
4351 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4352 /**
4353 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4354 * this flag will cause a newly launching task to be placed on top of the current
4355 * home activity task (if there is one). That is, pressing back from the task
4356 * will always return the user to home even if that was not the last activity they
4357 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4358 */
4359 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4360 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004361 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4362 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004363 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004364 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004365 * this flag. When set and the task's activity is finished, the recents
4366 * entry will remain in the interface for the user to re-launch it, like a
4367 * recents entry for a top-level application.
4368 * <p>
4369 * The receiving activity can override this request with
4370 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4371 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004372 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004373 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004374 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004375
4376 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004377 * If set, when sending a broadcast only registered receivers will be
4378 * called -- no BroadcastReceiver components will be launched.
4379 */
4380 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004381 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004382 * If set, when sending a broadcast the new broadcast will replace
4383 * any existing pending broadcast that matches it. Matching is defined
4384 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4385 * true for the intents of the two broadcasts. When a match is found,
4386 * the new broadcast (and receivers associated with it) will replace the
4387 * existing one in the pending broadcast list, remaining at the same
4388 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004389 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004390 * <p>This flag is most typically used with sticky broadcasts, which
4391 * only care about delivering the most recent values of the broadcast
4392 * to their receivers.
4393 */
4394 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4395 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004396 * If set, when sending a broadcast the recipient is allowed to run at
4397 * foreground priority, with a shorter timeout interval. During normal
4398 * broadcasts the receivers are not automatically hoisted out of the
4399 * background priority class.
4400 */
4401 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4402 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004403 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4404 * They can still propagate results through to later receivers, but they can not prevent
4405 * later receivers from seeing the broadcast.
4406 */
4407 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4408 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004409 * If set, when sending a broadcast <i>before boot has completed</i> only
4410 * registered receivers will be called -- no BroadcastReceiver components
4411 * will be launched. Sticky intent state will be recorded properly even
4412 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4413 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004414 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004415 * <p>This flag is only for use by system sevices as a convenience to
4416 * avoid having to implement a more complex mechanism around detection
4417 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004418 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004419 * @hide
4420 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004421 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004422 /**
4423 * Set when this broadcast is for a boot upgrade, a special mode that
4424 * allows the broadcast to be sent before the system is ready and launches
4425 * the app process with no providers running in it.
4426 * @hide
4427 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004428 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004429
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004430 /**
4431 * @hide Flags that can't be changed with PendingIntent.
4432 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004433 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4434 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4435 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004436
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004437 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004438 // ---------------------------------------------------------------------
4439 // toUri() and parseUri() options.
4440
4441 /**
4442 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4443 * always has the "intent:" scheme. This syntax can be used when you want
4444 * to later disambiguate between URIs that are intended to describe an
4445 * Intent vs. all others that should be treated as raw URIs. When used
4446 * with {@link #parseUri}, any other scheme will result in a generic
4447 * VIEW action for that raw URI.
4448 */
4449 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004450
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004451 /**
4452 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4453 * always has the "android-app:" scheme. This is a variation of
4454 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4455 * http/https URI being delivered to a specific package name. The format
4456 * is:
4457 *
4458 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004459 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004460 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004461 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4462 * you must also include a scheme; including a path also requires both a host and a scheme.
4463 * The final #Intent; fragment can be used without a scheme, host, or path.
4464 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004465 * used with intents that have a {@link #setSelector}, since the base intent
4466 * will always have an explicit package name.</p>
4467 *
4468 * <p>Some examples of how this scheme maps to Intent objects:</p>
4469 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4470 * <colgroup align="left" />
4471 * <colgroup align="left" />
4472 * <thead>
4473 * <tr><th>URI</th> <th>Intent</th></tr>
4474 * </thead>
4475 *
4476 * <tbody>
4477 * <tr><td><code>android-app://com.example.app</code></td>
4478 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4479 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4480 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4481 * </table></td>
4482 * </tr>
4483 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4484 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4485 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4486 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4487 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4488 * </table></td>
4489 * </tr>
4490 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4491 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4492 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4493 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4494 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4495 * </table></td>
4496 * </tr>
4497 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4498 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4499 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4500 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4501 * </table></td>
4502 * </tr>
4503 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4504 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4505 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4506 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4507 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4508 * </table></td>
4509 * </tr>
4510 * <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>
4511 * <td><table border="" style="margin:0" >
4512 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4513 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4514 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4515 * </table></td>
4516 * </tr>
4517 * </tbody>
4518 * </table>
4519 */
4520 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4521
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004522 /**
4523 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4524 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4525 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4526 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4527 * generated Intent can not cause unexpected data access to happen.
4528 *
4529 * <p>If you do not trust the source of the URI being parsed, you should still do further
4530 * processing to protect yourself from it. In particular, when using it to start an
4531 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4532 * that can handle it.</p>
4533 */
4534 public static final int URI_ALLOW_UNSAFE = 1<<2;
4535
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004536 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004537
4538 private String mAction;
4539 private Uri mData;
4540 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004541 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004542 private ComponentName mComponent;
4543 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004544 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004545 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004546 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004547 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004548 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004549 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004550
4551 // ---------------------------------------------------------------------
4552
4553 /**
4554 * Create an empty intent.
4555 */
4556 public Intent() {
4557 }
4558
4559 /**
4560 * Copy constructor.
4561 */
4562 public Intent(Intent o) {
4563 this.mAction = o.mAction;
4564 this.mData = o.mData;
4565 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004566 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004567 this.mComponent = o.mComponent;
4568 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004569 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004570 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004571 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004572 }
4573 if (o.mExtras != null) {
4574 this.mExtras = new Bundle(o.mExtras);
4575 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004576 if (o.mSourceBounds != null) {
4577 this.mSourceBounds = new Rect(o.mSourceBounds);
4578 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004579 if (o.mSelector != null) {
4580 this.mSelector = new Intent(o.mSelector);
4581 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004582 if (o.mClipData != null) {
4583 this.mClipData = new ClipData(o.mClipData);
4584 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004585 }
4586
4587 @Override
4588 public Object clone() {
4589 return new Intent(this);
4590 }
4591
4592 private Intent(Intent o, boolean all) {
4593 this.mAction = o.mAction;
4594 this.mData = o.mData;
4595 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004596 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004597 this.mComponent = o.mComponent;
4598 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004599 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004600 }
4601 }
4602
4603 /**
4604 * Make a clone of only the parts of the Intent that are relevant for
4605 * filter matching: the action, data, type, component, and categories.
4606 */
4607 public Intent cloneFilter() {
4608 return new Intent(this, false);
4609 }
4610
4611 /**
4612 * Create an intent with a given action. All other fields (data, type,
4613 * class) are null. Note that the action <em>must</em> be in a
4614 * namespace because Intents are used globally in the system -- for
4615 * example the system VIEW action is android.intent.action.VIEW; an
4616 * application's custom action would be something like
4617 * com.google.app.myapp.CUSTOM_ACTION.
4618 *
4619 * @param action The Intent action, such as ACTION_VIEW.
4620 */
4621 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004622 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004623 }
4624
4625 /**
4626 * Create an intent with a given action and for a given data url. Note
4627 * that the action <em>must</em> be in a namespace because Intents are
4628 * used globally in the system -- for example the system VIEW action is
4629 * android.intent.action.VIEW; an application's custom action would be
4630 * something like com.google.app.myapp.CUSTOM_ACTION.
4631 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004632 * <p><em>Note: scheme and host name matching in the Android framework is
4633 * case-sensitive, unlike the formal RFC. As a result,
4634 * you should always ensure that you write your Uri with these elements
4635 * using lower case letters, and normalize any Uris you receive from
4636 * outside of Android to ensure the scheme and host is lower case.</em></p>
4637 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004638 * @param action The Intent action, such as ACTION_VIEW.
4639 * @param uri The Intent data URI.
4640 */
4641 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004642 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004643 mData = uri;
4644 }
4645
4646 /**
4647 * Create an intent for a specific component. All other fields (action, data,
4648 * type, class) are null, though they can be modified later with explicit
4649 * calls. This provides a convenient way to create an intent that is
4650 * intended to execute a hard-coded class name, rather than relying on the
4651 * system to find an appropriate class for you; see {@link #setComponent}
4652 * for more information on the repercussions of this.
4653 *
4654 * @param packageContext A Context of the application package implementing
4655 * this class.
4656 * @param cls The component class that is to be used for the intent.
4657 *
4658 * @see #setClass
4659 * @see #setComponent
4660 * @see #Intent(String, android.net.Uri , Context, Class)
4661 */
4662 public Intent(Context packageContext, Class<?> cls) {
4663 mComponent = new ComponentName(packageContext, cls);
4664 }
4665
4666 /**
4667 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004668 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004669 * construct the Intent and then calling {@link #setClass} to set its
4670 * class.
4671 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004672 * <p><em>Note: scheme and host name matching in the Android framework is
4673 * case-sensitive, unlike the formal RFC. As a result,
4674 * you should always ensure that you write your Uri with these elements
4675 * using lower case letters, and normalize any Uris you receive from
4676 * outside of Android to ensure the scheme and host is lower case.</em></p>
4677 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004678 * @param action The Intent action, such as ACTION_VIEW.
4679 * @param uri The Intent data URI.
4680 * @param packageContext A Context of the application package implementing
4681 * this class.
4682 * @param cls The component class that is to be used for the intent.
4683 *
4684 * @see #Intent(String, android.net.Uri)
4685 * @see #Intent(Context, Class)
4686 * @see #setClass
4687 * @see #setComponent
4688 */
4689 public Intent(String action, Uri uri,
4690 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004691 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004692 mData = uri;
4693 mComponent = new ComponentName(packageContext, cls);
4694 }
4695
4696 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004697 * Create an intent to launch the main (root) activity of a task. This
4698 * is the Intent that is started when the application's is launched from
4699 * Home. For anything else that wants to launch an application in the
4700 * same way, it is important that they use an Intent structured the same
4701 * way, and can use this function to ensure this is the case.
4702 *
4703 * <p>The returned Intent has the given Activity component as its explicit
4704 * component, {@link #ACTION_MAIN} as its action, and includes the
4705 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4706 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4707 * to do that through {@link #addFlags(int)} on the returned Intent.
4708 *
4709 * @param mainActivity The main activity component that this Intent will
4710 * launch.
4711 * @return Returns a newly created Intent that can be used to launch the
4712 * activity as a main application entry.
4713 *
4714 * @see #setClass
4715 * @see #setComponent
4716 */
4717 public static Intent makeMainActivity(ComponentName mainActivity) {
4718 Intent intent = new Intent(ACTION_MAIN);
4719 intent.setComponent(mainActivity);
4720 intent.addCategory(CATEGORY_LAUNCHER);
4721 return intent;
4722 }
4723
4724 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004725 * Make an Intent for the main activity of an application, without
4726 * specifying a specific activity to run but giving a selector to find
4727 * the activity. This results in a final Intent that is structured
4728 * the same as when the application is launched from
4729 * Home. For anything else that wants to launch an application in the
4730 * same way, it is important that they use an Intent structured the same
4731 * way, and can use this function to ensure this is the case.
4732 *
4733 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4734 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4735 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4736 * to do that through {@link #addFlags(int)} on the returned Intent.
4737 *
4738 * @param selectorAction The action name of the Intent's selector.
4739 * @param selectorCategory The name of a category to add to the Intent's
4740 * selector.
4741 * @return Returns a newly created Intent that can be used to launch the
4742 * activity as a main application entry.
4743 *
4744 * @see #setSelector(Intent)
4745 */
4746 public static Intent makeMainSelectorActivity(String selectorAction,
4747 String selectorCategory) {
4748 Intent intent = new Intent(ACTION_MAIN);
4749 intent.addCategory(CATEGORY_LAUNCHER);
4750 Intent selector = new Intent();
4751 selector.setAction(selectorAction);
4752 selector.addCategory(selectorCategory);
4753 intent.setSelector(selector);
4754 return intent;
4755 }
4756
4757 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004758 * Make an Intent that can be used to re-launch an application's task
4759 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4760 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4761 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4762 *
4763 * @param mainActivity The activity component that is the root of the
4764 * task; this is the activity that has been published in the application's
4765 * manifest as the main launcher icon.
4766 *
4767 * @return Returns a newly created Intent that can be used to relaunch the
4768 * activity's task in its root state.
4769 */
4770 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4771 Intent intent = makeMainActivity(mainActivity);
4772 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4773 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4774 return intent;
4775 }
4776
4777 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004778 * Call {@link #parseUri} with 0 flags.
4779 * @deprecated Use {@link #parseUri} instead.
4780 */
4781 @Deprecated
4782 public static Intent getIntent(String uri) throws URISyntaxException {
4783 return parseUri(uri, 0);
4784 }
Tom Taylord4a47292009-12-21 13:59:18 -08004785
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004786 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004787 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004788 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004789 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004790 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004791 *
4792 * <p>The URI given here must not be relative -- that is, it must include
4793 * the scheme and full path.
4794 *
4795 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004796 * @param flags Additional processing flags. Either 0,
4797 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004798 *
4799 * @return Intent The newly created Intent object.
4800 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004801 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4802 * it bad (as parsed by the Uri class) or the Intent data within the
4803 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004804 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004805 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004806 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004807 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004808 int i = 0;
4809 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004810 final boolean androidApp = uri.startsWith("android-app:");
4811
4812 // Validate intent scheme if requested.
4813 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
4814 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004815 Intent intent = new Intent(ACTION_VIEW);
4816 try {
4817 intent.setData(Uri.parse(uri));
4818 } catch (IllegalArgumentException e) {
4819 throw new URISyntaxException(uri, e.getMessage());
4820 }
4821 return intent;
4822 }
4823 }
Tom Taylord4a47292009-12-21 13:59:18 -08004824
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004825 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004826 // simple case
4827 if (i == -1) {
4828 if (!androidApp) {
4829 return new Intent(ACTION_VIEW, Uri.parse(uri));
4830 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004831
4832 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004833 } else if (!uri.startsWith("#Intent;", i)) {
4834 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004835 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004836 } else {
4837 i = -1;
4838 }
4839 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004840
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004841 // new format
4842 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004843 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004844 boolean explicitAction = false;
4845 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004846
4847 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004848 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004849 String data;
4850 if (i >= 0) {
4851 data = uri.substring(0, i);
4852 i += 8; // length of "#Intent;"
4853 } else {
4854 data = uri;
4855 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004856
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004857 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004858 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004859 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004860 if (eq < 0) eq = i-1;
4861 int semi = uri.indexOf(';', i);
4862 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004863
4864 // action
4865 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004866 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004867 if (!inSelector) {
4868 explicitAction = true;
4869 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004870 }
4871
4872 // categories
4873 else if (uri.startsWith("category=", i)) {
4874 intent.addCategory(value);
4875 }
4876
4877 // type
4878 else if (uri.startsWith("type=", i)) {
4879 intent.mType = value;
4880 }
4881
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004882 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004883 else if (uri.startsWith("launchFlags=", i)) {
4884 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004885 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4886 intent.mFlags &= ~IMMUTABLE_FLAGS;
4887 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004888 }
4889
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004890 // package
4891 else if (uri.startsWith("package=", i)) {
4892 intent.mPackage = value;
4893 }
4894
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004895 // component
4896 else if (uri.startsWith("component=", i)) {
4897 intent.mComponent = ComponentName.unflattenFromString(value);
4898 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004899
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004900 // scheme
4901 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004902 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004903 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004904 } else {
4905 scheme = value;
4906 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004907 }
4908
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004909 // source bounds
4910 else if (uri.startsWith("sourceBounds=", i)) {
4911 intent.mSourceBounds = Rect.unflattenFromString(value);
4912 }
4913
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004914 // selector
4915 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4916 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004917 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004918 }
4919
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004920 // extra
4921 else {
4922 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004923 // create Bundle if it doesn't already exist
4924 if (intent.mExtras == null) intent.mExtras = new Bundle();
4925 Bundle b = intent.mExtras;
4926 // add EXTRA
4927 if (uri.startsWith("S.", i)) b.putString(key, value);
4928 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4929 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4930 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4931 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4932 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4933 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4934 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4935 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4936 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4937 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004938
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004939 // move to the next item
4940 i = semi + 1;
4941 }
4942
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004943 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004944 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004945 if (baseIntent.mPackage == null) {
4946 baseIntent.setSelector(intent);
4947 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004948 intent = baseIntent;
4949 }
4950
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004951 if (data != null) {
4952 if (data.startsWith("intent:")) {
4953 data = data.substring(7);
4954 if (scheme != null) {
4955 data = scheme + ':' + data;
4956 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004957 } else if (data.startsWith("android-app:")) {
4958 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
4959 // Correctly formed android-app, first part is package name.
4960 int end = data.indexOf('/', 14);
4961 if (end < 0) {
4962 // All we have is a package name.
4963 intent.mPackage = data.substring(14);
4964 if (!explicitAction) {
4965 intent.setAction(ACTION_MAIN);
4966 }
4967 data = "";
4968 } else {
4969 // Target the Intent at the given package name always.
4970 String authority = null;
4971 intent.mPackage = data.substring(14, end);
4972 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004973 if ((end+1) < data.length()) {
4974 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
4975 // Found a scheme, remember it.
4976 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004977 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004978 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
4979 // Found a authority, remember it.
4980 authority = data.substring(end+1, newEnd);
4981 end = newEnd;
4982 }
4983 } else {
4984 // All we have is a scheme.
4985 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004986 }
4987 }
4988 if (scheme == null) {
4989 // If there was no scheme, then this just targets the package.
4990 if (!explicitAction) {
4991 intent.setAction(ACTION_MAIN);
4992 }
4993 data = "";
4994 } else if (authority == null) {
4995 data = scheme + ":";
4996 } else {
4997 data = scheme + "://" + authority + data.substring(end);
4998 }
4999 }
5000 } else {
5001 data = "";
5002 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005003 }
Tom Taylord4a47292009-12-21 13:59:18 -08005004
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005005 if (data.length() > 0) {
5006 try {
5007 intent.mData = Uri.parse(data);
5008 } catch (IllegalArgumentException e) {
5009 throw new URISyntaxException(uri, e.getMessage());
5010 }
5011 }
5012 }
Tom Taylord4a47292009-12-21 13:59:18 -08005013
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005014 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005015
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005016 } catch (IndexOutOfBoundsException e) {
5017 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5018 }
5019 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005020
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005021 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005022 return getIntentOld(uri, 0);
5023 }
5024
5025 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005026 Intent intent;
5027
5028 int i = uri.lastIndexOf('#');
5029 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005030 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005031 final int intentFragmentStart = i;
5032 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005033
5034 i++;
5035
5036 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005037 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005038 i += 7;
5039 int j = uri.indexOf(')', i);
5040 action = uri.substring(i, j);
5041 i = j + 1;
5042 }
5043
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005044 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005045
5046 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005047 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005048 i += 11;
5049 int j = uri.indexOf(')', i);
5050 while (i < j) {
5051 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005052 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005053 if (i < sep) {
5054 intent.addCategory(uri.substring(i, sep));
5055 }
5056 i = sep + 1;
5057 }
5058 i = j + 1;
5059 }
5060
5061 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005062 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005063 i += 5;
5064 int j = uri.indexOf(')', i);
5065 intent.mType = uri.substring(i, j);
5066 i = j + 1;
5067 }
5068
5069 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005070 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005071 i += 12;
5072 int j = uri.indexOf(')', i);
5073 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005074 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5075 intent.mFlags &= ~IMMUTABLE_FLAGS;
5076 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005077 i = j + 1;
5078 }
5079
5080 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005081 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005082 i += 10;
5083 int j = uri.indexOf(')', i);
5084 int sep = uri.indexOf('!', i);
5085 if (sep >= 0 && sep < j) {
5086 String pkg = uri.substring(i, sep);
5087 String cls = uri.substring(sep + 1, j);
5088 intent.mComponent = new ComponentName(pkg, cls);
5089 }
5090 i = j + 1;
5091 }
5092
5093 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005094 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005095 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005096
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005097 final int closeParen = uri.indexOf(')', i);
5098 if (closeParen == -1) throw new URISyntaxException(uri,
5099 "EXTRA missing trailing ')'", i);
5100
5101 while (i < closeParen) {
5102 // fetch the key value
5103 int j = uri.indexOf('=', i);
5104 if (j <= i + 1 || i >= closeParen) {
5105 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5106 }
5107 char type = uri.charAt(i);
5108 i++;
5109 String key = uri.substring(i, j);
5110 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005111
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005112 // get type-value
5113 j = uri.indexOf('!', i);
5114 if (j == -1 || j >= closeParen) j = closeParen;
5115 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5116 String value = uri.substring(i, j);
5117 i = j;
5118
5119 // create Bundle if it doesn't already exist
5120 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005121
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005122 // add item to bundle
5123 try {
5124 switch (type) {
5125 case 'S':
5126 intent.mExtras.putString(key, Uri.decode(value));
5127 break;
5128 case 'B':
5129 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5130 break;
5131 case 'b':
5132 intent.mExtras.putByte(key, Byte.parseByte(value));
5133 break;
5134 case 'c':
5135 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5136 break;
5137 case 'd':
5138 intent.mExtras.putDouble(key, Double.parseDouble(value));
5139 break;
5140 case 'f':
5141 intent.mExtras.putFloat(key, Float.parseFloat(value));
5142 break;
5143 case 'i':
5144 intent.mExtras.putInt(key, Integer.parseInt(value));
5145 break;
5146 case 'l':
5147 intent.mExtras.putLong(key, Long.parseLong(value));
5148 break;
5149 case 's':
5150 intent.mExtras.putShort(key, Short.parseShort(value));
5151 break;
5152 default:
5153 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5154 }
5155 } catch (NumberFormatException e) {
5156 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5157 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005158
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005159 char ch = uri.charAt(i);
5160 if (ch == ')') break;
5161 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5162 i++;
5163 }
5164 }
5165
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005166 if (isIntentFragment) {
5167 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5168 } else {
5169 intent.mData = Uri.parse(uri);
5170 }
Tom Taylord4a47292009-12-21 13:59:18 -08005171
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005172 if (intent.mAction == null) {
5173 // By default, if no action is specified, then use VIEW.
5174 intent.mAction = ACTION_VIEW;
5175 }
5176
5177 } else {
5178 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5179 }
5180
5181 return intent;
5182 }
5183
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005184 /** @hide */
5185 public interface CommandOptionHandler {
5186 boolean handleOption(String opt, ShellCommand cmd);
5187 }
5188
5189 /** @hide */
5190 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5191 throws URISyntaxException {
5192 Intent intent = new Intent();
5193 Intent baseIntent = intent;
5194 boolean hasIntentInfo = false;
5195
5196 Uri data = null;
5197 String type = null;
5198
5199 String opt;
5200 while ((opt=cmd.getNextOption()) != null) {
5201 switch (opt) {
5202 case "-a":
5203 intent.setAction(cmd.getNextArgRequired());
5204 if (intent == baseIntent) {
5205 hasIntentInfo = true;
5206 }
5207 break;
5208 case "-d":
5209 data = Uri.parse(cmd.getNextArgRequired());
5210 if (intent == baseIntent) {
5211 hasIntentInfo = true;
5212 }
5213 break;
5214 case "-t":
5215 type = cmd.getNextArgRequired();
5216 if (intent == baseIntent) {
5217 hasIntentInfo = true;
5218 }
5219 break;
5220 case "-c":
5221 intent.addCategory(cmd.getNextArgRequired());
5222 if (intent == baseIntent) {
5223 hasIntentInfo = true;
5224 }
5225 break;
5226 case "-e":
5227 case "--es": {
5228 String key = cmd.getNextArgRequired();
5229 String value = cmd.getNextArgRequired();
5230 intent.putExtra(key, value);
5231 }
5232 break;
5233 case "--esn": {
5234 String key = cmd.getNextArgRequired();
5235 intent.putExtra(key, (String) null);
5236 }
5237 break;
5238 case "--ei": {
5239 String key = cmd.getNextArgRequired();
5240 String value = cmd.getNextArgRequired();
5241 intent.putExtra(key, Integer.decode(value));
5242 }
5243 break;
5244 case "--eu": {
5245 String key = cmd.getNextArgRequired();
5246 String value = cmd.getNextArgRequired();
5247 intent.putExtra(key, Uri.parse(value));
5248 }
5249 break;
5250 case "--ecn": {
5251 String key = cmd.getNextArgRequired();
5252 String value = cmd.getNextArgRequired();
5253 ComponentName cn = ComponentName.unflattenFromString(value);
5254 if (cn == null)
5255 throw new IllegalArgumentException("Bad component name: " + value);
5256 intent.putExtra(key, cn);
5257 }
5258 break;
5259 case "--eia": {
5260 String key = cmd.getNextArgRequired();
5261 String value = cmd.getNextArgRequired();
5262 String[] strings = value.split(",");
5263 int[] list = new int[strings.length];
5264 for (int i = 0; i < strings.length; i++) {
5265 list[i] = Integer.decode(strings[i]);
5266 }
5267 intent.putExtra(key, list);
5268 }
5269 break;
5270 case "--eial": {
5271 String key = cmd.getNextArgRequired();
5272 String value = cmd.getNextArgRequired();
5273 String[] strings = value.split(",");
5274 ArrayList<Integer> list = new ArrayList<>(strings.length);
5275 for (int i = 0; i < strings.length; i++) {
5276 list.add(Integer.decode(strings[i]));
5277 }
5278 intent.putExtra(key, list);
5279 }
5280 break;
5281 case "--el": {
5282 String key = cmd.getNextArgRequired();
5283 String value = cmd.getNextArgRequired();
5284 intent.putExtra(key, Long.valueOf(value));
5285 }
5286 break;
5287 case "--ela": {
5288 String key = cmd.getNextArgRequired();
5289 String value = cmd.getNextArgRequired();
5290 String[] strings = value.split(",");
5291 long[] list = new long[strings.length];
5292 for (int i = 0; i < strings.length; i++) {
5293 list[i] = Long.valueOf(strings[i]);
5294 }
5295 intent.putExtra(key, list);
5296 hasIntentInfo = true;
5297 }
5298 break;
5299 case "--elal": {
5300 String key = cmd.getNextArgRequired();
5301 String value = cmd.getNextArgRequired();
5302 String[] strings = value.split(",");
5303 ArrayList<Long> list = new ArrayList<>(strings.length);
5304 for (int i = 0; i < strings.length; i++) {
5305 list.add(Long.valueOf(strings[i]));
5306 }
5307 intent.putExtra(key, list);
5308 hasIntentInfo = true;
5309 }
5310 break;
5311 case "--ef": {
5312 String key = cmd.getNextArgRequired();
5313 String value = cmd.getNextArgRequired();
5314 intent.putExtra(key, Float.valueOf(value));
5315 hasIntentInfo = true;
5316 }
5317 break;
5318 case "--efa": {
5319 String key = cmd.getNextArgRequired();
5320 String value = cmd.getNextArgRequired();
5321 String[] strings = value.split(",");
5322 float[] list = new float[strings.length];
5323 for (int i = 0; i < strings.length; i++) {
5324 list[i] = Float.valueOf(strings[i]);
5325 }
5326 intent.putExtra(key, list);
5327 hasIntentInfo = true;
5328 }
5329 break;
5330 case "--efal": {
5331 String key = cmd.getNextArgRequired();
5332 String value = cmd.getNextArgRequired();
5333 String[] strings = value.split(",");
5334 ArrayList<Float> list = new ArrayList<>(strings.length);
5335 for (int i = 0; i < strings.length; i++) {
5336 list.add(Float.valueOf(strings[i]));
5337 }
5338 intent.putExtra(key, list);
5339 hasIntentInfo = true;
5340 }
5341 break;
5342 case "--esa": {
5343 String key = cmd.getNextArgRequired();
5344 String value = cmd.getNextArgRequired();
5345 // Split on commas unless they are preceeded by an escape.
5346 // The escape character must be escaped for the string and
5347 // again for the regex, thus four escape characters become one.
5348 String[] strings = value.split("(?<!\\\\),");
5349 intent.putExtra(key, strings);
5350 hasIntentInfo = true;
5351 }
5352 break;
5353 case "--esal": {
5354 String key = cmd.getNextArgRequired();
5355 String value = cmd.getNextArgRequired();
5356 // Split on commas unless they are preceeded by an escape.
5357 // The escape character must be escaped for the string and
5358 // again for the regex, thus four escape characters become one.
5359 String[] strings = value.split("(?<!\\\\),");
5360 ArrayList<String> list = new ArrayList<>(strings.length);
5361 for (int i = 0; i < strings.length; i++) {
5362 list.add(strings[i]);
5363 }
5364 intent.putExtra(key, list);
5365 hasIntentInfo = true;
5366 }
5367 break;
5368 case "--ez": {
5369 String key = cmd.getNextArgRequired();
5370 String value = cmd.getNextArgRequired().toLowerCase();
5371 // Boolean.valueOf() results in false for anything that is not "true", which is
5372 // error-prone in shell commands
5373 boolean arg;
5374 if ("true".equals(value) || "t".equals(value)) {
5375 arg = true;
5376 } else if ("false".equals(value) || "f".equals(value)) {
5377 arg = false;
5378 } else {
5379 try {
5380 arg = Integer.decode(value) != 0;
5381 } catch (NumberFormatException ex) {
5382 throw new IllegalArgumentException("Invalid boolean value: " + value);
5383 }
5384 }
5385
5386 intent.putExtra(key, arg);
5387 }
5388 break;
5389 case "-n": {
5390 String str = cmd.getNextArgRequired();
5391 ComponentName cn = ComponentName.unflattenFromString(str);
5392 if (cn == null)
5393 throw new IllegalArgumentException("Bad component name: " + str);
5394 intent.setComponent(cn);
5395 if (intent == baseIntent) {
5396 hasIntentInfo = true;
5397 }
5398 }
5399 break;
5400 case "-p": {
5401 String str = cmd.getNextArgRequired();
5402 intent.setPackage(str);
5403 if (intent == baseIntent) {
5404 hasIntentInfo = true;
5405 }
5406 }
5407 break;
5408 case "-f":
5409 String str = cmd.getNextArgRequired();
5410 intent.setFlags(Integer.decode(str).intValue());
5411 break;
5412 case "--grant-read-uri-permission":
5413 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5414 break;
5415 case "--grant-write-uri-permission":
5416 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5417 break;
5418 case "--grant-persistable-uri-permission":
5419 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5420 break;
5421 case "--grant-prefix-uri-permission":
5422 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5423 break;
5424 case "--exclude-stopped-packages":
5425 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5426 break;
5427 case "--include-stopped-packages":
5428 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5429 break;
5430 case "--debug-log-resolution":
5431 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5432 break;
5433 case "--activity-brought-to-front":
5434 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5435 break;
5436 case "--activity-clear-top":
5437 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5438 break;
5439 case "--activity-clear-when-task-reset":
5440 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5441 break;
5442 case "--activity-exclude-from-recents":
5443 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5444 break;
5445 case "--activity-launched-from-history":
5446 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5447 break;
5448 case "--activity-multiple-task":
5449 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5450 break;
5451 case "--activity-no-animation":
5452 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5453 break;
5454 case "--activity-no-history":
5455 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5456 break;
5457 case "--activity-no-user-action":
5458 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5459 break;
5460 case "--activity-previous-is-top":
5461 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5462 break;
5463 case "--activity-reorder-to-front":
5464 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5465 break;
5466 case "--activity-reset-task-if-needed":
5467 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5468 break;
5469 case "--activity-single-top":
5470 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5471 break;
5472 case "--activity-clear-task":
5473 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5474 break;
5475 case "--activity-task-on-home":
5476 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5477 break;
5478 case "--receiver-registered-only":
5479 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5480 break;
5481 case "--receiver-replace-pending":
5482 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5483 break;
5484 case "--selector":
5485 intent.setDataAndType(data, type);
5486 intent = new Intent();
5487 break;
5488 default:
5489 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5490 // Okay, caller handled this option.
5491 } else {
5492 throw new IllegalArgumentException("Unknown option: " + opt);
5493 }
5494 break;
5495 }
5496 }
5497 intent.setDataAndType(data, type);
5498
5499 final boolean hasSelector = intent != baseIntent;
5500 if (hasSelector) {
5501 // A selector was specified; fix up.
5502 baseIntent.setSelector(intent);
5503 intent = baseIntent;
5504 }
5505
5506 String arg = cmd.getNextArg();
5507 baseIntent = null;
5508 if (arg == null) {
5509 if (hasSelector) {
5510 // If a selector has been specified, and no arguments
5511 // have been supplied for the main Intent, then we can
5512 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5513 // need to have a component name specified yet, the
5514 // selector will take care of that.
5515 baseIntent = new Intent(Intent.ACTION_MAIN);
5516 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5517 }
5518 } else if (arg.indexOf(':') >= 0) {
5519 // The argument is a URI. Fully parse it, and use that result
5520 // to fill in any data not specified so far.
5521 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5522 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5523 } else if (arg.indexOf('/') >= 0) {
5524 // The argument is a component name. Build an Intent to launch
5525 // it.
5526 baseIntent = new Intent(Intent.ACTION_MAIN);
5527 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5528 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5529 } else {
5530 // Assume the argument is a package name.
5531 baseIntent = new Intent(Intent.ACTION_MAIN);
5532 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5533 baseIntent.setPackage(arg);
5534 }
5535 if (baseIntent != null) {
5536 Bundle extras = intent.getExtras();
5537 intent.replaceExtras((Bundle)null);
5538 Bundle uriExtras = baseIntent.getExtras();
5539 baseIntent.replaceExtras((Bundle)null);
5540 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5541 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5542 for (String c : cats) {
5543 baseIntent.removeCategory(c);
5544 }
5545 }
5546 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5547 if (extras == null) {
5548 extras = uriExtras;
5549 } else if (uriExtras != null) {
5550 uriExtras.putAll(extras);
5551 extras = uriExtras;
5552 }
5553 intent.replaceExtras(extras);
5554 hasIntentInfo = true;
5555 }
5556
5557 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5558 return intent;
5559 }
5560
5561 /** @hide */
5562 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5563 final String[] lines = new String[] {
5564 "<INTENT> specifications include these flags and arguments:",
5565 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5566 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5567 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5568 " [--esn <EXTRA_KEY> ...]",
5569 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5570 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5571 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5572 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5573 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5574 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5575 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5576 " (mutiple extras passed as Integer[])",
5577 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5578 " (mutiple extras passed as List<Integer>)",
5579 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5580 " (mutiple extras passed as Long[])",
5581 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5582 " (mutiple extras passed as List<Long>)",
5583 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5584 " (mutiple extras passed as Float[])",
5585 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5586 " (mutiple extras passed as List<Float>)",
5587 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5588 " (mutiple extras passed as String[]; to embed a comma into a string,",
5589 " escape it using \"\\,\")",
5590 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5591 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5592 " escape it using \"\\,\")",
5593 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5594 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5595 " [--debug-log-resolution] [--exclude-stopped-packages]",
5596 " [--include-stopped-packages]",
5597 " [--activity-brought-to-front] [--activity-clear-top]",
5598 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5599 " [--activity-launched-from-history] [--activity-multiple-task]",
5600 " [--activity-no-animation] [--activity-no-history]",
5601 " [--activity-no-user-action] [--activity-previous-is-top]",
5602 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5603 " [--activity-single-top] [--activity-clear-task]",
5604 " [--activity-task-on-home]",
5605 " [--receiver-registered-only] [--receiver-replace-pending]",
5606 " [--selector]",
5607 " [<URI> | <PACKAGE> | <COMPONENT>]"
5608 };
5609 for (String line : lines) {
5610 pw.print(prefix);
5611 pw.println(line);
5612 }
5613 }
5614
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005615 /**
5616 * Retrieve the general action to be performed, such as
5617 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5618 * the information in the intent should be interpreted -- most importantly,
5619 * what to do with the data returned by {@link #getData}.
5620 *
5621 * @return The action of this intent or null if none is specified.
5622 *
5623 * @see #setAction
5624 */
5625 public String getAction() {
5626 return mAction;
5627 }
5628
5629 /**
5630 * Retrieve data this intent is operating on. This URI specifies the name
5631 * of the data; often it uses the content: scheme, specifying data in a
5632 * content provider. Other schemes may be handled by specific activities,
5633 * such as http: by the web browser.
5634 *
5635 * @return The URI of the data this intent is targeting or null.
5636 *
5637 * @see #getScheme
5638 * @see #setData
5639 */
5640 public Uri getData() {
5641 return mData;
5642 }
5643
5644 /**
5645 * The same as {@link #getData()}, but returns the URI as an encoded
5646 * String.
5647 */
5648 public String getDataString() {
5649 return mData != null ? mData.toString() : null;
5650 }
5651
5652 /**
5653 * Return the scheme portion of the intent's data. If the data is null or
5654 * does not include a scheme, null is returned. Otherwise, the scheme
5655 * prefix without the final ':' is returned, i.e. "http".
5656 *
5657 * <p>This is the same as calling getData().getScheme() (and checking for
5658 * null data).
5659 *
5660 * @return The scheme of this intent.
5661 *
5662 * @see #getData
5663 */
5664 public String getScheme() {
5665 return mData != null ? mData.getScheme() : null;
5666 }
5667
5668 /**
5669 * Retrieve any explicit MIME type included in the intent. This is usually
5670 * null, as the type is determined by the intent data.
5671 *
5672 * @return If a type was manually set, it is returned; else null is
5673 * returned.
5674 *
5675 * @see #resolveType(ContentResolver)
5676 * @see #setType
5677 */
5678 public String getType() {
5679 return mType;
5680 }
5681
5682 /**
5683 * Return the MIME data type of this intent. If the type field is
5684 * explicitly set, that is simply returned. Otherwise, if the data is set,
5685 * the type of that data is returned. If neither fields are set, a null is
5686 * returned.
5687 *
5688 * @return The MIME type of this intent.
5689 *
5690 * @see #getType
5691 * @see #resolveType(ContentResolver)
5692 */
5693 public String resolveType(Context context) {
5694 return resolveType(context.getContentResolver());
5695 }
5696
5697 /**
5698 * Return the MIME data type of this intent. If the type field is
5699 * explicitly set, that is simply returned. Otherwise, if the data is set,
5700 * the type of that data is returned. If neither fields are set, a null is
5701 * returned.
5702 *
5703 * @param resolver A ContentResolver that can be used to determine the MIME
5704 * type of the intent's data.
5705 *
5706 * @return The MIME type of this intent.
5707 *
5708 * @see #getType
5709 * @see #resolveType(Context)
5710 */
5711 public String resolveType(ContentResolver resolver) {
5712 if (mType != null) {
5713 return mType;
5714 }
5715 if (mData != null) {
5716 if ("content".equals(mData.getScheme())) {
5717 return resolver.getType(mData);
5718 }
5719 }
5720 return null;
5721 }
5722
5723 /**
5724 * Return the MIME data type of this intent, only if it will be needed for
5725 * intent resolution. This is not generally useful for application code;
5726 * it is used by the frameworks for communicating with back-end system
5727 * services.
5728 *
5729 * @param resolver A ContentResolver that can be used to determine the MIME
5730 * type of the intent's data.
5731 *
5732 * @return The MIME type of this intent, or null if it is unknown or not
5733 * needed.
5734 */
5735 public String resolveTypeIfNeeded(ContentResolver resolver) {
5736 if (mComponent != null) {
5737 return mType;
5738 }
5739 return resolveType(resolver);
5740 }
5741
5742 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005743 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005744 *
5745 * @param category The category to check.
5746 *
5747 * @return boolean True if the intent contains the category, else false.
5748 *
5749 * @see #getCategories
5750 * @see #addCategory
5751 */
5752 public boolean hasCategory(String category) {
5753 return mCategories != null && mCategories.contains(category);
5754 }
5755
5756 /**
5757 * Return the set of all categories in the intent. If there are no categories,
5758 * returns NULL.
5759 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005760 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005761 *
5762 * @see #hasCategory
5763 * @see #addCategory
5764 */
5765 public Set<String> getCategories() {
5766 return mCategories;
5767 }
5768
5769 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005770 * Return the specific selector associated with this Intent. If there is
5771 * none, returns null. See {@link #setSelector} for more information.
5772 *
5773 * @see #setSelector
5774 */
5775 public Intent getSelector() {
5776 return mSelector;
5777 }
5778
5779 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005780 * Return the {@link ClipData} associated with this Intent. If there is
5781 * none, returns null. See {@link #setClipData} for more information.
5782 *
John Spurlock125d1332013-11-25 11:58:37 -05005783 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005784 */
5785 public ClipData getClipData() {
5786 return mClipData;
5787 }
5788
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005789 /** @hide */
5790 public int getContentUserHint() {
5791 return mContentUserHint;
5792 }
5793
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005794 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005795 * Sets the ClassLoader that will be used when unmarshalling
5796 * any Parcelable values from the extras of this Intent.
5797 *
5798 * @param loader a ClassLoader, or null to use the default loader
5799 * at the time of unmarshalling.
5800 */
5801 public void setExtrasClassLoader(ClassLoader loader) {
5802 if (mExtras != null) {
5803 mExtras.setClassLoader(loader);
5804 }
5805 }
5806
5807 /**
5808 * Returns true if an extra value is associated with the given name.
5809 * @param name the extra's name
5810 * @return true if the given extra is present.
5811 */
5812 public boolean hasExtra(String name) {
5813 return mExtras != null && mExtras.containsKey(name);
5814 }
5815
5816 /**
5817 * Returns true if the Intent's extras contain a parcelled file descriptor.
5818 * @return true if the Intent contains a parcelled file descriptor.
5819 */
5820 public boolean hasFileDescriptors() {
5821 return mExtras != null && mExtras.hasFileDescriptors();
5822 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005823
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04005824 /** @hide */
5825 public void setAllowFds(boolean allowFds) {
5826 if (mExtras != null) {
5827 mExtras.setAllowFds(allowFds);
5828 }
5829 }
5830
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005831 /**
5832 * Retrieve extended data from the intent.
5833 *
5834 * @param name The name of the desired item.
5835 *
5836 * @return the value of an item that previously added with putExtra()
5837 * or null if none was found.
5838 *
5839 * @deprecated
5840 * @hide
5841 */
5842 @Deprecated
5843 public Object getExtra(String name) {
5844 return getExtra(name, null);
5845 }
5846
5847 /**
5848 * Retrieve extended data from the intent.
5849 *
5850 * @param name The name of the desired item.
5851 * @param defaultValue the value to be returned if no value of the desired
5852 * type is stored with the given name.
5853 *
5854 * @return the value of an item that previously added with putExtra()
5855 * or the default value if none was found.
5856 *
5857 * @see #putExtra(String, boolean)
5858 */
5859 public boolean getBooleanExtra(String name, boolean defaultValue) {
5860 return mExtras == null ? defaultValue :
5861 mExtras.getBoolean(name, defaultValue);
5862 }
5863
5864 /**
5865 * Retrieve extended data from the intent.
5866 *
5867 * @param name The name of the desired item.
5868 * @param defaultValue the value to be returned if no value of the desired
5869 * type is stored with the given name.
5870 *
5871 * @return the value of an item that previously added with putExtra()
5872 * or the default value if none was found.
5873 *
5874 * @see #putExtra(String, byte)
5875 */
5876 public byte getByteExtra(String name, byte defaultValue) {
5877 return mExtras == null ? defaultValue :
5878 mExtras.getByte(name, defaultValue);
5879 }
5880
5881 /**
5882 * Retrieve extended data from the intent.
5883 *
5884 * @param name The name of the desired item.
5885 * @param defaultValue the value to be returned if no value of the desired
5886 * type is stored with the given name.
5887 *
5888 * @return the value of an item that previously added with putExtra()
5889 * or the default value if none was found.
5890 *
5891 * @see #putExtra(String, short)
5892 */
5893 public short getShortExtra(String name, short defaultValue) {
5894 return mExtras == null ? defaultValue :
5895 mExtras.getShort(name, defaultValue);
5896 }
5897
5898 /**
5899 * Retrieve extended data from the intent.
5900 *
5901 * @param name The name of the desired item.
5902 * @param defaultValue the value to be returned if no value of the desired
5903 * type is stored with the given name.
5904 *
5905 * @return the value of an item that previously added with putExtra()
5906 * or the default value if none was found.
5907 *
5908 * @see #putExtra(String, char)
5909 */
5910 public char getCharExtra(String name, char defaultValue) {
5911 return mExtras == null ? defaultValue :
5912 mExtras.getChar(name, defaultValue);
5913 }
5914
5915 /**
5916 * Retrieve extended data from the intent.
5917 *
5918 * @param name The name of the desired item.
5919 * @param defaultValue the value to be returned if no value of the desired
5920 * type is stored with the given name.
5921 *
5922 * @return the value of an item that previously added with putExtra()
5923 * or the default value if none was found.
5924 *
5925 * @see #putExtra(String, int)
5926 */
5927 public int getIntExtra(String name, int defaultValue) {
5928 return mExtras == null ? defaultValue :
5929 mExtras.getInt(name, defaultValue);
5930 }
5931
5932 /**
5933 * Retrieve extended data from the intent.
5934 *
5935 * @param name The name of the desired item.
5936 * @param defaultValue the value to be returned if no value of the desired
5937 * type is stored with the given name.
5938 *
5939 * @return the value of an item that previously added with putExtra()
5940 * or the default value if none was found.
5941 *
5942 * @see #putExtra(String, long)
5943 */
5944 public long getLongExtra(String name, long defaultValue) {
5945 return mExtras == null ? defaultValue :
5946 mExtras.getLong(name, defaultValue);
5947 }
5948
5949 /**
5950 * Retrieve extended data from the intent.
5951 *
5952 * @param name The name of the desired item.
5953 * @param defaultValue the value to be returned if no value of the desired
5954 * type is stored with the given name.
5955 *
5956 * @return the value of an item that previously added with putExtra(),
5957 * or the default value if no such item is present
5958 *
5959 * @see #putExtra(String, float)
5960 */
5961 public float getFloatExtra(String name, float defaultValue) {
5962 return mExtras == null ? defaultValue :
5963 mExtras.getFloat(name, defaultValue);
5964 }
5965
5966 /**
5967 * Retrieve extended data from the intent.
5968 *
5969 * @param name The name of the desired item.
5970 * @param defaultValue the value to be returned if no value of the desired
5971 * type is stored with the given name.
5972 *
5973 * @return the value of an item that previously added with putExtra()
5974 * or the default value if none was found.
5975 *
5976 * @see #putExtra(String, double)
5977 */
5978 public double getDoubleExtra(String name, double defaultValue) {
5979 return mExtras == null ? defaultValue :
5980 mExtras.getDouble(name, defaultValue);
5981 }
5982
5983 /**
5984 * Retrieve extended data from the intent.
5985 *
5986 * @param name The name of the desired item.
5987 *
5988 * @return the value of an item that previously added with putExtra()
5989 * or null if no String value was found.
5990 *
5991 * @see #putExtra(String, String)
5992 */
5993 public String getStringExtra(String name) {
5994 return mExtras == null ? null : mExtras.getString(name);
5995 }
5996
5997 /**
5998 * Retrieve extended data from the intent.
5999 *
6000 * @param name The name of the desired item.
6001 *
6002 * @return the value of an item that previously added with putExtra()
6003 * or null if no CharSequence value was found.
6004 *
6005 * @see #putExtra(String, CharSequence)
6006 */
6007 public CharSequence getCharSequenceExtra(String name) {
6008 return mExtras == null ? null : mExtras.getCharSequence(name);
6009 }
6010
6011 /**
6012 * Retrieve extended data from the intent.
6013 *
6014 * @param name The name of the desired item.
6015 *
6016 * @return the value of an item that previously added with putExtra()
6017 * or null if no Parcelable value was found.
6018 *
6019 * @see #putExtra(String, Parcelable)
6020 */
6021 public <T extends Parcelable> T getParcelableExtra(String name) {
6022 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6023 }
6024
6025 /**
6026 * Retrieve extended data from the intent.
6027 *
6028 * @param name The name of the desired item.
6029 *
6030 * @return the value of an item that previously added with putExtra()
6031 * or null if no Parcelable[] value was found.
6032 *
6033 * @see #putExtra(String, Parcelable[])
6034 */
6035 public Parcelable[] getParcelableArrayExtra(String name) {
6036 return mExtras == null ? null : mExtras.getParcelableArray(name);
6037 }
6038
6039 /**
6040 * Retrieve extended data from the intent.
6041 *
6042 * @param name The name of the desired item.
6043 *
6044 * @return the value of an item that previously added with putExtra()
6045 * or null if no ArrayList<Parcelable> value was found.
6046 *
6047 * @see #putParcelableArrayListExtra(String, ArrayList)
6048 */
6049 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6050 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6051 }
6052
6053 /**
6054 * Retrieve extended data from the intent.
6055 *
6056 * @param name The name of the desired item.
6057 *
6058 * @return the value of an item that previously added with putExtra()
6059 * or null if no Serializable value was found.
6060 *
6061 * @see #putExtra(String, Serializable)
6062 */
6063 public Serializable getSerializableExtra(String name) {
6064 return mExtras == null ? null : mExtras.getSerializable(name);
6065 }
6066
6067 /**
6068 * Retrieve extended data from the intent.
6069 *
6070 * @param name The name of the desired item.
6071 *
6072 * @return the value of an item that previously added with putExtra()
6073 * or null if no ArrayList<Integer> value was found.
6074 *
6075 * @see #putIntegerArrayListExtra(String, ArrayList)
6076 */
6077 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6078 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6079 }
6080
6081 /**
6082 * Retrieve extended data from the intent.
6083 *
6084 * @param name The name of the desired item.
6085 *
6086 * @return the value of an item that previously added with putExtra()
6087 * or null if no ArrayList<String> value was found.
6088 *
6089 * @see #putStringArrayListExtra(String, ArrayList)
6090 */
6091 public ArrayList<String> getStringArrayListExtra(String name) {
6092 return mExtras == null ? null : mExtras.getStringArrayList(name);
6093 }
6094
6095 /**
6096 * Retrieve extended data from the intent.
6097 *
6098 * @param name The name of the desired item.
6099 *
6100 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006101 * or null if no ArrayList<CharSequence> value was found.
6102 *
6103 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6104 */
6105 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6106 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6107 }
6108
6109 /**
6110 * Retrieve extended data from the intent.
6111 *
6112 * @param name The name of the desired item.
6113 *
6114 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006115 * or null if no boolean array value was found.
6116 *
6117 * @see #putExtra(String, boolean[])
6118 */
6119 public boolean[] getBooleanArrayExtra(String name) {
6120 return mExtras == null ? null : mExtras.getBooleanArray(name);
6121 }
6122
6123 /**
6124 * Retrieve extended data from the intent.
6125 *
6126 * @param name The name of the desired item.
6127 *
6128 * @return the value of an item that previously added with putExtra()
6129 * or null if no byte array value was found.
6130 *
6131 * @see #putExtra(String, byte[])
6132 */
6133 public byte[] getByteArrayExtra(String name) {
6134 return mExtras == null ? null : mExtras.getByteArray(name);
6135 }
6136
6137 /**
6138 * Retrieve extended data from the intent.
6139 *
6140 * @param name The name of the desired item.
6141 *
6142 * @return the value of an item that previously added with putExtra()
6143 * or null if no short array value was found.
6144 *
6145 * @see #putExtra(String, short[])
6146 */
6147 public short[] getShortArrayExtra(String name) {
6148 return mExtras == null ? null : mExtras.getShortArray(name);
6149 }
6150
6151 /**
6152 * Retrieve extended data from the intent.
6153 *
6154 * @param name The name of the desired item.
6155 *
6156 * @return the value of an item that previously added with putExtra()
6157 * or null if no char array value was found.
6158 *
6159 * @see #putExtra(String, char[])
6160 */
6161 public char[] getCharArrayExtra(String name) {
6162 return mExtras == null ? null : mExtras.getCharArray(name);
6163 }
6164
6165 /**
6166 * Retrieve extended data from the intent.
6167 *
6168 * @param name The name of the desired item.
6169 *
6170 * @return the value of an item that previously added with putExtra()
6171 * or null if no int array value was found.
6172 *
6173 * @see #putExtra(String, int[])
6174 */
6175 public int[] getIntArrayExtra(String name) {
6176 return mExtras == null ? null : mExtras.getIntArray(name);
6177 }
6178
6179 /**
6180 * Retrieve extended data from the intent.
6181 *
6182 * @param name The name of the desired item.
6183 *
6184 * @return the value of an item that previously added with putExtra()
6185 * or null if no long array value was found.
6186 *
6187 * @see #putExtra(String, long[])
6188 */
6189 public long[] getLongArrayExtra(String name) {
6190 return mExtras == null ? null : mExtras.getLongArray(name);
6191 }
6192
6193 /**
6194 * Retrieve extended data from the intent.
6195 *
6196 * @param name The name of the desired item.
6197 *
6198 * @return the value of an item that previously added with putExtra()
6199 * or null if no float array value was found.
6200 *
6201 * @see #putExtra(String, float[])
6202 */
6203 public float[] getFloatArrayExtra(String name) {
6204 return mExtras == null ? null : mExtras.getFloatArray(name);
6205 }
6206
6207 /**
6208 * Retrieve extended data from the intent.
6209 *
6210 * @param name The name of the desired item.
6211 *
6212 * @return the value of an item that previously added with putExtra()
6213 * or null if no double array value was found.
6214 *
6215 * @see #putExtra(String, double[])
6216 */
6217 public double[] getDoubleArrayExtra(String name) {
6218 return mExtras == null ? null : mExtras.getDoubleArray(name);
6219 }
6220
6221 /**
6222 * Retrieve extended data from the intent.
6223 *
6224 * @param name The name of the desired item.
6225 *
6226 * @return the value of an item that previously added with putExtra()
6227 * or null if no String array value was found.
6228 *
6229 * @see #putExtra(String, String[])
6230 */
6231 public String[] getStringArrayExtra(String name) {
6232 return mExtras == null ? null : mExtras.getStringArray(name);
6233 }
6234
6235 /**
6236 * Retrieve extended data from the intent.
6237 *
6238 * @param name The name of the desired item.
6239 *
6240 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006241 * or null if no CharSequence array value was found.
6242 *
6243 * @see #putExtra(String, CharSequence[])
6244 */
6245 public CharSequence[] getCharSequenceArrayExtra(String name) {
6246 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6247 }
6248
6249 /**
6250 * Retrieve extended data from the intent.
6251 *
6252 * @param name The name of the desired item.
6253 *
6254 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006255 * or null if no Bundle value was found.
6256 *
6257 * @see #putExtra(String, Bundle)
6258 */
6259 public Bundle getBundleExtra(String name) {
6260 return mExtras == null ? null : mExtras.getBundle(name);
6261 }
6262
6263 /**
6264 * Retrieve extended data from the intent.
6265 *
6266 * @param name The name of the desired item.
6267 *
6268 * @return the value of an item that previously added with putExtra()
6269 * or null if no IBinder value was found.
6270 *
6271 * @see #putExtra(String, IBinder)
6272 *
6273 * @deprecated
6274 * @hide
6275 */
6276 @Deprecated
6277 public IBinder getIBinderExtra(String name) {
6278 return mExtras == null ? null : mExtras.getIBinder(name);
6279 }
6280
6281 /**
6282 * Retrieve extended data from the intent.
6283 *
6284 * @param name The name of the desired item.
6285 * @param defaultValue The default value to return in case no item is
6286 * associated with the key 'name'
6287 *
6288 * @return the value of an item that previously added with putExtra()
6289 * or defaultValue if none was found.
6290 *
6291 * @see #putExtra
6292 *
6293 * @deprecated
6294 * @hide
6295 */
6296 @Deprecated
6297 public Object getExtra(String name, Object defaultValue) {
6298 Object result = defaultValue;
6299 if (mExtras != null) {
6300 Object result2 = mExtras.get(name);
6301 if (result2 != null) {
6302 result = result2;
6303 }
6304 }
6305
6306 return result;
6307 }
6308
6309 /**
6310 * Retrieves a map of extended data from the intent.
6311 *
6312 * @return the map of all extras previously added with putExtra(),
6313 * or null if none have been added.
6314 */
6315 public Bundle getExtras() {
6316 return (mExtras != null)
6317 ? new Bundle(mExtras)
6318 : null;
6319 }
6320
6321 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006322 * Filter extras to only basic types.
6323 * @hide
6324 */
6325 public void removeUnsafeExtras() {
6326 if (mExtras != null) {
6327 mExtras.filterValues();
6328 }
6329 }
6330
6331 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006332 * Retrieve any special flags associated with this intent. You will
6333 * normally just set them with {@link #setFlags} and let the system
6334 * take the appropriate action with them.
6335 *
6336 * @return int The currently set flags.
6337 *
6338 * @see #setFlags
6339 */
6340 public int getFlags() {
6341 return mFlags;
6342 }
6343
Dianne Hackborne7f97212011-02-24 14:40:20 -08006344 /** @hide */
6345 public boolean isExcludingStopped() {
6346 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6347 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6348 }
6349
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006350 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006351 * Retrieve the application package name this Intent is limited to. When
6352 * resolving an Intent, if non-null this limits the resolution to only
6353 * components in the given application package.
6354 *
6355 * @return The name of the application package for the Intent.
6356 *
6357 * @see #resolveActivity
6358 * @see #setPackage
6359 */
6360 public String getPackage() {
6361 return mPackage;
6362 }
6363
6364 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006365 * Retrieve the concrete component associated with the intent. When receiving
6366 * an intent, this is the component that was found to best handle it (that is,
6367 * yourself) and will always be non-null; in all other cases it will be
6368 * null unless explicitly set.
6369 *
6370 * @return The name of the application component to handle the intent.
6371 *
6372 * @see #resolveActivity
6373 * @see #setComponent
6374 */
6375 public ComponentName getComponent() {
6376 return mComponent;
6377 }
6378
6379 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006380 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6381 * used as a hint to the receiver for animations and the like. Null means that there
6382 * is no source bounds.
6383 */
6384 public Rect getSourceBounds() {
6385 return mSourceBounds;
6386 }
6387
6388 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006389 * Return the Activity component that should be used to handle this intent.
6390 * The appropriate component is determined based on the information in the
6391 * intent, evaluated as follows:
6392 *
6393 * <p>If {@link #getComponent} returns an explicit class, that is returned
6394 * without any further consideration.
6395 *
6396 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6397 * category to be considered.
6398 *
6399 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6400 * action.
6401 *
6402 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6403 * this type.
6404 *
6405 * <p>If {@link #addCategory} has added any categories, the activity must
6406 * handle ALL of the categories specified.
6407 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006408 * <p>If {@link #getPackage} is non-NULL, only activity components in
6409 * that application package will be considered.
6410 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006411 * <p>If there are no activities that satisfy all of these conditions, a
6412 * null string is returned.
6413 *
6414 * <p>If multiple activities are found to satisfy the intent, the one with
6415 * the highest priority will be used. If there are multiple activities
6416 * with the same priority, the system will either pick the best activity
6417 * based on user preference, or resolve to a system class that will allow
6418 * the user to pick an activity and forward from there.
6419 *
6420 * <p>This method is implemented simply by calling
6421 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6422 * true.</p>
6423 * <p> This API is called for you as part of starting an activity from an
6424 * intent. You do not normally need to call it yourself.</p>
6425 *
6426 * @param pm The package manager with which to resolve the Intent.
6427 *
6428 * @return Name of the component implementing an activity that can
6429 * display the intent.
6430 *
6431 * @see #setComponent
6432 * @see #getComponent
6433 * @see #resolveActivityInfo
6434 */
6435 public ComponentName resolveActivity(PackageManager pm) {
6436 if (mComponent != null) {
6437 return mComponent;
6438 }
6439
6440 ResolveInfo info = pm.resolveActivity(
6441 this, PackageManager.MATCH_DEFAULT_ONLY);
6442 if (info != null) {
6443 return new ComponentName(
6444 info.activityInfo.applicationInfo.packageName,
6445 info.activityInfo.name);
6446 }
6447
6448 return null;
6449 }
6450
6451 /**
6452 * Resolve the Intent into an {@link ActivityInfo}
6453 * describing the activity that should execute the intent. Resolution
6454 * follows the same rules as described for {@link #resolveActivity}, but
6455 * you get back the completely information about the resolved activity
6456 * instead of just its class name.
6457 *
6458 * @param pm The package manager with which to resolve the Intent.
6459 * @param flags Addition information to retrieve as per
6460 * {@link PackageManager#getActivityInfo(ComponentName, int)
6461 * PackageManager.getActivityInfo()}.
6462 *
6463 * @return PackageManager.ActivityInfo
6464 *
6465 * @see #resolveActivity
6466 */
6467 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6468 ActivityInfo ai = null;
6469 if (mComponent != null) {
6470 try {
6471 ai = pm.getActivityInfo(mComponent, flags);
6472 } catch (PackageManager.NameNotFoundException e) {
6473 // ignore
6474 }
6475 } else {
6476 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006477 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006478 if (info != null) {
6479 ai = info.activityInfo;
6480 }
6481 }
6482
6483 return ai;
6484 }
6485
6486 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006487 * Special function for use by the system to resolve service
6488 * intents to system apps. Throws an exception if there are
6489 * multiple potential matches to the Intent. Returns null if
6490 * there are no matches.
6491 * @hide
6492 */
6493 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6494 if (mComponent != null) {
6495 return mComponent;
6496 }
6497
6498 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6499 if (results == null) {
6500 return null;
6501 }
6502 ComponentName comp = null;
6503 for (int i=0; i<results.size(); i++) {
6504 ResolveInfo ri = results.get(i);
6505 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6506 continue;
6507 }
6508 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6509 ri.serviceInfo.name);
6510 if (comp != null) {
6511 throw new IllegalStateException("Multiple system services handle " + this
6512 + ": " + comp + ", " + foundComp);
6513 }
6514 comp = foundComp;
6515 }
6516 return comp;
6517 }
6518
6519 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006520 * Set the general action to be performed.
6521 *
6522 * @param action An action name, such as ACTION_VIEW. Application-specific
6523 * actions should be prefixed with the vendor's package name.
6524 *
6525 * @return Returns the same Intent object, for chaining multiple calls
6526 * into a single statement.
6527 *
6528 * @see #getAction
6529 */
6530 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006531 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006532 return this;
6533 }
6534
6535 /**
6536 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006537 * clears any type that was previously set by {@link #setType} or
6538 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006539 *
Nick Pellyccae4122012-01-09 14:12:58 -08006540 * <p><em>Note: scheme matching in the Android framework is
6541 * case-sensitive, unlike the formal RFC. As a result,
6542 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006543 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006544 * {@link #setDataAndNormalize}
6545 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006546 *
Nick Pellyccae4122012-01-09 14:12:58 -08006547 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006548 *
6549 * @return Returns the same Intent object, for chaining multiple calls
6550 * into a single statement.
6551 *
6552 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006553 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006554 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006555 */
6556 public Intent setData(Uri data) {
6557 mData = data;
6558 mType = null;
6559 return this;
6560 }
6561
6562 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006563 * Normalize and set the data this intent is operating on.
6564 *
6565 * <p>This method automatically clears any type that was
6566 * previously set (for example, by {@link #setType}).
6567 *
6568 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006569 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006570 * so really this is just a convenience method for
6571 * <pre>
6572 * setData(data.normalize())
6573 * </pre>
6574 *
6575 * @param data The Uri of the data this intent is now targeting.
6576 *
6577 * @return Returns the same Intent object, for chaining multiple calls
6578 * into a single statement.
6579 *
6580 * @see #getData
6581 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006582 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006583 */
6584 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006585 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006586 }
6587
6588 /**
6589 * Set an explicit MIME data type.
6590 *
6591 * <p>This is used to create intents that only specify a type and not data,
6592 * for example to indicate the type of data to return.
6593 *
6594 * <p>This method automatically clears any data that was
6595 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006596 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006597 * <p><em>Note: MIME type matching in the Android framework is
6598 * case-sensitive, unlike formal RFC MIME types. As a result,
6599 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006600 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6601 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006602 *
6603 * @param type The MIME type of the data being handled by this intent.
6604 *
6605 * @return Returns the same Intent object, for chaining multiple calls
6606 * into a single statement.
6607 *
6608 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006609 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006610 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006611 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006612 */
6613 public Intent setType(String type) {
6614 mData = null;
6615 mType = type;
6616 return this;
6617 }
6618
6619 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006620 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006621 *
Nick Pellyccae4122012-01-09 14:12:58 -08006622 * <p>This is used to create intents that only specify a type and not data,
6623 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006624 *
Nick Pellyccae4122012-01-09 14:12:58 -08006625 * <p>This method automatically clears any data that was
6626 * previously set (for example by {@link #setData}).
6627 *
6628 * <p>The MIME type is normalized using
6629 * {@link #normalizeMimeType} before it is set,
6630 * so really this is just a convenience method for
6631 * <pre>
6632 * setType(Intent.normalizeMimeType(type))
6633 * </pre>
6634 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006635 * @param type The MIME type of the data being handled by this intent.
6636 *
6637 * @return Returns the same Intent object, for chaining multiple calls
6638 * into a single statement.
6639 *
Nick Pellyccae4122012-01-09 14:12:58 -08006640 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006641 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006642 * @see #normalizeMimeType
6643 */
6644 public Intent setTypeAndNormalize(String type) {
6645 return setType(normalizeMimeType(type));
6646 }
6647
6648 /**
6649 * (Usually optional) Set the data for the intent along with an explicit
6650 * MIME data type. This method should very rarely be used -- it allows you
6651 * to override the MIME type that would ordinarily be inferred from the
6652 * data with your own type given here.
6653 *
6654 * <p><em>Note: MIME type and Uri scheme matching in the
6655 * Android framework is case-sensitive, unlike the formal RFC definitions.
6656 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006657 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006658 * {@link #setDataAndTypeAndNormalize}
6659 * to ensure that they are converted to lower case.</em>
6660 *
6661 * @param data The Uri of the data this intent is now targeting.
6662 * @param type The MIME type of the data being handled by this intent.
6663 *
6664 * @return Returns the same Intent object, for chaining multiple calls
6665 * into a single statement.
6666 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006667 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006668 * @see #setData
6669 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006670 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006671 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006672 */
6673 public Intent setDataAndType(Uri data, String type) {
6674 mData = data;
6675 mType = type;
6676 return this;
6677 }
6678
6679 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006680 * (Usually optional) Normalize and set both the data Uri and an explicit
6681 * MIME data type. This method should very rarely be used -- it allows you
6682 * to override the MIME type that would ordinarily be inferred from the
6683 * data with your own type given here.
6684 *
6685 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006686 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006687 * before they are set, so really this is just a convenience method for
6688 * <pre>
6689 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6690 * </pre>
6691 *
6692 * @param data The Uri of the data this intent is now targeting.
6693 * @param type The MIME type of the data being handled by this intent.
6694 *
6695 * @return Returns the same Intent object, for chaining multiple calls
6696 * into a single statement.
6697 *
6698 * @see #setType
6699 * @see #setData
6700 * @see #setDataAndType
6701 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006702 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006703 */
6704 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006705 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006706 }
6707
6708 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006709 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006710 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006711 * activities that provide <em>all</em> of the requested categories will be
6712 * used.
6713 *
6714 * @param category The desired category. This can be either one of the
6715 * predefined Intent categories, or a custom category in your own
6716 * namespace.
6717 *
6718 * @return Returns the same Intent object, for chaining multiple calls
6719 * into a single statement.
6720 *
6721 * @see #hasCategory
6722 * @see #removeCategory
6723 */
6724 public Intent addCategory(String category) {
6725 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006726 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006727 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006728 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006729 return this;
6730 }
6731
6732 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006733 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006734 *
6735 * @param category The category to remove.
6736 *
6737 * @see #addCategory
6738 */
6739 public void removeCategory(String category) {
6740 if (mCategories != null) {
6741 mCategories.remove(category);
6742 if (mCategories.size() == 0) {
6743 mCategories = null;
6744 }
6745 }
6746 }
6747
6748 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006749 * Set a selector for this Intent. This is a modification to the kinds of
6750 * things the Intent will match. If the selector is set, it will be used
6751 * when trying to find entities that can handle the Intent, instead of the
6752 * main contents of the Intent. This allows you build an Intent containing
6753 * a generic protocol while targeting it more specifically.
6754 *
6755 * <p>An example of where this may be used is with things like
6756 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6757 * Intent that will launch the Browser application. However, the correct
6758 * main entry point of an application is actually {@link #ACTION_MAIN}
6759 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
6760 * used to specify the actual Activity to launch. If you launch the browser
6761 * with something different, undesired behavior may happen if the user has
6762 * previously or later launches it the normal way, since they do not match.
6763 * Instead, you can build an Intent with the MAIN action (but no ComponentName
6764 * yet specified) and set a selector with {@link #ACTION_MAIN} and
6765 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
6766 *
6767 * <p>Setting a selector does not impact the behavior of
6768 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
6769 * desired behavior of a selector -- it does not impact the base meaning
6770 * of the Intent, just what kinds of things will be matched against it
6771 * when determining who can handle it.</p>
6772 *
6773 * <p>You can not use both a selector and {@link #setPackage(String)} on
6774 * the same base Intent.</p>
6775 *
6776 * @param selector The desired selector Intent; set to null to not use
6777 * a special selector.
6778 */
6779 public void setSelector(Intent selector) {
6780 if (selector == this) {
6781 throw new IllegalArgumentException(
6782 "Intent being set as a selector of itself");
6783 }
6784 if (selector != null && mPackage != null) {
6785 throw new IllegalArgumentException(
6786 "Can't set selector when package name is already set");
6787 }
6788 mSelector = selector;
6789 }
6790
6791 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006792 * Set a {@link ClipData} associated with this Intent. This replaces any
6793 * previously set ClipData.
6794 *
6795 * <p>The ClipData in an intent is not used for Intent matching or other
6796 * such operations. Semantically it is like extras, used to transmit
6797 * additional data with the Intent. The main feature of using this over
6798 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
6799 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
6800 * items included in the clip data. This is useful, in particular, if
6801 * you want to transmit an Intent containing multiple <code>content:</code>
6802 * URIs for which the recipient may not have global permission to access the
6803 * content provider.
6804 *
6805 * <p>If the ClipData contains items that are themselves Intents, any
6806 * grant flags in those Intents will be ignored. Only the top-level flags
6807 * of the main Intent are respected, and will be applied to all Uri or
6808 * Intent items in the clip (or sub-items of the clip).
6809 *
6810 * <p>The MIME type, label, and icon in the ClipData object are not
6811 * directly used by Intent. Applications should generally rely on the
6812 * MIME type of the Intent itself, not what it may find in the ClipData.
6813 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05006814 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006815 *
6816 * @param clip The new clip to set. May be null to clear the current clip.
6817 */
6818 public void setClipData(ClipData clip) {
6819 mClipData = clip;
6820 }
6821
6822 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006823 * This is NOT a secure mechanism to identify the user who sent the intent.
6824 * When the intent is sent to a different user, it is used to fix uris by adding the userId
6825 * who sent the intent.
6826 * @hide
6827 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01006828 public void prepareToLeaveUser(int userId) {
6829 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
6830 // We want mContentUserHint to refer to the original user, so don't do anything.
6831 if (mContentUserHint == UserHandle.USER_CURRENT) {
6832 mContentUserHint = userId;
6833 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006834 }
6835
6836 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006837 * Add extended data to the intent. The name must include a package
6838 * prefix, for example the app com.android.contacts would use names
6839 * like "com.android.contacts.ShowAll".
6840 *
6841 * @param name The name of the extra data, with package prefix.
6842 * @param value The boolean data value.
6843 *
6844 * @return Returns the same Intent object, for chaining multiple calls
6845 * into a single statement.
6846 *
6847 * @see #putExtras
6848 * @see #removeExtra
6849 * @see #getBooleanExtra(String, boolean)
6850 */
6851 public Intent putExtra(String name, boolean value) {
6852 if (mExtras == null) {
6853 mExtras = new Bundle();
6854 }
6855 mExtras.putBoolean(name, value);
6856 return this;
6857 }
6858
6859 /**
6860 * Add extended data to the intent. The name must include a package
6861 * prefix, for example the app com.android.contacts would use names
6862 * like "com.android.contacts.ShowAll".
6863 *
6864 * @param name The name of the extra data, with package prefix.
6865 * @param value The byte data value.
6866 *
6867 * @return Returns the same Intent object, for chaining multiple calls
6868 * into a single statement.
6869 *
6870 * @see #putExtras
6871 * @see #removeExtra
6872 * @see #getByteExtra(String, byte)
6873 */
6874 public Intent putExtra(String name, byte value) {
6875 if (mExtras == null) {
6876 mExtras = new Bundle();
6877 }
6878 mExtras.putByte(name, value);
6879 return this;
6880 }
6881
6882 /**
6883 * Add extended data to the intent. The name must include a package
6884 * prefix, for example the app com.android.contacts would use names
6885 * like "com.android.contacts.ShowAll".
6886 *
6887 * @param name The name of the extra data, with package prefix.
6888 * @param value The char data value.
6889 *
6890 * @return Returns the same Intent object, for chaining multiple calls
6891 * into a single statement.
6892 *
6893 * @see #putExtras
6894 * @see #removeExtra
6895 * @see #getCharExtra(String, char)
6896 */
6897 public Intent putExtra(String name, char value) {
6898 if (mExtras == null) {
6899 mExtras = new Bundle();
6900 }
6901 mExtras.putChar(name, value);
6902 return this;
6903 }
6904
6905 /**
6906 * Add extended data to the intent. The name must include a package
6907 * prefix, for example the app com.android.contacts would use names
6908 * like "com.android.contacts.ShowAll".
6909 *
6910 * @param name The name of the extra data, with package prefix.
6911 * @param value The short data value.
6912 *
6913 * @return Returns the same Intent object, for chaining multiple calls
6914 * into a single statement.
6915 *
6916 * @see #putExtras
6917 * @see #removeExtra
6918 * @see #getShortExtra(String, short)
6919 */
6920 public Intent putExtra(String name, short value) {
6921 if (mExtras == null) {
6922 mExtras = new Bundle();
6923 }
6924 mExtras.putShort(name, value);
6925 return this;
6926 }
6927
6928 /**
6929 * Add extended data to the intent. The name must include a package
6930 * prefix, for example the app com.android.contacts would use names
6931 * like "com.android.contacts.ShowAll".
6932 *
6933 * @param name The name of the extra data, with package prefix.
6934 * @param value The integer data value.
6935 *
6936 * @return Returns the same Intent object, for chaining multiple calls
6937 * into a single statement.
6938 *
6939 * @see #putExtras
6940 * @see #removeExtra
6941 * @see #getIntExtra(String, int)
6942 */
6943 public Intent putExtra(String name, int value) {
6944 if (mExtras == null) {
6945 mExtras = new Bundle();
6946 }
6947 mExtras.putInt(name, value);
6948 return this;
6949 }
6950
6951 /**
6952 * Add extended data to the intent. The name must include a package
6953 * prefix, for example the app com.android.contacts would use names
6954 * like "com.android.contacts.ShowAll".
6955 *
6956 * @param name The name of the extra data, with package prefix.
6957 * @param value The long data value.
6958 *
6959 * @return Returns the same Intent object, for chaining multiple calls
6960 * into a single statement.
6961 *
6962 * @see #putExtras
6963 * @see #removeExtra
6964 * @see #getLongExtra(String, long)
6965 */
6966 public Intent putExtra(String name, long value) {
6967 if (mExtras == null) {
6968 mExtras = new Bundle();
6969 }
6970 mExtras.putLong(name, value);
6971 return this;
6972 }
6973
6974 /**
6975 * Add extended data to the intent. The name must include a package
6976 * prefix, for example the app com.android.contacts would use names
6977 * like "com.android.contacts.ShowAll".
6978 *
6979 * @param name The name of the extra data, with package prefix.
6980 * @param value The float data value.
6981 *
6982 * @return Returns the same Intent object, for chaining multiple calls
6983 * into a single statement.
6984 *
6985 * @see #putExtras
6986 * @see #removeExtra
6987 * @see #getFloatExtra(String, float)
6988 */
6989 public Intent putExtra(String name, float value) {
6990 if (mExtras == null) {
6991 mExtras = new Bundle();
6992 }
6993 mExtras.putFloat(name, value);
6994 return this;
6995 }
6996
6997 /**
6998 * Add extended data to the intent. The name must include a package
6999 * prefix, for example the app com.android.contacts would use names
7000 * like "com.android.contacts.ShowAll".
7001 *
7002 * @param name The name of the extra data, with package prefix.
7003 * @param value The double data value.
7004 *
7005 * @return Returns the same Intent object, for chaining multiple calls
7006 * into a single statement.
7007 *
7008 * @see #putExtras
7009 * @see #removeExtra
7010 * @see #getDoubleExtra(String, double)
7011 */
7012 public Intent putExtra(String name, double value) {
7013 if (mExtras == null) {
7014 mExtras = new Bundle();
7015 }
7016 mExtras.putDouble(name, value);
7017 return this;
7018 }
7019
7020 /**
7021 * Add extended data to the intent. The name must include a package
7022 * prefix, for example the app com.android.contacts would use names
7023 * like "com.android.contacts.ShowAll".
7024 *
7025 * @param name The name of the extra data, with package prefix.
7026 * @param value The String data value.
7027 *
7028 * @return Returns the same Intent object, for chaining multiple calls
7029 * into a single statement.
7030 *
7031 * @see #putExtras
7032 * @see #removeExtra
7033 * @see #getStringExtra(String)
7034 */
7035 public Intent putExtra(String name, String value) {
7036 if (mExtras == null) {
7037 mExtras = new Bundle();
7038 }
7039 mExtras.putString(name, value);
7040 return this;
7041 }
7042
7043 /**
7044 * Add extended data to the intent. The name must include a package
7045 * prefix, for example the app com.android.contacts would use names
7046 * like "com.android.contacts.ShowAll".
7047 *
7048 * @param name The name of the extra data, with package prefix.
7049 * @param value The CharSequence data value.
7050 *
7051 * @return Returns the same Intent object, for chaining multiple calls
7052 * into a single statement.
7053 *
7054 * @see #putExtras
7055 * @see #removeExtra
7056 * @see #getCharSequenceExtra(String)
7057 */
7058 public Intent putExtra(String name, CharSequence value) {
7059 if (mExtras == null) {
7060 mExtras = new Bundle();
7061 }
7062 mExtras.putCharSequence(name, value);
7063 return this;
7064 }
7065
7066 /**
7067 * Add extended data to the intent. The name must include a package
7068 * prefix, for example the app com.android.contacts would use names
7069 * like "com.android.contacts.ShowAll".
7070 *
7071 * @param name The name of the extra data, with package prefix.
7072 * @param value The Parcelable data value.
7073 *
7074 * @return Returns the same Intent object, for chaining multiple calls
7075 * into a single statement.
7076 *
7077 * @see #putExtras
7078 * @see #removeExtra
7079 * @see #getParcelableExtra(String)
7080 */
7081 public Intent putExtra(String name, Parcelable value) {
7082 if (mExtras == null) {
7083 mExtras = new Bundle();
7084 }
7085 mExtras.putParcelable(name, value);
7086 return this;
7087 }
7088
7089 /**
7090 * Add extended data to the intent. The name must include a package
7091 * prefix, for example the app com.android.contacts would use names
7092 * like "com.android.contacts.ShowAll".
7093 *
7094 * @param name The name of the extra data, with package prefix.
7095 * @param value The Parcelable[] data value.
7096 *
7097 * @return Returns the same Intent object, for chaining multiple calls
7098 * into a single statement.
7099 *
7100 * @see #putExtras
7101 * @see #removeExtra
7102 * @see #getParcelableArrayExtra(String)
7103 */
7104 public Intent putExtra(String name, Parcelable[] value) {
7105 if (mExtras == null) {
7106 mExtras = new Bundle();
7107 }
7108 mExtras.putParcelableArray(name, value);
7109 return this;
7110 }
7111
7112 /**
7113 * Add extended data to the intent. The name must include a package
7114 * prefix, for example the app com.android.contacts would use names
7115 * like "com.android.contacts.ShowAll".
7116 *
7117 * @param name The name of the extra data, with package prefix.
7118 * @param value The ArrayList<Parcelable> data value.
7119 *
7120 * @return Returns the same Intent object, for chaining multiple calls
7121 * into a single statement.
7122 *
7123 * @see #putExtras
7124 * @see #removeExtra
7125 * @see #getParcelableArrayListExtra(String)
7126 */
7127 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7128 if (mExtras == null) {
7129 mExtras = new Bundle();
7130 }
7131 mExtras.putParcelableArrayList(name, value);
7132 return this;
7133 }
7134
7135 /**
7136 * Add extended data to the intent. The name must include a package
7137 * prefix, for example the app com.android.contacts would use names
7138 * like "com.android.contacts.ShowAll".
7139 *
7140 * @param name The name of the extra data, with package prefix.
7141 * @param value The ArrayList<Integer> data value.
7142 *
7143 * @return Returns the same Intent object, for chaining multiple calls
7144 * into a single statement.
7145 *
7146 * @see #putExtras
7147 * @see #removeExtra
7148 * @see #getIntegerArrayListExtra(String)
7149 */
7150 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7151 if (mExtras == null) {
7152 mExtras = new Bundle();
7153 }
7154 mExtras.putIntegerArrayList(name, value);
7155 return this;
7156 }
7157
7158 /**
7159 * Add extended data to the intent. The name must include a package
7160 * prefix, for example the app com.android.contacts would use names
7161 * like "com.android.contacts.ShowAll".
7162 *
7163 * @param name The name of the extra data, with package prefix.
7164 * @param value The ArrayList<String> data value.
7165 *
7166 * @return Returns the same Intent object, for chaining multiple calls
7167 * into a single statement.
7168 *
7169 * @see #putExtras
7170 * @see #removeExtra
7171 * @see #getStringArrayListExtra(String)
7172 */
7173 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7174 if (mExtras == null) {
7175 mExtras = new Bundle();
7176 }
7177 mExtras.putStringArrayList(name, value);
7178 return this;
7179 }
7180
7181 /**
7182 * Add extended data to the intent. The name must include a package
7183 * prefix, for example the app com.android.contacts would use names
7184 * like "com.android.contacts.ShowAll".
7185 *
7186 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007187 * @param value The ArrayList<CharSequence> data value.
7188 *
7189 * @return Returns the same Intent object, for chaining multiple calls
7190 * into a single statement.
7191 *
7192 * @see #putExtras
7193 * @see #removeExtra
7194 * @see #getCharSequenceArrayListExtra(String)
7195 */
7196 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7197 if (mExtras == null) {
7198 mExtras = new Bundle();
7199 }
7200 mExtras.putCharSequenceArrayList(name, value);
7201 return this;
7202 }
7203
7204 /**
7205 * Add extended data to the intent. The name must include a package
7206 * prefix, for example the app com.android.contacts would use names
7207 * like "com.android.contacts.ShowAll".
7208 *
7209 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007210 * @param value The Serializable data value.
7211 *
7212 * @return Returns the same Intent object, for chaining multiple calls
7213 * into a single statement.
7214 *
7215 * @see #putExtras
7216 * @see #removeExtra
7217 * @see #getSerializableExtra(String)
7218 */
7219 public Intent putExtra(String name, Serializable value) {
7220 if (mExtras == null) {
7221 mExtras = new Bundle();
7222 }
7223 mExtras.putSerializable(name, value);
7224 return this;
7225 }
7226
7227 /**
7228 * Add extended data to the intent. The name must include a package
7229 * prefix, for example the app com.android.contacts would use names
7230 * like "com.android.contacts.ShowAll".
7231 *
7232 * @param name The name of the extra data, with package prefix.
7233 * @param value The boolean array data value.
7234 *
7235 * @return Returns the same Intent object, for chaining multiple calls
7236 * into a single statement.
7237 *
7238 * @see #putExtras
7239 * @see #removeExtra
7240 * @see #getBooleanArrayExtra(String)
7241 */
7242 public Intent putExtra(String name, boolean[] value) {
7243 if (mExtras == null) {
7244 mExtras = new Bundle();
7245 }
7246 mExtras.putBooleanArray(name, value);
7247 return this;
7248 }
7249
7250 /**
7251 * Add extended data to the intent. The name must include a package
7252 * prefix, for example the app com.android.contacts would use names
7253 * like "com.android.contacts.ShowAll".
7254 *
7255 * @param name The name of the extra data, with package prefix.
7256 * @param value The byte array data value.
7257 *
7258 * @return Returns the same Intent object, for chaining multiple calls
7259 * into a single statement.
7260 *
7261 * @see #putExtras
7262 * @see #removeExtra
7263 * @see #getByteArrayExtra(String)
7264 */
7265 public Intent putExtra(String name, byte[] value) {
7266 if (mExtras == null) {
7267 mExtras = new Bundle();
7268 }
7269 mExtras.putByteArray(name, value);
7270 return this;
7271 }
7272
7273 /**
7274 * Add extended data to the intent. The name must include a package
7275 * prefix, for example the app com.android.contacts would use names
7276 * like "com.android.contacts.ShowAll".
7277 *
7278 * @param name The name of the extra data, with package prefix.
7279 * @param value The short array data value.
7280 *
7281 * @return Returns the same Intent object, for chaining multiple calls
7282 * into a single statement.
7283 *
7284 * @see #putExtras
7285 * @see #removeExtra
7286 * @see #getShortArrayExtra(String)
7287 */
7288 public Intent putExtra(String name, short[] value) {
7289 if (mExtras == null) {
7290 mExtras = new Bundle();
7291 }
7292 mExtras.putShortArray(name, value);
7293 return this;
7294 }
7295
7296 /**
7297 * Add extended data to the intent. The name must include a package
7298 * prefix, for example the app com.android.contacts would use names
7299 * like "com.android.contacts.ShowAll".
7300 *
7301 * @param name The name of the extra data, with package prefix.
7302 * @param value The char array data value.
7303 *
7304 * @return Returns the same Intent object, for chaining multiple calls
7305 * into a single statement.
7306 *
7307 * @see #putExtras
7308 * @see #removeExtra
7309 * @see #getCharArrayExtra(String)
7310 */
7311 public Intent putExtra(String name, char[] value) {
7312 if (mExtras == null) {
7313 mExtras = new Bundle();
7314 }
7315 mExtras.putCharArray(name, value);
7316 return this;
7317 }
7318
7319 /**
7320 * Add extended data to the intent. The name must include a package
7321 * prefix, for example the app com.android.contacts would use names
7322 * like "com.android.contacts.ShowAll".
7323 *
7324 * @param name The name of the extra data, with package prefix.
7325 * @param value The int array data value.
7326 *
7327 * @return Returns the same Intent object, for chaining multiple calls
7328 * into a single statement.
7329 *
7330 * @see #putExtras
7331 * @see #removeExtra
7332 * @see #getIntArrayExtra(String)
7333 */
7334 public Intent putExtra(String name, int[] value) {
7335 if (mExtras == null) {
7336 mExtras = new Bundle();
7337 }
7338 mExtras.putIntArray(name, value);
7339 return this;
7340 }
7341
7342 /**
7343 * Add extended data to the intent. The name must include a package
7344 * prefix, for example the app com.android.contacts would use names
7345 * like "com.android.contacts.ShowAll".
7346 *
7347 * @param name The name of the extra data, with package prefix.
7348 * @param value The byte array data value.
7349 *
7350 * @return Returns the same Intent object, for chaining multiple calls
7351 * into a single statement.
7352 *
7353 * @see #putExtras
7354 * @see #removeExtra
7355 * @see #getLongArrayExtra(String)
7356 */
7357 public Intent putExtra(String name, long[] value) {
7358 if (mExtras == null) {
7359 mExtras = new Bundle();
7360 }
7361 mExtras.putLongArray(name, value);
7362 return this;
7363 }
7364
7365 /**
7366 * Add extended data to the intent. The name must include a package
7367 * prefix, for example the app com.android.contacts would use names
7368 * like "com.android.contacts.ShowAll".
7369 *
7370 * @param name The name of the extra data, with package prefix.
7371 * @param value The float array data value.
7372 *
7373 * @return Returns the same Intent object, for chaining multiple calls
7374 * into a single statement.
7375 *
7376 * @see #putExtras
7377 * @see #removeExtra
7378 * @see #getFloatArrayExtra(String)
7379 */
7380 public Intent putExtra(String name, float[] value) {
7381 if (mExtras == null) {
7382 mExtras = new Bundle();
7383 }
7384 mExtras.putFloatArray(name, value);
7385 return this;
7386 }
7387
7388 /**
7389 * Add extended data to the intent. The name must include a package
7390 * prefix, for example the app com.android.contacts would use names
7391 * like "com.android.contacts.ShowAll".
7392 *
7393 * @param name The name of the extra data, with package prefix.
7394 * @param value The double array data value.
7395 *
7396 * @return Returns the same Intent object, for chaining multiple calls
7397 * into a single statement.
7398 *
7399 * @see #putExtras
7400 * @see #removeExtra
7401 * @see #getDoubleArrayExtra(String)
7402 */
7403 public Intent putExtra(String name, double[] value) {
7404 if (mExtras == null) {
7405 mExtras = new Bundle();
7406 }
7407 mExtras.putDoubleArray(name, value);
7408 return this;
7409 }
7410
7411 /**
7412 * Add extended data to the intent. The name must include a package
7413 * prefix, for example the app com.android.contacts would use names
7414 * like "com.android.contacts.ShowAll".
7415 *
7416 * @param name The name of the extra data, with package prefix.
7417 * @param value The String array data value.
7418 *
7419 * @return Returns the same Intent object, for chaining multiple calls
7420 * into a single statement.
7421 *
7422 * @see #putExtras
7423 * @see #removeExtra
7424 * @see #getStringArrayExtra(String)
7425 */
7426 public Intent putExtra(String name, String[] value) {
7427 if (mExtras == null) {
7428 mExtras = new Bundle();
7429 }
7430 mExtras.putStringArray(name, value);
7431 return this;
7432 }
7433
7434 /**
7435 * Add extended data to the intent. The name must include a package
7436 * prefix, for example the app com.android.contacts would use names
7437 * like "com.android.contacts.ShowAll".
7438 *
7439 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007440 * @param value The CharSequence array data value.
7441 *
7442 * @return Returns the same Intent object, for chaining multiple calls
7443 * into a single statement.
7444 *
7445 * @see #putExtras
7446 * @see #removeExtra
7447 * @see #getCharSequenceArrayExtra(String)
7448 */
7449 public Intent putExtra(String name, CharSequence[] value) {
7450 if (mExtras == null) {
7451 mExtras = new Bundle();
7452 }
7453 mExtras.putCharSequenceArray(name, value);
7454 return this;
7455 }
7456
7457 /**
7458 * Add extended data to the intent. The name must include a package
7459 * prefix, for example the app com.android.contacts would use names
7460 * like "com.android.contacts.ShowAll".
7461 *
7462 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007463 * @param value The Bundle data value.
7464 *
7465 * @return Returns the same Intent object, for chaining multiple calls
7466 * into a single statement.
7467 *
7468 * @see #putExtras
7469 * @see #removeExtra
7470 * @see #getBundleExtra(String)
7471 */
7472 public Intent putExtra(String name, Bundle value) {
7473 if (mExtras == null) {
7474 mExtras = new Bundle();
7475 }
7476 mExtras.putBundle(name, value);
7477 return this;
7478 }
7479
7480 /**
7481 * Add extended data to the intent. The name must include a package
7482 * prefix, for example the app com.android.contacts would use names
7483 * like "com.android.contacts.ShowAll".
7484 *
7485 * @param name The name of the extra data, with package prefix.
7486 * @param value The IBinder data value.
7487 *
7488 * @return Returns the same Intent object, for chaining multiple calls
7489 * into a single statement.
7490 *
7491 * @see #putExtras
7492 * @see #removeExtra
7493 * @see #getIBinderExtra(String)
7494 *
7495 * @deprecated
7496 * @hide
7497 */
7498 @Deprecated
7499 public Intent putExtra(String name, IBinder value) {
7500 if (mExtras == null) {
7501 mExtras = new Bundle();
7502 }
7503 mExtras.putIBinder(name, value);
7504 return this;
7505 }
7506
7507 /**
7508 * Copy all extras in 'src' in to this intent.
7509 *
7510 * @param src Contains the extras to copy.
7511 *
7512 * @see #putExtra
7513 */
7514 public Intent putExtras(Intent src) {
7515 if (src.mExtras != null) {
7516 if (mExtras == null) {
7517 mExtras = new Bundle(src.mExtras);
7518 } else {
7519 mExtras.putAll(src.mExtras);
7520 }
7521 }
7522 return this;
7523 }
7524
7525 /**
7526 * Add a set of extended data to the intent. The keys must include a package
7527 * prefix, for example the app com.android.contacts would use names
7528 * like "com.android.contacts.ShowAll".
7529 *
7530 * @param extras The Bundle of extras to add to this intent.
7531 *
7532 * @see #putExtra
7533 * @see #removeExtra
7534 */
7535 public Intent putExtras(Bundle extras) {
7536 if (mExtras == null) {
7537 mExtras = new Bundle();
7538 }
7539 mExtras.putAll(extras);
7540 return this;
7541 }
7542
7543 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007544 * Completely replace the extras in the Intent with the extras in the
7545 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007546 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007547 * @param src The exact extras contained in this Intent are copied
7548 * into the target intent, replacing any that were previously there.
7549 */
7550 public Intent replaceExtras(Intent src) {
7551 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7552 return this;
7553 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007554
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007555 /**
7556 * Completely replace the extras in the Intent with the given Bundle of
7557 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007558 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007559 * @param extras The new set of extras in the Intent, or null to erase
7560 * all extras.
7561 */
7562 public Intent replaceExtras(Bundle extras) {
7563 mExtras = extras != null ? new Bundle(extras) : null;
7564 return this;
7565 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007566
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007567 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007568 * Remove extended data from the intent.
7569 *
7570 * @see #putExtra
7571 */
7572 public void removeExtra(String name) {
7573 if (mExtras != null) {
7574 mExtras.remove(name);
7575 if (mExtras.size() == 0) {
7576 mExtras = null;
7577 }
7578 }
7579 }
7580
7581 /**
7582 * Set special flags controlling how this intent is handled. Most values
7583 * here depend on the type of component being executed by the Intent,
7584 * specifically the FLAG_ACTIVITY_* flags are all for use with
7585 * {@link Context#startActivity Context.startActivity()} and the
7586 * FLAG_RECEIVER_* flags are all for use with
7587 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7588 *
Scott Main7aee61f2011-02-08 11:25:01 -08007589 * <p>See the
7590 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7591 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007592 * the behavior of your application.
7593 *
7594 * @param flags The desired flags.
7595 *
7596 * @return Returns the same Intent object, for chaining multiple calls
7597 * into a single statement.
7598 *
7599 * @see #getFlags
7600 * @see #addFlags
7601 *
7602 * @see #FLAG_GRANT_READ_URI_PERMISSION
7603 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007604 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7605 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007606 * @see #FLAG_DEBUG_LOG_RESOLUTION
7607 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007608 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007609 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007610 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007611 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007612 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7613 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007614 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007615 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007616 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007617 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007618 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007619 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007620 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007621 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7622 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007623 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007624 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007625 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007626 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7627 */
7628 public Intent setFlags(int flags) {
7629 mFlags = flags;
7630 return this;
7631 }
7632
7633 /**
7634 * Add additional flags to the intent (or with existing flags
7635 * value).
7636 *
7637 * @param flags The new flags to set.
7638 *
7639 * @return Returns the same Intent object, for chaining multiple calls
7640 * into a single statement.
7641 *
7642 * @see #setFlags
7643 */
7644 public Intent addFlags(int flags) {
7645 mFlags |= flags;
7646 return this;
7647 }
7648
7649 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007650 * (Usually optional) Set an explicit application package name that limits
7651 * the components this Intent will resolve to. If left to the default
7652 * value of null, all components in all applications will considered.
7653 * If non-null, the Intent can only match the components in the given
7654 * application package.
7655 *
7656 * @param packageName The name of the application package to handle the
7657 * intent, or null to allow any application package.
7658 *
7659 * @return Returns the same Intent object, for chaining multiple calls
7660 * into a single statement.
7661 *
7662 * @see #getPackage
7663 * @see #resolveActivity
7664 */
7665 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007666 if (packageName != null && mSelector != null) {
7667 throw new IllegalArgumentException(
7668 "Can't set package name when selector is already set");
7669 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007670 mPackage = packageName;
7671 return this;
7672 }
7673
7674 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007675 * (Usually optional) Explicitly set the component to handle the intent.
7676 * If left with the default value of null, the system will determine the
7677 * appropriate class to use based on the other fields (action, data,
7678 * type, categories) in the Intent. If this class is defined, the
7679 * specified class will always be used regardless of the other fields. You
7680 * should only set this value when you know you absolutely want a specific
7681 * class to be used; otherwise it is better to let the system find the
7682 * appropriate class so that you will respect the installed applications
7683 * and user preferences.
7684 *
7685 * @param component The name of the application component to handle the
7686 * intent, or null to let the system find one for you.
7687 *
7688 * @return Returns the same Intent object, for chaining multiple calls
7689 * into a single statement.
7690 *
7691 * @see #setClass
7692 * @see #setClassName(Context, String)
7693 * @see #setClassName(String, String)
7694 * @see #getComponent
7695 * @see #resolveActivity
7696 */
7697 public Intent setComponent(ComponentName component) {
7698 mComponent = component;
7699 return this;
7700 }
7701
7702 /**
7703 * Convenience for calling {@link #setComponent} with an
7704 * explicit class name.
7705 *
7706 * @param packageContext A Context of the application package implementing
7707 * this class.
7708 * @param className The name of a class inside of the application package
7709 * that will be used as the component for this Intent.
7710 *
7711 * @return Returns the same Intent object, for chaining multiple calls
7712 * into a single statement.
7713 *
7714 * @see #setComponent
7715 * @see #setClass
7716 */
7717 public Intent setClassName(Context packageContext, String className) {
7718 mComponent = new ComponentName(packageContext, className);
7719 return this;
7720 }
7721
7722 /**
7723 * Convenience for calling {@link #setComponent} with an
7724 * explicit application package name and class name.
7725 *
7726 * @param packageName The name of the package implementing the desired
7727 * component.
7728 * @param className The name of a class inside of the application package
7729 * that will be used as the component for this Intent.
7730 *
7731 * @return Returns the same Intent object, for chaining multiple calls
7732 * into a single statement.
7733 *
7734 * @see #setComponent
7735 * @see #setClass
7736 */
7737 public Intent setClassName(String packageName, String className) {
7738 mComponent = new ComponentName(packageName, className);
7739 return this;
7740 }
7741
7742 /**
7743 * Convenience for calling {@link #setComponent(ComponentName)} with the
7744 * name returned by a {@link Class} object.
7745 *
7746 * @param packageContext A Context of the application package implementing
7747 * this class.
7748 * @param cls The class name to set, equivalent to
7749 * <code>setClassName(context, cls.getName())</code>.
7750 *
7751 * @return Returns the same Intent object, for chaining multiple calls
7752 * into a single statement.
7753 *
7754 * @see #setComponent
7755 */
7756 public Intent setClass(Context packageContext, Class<?> cls) {
7757 mComponent = new ComponentName(packageContext, cls);
7758 return this;
7759 }
7760
7761 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007762 * Set the bounds of the sender of this intent, in screen coordinates. This can be
7763 * used as a hint to the receiver for animations and the like. Null means that there
7764 * is no source bounds.
7765 */
7766 public void setSourceBounds(Rect r) {
7767 if (r != null) {
7768 mSourceBounds = new Rect(r);
7769 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07007770 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007771 }
7772 }
7773
Tor Norbyed9273d62013-05-30 15:59:53 -07007774 /** @hide */
7775 @IntDef(flag = true,
7776 value = {
7777 FILL_IN_ACTION,
7778 FILL_IN_DATA,
7779 FILL_IN_CATEGORIES,
7780 FILL_IN_COMPONENT,
7781 FILL_IN_PACKAGE,
7782 FILL_IN_SOURCE_BOUNDS,
7783 FILL_IN_SELECTOR,
7784 FILL_IN_CLIP_DATA
7785 })
7786 @Retention(RetentionPolicy.SOURCE)
7787 public @interface FillInFlags {}
7788
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007789 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007790 * Use with {@link #fillIn} to allow the current action value to be
7791 * overwritten, even if it is already set.
7792 */
7793 public static final int FILL_IN_ACTION = 1<<0;
7794
7795 /**
7796 * Use with {@link #fillIn} to allow the current data or type value
7797 * overwritten, even if it is already set.
7798 */
7799 public static final int FILL_IN_DATA = 1<<1;
7800
7801 /**
7802 * Use with {@link #fillIn} to allow the current categories to be
7803 * overwritten, even if they are already set.
7804 */
7805 public static final int FILL_IN_CATEGORIES = 1<<2;
7806
7807 /**
7808 * Use with {@link #fillIn} to allow the current component value to be
7809 * overwritten, even if it is already set.
7810 */
7811 public static final int FILL_IN_COMPONENT = 1<<3;
7812
7813 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007814 * Use with {@link #fillIn} to allow the current package value to be
7815 * overwritten, even if it is already set.
7816 */
7817 public static final int FILL_IN_PACKAGE = 1<<4;
7818
7819 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007820 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007821 * overwritten, even if it is already set.
7822 */
7823 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
7824
7825 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007826 * Use with {@link #fillIn} to allow the current selector to be
7827 * overwritten, even if it is already set.
7828 */
7829 public static final int FILL_IN_SELECTOR = 1<<6;
7830
7831 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007832 * Use with {@link #fillIn} to allow the current ClipData to be
7833 * overwritten, even if it is already set.
7834 */
7835 public static final int FILL_IN_CLIP_DATA = 1<<7;
7836
7837 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007838 * Copy the contents of <var>other</var> in to this object, but only
7839 * where fields are not defined by this object. For purposes of a field
7840 * being defined, the following pieces of data in the Intent are
7841 * considered to be separate fields:
7842 *
7843 * <ul>
7844 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08007845 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007846 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
7847 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007848 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007849 * <li> component, as set by {@link #setComponent(ComponentName)} or
7850 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007851 * <li> source bounds, as set by {@link #setSourceBounds}.
7852 * <li> selector, as set by {@link #setSelector(Intent)}.
7853 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007854 * <li> each top-level name in the associated extras.
7855 * </ul>
7856 *
7857 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007858 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007859 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7860 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
7861 * the restriction where the corresponding field will not be replaced if
7862 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007863 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007864 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
7865 * is explicitly specified. The selector will only be copied if
7866 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07007867 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007868 * <p>For example, consider Intent A with {data="foo", categories="bar"}
7869 * and Intent B with {action="gotit", data-type="some/thing",
7870 * categories="one","two"}.
7871 *
7872 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
7873 * containing: {action="gotit", data-type="some/thing",
7874 * categories="bar"}.
7875 *
7876 * @param other Another Intent whose values are to be used to fill in
7877 * the current one.
7878 * @param flags Options to control which fields can be filled in.
7879 *
7880 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007881 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07007882 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7883 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
7884 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007885 */
Tor Norbyed9273d62013-05-30 15:59:53 -07007886 @FillInFlags
7887 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007888 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007889 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007890 if (other.mAction != null
7891 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007892 mAction = other.mAction;
7893 changes |= FILL_IN_ACTION;
7894 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007895 if ((other.mData != null || other.mType != null)
7896 && ((mData == null && mType == null)
7897 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007898 mData = other.mData;
7899 mType = other.mType;
7900 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007901 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007902 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007903 if (other.mCategories != null
7904 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007905 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007906 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007907 }
7908 changes |= FILL_IN_CATEGORIES;
7909 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007910 if (other.mPackage != null
7911 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007912 // Only do this if mSelector is not set.
7913 if (mSelector == null) {
7914 mPackage = other.mPackage;
7915 changes |= FILL_IN_PACKAGE;
7916 }
7917 }
7918 // Selector is special: it can only be set if explicitly allowed,
7919 // for the same reason as the component name.
7920 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
7921 if (mPackage == null) {
7922 mSelector = new Intent(other.mSelector);
7923 mPackage = null;
7924 changes |= FILL_IN_SELECTOR;
7925 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007926 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007927 if (other.mClipData != null
7928 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
7929 mClipData = other.mClipData;
7930 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007931 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007932 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007933 // Component is special: it can -only- be set if explicitly allowed,
7934 // since otherwise the sender could force the intent somewhere the
7935 // originator didn't intend.
7936 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007937 mComponent = other.mComponent;
7938 changes |= FILL_IN_COMPONENT;
7939 }
7940 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007941 if (other.mSourceBounds != null
7942 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
7943 mSourceBounds = new Rect(other.mSourceBounds);
7944 changes |= FILL_IN_SOURCE_BOUNDS;
7945 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007946 if (mExtras == null) {
7947 if (other.mExtras != null) {
7948 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007949 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007950 }
7951 } else if (other.mExtras != null) {
7952 try {
7953 Bundle newb = new Bundle(other.mExtras);
7954 newb.putAll(mExtras);
7955 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007956 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007957 } catch (RuntimeException e) {
7958 // Modifying the extras can cause us to unparcel the contents
7959 // of the bundle, and if we do this in the system process that
7960 // may fail. We really should handle this (i.e., the Bundle
7961 // impl shouldn't be on top of a plain map), but for now just
7962 // ignore it and keep the original contents. :(
7963 Log.w("Intent", "Failure filling in extras", e);
7964 }
7965 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007966 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
7967 && other.mContentUserHint != UserHandle.USER_CURRENT) {
7968 mContentUserHint = other.mContentUserHint;
7969 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007970 return changes;
7971 }
7972
7973 /**
7974 * Wrapper class holding an Intent and implementing comparisons on it for
7975 * the purpose of filtering. The class implements its
7976 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
7977 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
7978 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
7979 * on the wrapped Intent.
7980 */
7981 public static final class FilterComparison {
7982 private final Intent mIntent;
7983 private final int mHashCode;
7984
7985 public FilterComparison(Intent intent) {
7986 mIntent = intent;
7987 mHashCode = intent.filterHashCode();
7988 }
7989
7990 /**
7991 * Return the Intent that this FilterComparison represents.
7992 * @return Returns the Intent held by the FilterComparison. Do
7993 * not modify!
7994 */
7995 public Intent getIntent() {
7996 return mIntent;
7997 }
7998
7999 @Override
8000 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008001 if (obj instanceof FilterComparison) {
8002 Intent other = ((FilterComparison)obj).mIntent;
8003 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008004 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008005 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008006 }
8007
8008 @Override
8009 public int hashCode() {
8010 return mHashCode;
8011 }
8012 }
8013
8014 /**
8015 * Determine if two intents are the same for the purposes of intent
8016 * resolution (filtering). That is, if their action, data, type,
8017 * class, and categories are the same. This does <em>not</em> compare
8018 * any extra data included in the intents.
8019 *
8020 * @param other The other Intent to compare against.
8021 *
8022 * @return Returns true if action, data, type, class, and categories
8023 * are the same.
8024 */
8025 public boolean filterEquals(Intent other) {
8026 if (other == null) {
8027 return false;
8028 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008029 if (!Objects.equals(this.mAction, other.mAction)) return false;
8030 if (!Objects.equals(this.mData, other.mData)) return false;
8031 if (!Objects.equals(this.mType, other.mType)) return false;
8032 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8033 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8034 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008035
8036 return true;
8037 }
8038
8039 /**
8040 * Generate hash code that matches semantics of filterEquals().
8041 *
8042 * @return Returns the hash value of the action, data, type, class, and
8043 * categories.
8044 *
8045 * @see #filterEquals
8046 */
8047 public int filterHashCode() {
8048 int code = 0;
8049 if (mAction != null) {
8050 code += mAction.hashCode();
8051 }
8052 if (mData != null) {
8053 code += mData.hashCode();
8054 }
8055 if (mType != null) {
8056 code += mType.hashCode();
8057 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008058 if (mPackage != null) {
8059 code += mPackage.hashCode();
8060 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008061 if (mComponent != null) {
8062 code += mComponent.hashCode();
8063 }
8064 if (mCategories != null) {
8065 code += mCategories.hashCode();
8066 }
8067 return code;
8068 }
8069
8070 @Override
8071 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008072 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008073
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008074 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008075 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008076 b.append(" }");
8077
8078 return b.toString();
8079 }
8080
8081 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008082 public String toInsecureString() {
8083 StringBuilder b = new StringBuilder(128);
8084
8085 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008086 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008087 b.append(" }");
8088
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008089 return b.toString();
8090 }
Romain Guy4969af72009-06-17 10:53:19 -07008091
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008092 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008093 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008094 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008095
8096 b.append("Intent { ");
8097 toShortString(b, false, true, true, true);
8098 b.append(" }");
8099
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008100 return b.toString();
8101 }
8102
8103 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008104 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8105 StringBuilder b = new StringBuilder(128);
8106 toShortString(b, secure, comp, extras, clip);
8107 return b.toString();
8108 }
8109
8110 /** @hide */
8111 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8112 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008113 boolean first = true;
8114 if (mAction != null) {
8115 b.append("act=").append(mAction);
8116 first = false;
8117 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008118 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008119 if (!first) {
8120 b.append(' ');
8121 }
8122 first = false;
8123 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008124 for (int i=0; i<mCategories.size(); i++) {
8125 if (i > 0) b.append(',');
8126 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008127 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008128 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008129 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008130 if (mData != null) {
8131 if (!first) {
8132 b.append(' ');
8133 }
8134 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008135 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008136 if (secure) {
8137 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008138 } else {
8139 b.append(mData);
8140 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008141 }
8142 if (mType != null) {
8143 if (!first) {
8144 b.append(' ');
8145 }
8146 first = false;
8147 b.append("typ=").append(mType);
8148 }
8149 if (mFlags != 0) {
8150 if (!first) {
8151 b.append(' ');
8152 }
8153 first = false;
8154 b.append("flg=0x").append(Integer.toHexString(mFlags));
8155 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008156 if (mPackage != null) {
8157 if (!first) {
8158 b.append(' ');
8159 }
8160 first = false;
8161 b.append("pkg=").append(mPackage);
8162 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008163 if (comp && mComponent != null) {
8164 if (!first) {
8165 b.append(' ');
8166 }
8167 first = false;
8168 b.append("cmp=").append(mComponent.flattenToShortString());
8169 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008170 if (mSourceBounds != null) {
8171 if (!first) {
8172 b.append(' ');
8173 }
8174 first = false;
8175 b.append("bnds=").append(mSourceBounds.toShortString());
8176 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008177 if (mClipData != null) {
8178 if (!first) {
8179 b.append(' ');
8180 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008181 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008182 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008183 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008184 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008185 if (mClipData.getDescription() != null) {
8186 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8187 } else {
8188 first = true;
8189 }
8190 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008191 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008192 first = false;
8193 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008194 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008195 if (extras && mExtras != null) {
8196 if (!first) {
8197 b.append(' ');
8198 }
8199 first = false;
8200 b.append("(has extras)");
8201 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008202 if (mContentUserHint != UserHandle.USER_CURRENT) {
8203 if (!first) {
8204 b.append(' ');
8205 }
8206 first = false;
8207 b.append("u=").append(mContentUserHint);
8208 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008209 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008210 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008211 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008212 b.append("}");
8213 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008214 }
8215
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008216 /**
8217 * Call {@link #toUri} with 0 flags.
8218 * @deprecated Use {@link #toUri} instead.
8219 */
8220 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008221 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008222 return toUri(0);
8223 }
8224
8225 /**
8226 * Convert this Intent into a String holding a URI representation of it.
8227 * The returned URI string has been properly URI encoded, so it can be
8228 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8229 * Intent's data as the base URI, with an additional fragment describing
8230 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008231 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008232 * <p>You can convert the returned string back to an Intent with
8233 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008234 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008235 * @param flags Additional operating flags. Either 0,
8236 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008237 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008238 * @return Returns a URI encoding URI string describing the entire contents
8239 * of the Intent.
8240 */
8241 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008242 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008243 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8244 if (mPackage == null) {
8245 throw new IllegalArgumentException(
8246 "Intent must include an explicit package name to build an android-app: "
8247 + this);
8248 }
8249 uri.append("android-app://");
8250 uri.append(mPackage);
8251 String scheme = null;
8252 if (mData != null) {
8253 scheme = mData.getScheme();
8254 if (scheme != null) {
8255 uri.append('/');
8256 uri.append(scheme);
8257 String authority = mData.getEncodedAuthority();
8258 if (authority != null) {
8259 uri.append('/');
8260 uri.append(authority);
8261 String path = mData.getEncodedPath();
8262 if (path != null) {
8263 uri.append(path);
8264 }
8265 String queryParams = mData.getEncodedQuery();
8266 if (queryParams != null) {
8267 uri.append('?');
8268 uri.append(queryParams);
8269 }
8270 String fragment = mData.getEncodedFragment();
8271 if (fragment != null) {
8272 uri.append('#');
8273 uri.append(fragment);
8274 }
8275 }
8276 }
8277 }
8278 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8279 mPackage, flags);
8280 return uri.toString();
8281 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008282 String scheme = null;
8283 if (mData != null) {
8284 String data = mData.toString();
8285 if ((flags&URI_INTENT_SCHEME) != 0) {
8286 final int N = data.length();
8287 for (int i=0; i<N; i++) {
8288 char c = data.charAt(i);
8289 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8290 || c == '.' || c == '-') {
8291 continue;
8292 }
8293 if (c == ':' && i > 0) {
8294 // Valid scheme.
8295 scheme = data.substring(0, i);
8296 uri.append("intent:");
8297 data = data.substring(i+1);
8298 break;
8299 }
Tom Taylord4a47292009-12-21 13:59:18 -08008300
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008301 // No scheme.
8302 break;
8303 }
8304 }
8305 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008306
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008307 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8308 uri.append("intent:");
8309 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008310
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008311 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008312
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008313 return uri.toString();
8314 }
8315
8316 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8317 String defPackage, int flags) {
8318 StringBuilder frag = new StringBuilder(128);
8319
8320 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008321 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008322 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008323 // Note that for now we are not going to try to handle the
8324 // data part; not clear how to represent this as a URI, and
8325 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008326 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8327 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008328 }
8329
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008330 if (frag.length() > 0) {
8331 uri.append("#Intent;");
8332 uri.append(frag);
8333 uri.append("end");
8334 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008335 }
8336
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008337 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8338 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008339 if (scheme != null) {
8340 uri.append("scheme=").append(scheme).append(';');
8341 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008342 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008343 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008344 }
8345 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008346 for (int i=0; i<mCategories.size(); i++) {
8347 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008348 }
8349 }
8350 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008351 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008352 }
8353 if (mFlags != 0) {
8354 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8355 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008356 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008357 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8358 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008359 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008360 uri.append("component=").append(Uri.encode(
8361 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008362 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008363 if (mSourceBounds != null) {
8364 uri.append("sourceBounds=")
8365 .append(Uri.encode(mSourceBounds.flattenToString()))
8366 .append(';');
8367 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008368 if (mExtras != null) {
8369 for (String key : mExtras.keySet()) {
8370 final Object value = mExtras.get(key);
8371 char entryType =
8372 value instanceof String ? 'S' :
8373 value instanceof Boolean ? 'B' :
8374 value instanceof Byte ? 'b' :
8375 value instanceof Character ? 'c' :
8376 value instanceof Double ? 'd' :
8377 value instanceof Float ? 'f' :
8378 value instanceof Integer ? 'i' :
8379 value instanceof Long ? 'l' :
8380 value instanceof Short ? 's' :
8381 '\0';
8382
8383 if (entryType != '\0') {
8384 uri.append(entryType);
8385 uri.append('.');
8386 uri.append(Uri.encode(key));
8387 uri.append('=');
8388 uri.append(Uri.encode(value.toString()));
8389 uri.append(';');
8390 }
8391 }
8392 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008393 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008394
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008395 public int describeContents() {
8396 return (mExtras != null) ? mExtras.describeContents() : 0;
8397 }
8398
8399 public void writeToParcel(Parcel out, int flags) {
8400 out.writeString(mAction);
8401 Uri.writeToParcel(out, mData);
8402 out.writeString(mType);
8403 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008404 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008405 ComponentName.writeToParcel(mComponent, out);
8406
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008407 if (mSourceBounds != null) {
8408 out.writeInt(1);
8409 mSourceBounds.writeToParcel(out, flags);
8410 } else {
8411 out.writeInt(0);
8412 }
8413
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008414 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008415 final int N = mCategories.size();
8416 out.writeInt(N);
8417 for (int i=0; i<N; i++) {
8418 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008419 }
8420 } else {
8421 out.writeInt(0);
8422 }
8423
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008424 if (mSelector != null) {
8425 out.writeInt(1);
8426 mSelector.writeToParcel(out, flags);
8427 } else {
8428 out.writeInt(0);
8429 }
8430
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008431 if (mClipData != null) {
8432 out.writeInt(1);
8433 mClipData.writeToParcel(out, flags);
8434 } else {
8435 out.writeInt(0);
8436 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008437 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008438 out.writeBundle(mExtras);
8439 }
8440
8441 public static final Parcelable.Creator<Intent> CREATOR
8442 = new Parcelable.Creator<Intent>() {
8443 public Intent createFromParcel(Parcel in) {
8444 return new Intent(in);
8445 }
8446 public Intent[] newArray(int size) {
8447 return new Intent[size];
8448 }
8449 };
8450
Dianne Hackborneb034652009-09-07 00:49:58 -07008451 /** @hide */
8452 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008453 readFromParcel(in);
8454 }
8455
8456 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008457 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008458 mData = Uri.CREATOR.createFromParcel(in);
8459 mType = in.readString();
8460 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008461 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008462 mComponent = ComponentName.readFromParcel(in);
8463
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008464 if (in.readInt() != 0) {
8465 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8466 }
8467
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008468 int N = in.readInt();
8469 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008470 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008471 int i;
8472 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008473 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008474 }
8475 } else {
8476 mCategories = null;
8477 }
8478
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008479 if (in.readInt() != 0) {
8480 mSelector = new Intent(in);
8481 }
8482
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008483 if (in.readInt() != 0) {
8484 mClipData = new ClipData(in);
8485 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008486 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008487 mExtras = in.readBundle();
8488 }
8489
8490 /**
8491 * Parses the "intent" element (and its children) from XML and instantiates
8492 * an Intent object. The given XML parser should be located at the tag
8493 * where parsing should start (often named "intent"), from which the
8494 * basic action, data, type, and package and class name will be
8495 * retrieved. The function will then parse in to any child elements,
8496 * looking for <category android:name="xxx"> tags to add categories and
8497 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8498 * to the intent.
8499 *
8500 * @param resources The Resources to use when inflating resources.
8501 * @param parser The XML parser pointing at an "intent" tag.
8502 * @param attrs The AttributeSet interface for retrieving extended
8503 * attribute data at the current <var>parser</var> location.
8504 * @return An Intent object matching the XML data.
8505 * @throws XmlPullParserException If there was an XML parsing error.
8506 * @throws IOException If there was an I/O error.
8507 */
8508 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8509 throws XmlPullParserException, IOException {
8510 Intent intent = new Intent();
8511
8512 TypedArray sa = resources.obtainAttributes(attrs,
8513 com.android.internal.R.styleable.Intent);
8514
8515 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8516
8517 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8518 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8519 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8520
8521 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8522 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8523 if (packageName != null && className != null) {
8524 intent.setComponent(new ComponentName(packageName, className));
8525 }
8526
8527 sa.recycle();
8528
8529 int outerDepth = parser.getDepth();
8530 int type;
8531 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8532 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8533 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8534 continue;
8535 }
8536
8537 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008538 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008539 sa = resources.obtainAttributes(attrs,
8540 com.android.internal.R.styleable.IntentCategory);
8541 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8542 sa.recycle();
8543
8544 if (cat != null) {
8545 intent.addCategory(cat);
8546 }
8547 XmlUtils.skipCurrentTag(parser);
8548
Craig Mautner21d24a22014-04-23 11:45:37 -07008549 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008550 if (intent.mExtras == null) {
8551 intent.mExtras = new Bundle();
8552 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008553 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008554 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008555
8556 } else {
8557 XmlUtils.skipCurrentTag(parser);
8558 }
8559 }
8560
8561 return intent;
8562 }
Nick Pellyccae4122012-01-09 14:12:58 -08008563
Craig Mautner21d24a22014-04-23 11:45:37 -07008564 /** @hide */
8565 public void saveToXml(XmlSerializer out) throws IOException {
8566 if (mAction != null) {
8567 out.attribute(null, ATTR_ACTION, mAction);
8568 }
8569 if (mData != null) {
8570 out.attribute(null, ATTR_DATA, mData.toString());
8571 }
8572 if (mType != null) {
8573 out.attribute(null, ATTR_TYPE, mType);
8574 }
8575 if (mComponent != null) {
8576 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8577 }
8578 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8579
8580 if (mCategories != null) {
8581 out.startTag(null, TAG_CATEGORIES);
8582 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8583 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8584 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008585 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008586 }
8587 }
8588
8589 /** @hide */
8590 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8591 XmlPullParserException {
8592 Intent intent = new Intent();
8593 final int outerDepth = in.getDepth();
8594
8595 int attrCount = in.getAttributeCount();
8596 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8597 final String attrName = in.getAttributeName(attrNdx);
8598 final String attrValue = in.getAttributeValue(attrNdx);
8599 if (ATTR_ACTION.equals(attrName)) {
8600 intent.setAction(attrValue);
8601 } else if (ATTR_DATA.equals(attrName)) {
8602 intent.setData(Uri.parse(attrValue));
8603 } else if (ATTR_TYPE.equals(attrName)) {
8604 intent.setType(attrValue);
8605 } else if (ATTR_COMPONENT.equals(attrName)) {
8606 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8607 } else if (ATTR_FLAGS.equals(attrName)) {
8608 intent.setFlags(Integer.valueOf(attrValue, 16));
8609 } else {
8610 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8611 }
8612 }
8613
8614 int event;
8615 String name;
8616 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8617 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8618 if (event == XmlPullParser.START_TAG) {
8619 name = in.getName();
8620 if (TAG_CATEGORIES.equals(name)) {
8621 attrCount = in.getAttributeCount();
8622 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8623 intent.addCategory(in.getAttributeValue(attrNdx));
8624 }
8625 } else {
8626 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8627 XmlUtils.skipCurrentTag(in);
8628 }
8629 }
8630 }
8631
8632 return intent;
8633 }
8634
Nick Pellyccae4122012-01-09 14:12:58 -08008635 /**
8636 * Normalize a MIME data type.
8637 *
8638 * <p>A normalized MIME type has white-space trimmed,
8639 * content-type parameters removed, and is lower-case.
8640 * This aligns the type with Android best practices for
8641 * intent filtering.
8642 *
8643 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8644 * "text/x-vCard" becomes "text/x-vcard".
8645 *
8646 * <p>All MIME types received from outside Android (such as user input,
8647 * or external sources like Bluetooth, NFC, or the Internet) should
8648 * be normalized before they are used to create an Intent.
8649 *
8650 * @param type MIME data type to normalize
8651 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008652 * @see #setType
8653 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008654 */
8655 public static String normalizeMimeType(String type) {
8656 if (type == null) {
8657 return null;
8658 }
8659
Elliott Hughescb64d432013-08-02 10:00:44 -07008660 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008661
8662 final int semicolonIndex = type.indexOf(';');
8663 if (semicolonIndex != -1) {
8664 type = type.substring(0, semicolonIndex);
8665 }
8666 return type;
8667 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008668
8669 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008670 * Prepare this {@link Intent} to leave an app process.
8671 *
8672 * @hide
8673 */
8674 public void prepareToLeaveProcess() {
8675 setAllowFds(false);
8676
8677 if (mSelector != null) {
8678 mSelector.prepareToLeaveProcess();
8679 }
8680 if (mClipData != null) {
8681 mClipData.prepareToLeaveProcess();
8682 }
8683
8684 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
8685 // There are several ACTION_MEDIA_* broadcasts that send file://
8686 // Uris, so only check common actions.
8687 if (ACTION_VIEW.equals(mAction) ||
8688 ACTION_EDIT.equals(mAction) ||
8689 ACTION_ATTACH_DATA.equals(mAction)) {
8690 mData.checkFileUriExposed("Intent.getData()");
8691 }
8692 }
8693 }
8694
8695 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008696 * @hide
8697 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008698 public void prepareToEnterProcess() {
8699 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008700 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8701 fixUris(mContentUserHint);
8702 mContentUserHint = UserHandle.USER_CURRENT;
8703 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008704 }
8705 }
8706
8707 /**
8708 * @hide
8709 */
8710 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008711 Uri data = getData();
8712 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008713 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008714 }
8715 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008716 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008717 }
8718 String action = getAction();
8719 if (ACTION_SEND.equals(action)) {
8720 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8721 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008722 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008723 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008724 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008725 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8726 if (streams != null) {
8727 ArrayList<Uri> newStreams = new ArrayList<Uri>();
8728 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008729 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008730 }
8731 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
8732 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008733 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8734 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8735 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8736 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8737 if (output != null) {
8738 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
8739 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008740 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008741 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008742
8743 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008744 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008745 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
8746 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008747 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008748 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008749 * @hide
8750 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008751 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008752 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008753 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008754
8755 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008756 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008757
8758 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008759 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008760 // Inspect contained intents to see if we need to migrate extras. We
8761 // don't promote ClipData to the parent, since ChooserActivity will
8762 // already start the picked item as the caller, and we can't combine
8763 // the flags in a safe way.
8764
8765 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07008766 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008767 final Intent intent = getParcelableExtra(EXTRA_INTENT);
8768 if (intent != null) {
8769 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07008770 }
8771 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008772 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008773 try {
8774 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
8775 if (intents != null) {
8776 for (int i = 0; i < intents.length; i++) {
8777 final Intent intent = (Intent) intents[i];
8778 if (intent != null) {
8779 migrated |= intent.migrateExtraStreamToClipData();
8780 }
8781 }
8782 }
8783 } catch (ClassCastException e) {
8784 }
8785 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008786
8787 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008788 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008789 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8790 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
8791 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
8792 if (stream != null || text != null || htmlText != null) {
8793 final ClipData clipData = new ClipData(
8794 null, new String[] { getType() },
8795 new ClipData.Item(text, htmlText, null, stream));
8796 setClipData(clipData);
8797 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008798 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008799 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008800 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008801 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008802
8803 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008804 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008805 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8806 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
8807 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
8808 int num = -1;
8809 if (streams != null) {
8810 num = streams.size();
8811 }
8812 if (texts != null) {
8813 if (num >= 0 && num != texts.size()) {
8814 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008815 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008816 }
8817 num = texts.size();
8818 }
8819 if (htmlTexts != null) {
8820 if (num >= 0 && num != htmlTexts.size()) {
8821 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008822 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008823 }
8824 num = htmlTexts.size();
8825 }
8826 if (num > 0) {
8827 final ClipData clipData = new ClipData(
8828 null, new String[] { getType() },
8829 makeClipItem(streams, texts, htmlTexts, 0));
8830
8831 for (int i = 1; i < num; i++) {
8832 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
8833 }
8834
8835 setClipData(clipData);
8836 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008837 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008838 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008839 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008840 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008841 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8842 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8843 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8844 final Uri output;
8845 try {
8846 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8847 } catch (ClassCastException e) {
8848 return false;
8849 }
8850 if (output != null) {
8851 setClipData(ClipData.newRawUri("", output));
8852 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
8853 return true;
8854 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008855 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008856
8857 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008858 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07008859
8860 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
8861 ArrayList<String> htmlTexts, int which) {
8862 Uri uri = streams != null ? streams.get(which) : null;
8863 CharSequence text = texts != null ? texts.get(which) : null;
8864 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
8865 return new ClipData.Item(text, htmlText, null, uri);
8866 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07008867
8868 /** @hide */
8869 public boolean isDocument() {
8870 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
8871 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008872}