blob: 35cd2bef6093ca838ae2a4ee4b08014f53c045aa [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";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001929
1930 /**
1931 * Broadcast Action: This is broadcast once, after the system has finished
1932 * booting and the user is in a "locked" state. A user is locked when their
1933 * credential-encrypted private app data storage is unavailable. Once the
1934 * user has entered their credentials (such as a lock pattern or PIN) for
1935 * the first time, the {@link #ACTION_BOOT_COMPLETED} broadcast will be
1936 * sent.
1937 * <p>
1938 * You must hold the
1939 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1940 * order to receive this broadcast.
1941 * <p class="note">
1942 * This is a protected intent that can only be sent by the system.
1943 */
1944 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1945 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1946
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001947 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001948 * Broadcast Action: This is broadcast once, after the system has finished
1949 * booting. It can be used to perform application-specific initialization,
1950 * such as installing alarms. You must hold the
1951 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1952 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001953 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001954 * <p class="note">This is a protected intent that can only be sent
1955 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001956 */
1957 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1958 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001959
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001960 /**
1961 * Broadcast Action: This is broadcast when a user action should request a
1962 * temporary system dialog to dismiss. Some examples of temporary system
1963 * dialogs are the notification window-shade and the recent tasks dialog.
1964 */
1965 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1966 /**
1967 * Broadcast Action: Trigger the download and eventual installation
1968 * of a package.
1969 * <p>Input: {@link #getData} is the URI of the package file to download.
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.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001973 *
1974 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001975 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001976 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001977 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1978 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1979 /**
1980 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001981 * device. The data contains the name of the package. Note that the
1982 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001983 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001984 * <ul>
1985 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1986 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1987 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1988 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001989 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001990 * <p class="note">This is a protected intent that can only be sent
1991 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001992 */
1993 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1994 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1995 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001996 * Broadcast Action: A new version of an application package has been
1997 * installed, replacing an existing version that was previously installed.
1998 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001999 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002000 * <ul>
2001 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2002 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002003 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002004 * <p class="note">This is a protected intent that can only be sent
2005 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002006 */
2007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2008 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2009 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002010 * Broadcast Action: A new version of your application has been installed
2011 * over an existing one. This is only sent to the application that was
2012 * replaced. It does not contain any additional data; to receive it, just
2013 * use an intent filter for this action.
2014 *
2015 * <p class="note">This is a protected intent that can only be sent
2016 * by the system.
2017 */
2018 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2019 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2020 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002021 * Broadcast Action: An existing application package has been removed from
2022 * the device. The data contains the name of the package. The package
2023 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002024 * <ul>
2025 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2026 * to the package.
2027 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2028 * application -- data and code -- is being removed.
2029 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2030 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2031 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002032 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002033 * <p class="note">This is a protected intent that can only be sent
2034 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002035 */
2036 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2037 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2038 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002039 * Broadcast Action: An existing application package has been completely
2040 * removed from the device. The data contains the name of the package.
2041 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2042 * {@link #EXTRA_DATA_REMOVED} is true and
2043 * {@link #EXTRA_REPLACING} is false of that broadcast.
2044 *
2045 * <ul>
2046 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2047 * to the package.
2048 * </ul>
2049 *
2050 * <p class="note">This is a protected intent that can only be sent
2051 * by the system.
2052 */
2053 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2054 public static final String ACTION_PACKAGE_FULLY_REMOVED
2055 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2056 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002057 * Broadcast Action: An existing application package has been changed (e.g.
2058 * a component has been enabled or disabled). The data contains the name of
2059 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002060 * <ul>
2061 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002062 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002063 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002064 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2065 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002066 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002067 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002068 * <p class="note">This is a protected intent that can only be sent
2069 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002070 */
2071 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2072 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2073 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002074 * @hide
2075 * Broadcast Action: Ask system services if there is any reason to
2076 * restart the given package. The data contains the name of the
2077 * package.
2078 * <ul>
2079 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2080 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2081 * </ul>
2082 *
2083 * <p class="note">This is a protected intent that can only be sent
2084 * by the system.
2085 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002086 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002087 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2088 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2089 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002090 * Broadcast Action: The user has restarted a package, and all of its
2091 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002092 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002093 * be removed. Note that the restarted package does <em>not</em>
2094 * receive this broadcast.
2095 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002096 * <ul>
2097 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2098 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002099 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002100 * <p class="note">This is a protected intent that can only be sent
2101 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002102 */
2103 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2104 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2105 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002106 * Broadcast Action: The user has cleared the data of a package. This should
2107 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002108 * its persistent data is erased and this broadcast sent.
2109 * Note that the cleared package does <em>not</em>
2110 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002111 * <ul>
2112 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2113 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002114 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002115 * <p class="note">This is a protected intent that can only be sent
2116 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002117 */
2118 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2119 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2120 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002121 * Broadcast Action: A user ID has been removed from the system. The user
2122 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002123 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002124 * <p class="note">This is a protected intent that can only be sent
2125 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002126 */
2127 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2128 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002129
2130 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002131 * Broadcast Action: Sent to the installer package of an application
2132 * when that application is first launched (that is the first time it
2133 * is moved out of the stopped state). The data contains the name of the package.
2134 *
2135 * <p class="note">This is a protected intent that can only be sent
2136 * by the system.
2137 */
2138 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2139 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2140
2141 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002142 * Broadcast Action: Sent to the system package verifier when a package
2143 * needs to be verified. The data contains the package URI.
2144 * <p class="note">
2145 * This is a protected intent that can only be sent by the system.
2146 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002147 */
2148 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2149 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2150
2151 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002152 * Broadcast Action: Sent to the system package verifier when a package is
2153 * verified. The data contains the package URI.
2154 * <p class="note">
2155 * This is a protected intent that can only be sent by the system.
2156 */
2157 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2158 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2159
2160 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002161 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
2162 * needs to be verified. The data contains the filter data hosts to be verified against.
2163 * <p class="note">
2164 * This is a protected intent that can only be sent by the system.
2165 * </p>
2166 *
2167 * @hide
2168 */
2169 @SystemApi
2170 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2171 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2172
2173 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002174 * Broadcast Action: Resources for a set of packages (which were
2175 * previously unavailable) are currently
2176 * available since the media on which they exist is available.
2177 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2178 * list of packages whose availability changed.
2179 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2180 * list of uids of packages whose availability changed.
2181 * Note that the
2182 * packages in this list do <em>not</em> receive this broadcast.
2183 * The specified set of packages are now available on the system.
2184 * <p>Includes the following extras:
2185 * <ul>
2186 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2187 * whose resources(were previously unavailable) are currently available.
2188 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2189 * packages whose resources(were previously unavailable)
2190 * are currently available.
2191 * </ul>
2192 *
2193 * <p class="note">This is a protected intent that can only be sent
2194 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002195 */
2196 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002197 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2198 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002199
2200 /**
2201 * Broadcast Action: Resources for a set of packages are currently
2202 * unavailable since the media on which they exist is unavailable.
2203 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2204 * list of packages whose availability changed.
2205 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2206 * list of uids of packages whose availability changed.
2207 * The specified set of packages can no longer be
2208 * launched and are practically unavailable on the system.
2209 * <p>Inclues the following extras:
2210 * <ul>
2211 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2212 * whose resources are no longer available.
2213 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2214 * whose resources are no longer available.
2215 * </ul>
2216 *
2217 * <p class="note">This is a protected intent that can only be sent
2218 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002219 */
2220 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002221 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002222 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002223
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002224 /**
2225 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002226 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002227 * This should <em>only</em> be used to determine when the wallpaper
2228 * has changed to show the new wallpaper to the user. You should certainly
2229 * never, in response to this, change the wallpaper or other attributes of
2230 * it such as the suggested size. That would be crazy, right? You'd cause
2231 * all kinds of loops, especially if other apps are doing similar things,
2232 * right? Of course. So please don't do this.
2233 *
2234 * @deprecated Modern applications should use
2235 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2236 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2237 * shown behind their UI, rather than watching for this broadcast and
2238 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002239 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002240 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002241 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2242 /**
2243 * Broadcast Action: The current device {@link android.content.res.Configuration}
2244 * (orientation, locale, etc) has changed. When such a change happens, the
2245 * UIs (view hierarchy) will need to be rebuilt based on this new
2246 * information; for the most part, applications don't need to worry about
2247 * this, because the system will take care of stopping and restarting the
2248 * application to make sure it sees the new changes. Some system code that
2249 * can not be restarted will need to watch for this action and handle it
2250 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002251 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002252 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002253 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002254 * in manifests, only by explicitly registering for it with
2255 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2256 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002257 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002258 * <p class="note">This is a protected intent that can only be sent
2259 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002260 *
2261 * @see android.content.res.Configuration
2262 */
2263 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2264 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2265 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002266 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002267 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002268 * <p class="note">This is a protected intent that can only be sent
2269 * by the system.
2270 */
2271 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2272 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2273 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002274 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2275 * charging state, level, and other information about the battery.
2276 * See {@link android.os.BatteryManager} for documentation on the
2277 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002278 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002279 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002280 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002281 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002282 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002283 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2284 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2285 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2286 * broadcasts that are sent and can be received through manifest
2287 * receivers.
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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002291 */
2292 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2293 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2294 /**
2295 * Broadcast Action: Indicates low battery condition on the device.
2296 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002297 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002298 * <p class="note">This is a protected intent that can only be sent
2299 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002300 */
2301 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2302 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2303 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002304 * Broadcast Action: Indicates the battery is now okay after being low.
2305 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2306 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002307 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002308 * <p class="note">This is a protected intent that can only be sent
2309 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002310 */
2311 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2312 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2313 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002314 * Broadcast Action: External power has been connected to the device.
2315 * This is intended for applications that wish to register specifically to this notification.
2316 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2317 * stay active to receive this notification. This action can be used to implement actions
2318 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002319 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002320 * <p class="note">This is a protected intent that can only be sent
2321 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002322 */
2323 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002324 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002325 /**
2326 * Broadcast Action: External power has been removed from the device.
2327 * This is intended for applications that wish to register specifically to this notification.
2328 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2329 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002330 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002331 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002332 * <p class="note">This is a protected intent that can only be sent
2333 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002334 */
2335 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002336 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002337 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002338 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002339 * Broadcast Action: Device is shutting down.
2340 * This is broadcast when the device is being shut down (completely turned
2341 * off, not sleeping). Once the broadcast is complete, the final shutdown
2342 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002343 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002344 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002345 * <p class="note">This is a protected intent that can only be sent
2346 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002347 * <p>May include the following extras:
2348 * <ul>
2349 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2350 * shutdown is only for userspace processes. If not set, assumed to be false.
2351 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002352 */
2353 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002354 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002355 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002356 * Activity Action: Start this activity to request system shutdown.
2357 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002358 * to request confirmation from the user before shutting down. The optional boolean
2359 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2360 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002361 *
2362 * <p class="note">This is a protected intent that can only be sent
2363 * by the system.
2364 *
2365 * {@hide}
2366 */
2367 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2368 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002369 * Broadcast Action: A sticky broadcast that indicates low memory
2370 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002371 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002372 * <p class="note">This is a protected intent that can only be sent
2373 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002374 */
2375 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2376 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2377 /**
2378 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002379 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002380 * <p class="note">This is a protected intent that can only be sent
2381 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002382 */
2383 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2384 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2385 /**
Jake Hambybb371632010-08-23 18:16:48 -07002386 * Broadcast Action: A sticky broadcast that indicates a memory full
2387 * condition on the device. This is intended for activities that want
2388 * to be able to fill the data partition completely, leaving only
2389 * enough free space to prevent system-wide SQLite failures.
2390 *
2391 * <p class="note">This is a protected intent that can only be sent
2392 * by the system.
2393 *
2394 * {@hide}
2395 */
2396 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2397 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2398 /**
2399 * Broadcast Action: Indicates memory full condition on the device
2400 * no longer exists.
2401 *
2402 * <p class="note">This is a protected intent that can only be sent
2403 * by the system.
2404 *
2405 * {@hide}
2406 */
2407 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2408 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2409 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002410 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2411 * and package management should be started.
2412 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2413 * notification.
2414 */
2415 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2416 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2417 /**
2418 * Broadcast Action: The device has entered USB Mass Storage mode.
2419 * This is used mainly for the USB Settings panel.
2420 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2421 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002422 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002423 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002424 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002425 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2426
2427 /**
2428 * Broadcast Action: The device has exited USB Mass Storage mode.
2429 * This is used mainly for the USB Settings panel.
2430 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2431 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002432 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002433 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002434 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002435 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2436
2437 /**
2438 * Broadcast Action: External media has been removed.
2439 * The path to the mount point for the removed media is contained in the Intent.mData field.
2440 */
2441 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2442 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2443
2444 /**
2445 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002446 * 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 -07002447 */
2448 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2449 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2450
2451 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002452 * Broadcast Action: External media is present, and being disk-checked
2453 * 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 -08002454 */
2455 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2456 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2457
2458 /**
2459 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2460 * 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 -08002461 */
2462 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2463 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2464
2465 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002466 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002467 * 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 -07002468 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2469 * media was mounted read only.
2470 */
2471 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2472 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2473
2474 /**
2475 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002476 * 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 -07002477 */
2478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2479 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2480
2481 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002482 * Broadcast Action: External media is no longer being shared via USB mass storage.
2483 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2484 *
2485 * @hide
2486 */
2487 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2488
2489 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002490 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2491 * The path to the mount point for the removed media is contained in the Intent.mData field.
2492 */
2493 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2494 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2495
2496 /**
2497 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002498 * 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 -07002499 */
2500 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2501 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2502
2503 /**
2504 * Broadcast Action: User has expressed the desire to remove the external storage media.
2505 * Applications should close all files they have open within the mount point when they receive this intent.
2506 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2507 */
2508 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2509 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2510
2511 /**
2512 * Broadcast Action: The media scanner has started scanning a directory.
2513 * The path to the directory being scanned is contained in the Intent.mData field.
2514 */
2515 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2516 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2517
2518 /**
2519 * Broadcast Action: The media scanner has finished scanning a directory.
2520 * The path to the scanned directory is contained in the Intent.mData field.
2521 */
2522 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2523 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2524
2525 /**
2526 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2527 * The path to the file is contained in the Intent.mData field.
2528 */
2529 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2530 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2531
2532 /**
2533 * Broadcast Action: The "Media Button" was pressed. Includes a single
2534 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2535 * caused the broadcast.
2536 */
2537 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2538 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2539
2540 /**
2541 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2542 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2543 * caused the broadcast.
2544 */
2545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2546 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2547
2548 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2549 // location; they are not general-purpose actions.
2550
2551 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002552 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002553 */
2554 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2555 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2556 "android.intent.action.GTALK_CONNECTED";
2557
2558 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002559 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002560 */
2561 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2562 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2563 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002564
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002565 /**
2566 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002567 */
2568 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2569 public static final String ACTION_INPUT_METHOD_CHANGED =
2570 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002571
2572 /**
2573 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2574 * more radios have been turned off or on. The intent will have the following extra value:</p>
2575 * <ul>
2576 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2577 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2578 * turned off</li>
2579 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002580 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002581 * <p class="note">This is a protected intent that can only be sent
2582 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002583 */
2584 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2585 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2586
2587 /**
2588 * Broadcast Action: Some content providers have parts of their namespace
2589 * where they publish new events or items that the user may be especially
2590 * interested in. For these things, they may broadcast this action when the
2591 * set of interesting items change.
2592 *
2593 * For example, GmailProvider sends this notification when the set of unread
2594 * mail in the inbox changes.
2595 *
2596 * <p>The data of the intent identifies which part of which provider
2597 * changed. When queried through the content resolver, the data URI will
2598 * return the data set in question.
2599 *
2600 * <p>The intent will have the following extra values:
2601 * <ul>
2602 * <li><em>count</em> - The number of items in the data set. This is the
2603 * same as the number of items in the cursor returned by querying the
2604 * data URI. </li>
2605 * </ul>
2606 *
2607 * This intent will be sent at boot (if the count is non-zero) and when the
2608 * data set changes. It is possible for the data set to change without the
2609 * count changing (for example, if a new unread message arrives in the same
2610 * sync operation in which a message is archived). The phone should still
2611 * ring/vibrate/etc as normal in this case.
2612 */
2613 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2614 public static final String ACTION_PROVIDER_CHANGED =
2615 "android.intent.action.PROVIDER_CHANGED";
2616
2617 /**
2618 * Broadcast Action: Wired Headset plugged in or unplugged.
2619 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002620 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2621 * and documentation.
2622 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002623 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002624 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002625 */
2626 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002627 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002628
2629 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002630 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2631 * <ul>
2632 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2633 * </ul>
2634 *
2635 * <p class="note">This is a protected intent that can only be sent
2636 * by the system.
2637 *
2638 * @hide
2639 */
2640 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2641 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2642 = "android.intent.action.ADVANCED_SETTINGS";
2643
2644 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002645 * Broadcast Action: Sent after application restrictions are changed.
2646 *
2647 * <p class="note">This is a protected intent that can only be sent
2648 * by the system.</p>
2649 */
2650 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2651 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2652 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2653
2654 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002655 * Broadcast Action: An outgoing call is about to be placed.
2656 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002657 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002658 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002659 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002660 * the phone number originally intended to be dialed.</li>
2661 * </ul>
2662 * <p>Once the broadcast is finished, the resultData is used as the actual
2663 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002664 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002665 * outgoing call in turn: for example, a parental control application
2666 * might verify that the user is authorized to place the call at that
2667 * time, then a number-rewriting application might add an area code if
2668 * one was not specified.</p>
2669 * <p>For consistency, any receiver whose purpose is to prohibit phone
2670 * calls should have a priority of 0, to ensure it will see the final
2671 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002672 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002673 * should have a positive priority.
2674 * Negative priorities are reserved for the system for this broadcast;
2675 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002676 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2677 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002678 * <p>Emergency calls cannot be intercepted using this mechanism, and
2679 * other calls cannot be modified to call emergency numbers using this
2680 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002681 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2682 * call to use their own service instead. Those apps should first prevent
2683 * the call from being placed by setting resultData to <code>null</code>
2684 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002685 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002686 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2687 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002688 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002689 * <p class="note">This is a protected intent that can only be sent
2690 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002691 */
2692 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2693 public static final String ACTION_NEW_OUTGOING_CALL =
2694 "android.intent.action.NEW_OUTGOING_CALL";
2695
2696 /**
2697 * Broadcast Action: Have the device reboot. This is only for use by
2698 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002699 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002700 * <p class="note">This is a protected intent that can only be sent
2701 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002702 */
2703 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2704 public static final String ACTION_REBOOT =
2705 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002706
Wei Huang97ecc9c2009-05-11 17:44:20 -07002707 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002708 * Broadcast Action: A sticky broadcast for changes in the physical
2709 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002710 *
2711 * <p>The intent will have the following extra values:
2712 * <ul>
2713 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002714 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002715 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002716 * <p>This is intended for monitoring the current physical dock state.
2717 * See {@link android.app.UiModeManager} for the normal API dealing with
2718 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002719 */
2720 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2721 public static final String ACTION_DOCK_EVENT =
2722 "android.intent.action.DOCK_EVENT";
2723
2724 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002725 * Broadcast Action: A broadcast when idle maintenance can be started.
2726 * This means that the user is not interacting with the device and is
2727 * not expected to do so soon. Typical use of the idle maintenance is
2728 * to perform somehow expensive tasks that can be postponed at a moment
2729 * when they will not degrade user experience.
2730 * <p>
2731 * <p class="note">In order to keep the device responsive in case of an
2732 * unexpected user interaction, implementations of a maintenance task
2733 * should be interruptible. In such a scenario a broadcast with action
2734 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2735 * should not do the maintenance work in
2736 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2737 * maintenance service by {@link Context#startService(Intent)}. Also
2738 * you should hold a wake lock while your maintenance service is running
2739 * to prevent the device going to sleep.
2740 * </p>
2741 * <p>
2742 * <p class="note">This is a protected intent that can only be sent by
2743 * the system.
2744 * </p>
2745 *
2746 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002747 *
2748 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002749 */
2750 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2751 public static final String ACTION_IDLE_MAINTENANCE_START =
2752 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2753
2754 /**
2755 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2756 * This means that the user was not interacting with the device as a result
2757 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2758 * was sent and now the user started interacting with the device. Typical
2759 * use of the idle maintenance is to perform somehow expensive tasks that
2760 * can be postponed at a moment when they will not degrade user experience.
2761 * <p>
2762 * <p class="note">In order to keep the device responsive in case of an
2763 * unexpected user interaction, implementations of a maintenance task
2764 * should be interruptible. Hence, on receiving a broadcast with this
2765 * action, the maintenance task should be interrupted as soon as possible.
2766 * In other words, you should not do the maintenance work in
2767 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2768 * maintenance service that was started on receiving of
2769 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2770 * lock you acquired when your maintenance service started.
2771 * </p>
2772 * <p class="note">This is a protected intent that can only be sent
2773 * by the system.
2774 *
2775 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002776 *
2777 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002778 */
2779 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2780 public static final String ACTION_IDLE_MAINTENANCE_END =
2781 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2782
2783 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002784 * Broadcast Action: a remote intent is to be broadcasted.
2785 *
2786 * A remote intent is used for remote RPC between devices. The remote intent
2787 * is serialized and sent from one device to another device. The receiving
2788 * device parses the remote intent and broadcasts it. Note that anyone can
2789 * broadcast a remote intent. However, if the intent receiver of the remote intent
2790 * does not trust intent broadcasts from arbitrary intent senders, it should require
2791 * the sender to hold certain permissions so only trusted sender's broadcast will be
2792 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002793 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002794 */
2795 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002796 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002797
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002798 /**
2799 * Broadcast Action: hook for permforming cleanup after a system update.
2800 *
2801 * The broadcast is sent when the system is booting, before the
2802 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2803 * image. A receiver for this should do its work and then disable itself
2804 * so that it does not get run again at the next boot.
2805 * @hide
2806 */
2807 public static final String ACTION_PRE_BOOT_COMPLETED =
2808 "android.intent.action.PRE_BOOT_COMPLETED";
2809
Amith Yamasani13593602012-03-22 16:16:17 -07002810 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002811 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002812 * on restricted users. The broadcast intent contains an extra
2813 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2814 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2815 * String[] depending on the restriction type.<p/>
2816 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002817 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2818 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2819 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002820 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2821 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002822 * @see RestrictionEntry
2823 */
2824 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2825 "android.intent.action.GET_RESTRICTION_ENTRIES";
2826
2827 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002828 * Sent the first time a user is starting, to allow system apps to
2829 * perform one time initialization. (This will not be seen by third
2830 * party applications because a newly initialized user does not have any
2831 * third party applications installed for it.) This is sent early in
2832 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002833 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2834 * broadcast, since it is part of a visible user interaction; be as quick
2835 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002836 */
2837 public static final String ACTION_USER_INITIALIZE =
2838 "android.intent.action.USER_INITIALIZE";
2839
2840 /**
2841 * Sent when a user switch is happening, causing the process's user to be
2842 * brought to the foreground. This is only sent to receivers registered
2843 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2844 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002845 * foreground. This is sent as a foreground
2846 * broadcast, since it is part of a visible user interaction; be as quick
2847 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002848 */
2849 public static final String ACTION_USER_FOREGROUND =
2850 "android.intent.action.USER_FOREGROUND";
2851
2852 /**
2853 * Sent when a user switch is happening, causing the process's user to be
2854 * sent to the background. This is only sent to receivers registered
2855 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2856 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002857 * background. This is sent as a foreground
2858 * broadcast, since it is part of a visible user interaction; be as quick
2859 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002860 */
2861 public static final String ACTION_USER_BACKGROUND =
2862 "android.intent.action.USER_BACKGROUND";
2863
2864 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002865 * Broadcast sent to the system when a user is added. Carries an extra
2866 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2867 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002868 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002869 * @hide
2870 */
2871 public static final String ACTION_USER_ADDED =
2872 "android.intent.action.USER_ADDED";
2873
2874 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002875 * Broadcast sent by the system when a user is started. Carries an extra
2876 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002877 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002878 * that has been started. This is sent as a foreground
2879 * broadcast, since it is part of a visible user interaction; be as quick
2880 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002881 * @hide
2882 */
2883 public static final String ACTION_USER_STARTED =
2884 "android.intent.action.USER_STARTED";
2885
2886 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002887 * Broadcast sent when a user is in the process of starting. Carries an extra
2888 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2889 * sent to registered receivers, not manifest receivers. It is sent to all
2890 * users (including the one that is being started). You must hold
2891 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2892 * this broadcast. This is sent as a background broadcast, since
2893 * its result is not part of the primary UX flow; to safely keep track of
2894 * started/stopped state of a user you can use this in conjunction with
2895 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2896 * other user state broadcasts since those are foreground broadcasts so can
2897 * execute in a different order.
2898 * @hide
2899 */
2900 public static final String ACTION_USER_STARTING =
2901 "android.intent.action.USER_STARTING";
2902
2903 /**
2904 * Broadcast sent when a user is going to be stopped. Carries an extra
2905 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2906 * sent to registered receivers, not manifest receivers. It is sent to all
2907 * users (including the one that is being stopped). You must hold
2908 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2909 * this broadcast. The user will not stop until all receivers have
2910 * handled the broadcast. This is sent as a background broadcast, since
2911 * its result is not part of the primary UX flow; to safely keep track of
2912 * started/stopped state of a user you can use this in conjunction with
2913 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2914 * other user state broadcasts since those are foreground broadcasts so can
2915 * execute in a different order.
2916 * @hide
2917 */
2918 public static final String ACTION_USER_STOPPING =
2919 "android.intent.action.USER_STOPPING";
2920
2921 /**
2922 * Broadcast sent to the system when a user is stopped. Carries an extra
2923 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2924 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2925 * specific package. This is only sent to registered receivers, not manifest
2926 * receivers. It is sent to all running users <em>except</em> the one that
2927 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002928 * @hide
2929 */
2930 public static final String ACTION_USER_STOPPED =
2931 "android.intent.action.USER_STOPPED";
2932
2933 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002934 * 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 -07002935 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002936 * one that has been removed. The user will not be completely removed until all receivers have
2937 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002938 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002939 * @hide
2940 */
2941 public static final String ACTION_USER_REMOVED =
2942 "android.intent.action.USER_REMOVED";
2943
2944 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002945 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002946 * the userHandle of the user to become the current one. This is only sent to
2947 * registered receivers, not manifest receivers. It is sent to all running users.
2948 * You must hold
2949 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002950 * @hide
2951 */
2952 public static final String ACTION_USER_SWITCHED =
2953 "android.intent.action.USER_SWITCHED";
2954
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002955 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07002956 * Broadcast Action: Sent when the credential-encrypted private storage has
2957 * become unlocked for the target user. This is only sent to registered
2958 * receivers, not manifest receivers.
2959 */
2960 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2961 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
2962
2963 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002964 * Broadcast sent to the system when a user's information changes. Carries an extra
2965 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002966 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002967 * @hide
2968 */
2969 public static final String ACTION_USER_INFO_CHANGED =
2970 "android.intent.action.USER_INFO_CHANGED";
2971
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002972 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002973 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2974 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002975 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2976 * that need to display merged content across both primary and managed profiles need to
2977 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002978 * not manifest receivers.
2979 */
2980 public static final String ACTION_MANAGED_PROFILE_ADDED =
2981 "android.intent.action.MANAGED_PROFILE_ADDED";
2982
2983 /**
2984 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002985 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2986 * Only applications (for example Launchers) that need to display merged content across both
2987 * primary and managed profiles need to worry about this broadcast. This is only sent to
2988 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002989 */
2990 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2991 "android.intent.action.MANAGED_PROFILE_REMOVED";
2992
2993 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00002994 * Broadcast sent to the primary user when an associated managed profile's availability has
2995 * changed. This includes when the user toggles the profile's quiet mode, or when the profile
2996 * owner suspends the profile. Carries an extra {@link #EXTRA_USER} that specifies the
2997 * UserHandle of the profile. When quiet mode is changed, this broadcast will carry a boolean
2998 * extra {@link #EXTRA_QUIET_MODE} indicating the new state of quiet mode. This is only sent to
2999 * registered receivers, not manifest receivers.
3000 */
3001 public static final String ACTION_MANAGED_PROFILE_AVAILABILITY_CHANGED =
3002 "android.intent.action.MANAGED_PROFILE_AVAILABILITY_CHANGED";
3003
3004 /**
3005 * Broadcast sent to the managed profile when its availability has changed. This includes when
3006 * the user toggles the profile's quiet mode, or when the profile owner suspends the profile.
3007 * When quiet mode is changed, this broadcast will carry a boolean extra
3008 * {@link #EXTRA_QUIET_MODE} indicating the new state of quiet mode. This is only sent to
3009 * registered receivers, not manifest receivers. See also
3010 * {@link #ACTION_MANAGED_PROFILE_AVAILABILITY_CHANGED}
3011 */
3012 public static final String ACTION_AVAILABILITY_CHANGED =
3013 "android.intent.action.AVAILABILITY_CHANGED";
3014
3015 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003016 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3017 */
3018 public static final String ACTION_QUICK_CLOCK =
3019 "android.intent.action.QUICK_CLOCK";
3020
Michael Wright0087a142013-02-05 16:29:39 -08003021 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003022 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003023 * @hide
3024 */
3025 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3026 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3027
Justin Kohd378ad72013-04-01 12:18:26 -07003028 /**
3029 * Broadcast Action: A global button was pressed. Includes a single
3030 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3031 * caused the broadcast.
3032 * @hide
3033 */
3034 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3035
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003036 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003037 * Activity Action: Allow the user to select and return one or more existing
3038 * documents. When invoked, the system will display the various
3039 * {@link DocumentsProvider} instances installed on the device, letting the
3040 * user interactively navigate through them. These documents include local
3041 * media, such as photos and video, and documents provided by installed
3042 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003043 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003044 * Each document is represented as a {@code content://} URI backed by a
3045 * {@link DocumentsProvider}, which can be opened as a stream with
3046 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3047 * {@link android.provider.DocumentsContract.Document} metadata.
3048 * <p>
3049 * All selected documents are returned to the calling application with
3050 * persistable read and write permission grants. If you want to maintain
3051 * access to the documents across device reboots, you need to explicitly
3052 * take the persistable permissions using
3053 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3054 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003055 * Callers must indicate the acceptable document MIME types through
3056 * {@link #setType(String)}. For example, to select photos, use
3057 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3058 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3059 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003060 * <p>
3061 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003062 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3063 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003064 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003065 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3066 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003067 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003068 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003069 * Output: The URI of the item that was picked, returned in
3070 * {@link #getData()}. This must be a {@code content://} URI so that any
3071 * receiver can access it. If multiple documents were selected, they are
3072 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003073 *
3074 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003075 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003076 * @see #ACTION_CREATE_DOCUMENT
3077 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003078 */
3079 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3080 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3081
3082 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003083 * Activity Action: Allow the user to create a new document. When invoked,
3084 * the system will display the various {@link DocumentsProvider} instances
3085 * installed on the device, letting the user navigate through them. The
3086 * returned document may be a newly created document with no content, or it
3087 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003088 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003089 * Each document is represented as a {@code content://} URI backed by a
3090 * {@link DocumentsProvider}, which can be opened as a stream with
3091 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3092 * {@link android.provider.DocumentsContract.Document} metadata.
3093 * <p>
3094 * Callers must indicate the concrete MIME type of the document being
3095 * created by setting {@link #setType(String)}. This MIME type cannot be
3096 * changed after the document is created.
3097 * <p>
3098 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3099 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003100 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003101 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3102 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003103 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003104 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003105 * Output: The URI of the item that was created. This must be a
3106 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003107 *
3108 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003109 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003110 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003111 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003112 */
3113 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3114 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3115
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003116 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003117 * Activity Action: Allow the user to pick a directory subtree. When
3118 * invoked, the system will display the various {@link DocumentsProvider}
3119 * instances installed on the device, letting the user navigate through
3120 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003121 * <p>
3122 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003123 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3124 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3125 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003126 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003127 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003128 *
3129 * @see DocumentsContract
3130 */
3131 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003132 public static final String
3133 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003134
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003135 /** {@hide} */
3136 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3137
Christopher Tate6597e342015-02-17 12:15:25 -08003138 /**
3139 * Broadcast action: report that a settings element is being restored from backup. The intent
3140 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3141 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3142 * is the value of that settings entry prior to the restore operation. All of these values are
3143 * represented as strings.
3144 *
3145 * <p>This broadcast is sent only for settings provider entries known to require special handling
3146 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3147 * the provider's backup agent implementation.
3148 *
3149 * @see #EXTRA_SETTING_NAME
3150 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3151 * @see #EXTRA_SETTING_NEW_VALUE
3152 * {@hide}
3153 */
3154 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3155
3156 /** {@hide} */
3157 public static final String EXTRA_SETTING_NAME = "setting_name";
3158 /** {@hide} */
3159 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3160 /** {@hide} */
3161 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3162
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003163 /**
3164 * Activity Action: Process a piece of text.
3165 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3166 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3167 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3168 */
3169 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3170 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3171 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003172 * The name of the extra used to define the text to be processed, as a
3173 * CharSequence. Note that this may be a styled CharSequence, so you must use
3174 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003175 */
3176 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3177 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003178 * 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 +00003179 */
3180 public static final String EXTRA_PROCESS_TEXT_READONLY =
3181 "android.intent.extra.PROCESS_TEXT_READONLY";
3182
Bryce Leebc58f592015-09-25 16:43:01 -07003183 /**
3184 * Broadcast action: reports when a new thermal event has been reached. When the device
3185 * is reaching its maximum temperatue, the thermal level reported
3186 * {@hide}
3187 */
3188 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3189 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3190
3191 /** {@hide} */
3192 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3193
3194 /**
3195 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003196 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003197 * {@hide}
3198 */
3199 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3200
3201 /**
3202 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003203 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003204 * {@hide}
3205 */
3206 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3207
3208 /**
3209 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003210 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003211 * {@hide}
3212 */
3213 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3214
3215
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003216 // ---------------------------------------------------------------------
3217 // ---------------------------------------------------------------------
3218 // Standard intent categories (see addCategory()).
3219
3220 /**
3221 * Set if the activity should be an option for the default action
3222 * (center press) to perform on a piece of data. Setting this will
3223 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003224 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003225 * Intent when initiating an action -- it is for use in intent filters
3226 * specified in packages.
3227 */
3228 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3229 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3230 /**
3231 * Activities that can be safely invoked from a browser must support this
3232 * category. For example, if the user is viewing a web page or an e-mail
3233 * and clicks on a link in the text, the Intent generated execute that
3234 * link will require the BROWSABLE category, so that only activities
3235 * supporting this category will be considered as possible actions. By
3236 * supporting this category, you are promising that there is nothing
3237 * damaging (without user intervention) that can happen by invoking any
3238 * matching Intent.
3239 */
3240 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3241 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3242 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003243 * Categories for activities that can participate in voice interaction.
3244 * An activity that supports this category must be prepared to run with
3245 * no UI shown at all (though in some case it may have a UI shown), and
3246 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3247 */
3248 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3249 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3250 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003251 * Set if the activity should be considered as an alternative action to
3252 * the data the user is currently viewing. See also
3253 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3254 * applies to the selection in a list of items.
3255 *
3256 * <p>Supporting this category means that you would like your activity to be
3257 * displayed in the set of alternative things the user can do, usually as
3258 * part of the current activity's options menu. You will usually want to
3259 * include a specific label in the &lt;intent-filter&gt; of this action
3260 * describing to the user what it does.
3261 *
3262 * <p>The action of IntentFilter with this category is important in that it
3263 * describes the specific action the target will perform. This generally
3264 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3265 * a specific name such as "com.android.camera.action.CROP. Only one
3266 * alternative of any particular action will be shown to the user, so using
3267 * a specific action like this makes sure that your alternative will be
3268 * displayed while also allowing other applications to provide their own
3269 * overrides of that particular action.
3270 */
3271 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3272 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3273 /**
3274 * Set if the activity should be considered as an alternative selection
3275 * action to the data the user has currently selected. This is like
3276 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3277 * of items from which the user can select, giving them alternatives to the
3278 * default action that will be performed on it.
3279 */
3280 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3281 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3282 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003283 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003284 */
3285 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3286 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3287 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003288 * Should be displayed in the top-level launcher.
3289 */
3290 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3291 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3292 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003293 * Indicates an activity optimized for Leanback mode, and that should
3294 * be displayed in the Leanback launcher.
3295 */
3296 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3297 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3298 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003299 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3300 * @hide
3301 */
3302 @SystemApi
3303 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3304 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003305 * Provides information about the package it is in; typically used if
3306 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3307 * a front-door to the user without having to be shown in the all apps list.
3308 */
3309 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3310 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3311 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003312 * This is the home activity, that is the first activity that is displayed
3313 * when the device boots.
3314 */
3315 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3316 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3317 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003318 * This is the home activity that is displayed when the device is finished setting up and ready
3319 * for use.
3320 * @hide
3321 */
3322 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3323 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3324 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003325 * This is the setup wizard activity, that is the first activity that is displayed
3326 * when the user sets up the device for the first time.
3327 * @hide
3328 */
3329 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3330 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3331 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003332 * This activity is a preference panel.
3333 */
3334 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3335 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3336 /**
3337 * This activity is a development preference panel.
3338 */
3339 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3340 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3341 /**
3342 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003343 */
3344 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3345 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3346 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003347 * This activity allows the user to browse and download new applications.
3348 */
3349 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3350 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3351 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003352 * This activity may be exercised by the monkey or other automated test tools.
3353 */
3354 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3355 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3356 /**
3357 * To be used as a test (not part of the normal user experience).
3358 */
3359 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3360 /**
3361 * To be used as a unit test (run through the Test Harness).
3362 */
3363 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3364 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003365 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003366 * experience).
3367 */
3368 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003369
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003370 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003371 * Used to indicate that an intent only wants URIs that can be opened with
3372 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3373 * must support at least the columns defined in {@link OpenableColumns} when
3374 * queried.
3375 *
3376 * @see #ACTION_GET_CONTENT
3377 * @see #ACTION_OPEN_DOCUMENT
3378 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003379 */
3380 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3381 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3382
3383 /**
3384 * To be used as code under test for framework instrumentation tests.
3385 */
3386 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3387 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003388 /**
3389 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003390 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3391 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003392 */
3393 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3394 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3395 /**
3396 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003397 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3398 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003399 */
3400 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3401 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003402 /**
3403 * An activity to run when device is inserted into a analog (low end) dock.
3404 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3405 * information, see {@link android.app.UiModeManager}.
3406 */
3407 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3408 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3409
3410 /**
3411 * An activity to run when device is inserted into a digital (high end) dock.
3412 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3413 * information, see {@link android.app.UiModeManager}.
3414 */
3415 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3416 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003417
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003418 /**
3419 * Used to indicate that the activity can be used in a car environment.
3420 */
3421 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3422 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3423
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003424 // ---------------------------------------------------------------------
3425 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003426 // Application launch intent categories (see addCategory()).
3427
3428 /**
3429 * Used with {@link #ACTION_MAIN} to launch the browser application.
3430 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003431 * <p>NOTE: This should not be used as the primary key of an Intent,
3432 * since it will not result in the app launching with the correct
3433 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003434 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003435 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003436 */
3437 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3438 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3439
3440 /**
3441 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3442 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003443 * <p>NOTE: This should not be used as the primary key of an Intent,
3444 * since it will not result in the app launching with the correct
3445 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003446 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003447 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003448 */
3449 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3450 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3451
3452 /**
3453 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3454 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003455 * <p>NOTE: This should not be used as the primary key of an Intent,
3456 * since it will not result in the app launching with the correct
3457 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003458 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003459 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003460 */
3461 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3462 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3463
3464 /**
3465 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3466 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003467 * <p>NOTE: This should not be used as the primary key of an Intent,
3468 * since it will not result in the app launching with the correct
3469 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003470 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003471 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003472 */
3473 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3474 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3475
3476 /**
3477 * Used with {@link #ACTION_MAIN} to launch the email application.
3478 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003479 * <p>NOTE: This should not be used as the primary key of an Intent,
3480 * since it will not result in the app launching with the correct
3481 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003482 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003483 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003484 */
3485 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3486 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3487
3488 /**
3489 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3490 * The activity should be able to view and manipulate image and video files
3491 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003492 * <p>NOTE: This should not be used as the primary key of an Intent,
3493 * since it will not result in the app launching with the correct
3494 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003495 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003496 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003497 */
3498 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3499 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3500
3501 /**
3502 * Used with {@link #ACTION_MAIN} to launch the maps application.
3503 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003504 * <p>NOTE: This should not be used as the primary key of an Intent,
3505 * since it will not result in the app launching with the correct
3506 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003507 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003508 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003509 */
3510 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3511 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3512
3513 /**
3514 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3515 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003516 * <p>NOTE: This should not be used as the primary key of an Intent,
3517 * since it will not result in the app launching with the correct
3518 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003519 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003520 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003521 */
3522 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3523 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3524
3525 /**
3526 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003527 * The activity should be able to play, browse, or manipulate music files
3528 * stored on the device.
3529 * <p>NOTE: This should not be used as the primary key of an Intent,
3530 * since it will not result in the app launching with the correct
3531 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003532 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003533 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003534 */
3535 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3536 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3537
3538 // ---------------------------------------------------------------------
3539 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003540 // Standard extra data keys.
3541
3542 /**
3543 * The initial data to place in a newly created record. Use with
3544 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3545 * fields as would be given to the underlying ContentProvider.insert()
3546 * call.
3547 */
3548 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3549
3550 /**
3551 * A constant CharSequence that is associated with the Intent, used with
3552 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3553 * this may be a styled CharSequence, so you must use
3554 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3555 * retrieve it.
3556 */
3557 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3558
3559 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003560 * A constant String that is associated with the Intent, used with
3561 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3562 * as HTML formatted text. Note that you <em>must</em> also supply
3563 * {@link #EXTRA_TEXT}.
3564 */
3565 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3566
3567 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003568 * A content: URI holding a stream of data associated with the Intent,
3569 * used with {@link #ACTION_SEND} to supply the data being sent.
3570 */
3571 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3572
3573 /**
3574 * A String[] holding e-mail addresses that should be delivered to.
3575 */
3576 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3577
3578 /**
3579 * A String[] holding e-mail addresses that should be carbon copied.
3580 */
3581 public static final String EXTRA_CC = "android.intent.extra.CC";
3582
3583 /**
3584 * A String[] holding e-mail addresses that should be blind carbon copied.
3585 */
3586 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3587
3588 /**
3589 * A constant string holding the desired subject line of a message.
3590 */
3591 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3592
3593 /**
3594 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003595 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003596 */
3597 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3598
3599 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003600 * An int representing the user id to be used.
3601 *
3602 * @hide
3603 */
3604 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3605
3606 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003607 * An int representing the task id to be retrieved. This is used when a launch from recents is
3608 * intercepted by another action such as credentials confirmation to remember which task should
3609 * be resumed when complete.
3610 *
3611 * @hide
3612 */
3613 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3614
3615 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003616 * An Intent[] describing additional, alternate choices you would like shown with
3617 * {@link #ACTION_CHOOSER}.
3618 *
3619 * <p>An app may be capable of providing several different payload types to complete a
3620 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3621 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3622 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3623 * photo data or a hosted link where the photos can be viewed.</p>
3624 *
3625 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3626 * first/primary/preferred intent in the set. Additional intents specified in
3627 * this extra are ordered; by default intents that appear earlier in the array will be
3628 * preferred over intents that appear later in the array as matches for the same
3629 * target component. To alter this preference, a calling app may also supply
3630 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3631 */
3632 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3633
3634 /**
3635 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3636 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3637 *
3638 * <p>An app preparing an action for another app to complete may wish to allow the user to
3639 * disambiguate between several options for completing the action based on the chosen target
3640 * or otherwise refine the action before it is invoked.
3641 * </p>
3642 *
3643 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3644 * <ul>
3645 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3646 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3647 * chosen target beyond the first</li>
3648 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3649 * should fill in and send once the disambiguation is complete</li>
3650 * </ul>
3651 */
3652 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3653 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3654
3655 /**
3656 * A {@link ResultReceiver} used to return data back to the sender.
3657 *
3658 * <p>Used to complete an app-specific
3659 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3660 *
3661 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3662 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3663 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3664 * when the user selects a target component from the chooser. It is up to the recipient
3665 * to send a result to this ResultReceiver to signal that disambiguation is complete
3666 * and that the chooser should invoke the user's choice.</p>
3667 *
3668 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3669 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3670 * to match and fill in the final Intent or ChooserTarget before starting it.
3671 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3672 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3673 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3674 *
3675 * <p>The result code passed to the ResultReceiver should be
3676 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3677 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3678 * the chooser should finish without starting a target.</p>
3679 */
3680 public static final String EXTRA_RESULT_RECEIVER
3681 = "android.intent.extra.RESULT_RECEIVER";
3682
3683 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003684 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003685 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003686 */
3687 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3688
3689 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003690 * A Parcelable[] of {@link Intent} or
3691 * {@link android.content.pm.LabeledIntent} objects as set with
3692 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3693 * a the front of the list of choices, when shown to the user with a
3694 * {@link #ACTION_CHOOSER}.
3695 */
3696 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3697
3698 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003699 * A {@link IntentSender} to start after ephemeral installation success.
3700 * @hide
3701 */
3702 @SystemApi
3703 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3704
3705 /**
3706 * A {@link IntentSender} to start after ephemeral installation failure.
3707 * @hide
3708 */
3709 @SystemApi
3710 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3711
3712 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003713 * A Bundle forming a mapping of potential target package names to different extras Bundles
3714 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3715 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3716 * be currently installed on the device.
3717 *
3718 * <p>An application may choose to provide alternate extras for the case where a user
3719 * selects an activity from a predetermined set of target packages. If the activity
3720 * the user selects from the chooser belongs to a package with its package name as
3721 * a key in this bundle, the corresponding extras for that package will be merged with
3722 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3723 * extra has the same key as an extra already present in the intent it will overwrite
3724 * the extra from the intent.</p>
3725 *
3726 * <p><em>Examples:</em>
3727 * <ul>
3728 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3729 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3730 * parameters for that target.</li>
3731 * <li>An application may offer additional metadata for known targets of a given intent
3732 * to pass along information only relevant to that target such as account or content
3733 * identifiers already known to that application.</li>
3734 * </ul></p>
3735 */
3736 public static final String EXTRA_REPLACEMENT_EXTRAS =
3737 "android.intent.extra.REPLACEMENT_EXTRAS";
3738
3739 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003740 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3741 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3742 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3743 * {@link ComponentName} of the chosen component.
3744 *
3745 * <p>In some situations this callback may never come, for example if the user abandons
3746 * the chooser, switches to another task or any number of other reasons. Apps should not
3747 * be written assuming that this callback will always occur.</p>
3748 */
3749 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3750 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3751
3752 /**
3753 * The {@link ComponentName} chosen by the user to complete an action.
3754 *
3755 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3756 */
3757 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3758
3759 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003760 * A {@link android.view.KeyEvent} object containing the event that
3761 * triggered the creation of the Intent it is in.
3762 */
3763 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3764
3765 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003766 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3767 * before shutting down.
3768 *
3769 * {@hide}
3770 */
3771 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3772
3773 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003774 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3775 * requested by the user.
3776 *
3777 * {@hide}
3778 */
3779 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3780 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3781
3782 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003783 * 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 -07003784 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3785 * of restarting the application.
3786 */
3787 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3788
3789 /**
3790 * A String holding the phone number originally entered in
3791 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3792 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3793 */
3794 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003795
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003796 /**
3797 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3798 * intents to supply the uid the package had been assigned. Also an optional
3799 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3800 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3801 * purpose.
3802 */
3803 public static final String EXTRA_UID = "android.intent.extra.UID";
3804
3805 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003806 * @hide String array of package names.
3807 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003808 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003809 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3810
3811 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003812 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3813 * intents to indicate whether this represents a full uninstall (removing
3814 * both the code and its data) or a partial uninstall (leaving its data,
3815 * implying that this is an update).
3816 */
3817 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003818
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003819 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003820 * @hide
3821 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3822 * intents to indicate that at this point the package has been removed for
3823 * all users on the device.
3824 */
3825 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3826 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3827
3828 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003829 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3830 * intents to indicate that this is a replacement of the package, so this
3831 * broadcast will immediately be followed by an add broadcast for a
3832 * different version of the same package.
3833 */
3834 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003835
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003836 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003837 * Used as an int extra field in {@link android.app.AlarmManager} intents
3838 * to tell the application being invoked how many pending alarms are being
3839 * delievered with the intent. For one-shot alarms this will always be 1.
3840 * For recurring alarms, this might be greater than 1 if the device was
3841 * asleep or powered off at the time an earlier alarm would have been
3842 * delivered.
3843 */
3844 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003845
Jacek Surazski86b6c532009-05-13 14:38:28 +02003846 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003847 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3848 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003849 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3850 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003851 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3852 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3853 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003854 */
3855 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3856
3857 /**
3858 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3859 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003860 */
3861 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3862
3863 /**
3864 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3865 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003866 */
3867 public static final int EXTRA_DOCK_STATE_DESK = 1;
3868
3869 /**
3870 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3871 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003872 */
3873 public static final int EXTRA_DOCK_STATE_CAR = 2;
3874
3875 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003876 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3877 * to represent that the phone is in a analog (low end) dock.
3878 */
3879 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3880
3881 /**
3882 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3883 * to represent that the phone is in a digital (high end) dock.
3884 */
3885 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3886
3887 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003888 * Boolean that can be supplied as meta-data with a dock activity, to
3889 * indicate that the dock should take over the home key when it is active.
3890 */
3891 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003892
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003893 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003894 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3895 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003896 */
3897 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3898
3899 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003900 * Used in the extra field in the remote intent. It's astring token passed with the
3901 * remote intent.
3902 */
3903 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3904 "android.intent.extra.remote_intent_token";
3905
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003906 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003907 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003908 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003909 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003910 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003911 "android.intent.extra.changed_component_name";
3912
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003913 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003914 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003915 * and contains a string array of all of the components that have changed. If
3916 * the state of the overall package has changed, then it will contain an entry
3917 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003918 */
3919 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3920 "android.intent.extra.changed_component_name_list";
3921
3922 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003923 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003924 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3925 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003926 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003927 */
3928 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3929 "android.intent.extra.changed_package_list";
3930
3931 /**
3932 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003933 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3934 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003935 * and contains an integer array of uids of all of the components
3936 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003937 */
3938 public static final String EXTRA_CHANGED_UID_LIST =
3939 "android.intent.extra.changed_uid_list";
3940
3941 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003942 * @hide
3943 * Magic extra system code can use when binding, to give a label for
3944 * who it is that has bound to a service. This is an integer giving
3945 * a framework string resource that can be displayed to the user.
3946 */
3947 public static final String EXTRA_CLIENT_LABEL =
3948 "android.intent.extra.client_label";
3949
3950 /**
3951 * @hide
3952 * Magic extra system code can use when binding, to give a PendingIntent object
3953 * that can be launched for the user to disable the system's use of this
3954 * service.
3955 */
3956 public static final String EXTRA_CLIENT_INTENT =
3957 "android.intent.extra.client_intent";
3958
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003959 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003960 * Extra used to indicate that an intent should only return data that is on
3961 * the local device. This is a boolean extra; the default is false. If true,
3962 * an implementation should only allow the user to select data that is
3963 * already on the device, not requiring it be downloaded from a remote
3964 * service when opened.
3965 *
3966 * @see #ACTION_GET_CONTENT
3967 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003968 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003969 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003970 */
3971 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003972 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003973
Amith Yamasani13593602012-03-22 16:16:17 -07003974 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003975 * Extra used to indicate that an intent can allow the user to select and
3976 * return multiple items. This is a boolean extra; the default is false. If
3977 * true, an implementation is allowed to present the user with a UI where
3978 * they can pick multiple items that are all returned to the caller. When
3979 * this happens, they should be returned as the {@link #getClipData()} part
3980 * of the result Intent.
3981 *
3982 * @see #ACTION_GET_CONTENT
3983 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003984 */
3985 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003986 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003987
3988 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003989 * The integer userHandle carried with broadcast intents related to addition, removal and
3990 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3991 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3992 *
Amith Yamasani13593602012-03-22 16:16:17 -07003993 * @hide
3994 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003995 public static final String EXTRA_USER_HANDLE =
3996 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003997
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003998 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003999 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4000 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4001 */
4002 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004003 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004004
4005 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004006 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004007 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4008 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004009 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004010 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4011
4012 /**
4013 * Extra sent in the intent to the BroadcastReceiver that handles
4014 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4015 * the restrictions as key/value pairs.
4016 */
4017 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4018 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004019
Amith Yamasani86118ba2013-03-28 14:33:16 -07004020 /**
4021 * Extra used in the response from a BroadcastReceiver that handles
4022 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4023 */
4024 public static final String EXTRA_RESTRICTIONS_INTENT =
4025 "android.intent.extra.restrictions_intent";
4026
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004027 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004028 * Extra used to communicate a set of acceptable MIME types. The type of the
4029 * extra is {@code String[]}. Values may be a combination of concrete MIME
4030 * types (such as "image/png") and/or partial MIME types (such as
4031 * "audio/*").
4032 *
4033 * @see #ACTION_GET_CONTENT
4034 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004035 */
4036 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4037
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004038 /**
4039 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4040 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004041 * When this is true, hardware devices can use this information to determine that
4042 * they shouldn't do a complete shutdown of their device since this is not a
4043 * complete shutdown down to the kernel, but only user space restarting.
4044 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004045 */
4046 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4047 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4048
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004049 /**
4050 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4051 * user has set their time format preferences to the 24 hour format.
4052 *
4053 * @hide for internal use only.
4054 */
4055 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4056 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4057
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004058 /** {@hide} */
4059 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4060
Rubin Xue8490f12015-06-25 12:17:48 +01004061 /** {@hide} */
4062 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4063
Santos Cordon15a13782015-03-31 18:32:31 -07004064 /**
4065 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4066 * activation request.
4067 * TODO: Add information about the structure and response data used with the pending intent.
4068 * @hide
4069 */
4070 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4071 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4072
Steve McKay6eaf38632015-08-04 10:11:01 -07004073 /** {@hide} */
4074 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4075
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004076 /**
4077 * Optional boolean extra indicating whether quiet mode has been switched on or off.
4078 */
4079 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004080 // ---------------------------------------------------------------------
4081 // ---------------------------------------------------------------------
4082 // Intent flags (see mFlags variable).
4083
Tor Norbyed9273d62013-05-30 15:59:53 -07004084 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004085 @IntDef(flag = true, value = {
4086 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4087 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004088 @Retention(RetentionPolicy.SOURCE)
4089 public @interface GrantUriMode {}
4090
Jeff Sharkey846318a2014-04-04 12:12:41 -07004091 /** @hide */
4092 @IntDef(flag = true, value = {
4093 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4094 @Retention(RetentionPolicy.SOURCE)
4095 public @interface AccessUriMode {}
4096
4097 /**
4098 * Test if given mode flags specify an access mode, which must be at least
4099 * read and/or write.
4100 *
4101 * @hide
4102 */
4103 public static boolean isAccessUriMode(int modeFlags) {
4104 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4105 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4106 }
4107
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004108 /**
4109 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004110 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004111 * specified in its ClipData. When applying to an Intent's ClipData,
4112 * all URIs as well as recursive traversals through data or other ClipData
4113 * in Intent items will be granted; only the grant flags of the top-level
4114 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004115 */
4116 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4117 /**
4118 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004119 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004120 * specified in its ClipData. When applying to an Intent's ClipData,
4121 * all URIs as well as recursive traversals through data or other ClipData
4122 * in Intent items will be granted; only the grant flags of the top-level
4123 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004124 */
4125 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4126 /**
4127 * Can be set by the caller to indicate that this Intent is coming from
4128 * a background operation, not from direct user interaction.
4129 */
4130 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4131 /**
4132 * A flag you can enable for debugging: when set, log messages will be
4133 * printed during the resolution of this intent to show you what has
4134 * been found to create the final resolved list.
4135 */
4136 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004137 /**
4138 * If set, this intent will not match any components in packages that
4139 * are currently stopped. If this is not set, then the default behavior
4140 * is to include such applications in the result.
4141 */
4142 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4143 /**
4144 * If set, this intent will always match any components in packages that
4145 * are currently stopped. This is the default behavior when
4146 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4147 * flags are set, this one wins (it allows overriding of exclude for
4148 * places where the framework may automatically set the exclude flag).
4149 */
4150 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004151
4152 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004153 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004154 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004155 * persisted across device reboots until explicitly revoked with
4156 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4157 * grant for possible persisting; the receiving application must call
4158 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4159 * actually persist.
4160 *
4161 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4162 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4163 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004164 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004165 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004166 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004167
4168 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004169 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4170 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4171 * applies to any URI that is a prefix match against the original granted
4172 * URI. (Without this flag, the URI must match exactly for access to be
4173 * granted.) Another URI is considered a prefix match only when scheme,
4174 * authority, and all path segments defined by the prefix are an exact
4175 * match.
4176 */
4177 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4178
4179 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004180 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004181 * homework and verified that they correctly handle packages and components
4182 * that come and go over time. In particular:
4183 * <ul>
4184 * <li>Apps installed on external storage, which will appear to be
4185 * uninstalled while the the device is ejected.
4186 * <li>Apps with encryption unaware components, which will appear to not
4187 * exist while the device is locked.
4188 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004189 *
4190 * @hide
4191 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004192 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004193
4194 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004195 * If set, the new activity is not kept in the history stack. As soon as
4196 * the user navigates away from it, the activity is finished. This may also
4197 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4198 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004199 *
4200 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4201 * is never invoked when the current activity starts a new activity which
4202 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004203 */
4204 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4205 /**
4206 * If set, the activity will not be launched if it is already running
4207 * at the top of the history stack.
4208 */
4209 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4210 /**
4211 * If set, this activity will become the start of a new task on this
4212 * history stack. A task (from the activity that started it to the
4213 * next task activity) defines an atomic group of activities that the
4214 * user can move to. Tasks can be moved to the foreground and background;
4215 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004216 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004217 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4218 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004219 *
4220 * <p>This flag is generally used by activities that want
4221 * to present a "launcher" style behavior: they give the user a list of
4222 * separate things that can be done, which otherwise run completely
4223 * independently of the activity launching them.
4224 *
4225 * <p>When using this flag, if a task is already running for the activity
4226 * you are now starting, then a new activity will not be started; instead,
4227 * the current task will simply be brought to the front of the screen with
4228 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4229 * to disable this behavior.
4230 *
4231 * <p>This flag can not be used when the caller is requesting a result from
4232 * the activity being launched.
4233 */
4234 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4235 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004236 * This flag is used to create a new task and launch an activity into it.
4237 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4238 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4239 * search through existing tasks for ones matching this Intent. Only if no such
4240 * task is found would a new task be created. When paired with
4241 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4242 * the search for a matching task and unconditionally start a new task.
4243 *
4244 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4245 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004246 * top-level application launcher.</strong> Used in conjunction with
4247 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4248 * behavior of bringing an existing task to the foreground. When set,
4249 * a new task is <em>always</em> started to host the Activity for the
4250 * Intent, regardless of whether there is already an existing task running
4251 * the same thing.
4252 *
4253 * <p><strong>Because the default system does not include graphical task management,
4254 * you should not use this flag unless you provide some way for a user to
4255 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004256 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004257 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4258 * creating new document tasks.
4259 *
4260 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004261 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004262 *
Scott Main7aee61f2011-02-08 11:25:01 -08004263 * <p>See
4264 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4265 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004266 *
4267 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4268 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004269 */
4270 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4271 /**
4272 * If set, and the activity being launched is already running in the
4273 * current task, then instead of launching a new instance of that activity,
4274 * all of the other activities on top of it will be closed and this Intent
4275 * will be delivered to the (now on top) old activity as a new Intent.
4276 *
4277 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4278 * If D calls startActivity() with an Intent that resolves to the component
4279 * of activity B, then C and D will be finished and B receive the given
4280 * Intent, resulting in the stack now being: A, B.
4281 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004282 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004283 * either receive the new intent you are starting here in its
4284 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004285 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004286 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4287 * the same intent, then it will be finished and re-created; for all other
4288 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4289 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004290 *
4291 * <p>This launch mode can also be used to good effect in conjunction with
4292 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4293 * of a task, it will bring any currently running instance of that task
4294 * to the foreground, and then clear it to its root state. This is
4295 * especially useful, for example, when launching an activity from the
4296 * notification manager.
4297 *
Scott Main7aee61f2011-02-08 11:25:01 -08004298 * <p>See
4299 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4300 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004301 */
4302 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4303 /**
4304 * If set and this intent is being used to launch a new activity from an
4305 * existing one, then the reply target of the existing activity will be
4306 * transfered to the new activity. This way the new activity can call
4307 * {@link android.app.Activity#setResult} and have that result sent back to
4308 * the reply target of the original activity.
4309 */
4310 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4311 /**
4312 * If set and this intent is being used to launch a new activity from an
4313 * existing one, the current activity will not be counted as the top
4314 * activity for deciding whether the new intent should be delivered to
4315 * the top instead of starting a new one. The previous activity will
4316 * be used as the top, with the assumption being that the current activity
4317 * will finish itself immediately.
4318 */
4319 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4320 /**
4321 * If set, the new activity is not kept in the list of recently launched
4322 * activities.
4323 */
4324 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4325 /**
4326 * This flag is not normally set by application code, but set for you by
4327 * the system as described in the
4328 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4329 * launchMode} documentation for the singleTask mode.
4330 */
4331 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4332 /**
4333 * If set, and this activity is either being started in a new task or
4334 * bringing to the top an existing task, then it will be launched as
4335 * the front door of the task. This will result in the application of
4336 * any affinities needed to have that task in the proper state (either
4337 * moving activities to or from it), or simply resetting that task to
4338 * its initial state if needed.
4339 */
4340 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4341 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004342 * This flag is not normally set by application code, but set for you by
4343 * the system if this activity is being launched from history
4344 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004345 */
4346 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004347 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004348 * @deprecated As of API 21 this performs identically to
4349 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004350 */
4351 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004352 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004353 * This flag is used to open a document into a new task rooted at the activity launched
4354 * by this Intent. Through the use of this flag, or its equivalent attribute,
4355 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004356 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004357 *
Craig Mautner026596b2014-05-21 15:35:44 -07004358 * <p>The use of the activity attribute form of this,
4359 * {@link android.R.attr#documentLaunchMode}, is
4360 * preferred over the Intent flag described here. The attribute form allows the
4361 * Activity to specify multiple document behavior for all launchers of the Activity
4362 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004363 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004364 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4365 * it is kept after the activity is finished is different than the use of
4366 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4367 * this flag is being used to create a new recents entry, then by default that entry
4368 * will be removed once the activity is finished. You can modify this behavior with
4369 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4370 *
Craig Mautner026596b2014-05-21 15:35:44 -07004371 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4372 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4373 * equivalent of the Activity manifest specifying {@link
4374 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4375 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4376 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004377 *
Craig Mautner026596b2014-05-21 15:35:44 -07004378 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004379 *
Craig Mautner026596b2014-05-21 15:35:44 -07004380 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004381 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4382 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004383 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004384 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004385 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004386 * callback from occurring on the current frontmost activity before it is
4387 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004388 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004389 * <p>Typically, an activity can rely on that callback to indicate that an
4390 * explicit user action has caused their activity to be moved out of the
4391 * foreground. The callback marks an appropriate point in the activity's
4392 * lifecycle for it to dismiss any notifications that it intends to display
4393 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004394 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004395 * <p>If an activity is ever started via any non-user-driven events such as
4396 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4397 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004398 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004399 */
4400 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004401 /**
4402 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4403 * this flag will cause the launched activity to be brought to the front of its
4404 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004405 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004406 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4407 * If D calls startActivity() with an Intent that resolves to the component
4408 * of activity B, then B will be brought to the front of the history stack,
4409 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004410 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004411 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004412 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004413 */
4414 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004415 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004416 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4417 * this flag will prevent the system from applying an activity transition
4418 * animation to go to the next activity state. This doesn't mean an
4419 * animation will never run -- if another activity change happens that doesn't
4420 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004421 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004422 * when you are going to do a series of activity operations but the
4423 * animation seen by the user shouldn't be driven by the first activity
4424 * change but rather a later one.
4425 */
4426 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4427 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004428 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4429 * this flag will cause any existing task that would be associated with the
4430 * activity to be cleared before the activity is started. That is, the activity
4431 * becomes the new root of an otherwise empty task, and any old activities
4432 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4433 */
4434 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4435 /**
4436 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4437 * this flag will cause a newly launching task to be placed on top of the current
4438 * home activity task (if there is one). That is, pressing back from the task
4439 * will always return the user to home even if that was not the last activity they
4440 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4441 */
4442 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4443 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004444 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4445 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004446 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004447 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004448 * this flag. When set and the task's activity is finished, the recents
4449 * entry will remain in the interface for the user to re-launch it, like a
4450 * recents entry for a top-level application.
4451 * <p>
4452 * The receiving activity can override this request with
4453 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4454 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004455 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004456 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004457 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004458
4459 /**
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004460 * This flag is only used in the multi-window mode. The new activity will be displayed on
4461 * the other side than the one that is launching it. This can only be used in conjunction with
4462 * {@link #FLAG_ACTIVITY_NEW_TASK}.
4463 */
4464 public static final int FLAG_ACTIVITY_LAUNCH_TO_SIDE = 0x00001000;
4465
4466 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004467 * If set, when sending a broadcast only registered receivers will be
4468 * called -- no BroadcastReceiver components will be launched.
4469 */
4470 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004471 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004472 * If set, when sending a broadcast the new broadcast will replace
4473 * any existing pending broadcast that matches it. Matching is defined
4474 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4475 * true for the intents of the two broadcasts. When a match is found,
4476 * the new broadcast (and receivers associated with it) will replace the
4477 * existing one in the pending broadcast list, remaining at the same
4478 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004479 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004480 * <p>This flag is most typically used with sticky broadcasts, which
4481 * only care about delivering the most recent values of the broadcast
4482 * to their receivers.
4483 */
4484 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4485 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004486 * If set, when sending a broadcast the recipient is allowed to run at
4487 * foreground priority, with a shorter timeout interval. During normal
4488 * broadcasts the receivers are not automatically hoisted out of the
4489 * background priority class.
4490 */
4491 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4492 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004493 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4494 * They can still propagate results through to later receivers, but they can not prevent
4495 * later receivers from seeing the broadcast.
4496 */
4497 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4498 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004499 * If set, when sending a broadcast <i>before boot has completed</i> only
4500 * registered receivers will be called -- no BroadcastReceiver components
4501 * will be launched. Sticky intent state will be recorded properly even
4502 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4503 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004504 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004505 * <p>This flag is only for use by system sevices as a convenience to
4506 * avoid having to implement a more complex mechanism around detection
4507 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004508 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004509 * @hide
4510 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004511 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004512 /**
4513 * Set when this broadcast is for a boot upgrade, a special mode that
4514 * allows the broadcast to be sent before the system is ready and launches
4515 * the app process with no providers running in it.
4516 * @hide
4517 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004518 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004519 /**
4520 * If set, the broadcast will always go to manifest receivers in background (cached
4521 * or not running) apps, regardless of whether that would be done by default. By
4522 * default they will only receive broadcasts if the broadcast has specified an
4523 * explicit component or package name.
4524 * @hide
4525 */
4526 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4527 /**
4528 * If set, the broadcast will never go to manifest receivers in background (cached
4529 * or not running) apps, regardless of whether that would be done by default. By
4530 * default they will receive broadcasts if the broadcast has specified an
4531 * explicit component or package name.
4532 * @hide
4533 */
4534 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004535
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004536 /**
4537 * @hide Flags that can't be changed with PendingIntent.
4538 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004539 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4540 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4541 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004542
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004543 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004544 // ---------------------------------------------------------------------
4545 // toUri() and parseUri() options.
4546
4547 /**
4548 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4549 * always has the "intent:" scheme. This syntax can be used when you want
4550 * to later disambiguate between URIs that are intended to describe an
4551 * Intent vs. all others that should be treated as raw URIs. When used
4552 * with {@link #parseUri}, any other scheme will result in a generic
4553 * VIEW action for that raw URI.
4554 */
4555 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004556
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004557 /**
4558 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4559 * always has the "android-app:" scheme. This is a variation of
4560 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4561 * http/https URI being delivered to a specific package name. The format
4562 * is:
4563 *
4564 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004565 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004566 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004567 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4568 * you must also include a scheme; including a path also requires both a host and a scheme.
4569 * The final #Intent; fragment can be used without a scheme, host, or path.
4570 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004571 * used with intents that have a {@link #setSelector}, since the base intent
4572 * will always have an explicit package name.</p>
4573 *
4574 * <p>Some examples of how this scheme maps to Intent objects:</p>
4575 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4576 * <colgroup align="left" />
4577 * <colgroup align="left" />
4578 * <thead>
4579 * <tr><th>URI</th> <th>Intent</th></tr>
4580 * </thead>
4581 *
4582 * <tbody>
4583 * <tr><td><code>android-app://com.example.app</code></td>
4584 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4585 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4586 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4587 * </table></td>
4588 * </tr>
4589 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4590 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4591 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4592 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4593 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4594 * </table></td>
4595 * </tr>
4596 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4597 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4598 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4599 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4600 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4601 * </table></td>
4602 * </tr>
4603 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4604 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4605 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4606 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4607 * </table></td>
4608 * </tr>
4609 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4610 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4611 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4612 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4613 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4614 * </table></td>
4615 * </tr>
4616 * <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>
4617 * <td><table border="" style="margin:0" >
4618 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4619 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4620 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4621 * </table></td>
4622 * </tr>
4623 * </tbody>
4624 * </table>
4625 */
4626 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4627
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004628 /**
4629 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4630 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4631 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4632 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4633 * generated Intent can not cause unexpected data access to happen.
4634 *
4635 * <p>If you do not trust the source of the URI being parsed, you should still do further
4636 * processing to protect yourself from it. In particular, when using it to start an
4637 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4638 * that can handle it.</p>
4639 */
4640 public static final int URI_ALLOW_UNSAFE = 1<<2;
4641
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004642 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004643
4644 private String mAction;
4645 private Uri mData;
4646 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004647 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004648 private ComponentName mComponent;
4649 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004650 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004651 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004652 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004653 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004654 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004655 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004656
4657 // ---------------------------------------------------------------------
4658
4659 /**
4660 * Create an empty intent.
4661 */
4662 public Intent() {
4663 }
4664
4665 /**
4666 * Copy constructor.
4667 */
4668 public Intent(Intent o) {
4669 this.mAction = o.mAction;
4670 this.mData = o.mData;
4671 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004672 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004673 this.mComponent = o.mComponent;
4674 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004675 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004676 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004677 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004678 }
4679 if (o.mExtras != null) {
4680 this.mExtras = new Bundle(o.mExtras);
4681 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004682 if (o.mSourceBounds != null) {
4683 this.mSourceBounds = new Rect(o.mSourceBounds);
4684 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004685 if (o.mSelector != null) {
4686 this.mSelector = new Intent(o.mSelector);
4687 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004688 if (o.mClipData != null) {
4689 this.mClipData = new ClipData(o.mClipData);
4690 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004691 }
4692
4693 @Override
4694 public Object clone() {
4695 return new Intent(this);
4696 }
4697
4698 private Intent(Intent o, boolean all) {
4699 this.mAction = o.mAction;
4700 this.mData = o.mData;
4701 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004702 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004703 this.mComponent = o.mComponent;
4704 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004705 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004706 }
4707 }
4708
4709 /**
4710 * Make a clone of only the parts of the Intent that are relevant for
4711 * filter matching: the action, data, type, component, and categories.
4712 */
4713 public Intent cloneFilter() {
4714 return new Intent(this, false);
4715 }
4716
4717 /**
4718 * Create an intent with a given action. All other fields (data, type,
4719 * class) are null. Note that the action <em>must</em> be in a
4720 * namespace because Intents are used globally in the system -- for
4721 * example the system VIEW action is android.intent.action.VIEW; an
4722 * application's custom action would be something like
4723 * com.google.app.myapp.CUSTOM_ACTION.
4724 *
4725 * @param action The Intent action, such as ACTION_VIEW.
4726 */
4727 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004728 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004729 }
4730
4731 /**
4732 * Create an intent with a given action and for a given data url. Note
4733 * that the action <em>must</em> be in a namespace because Intents are
4734 * used globally in the system -- for example the system VIEW action is
4735 * android.intent.action.VIEW; an application's custom action would be
4736 * something like com.google.app.myapp.CUSTOM_ACTION.
4737 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004738 * <p><em>Note: scheme and host name matching in the Android framework is
4739 * case-sensitive, unlike the formal RFC. As a result,
4740 * you should always ensure that you write your Uri with these elements
4741 * using lower case letters, and normalize any Uris you receive from
4742 * outside of Android to ensure the scheme and host is lower case.</em></p>
4743 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004744 * @param action The Intent action, such as ACTION_VIEW.
4745 * @param uri The Intent data URI.
4746 */
4747 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004748 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004749 mData = uri;
4750 }
4751
4752 /**
4753 * Create an intent for a specific component. All other fields (action, data,
4754 * type, class) are null, though they can be modified later with explicit
4755 * calls. This provides a convenient way to create an intent that is
4756 * intended to execute a hard-coded class name, rather than relying on the
4757 * system to find an appropriate class for you; see {@link #setComponent}
4758 * for more information on the repercussions of this.
4759 *
4760 * @param packageContext A Context of the application package implementing
4761 * this class.
4762 * @param cls The component class that is to be used for the intent.
4763 *
4764 * @see #setClass
4765 * @see #setComponent
4766 * @see #Intent(String, android.net.Uri , Context, Class)
4767 */
4768 public Intent(Context packageContext, Class<?> cls) {
4769 mComponent = new ComponentName(packageContext, cls);
4770 }
4771
4772 /**
4773 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004774 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004775 * construct the Intent and then calling {@link #setClass} to set its
4776 * class.
4777 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004778 * <p><em>Note: scheme and host name matching in the Android framework is
4779 * case-sensitive, unlike the formal RFC. As a result,
4780 * you should always ensure that you write your Uri with these elements
4781 * using lower case letters, and normalize any Uris you receive from
4782 * outside of Android to ensure the scheme and host is lower case.</em></p>
4783 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004784 * @param action The Intent action, such as ACTION_VIEW.
4785 * @param uri The Intent data URI.
4786 * @param packageContext A Context of the application package implementing
4787 * this class.
4788 * @param cls The component class that is to be used for the intent.
4789 *
4790 * @see #Intent(String, android.net.Uri)
4791 * @see #Intent(Context, Class)
4792 * @see #setClass
4793 * @see #setComponent
4794 */
4795 public Intent(String action, Uri uri,
4796 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004797 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004798 mData = uri;
4799 mComponent = new ComponentName(packageContext, cls);
4800 }
4801
4802 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004803 * Create an intent to launch the main (root) activity of a task. This
4804 * is the Intent that is started when the application's is launched from
4805 * Home. For anything else that wants to launch an application in the
4806 * same way, it is important that they use an Intent structured the same
4807 * way, and can use this function to ensure this is the case.
4808 *
4809 * <p>The returned Intent has the given Activity component as its explicit
4810 * component, {@link #ACTION_MAIN} as its action, and includes the
4811 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4812 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4813 * to do that through {@link #addFlags(int)} on the returned Intent.
4814 *
4815 * @param mainActivity The main activity component that this Intent will
4816 * launch.
4817 * @return Returns a newly created Intent that can be used to launch the
4818 * activity as a main application entry.
4819 *
4820 * @see #setClass
4821 * @see #setComponent
4822 */
4823 public static Intent makeMainActivity(ComponentName mainActivity) {
4824 Intent intent = new Intent(ACTION_MAIN);
4825 intent.setComponent(mainActivity);
4826 intent.addCategory(CATEGORY_LAUNCHER);
4827 return intent;
4828 }
4829
4830 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004831 * Make an Intent for the main activity of an application, without
4832 * specifying a specific activity to run but giving a selector to find
4833 * the activity. This results in a final Intent that is structured
4834 * the same as when the application is launched from
4835 * Home. For anything else that wants to launch an application in the
4836 * same way, it is important that they use an Intent structured the same
4837 * way, and can use this function to ensure this is the case.
4838 *
4839 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4840 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4841 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4842 * to do that through {@link #addFlags(int)} on the returned Intent.
4843 *
4844 * @param selectorAction The action name of the Intent's selector.
4845 * @param selectorCategory The name of a category to add to the Intent's
4846 * selector.
4847 * @return Returns a newly created Intent that can be used to launch the
4848 * activity as a main application entry.
4849 *
4850 * @see #setSelector(Intent)
4851 */
4852 public static Intent makeMainSelectorActivity(String selectorAction,
4853 String selectorCategory) {
4854 Intent intent = new Intent(ACTION_MAIN);
4855 intent.addCategory(CATEGORY_LAUNCHER);
4856 Intent selector = new Intent();
4857 selector.setAction(selectorAction);
4858 selector.addCategory(selectorCategory);
4859 intent.setSelector(selector);
4860 return intent;
4861 }
4862
4863 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004864 * Make an Intent that can be used to re-launch an application's task
4865 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4866 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4867 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4868 *
4869 * @param mainActivity The activity component that is the root of the
4870 * task; this is the activity that has been published in the application's
4871 * manifest as the main launcher icon.
4872 *
4873 * @return Returns a newly created Intent that can be used to relaunch the
4874 * activity's task in its root state.
4875 */
4876 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4877 Intent intent = makeMainActivity(mainActivity);
4878 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4879 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4880 return intent;
4881 }
4882
4883 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004884 * Call {@link #parseUri} with 0 flags.
4885 * @deprecated Use {@link #parseUri} instead.
4886 */
4887 @Deprecated
4888 public static Intent getIntent(String uri) throws URISyntaxException {
4889 return parseUri(uri, 0);
4890 }
Tom Taylord4a47292009-12-21 13:59:18 -08004891
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004892 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004893 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004894 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004895 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004896 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004897 *
4898 * <p>The URI given here must not be relative -- that is, it must include
4899 * the scheme and full path.
4900 *
4901 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004902 * @param flags Additional processing flags. Either 0,
4903 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004904 *
4905 * @return Intent The newly created Intent object.
4906 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004907 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4908 * it bad (as parsed by the Uri class) or the Intent data within the
4909 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004910 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004911 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004912 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004913 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004914 int i = 0;
4915 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004916 final boolean androidApp = uri.startsWith("android-app:");
4917
4918 // Validate intent scheme if requested.
4919 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
4920 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004921 Intent intent = new Intent(ACTION_VIEW);
4922 try {
4923 intent.setData(Uri.parse(uri));
4924 } catch (IllegalArgumentException e) {
4925 throw new URISyntaxException(uri, e.getMessage());
4926 }
4927 return intent;
4928 }
4929 }
Tom Taylord4a47292009-12-21 13:59:18 -08004930
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004931 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004932 // simple case
4933 if (i == -1) {
4934 if (!androidApp) {
4935 return new Intent(ACTION_VIEW, Uri.parse(uri));
4936 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004937
4938 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004939 } else if (!uri.startsWith("#Intent;", i)) {
4940 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004941 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004942 } else {
4943 i = -1;
4944 }
4945 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004946
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004947 // new format
4948 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004949 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004950 boolean explicitAction = false;
4951 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004952
4953 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004954 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004955 String data;
4956 if (i >= 0) {
4957 data = uri.substring(0, i);
4958 i += 8; // length of "#Intent;"
4959 } else {
4960 data = uri;
4961 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004962
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004963 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004964 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004965 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004966 if (eq < 0) eq = i-1;
4967 int semi = uri.indexOf(';', i);
4968 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004969
4970 // action
4971 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004972 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004973 if (!inSelector) {
4974 explicitAction = true;
4975 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004976 }
4977
4978 // categories
4979 else if (uri.startsWith("category=", i)) {
4980 intent.addCategory(value);
4981 }
4982
4983 // type
4984 else if (uri.startsWith("type=", i)) {
4985 intent.mType = value;
4986 }
4987
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004988 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004989 else if (uri.startsWith("launchFlags=", i)) {
4990 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004991 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4992 intent.mFlags &= ~IMMUTABLE_FLAGS;
4993 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004994 }
4995
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004996 // package
4997 else if (uri.startsWith("package=", i)) {
4998 intent.mPackage = value;
4999 }
5000
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005001 // component
5002 else if (uri.startsWith("component=", i)) {
5003 intent.mComponent = ComponentName.unflattenFromString(value);
5004 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005005
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005006 // scheme
5007 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005008 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005009 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005010 } else {
5011 scheme = value;
5012 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005013 }
5014
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005015 // source bounds
5016 else if (uri.startsWith("sourceBounds=", i)) {
5017 intent.mSourceBounds = Rect.unflattenFromString(value);
5018 }
5019
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005020 // selector
5021 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5022 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005023 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005024 }
5025
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005026 // extra
5027 else {
5028 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005029 // create Bundle if it doesn't already exist
5030 if (intent.mExtras == null) intent.mExtras = new Bundle();
5031 Bundle b = intent.mExtras;
5032 // add EXTRA
5033 if (uri.startsWith("S.", i)) b.putString(key, value);
5034 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5035 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5036 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5037 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5038 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5039 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5040 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5041 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5042 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5043 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005044
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005045 // move to the next item
5046 i = semi + 1;
5047 }
5048
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005049 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005050 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005051 if (baseIntent.mPackage == null) {
5052 baseIntent.setSelector(intent);
5053 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005054 intent = baseIntent;
5055 }
5056
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005057 if (data != null) {
5058 if (data.startsWith("intent:")) {
5059 data = data.substring(7);
5060 if (scheme != null) {
5061 data = scheme + ':' + data;
5062 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005063 } else if (data.startsWith("android-app:")) {
5064 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5065 // Correctly formed android-app, first part is package name.
5066 int end = data.indexOf('/', 14);
5067 if (end < 0) {
5068 // All we have is a package name.
5069 intent.mPackage = data.substring(14);
5070 if (!explicitAction) {
5071 intent.setAction(ACTION_MAIN);
5072 }
5073 data = "";
5074 } else {
5075 // Target the Intent at the given package name always.
5076 String authority = null;
5077 intent.mPackage = data.substring(14, end);
5078 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005079 if ((end+1) < data.length()) {
5080 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5081 // Found a scheme, remember it.
5082 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005083 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005084 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5085 // Found a authority, remember it.
5086 authority = data.substring(end+1, newEnd);
5087 end = newEnd;
5088 }
5089 } else {
5090 // All we have is a scheme.
5091 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005092 }
5093 }
5094 if (scheme == null) {
5095 // If there was no scheme, then this just targets the package.
5096 if (!explicitAction) {
5097 intent.setAction(ACTION_MAIN);
5098 }
5099 data = "";
5100 } else if (authority == null) {
5101 data = scheme + ":";
5102 } else {
5103 data = scheme + "://" + authority + data.substring(end);
5104 }
5105 }
5106 } else {
5107 data = "";
5108 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005109 }
Tom Taylord4a47292009-12-21 13:59:18 -08005110
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005111 if (data.length() > 0) {
5112 try {
5113 intent.mData = Uri.parse(data);
5114 } catch (IllegalArgumentException e) {
5115 throw new URISyntaxException(uri, e.getMessage());
5116 }
5117 }
5118 }
Tom Taylord4a47292009-12-21 13:59:18 -08005119
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005120 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005121
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005122 } catch (IndexOutOfBoundsException e) {
5123 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5124 }
5125 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005126
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005127 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005128 return getIntentOld(uri, 0);
5129 }
5130
5131 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005132 Intent intent;
5133
5134 int i = uri.lastIndexOf('#');
5135 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005136 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005137 final int intentFragmentStart = i;
5138 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005139
5140 i++;
5141
5142 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005143 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005144 i += 7;
5145 int j = uri.indexOf(')', i);
5146 action = uri.substring(i, j);
5147 i = j + 1;
5148 }
5149
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005150 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005151
5152 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005153 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005154 i += 11;
5155 int j = uri.indexOf(')', i);
5156 while (i < j) {
5157 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005158 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005159 if (i < sep) {
5160 intent.addCategory(uri.substring(i, sep));
5161 }
5162 i = sep + 1;
5163 }
5164 i = j + 1;
5165 }
5166
5167 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005168 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005169 i += 5;
5170 int j = uri.indexOf(')', i);
5171 intent.mType = uri.substring(i, j);
5172 i = j + 1;
5173 }
5174
5175 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005176 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005177 i += 12;
5178 int j = uri.indexOf(')', i);
5179 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005180 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5181 intent.mFlags &= ~IMMUTABLE_FLAGS;
5182 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005183 i = j + 1;
5184 }
5185
5186 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005187 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005188 i += 10;
5189 int j = uri.indexOf(')', i);
5190 int sep = uri.indexOf('!', i);
5191 if (sep >= 0 && sep < j) {
5192 String pkg = uri.substring(i, sep);
5193 String cls = uri.substring(sep + 1, j);
5194 intent.mComponent = new ComponentName(pkg, cls);
5195 }
5196 i = j + 1;
5197 }
5198
5199 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005200 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005201 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005202
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005203 final int closeParen = uri.indexOf(')', i);
5204 if (closeParen == -1) throw new URISyntaxException(uri,
5205 "EXTRA missing trailing ')'", i);
5206
5207 while (i < closeParen) {
5208 // fetch the key value
5209 int j = uri.indexOf('=', i);
5210 if (j <= i + 1 || i >= closeParen) {
5211 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5212 }
5213 char type = uri.charAt(i);
5214 i++;
5215 String key = uri.substring(i, j);
5216 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005217
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005218 // get type-value
5219 j = uri.indexOf('!', i);
5220 if (j == -1 || j >= closeParen) j = closeParen;
5221 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5222 String value = uri.substring(i, j);
5223 i = j;
5224
5225 // create Bundle if it doesn't already exist
5226 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005227
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005228 // add item to bundle
5229 try {
5230 switch (type) {
5231 case 'S':
5232 intent.mExtras.putString(key, Uri.decode(value));
5233 break;
5234 case 'B':
5235 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5236 break;
5237 case 'b':
5238 intent.mExtras.putByte(key, Byte.parseByte(value));
5239 break;
5240 case 'c':
5241 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5242 break;
5243 case 'd':
5244 intent.mExtras.putDouble(key, Double.parseDouble(value));
5245 break;
5246 case 'f':
5247 intent.mExtras.putFloat(key, Float.parseFloat(value));
5248 break;
5249 case 'i':
5250 intent.mExtras.putInt(key, Integer.parseInt(value));
5251 break;
5252 case 'l':
5253 intent.mExtras.putLong(key, Long.parseLong(value));
5254 break;
5255 case 's':
5256 intent.mExtras.putShort(key, Short.parseShort(value));
5257 break;
5258 default:
5259 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5260 }
5261 } catch (NumberFormatException e) {
5262 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5263 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005264
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005265 char ch = uri.charAt(i);
5266 if (ch == ')') break;
5267 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5268 i++;
5269 }
5270 }
5271
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005272 if (isIntentFragment) {
5273 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5274 } else {
5275 intent.mData = Uri.parse(uri);
5276 }
Tom Taylord4a47292009-12-21 13:59:18 -08005277
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005278 if (intent.mAction == null) {
5279 // By default, if no action is specified, then use VIEW.
5280 intent.mAction = ACTION_VIEW;
5281 }
5282
5283 } else {
5284 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5285 }
5286
5287 return intent;
5288 }
5289
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005290 /** @hide */
5291 public interface CommandOptionHandler {
5292 boolean handleOption(String opt, ShellCommand cmd);
5293 }
5294
5295 /** @hide */
5296 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5297 throws URISyntaxException {
5298 Intent intent = new Intent();
5299 Intent baseIntent = intent;
5300 boolean hasIntentInfo = false;
5301
5302 Uri data = null;
5303 String type = null;
5304
5305 String opt;
5306 while ((opt=cmd.getNextOption()) != null) {
5307 switch (opt) {
5308 case "-a":
5309 intent.setAction(cmd.getNextArgRequired());
5310 if (intent == baseIntent) {
5311 hasIntentInfo = true;
5312 }
5313 break;
5314 case "-d":
5315 data = Uri.parse(cmd.getNextArgRequired());
5316 if (intent == baseIntent) {
5317 hasIntentInfo = true;
5318 }
5319 break;
5320 case "-t":
5321 type = cmd.getNextArgRequired();
5322 if (intent == baseIntent) {
5323 hasIntentInfo = true;
5324 }
5325 break;
5326 case "-c":
5327 intent.addCategory(cmd.getNextArgRequired());
5328 if (intent == baseIntent) {
5329 hasIntentInfo = true;
5330 }
5331 break;
5332 case "-e":
5333 case "--es": {
5334 String key = cmd.getNextArgRequired();
5335 String value = cmd.getNextArgRequired();
5336 intent.putExtra(key, value);
5337 }
5338 break;
5339 case "--esn": {
5340 String key = cmd.getNextArgRequired();
5341 intent.putExtra(key, (String) null);
5342 }
5343 break;
5344 case "--ei": {
5345 String key = cmd.getNextArgRequired();
5346 String value = cmd.getNextArgRequired();
5347 intent.putExtra(key, Integer.decode(value));
5348 }
5349 break;
5350 case "--eu": {
5351 String key = cmd.getNextArgRequired();
5352 String value = cmd.getNextArgRequired();
5353 intent.putExtra(key, Uri.parse(value));
5354 }
5355 break;
5356 case "--ecn": {
5357 String key = cmd.getNextArgRequired();
5358 String value = cmd.getNextArgRequired();
5359 ComponentName cn = ComponentName.unflattenFromString(value);
5360 if (cn == null)
5361 throw new IllegalArgumentException("Bad component name: " + value);
5362 intent.putExtra(key, cn);
5363 }
5364 break;
5365 case "--eia": {
5366 String key = cmd.getNextArgRequired();
5367 String value = cmd.getNextArgRequired();
5368 String[] strings = value.split(",");
5369 int[] list = new int[strings.length];
5370 for (int i = 0; i < strings.length; i++) {
5371 list[i] = Integer.decode(strings[i]);
5372 }
5373 intent.putExtra(key, list);
5374 }
5375 break;
5376 case "--eial": {
5377 String key = cmd.getNextArgRequired();
5378 String value = cmd.getNextArgRequired();
5379 String[] strings = value.split(",");
5380 ArrayList<Integer> list = new ArrayList<>(strings.length);
5381 for (int i = 0; i < strings.length; i++) {
5382 list.add(Integer.decode(strings[i]));
5383 }
5384 intent.putExtra(key, list);
5385 }
5386 break;
5387 case "--el": {
5388 String key = cmd.getNextArgRequired();
5389 String value = cmd.getNextArgRequired();
5390 intent.putExtra(key, Long.valueOf(value));
5391 }
5392 break;
5393 case "--ela": {
5394 String key = cmd.getNextArgRequired();
5395 String value = cmd.getNextArgRequired();
5396 String[] strings = value.split(",");
5397 long[] list = new long[strings.length];
5398 for (int i = 0; i < strings.length; i++) {
5399 list[i] = Long.valueOf(strings[i]);
5400 }
5401 intent.putExtra(key, list);
5402 hasIntentInfo = true;
5403 }
5404 break;
5405 case "--elal": {
5406 String key = cmd.getNextArgRequired();
5407 String value = cmd.getNextArgRequired();
5408 String[] strings = value.split(",");
5409 ArrayList<Long> list = new ArrayList<>(strings.length);
5410 for (int i = 0; i < strings.length; i++) {
5411 list.add(Long.valueOf(strings[i]));
5412 }
5413 intent.putExtra(key, list);
5414 hasIntentInfo = true;
5415 }
5416 break;
5417 case "--ef": {
5418 String key = cmd.getNextArgRequired();
5419 String value = cmd.getNextArgRequired();
5420 intent.putExtra(key, Float.valueOf(value));
5421 hasIntentInfo = true;
5422 }
5423 break;
5424 case "--efa": {
5425 String key = cmd.getNextArgRequired();
5426 String value = cmd.getNextArgRequired();
5427 String[] strings = value.split(",");
5428 float[] list = new float[strings.length];
5429 for (int i = 0; i < strings.length; i++) {
5430 list[i] = Float.valueOf(strings[i]);
5431 }
5432 intent.putExtra(key, list);
5433 hasIntentInfo = true;
5434 }
5435 break;
5436 case "--efal": {
5437 String key = cmd.getNextArgRequired();
5438 String value = cmd.getNextArgRequired();
5439 String[] strings = value.split(",");
5440 ArrayList<Float> list = new ArrayList<>(strings.length);
5441 for (int i = 0; i < strings.length; i++) {
5442 list.add(Float.valueOf(strings[i]));
5443 }
5444 intent.putExtra(key, list);
5445 hasIntentInfo = true;
5446 }
5447 break;
5448 case "--esa": {
5449 String key = cmd.getNextArgRequired();
5450 String value = cmd.getNextArgRequired();
5451 // Split on commas unless they are preceeded by an escape.
5452 // The escape character must be escaped for the string and
5453 // again for the regex, thus four escape characters become one.
5454 String[] strings = value.split("(?<!\\\\),");
5455 intent.putExtra(key, strings);
5456 hasIntentInfo = true;
5457 }
5458 break;
5459 case "--esal": {
5460 String key = cmd.getNextArgRequired();
5461 String value = cmd.getNextArgRequired();
5462 // Split on commas unless they are preceeded by an escape.
5463 // The escape character must be escaped for the string and
5464 // again for the regex, thus four escape characters become one.
5465 String[] strings = value.split("(?<!\\\\),");
5466 ArrayList<String> list = new ArrayList<>(strings.length);
5467 for (int i = 0; i < strings.length; i++) {
5468 list.add(strings[i]);
5469 }
5470 intent.putExtra(key, list);
5471 hasIntentInfo = true;
5472 }
5473 break;
5474 case "--ez": {
5475 String key = cmd.getNextArgRequired();
5476 String value = cmd.getNextArgRequired().toLowerCase();
5477 // Boolean.valueOf() results in false for anything that is not "true", which is
5478 // error-prone in shell commands
5479 boolean arg;
5480 if ("true".equals(value) || "t".equals(value)) {
5481 arg = true;
5482 } else if ("false".equals(value) || "f".equals(value)) {
5483 arg = false;
5484 } else {
5485 try {
5486 arg = Integer.decode(value) != 0;
5487 } catch (NumberFormatException ex) {
5488 throw new IllegalArgumentException("Invalid boolean value: " + value);
5489 }
5490 }
5491
5492 intent.putExtra(key, arg);
5493 }
5494 break;
5495 case "-n": {
5496 String str = cmd.getNextArgRequired();
5497 ComponentName cn = ComponentName.unflattenFromString(str);
5498 if (cn == null)
5499 throw new IllegalArgumentException("Bad component name: " + str);
5500 intent.setComponent(cn);
5501 if (intent == baseIntent) {
5502 hasIntentInfo = true;
5503 }
5504 }
5505 break;
5506 case "-p": {
5507 String str = cmd.getNextArgRequired();
5508 intent.setPackage(str);
5509 if (intent == baseIntent) {
5510 hasIntentInfo = true;
5511 }
5512 }
5513 break;
5514 case "-f":
5515 String str = cmd.getNextArgRequired();
5516 intent.setFlags(Integer.decode(str).intValue());
5517 break;
5518 case "--grant-read-uri-permission":
5519 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5520 break;
5521 case "--grant-write-uri-permission":
5522 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5523 break;
5524 case "--grant-persistable-uri-permission":
5525 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5526 break;
5527 case "--grant-prefix-uri-permission":
5528 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5529 break;
5530 case "--exclude-stopped-packages":
5531 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5532 break;
5533 case "--include-stopped-packages":
5534 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5535 break;
5536 case "--debug-log-resolution":
5537 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5538 break;
5539 case "--activity-brought-to-front":
5540 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5541 break;
5542 case "--activity-clear-top":
5543 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5544 break;
5545 case "--activity-clear-when-task-reset":
5546 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5547 break;
5548 case "--activity-exclude-from-recents":
5549 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5550 break;
5551 case "--activity-launched-from-history":
5552 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5553 break;
5554 case "--activity-multiple-task":
5555 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5556 break;
5557 case "--activity-no-animation":
5558 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5559 break;
5560 case "--activity-no-history":
5561 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5562 break;
5563 case "--activity-no-user-action":
5564 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5565 break;
5566 case "--activity-previous-is-top":
5567 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5568 break;
5569 case "--activity-reorder-to-front":
5570 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5571 break;
5572 case "--activity-reset-task-if-needed":
5573 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5574 break;
5575 case "--activity-single-top":
5576 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5577 break;
5578 case "--activity-clear-task":
5579 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5580 break;
5581 case "--activity-task-on-home":
5582 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5583 break;
5584 case "--receiver-registered-only":
5585 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5586 break;
5587 case "--receiver-replace-pending":
5588 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5589 break;
5590 case "--selector":
5591 intent.setDataAndType(data, type);
5592 intent = new Intent();
5593 break;
5594 default:
5595 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5596 // Okay, caller handled this option.
5597 } else {
5598 throw new IllegalArgumentException("Unknown option: " + opt);
5599 }
5600 break;
5601 }
5602 }
5603 intent.setDataAndType(data, type);
5604
5605 final boolean hasSelector = intent != baseIntent;
5606 if (hasSelector) {
5607 // A selector was specified; fix up.
5608 baseIntent.setSelector(intent);
5609 intent = baseIntent;
5610 }
5611
5612 String arg = cmd.getNextArg();
5613 baseIntent = null;
5614 if (arg == null) {
5615 if (hasSelector) {
5616 // If a selector has been specified, and no arguments
5617 // have been supplied for the main Intent, then we can
5618 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5619 // need to have a component name specified yet, the
5620 // selector will take care of that.
5621 baseIntent = new Intent(Intent.ACTION_MAIN);
5622 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5623 }
5624 } else if (arg.indexOf(':') >= 0) {
5625 // The argument is a URI. Fully parse it, and use that result
5626 // to fill in any data not specified so far.
5627 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5628 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5629 } else if (arg.indexOf('/') >= 0) {
5630 // The argument is a component name. Build an Intent to launch
5631 // it.
5632 baseIntent = new Intent(Intent.ACTION_MAIN);
5633 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5634 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5635 } else {
5636 // Assume the argument is a package name.
5637 baseIntent = new Intent(Intent.ACTION_MAIN);
5638 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5639 baseIntent.setPackage(arg);
5640 }
5641 if (baseIntent != null) {
5642 Bundle extras = intent.getExtras();
5643 intent.replaceExtras((Bundle)null);
5644 Bundle uriExtras = baseIntent.getExtras();
5645 baseIntent.replaceExtras((Bundle)null);
5646 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5647 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5648 for (String c : cats) {
5649 baseIntent.removeCategory(c);
5650 }
5651 }
5652 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5653 if (extras == null) {
5654 extras = uriExtras;
5655 } else if (uriExtras != null) {
5656 uriExtras.putAll(extras);
5657 extras = uriExtras;
5658 }
5659 intent.replaceExtras(extras);
5660 hasIntentInfo = true;
5661 }
5662
5663 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5664 return intent;
5665 }
5666
5667 /** @hide */
5668 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5669 final String[] lines = new String[] {
5670 "<INTENT> specifications include these flags and arguments:",
5671 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5672 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5673 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5674 " [--esn <EXTRA_KEY> ...]",
5675 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5676 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5677 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5678 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5679 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5680 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5681 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5682 " (mutiple extras passed as Integer[])",
5683 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5684 " (mutiple extras passed as List<Integer>)",
5685 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5686 " (mutiple extras passed as Long[])",
5687 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5688 " (mutiple extras passed as List<Long>)",
5689 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5690 " (mutiple extras passed as Float[])",
5691 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5692 " (mutiple extras passed as List<Float>)",
5693 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5694 " (mutiple extras passed as String[]; to embed a comma into a string,",
5695 " escape it using \"\\,\")",
5696 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5697 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5698 " escape it using \"\\,\")",
5699 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5700 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5701 " [--debug-log-resolution] [--exclude-stopped-packages]",
5702 " [--include-stopped-packages]",
5703 " [--activity-brought-to-front] [--activity-clear-top]",
5704 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5705 " [--activity-launched-from-history] [--activity-multiple-task]",
5706 " [--activity-no-animation] [--activity-no-history]",
5707 " [--activity-no-user-action] [--activity-previous-is-top]",
5708 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5709 " [--activity-single-top] [--activity-clear-task]",
5710 " [--activity-task-on-home]",
5711 " [--receiver-registered-only] [--receiver-replace-pending]",
5712 " [--selector]",
5713 " [<URI> | <PACKAGE> | <COMPONENT>]"
5714 };
5715 for (String line : lines) {
5716 pw.print(prefix);
5717 pw.println(line);
5718 }
5719 }
5720
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005721 /**
5722 * Retrieve the general action to be performed, such as
5723 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5724 * the information in the intent should be interpreted -- most importantly,
5725 * what to do with the data returned by {@link #getData}.
5726 *
5727 * @return The action of this intent or null if none is specified.
5728 *
5729 * @see #setAction
5730 */
5731 public String getAction() {
5732 return mAction;
5733 }
5734
5735 /**
5736 * Retrieve data this intent is operating on. This URI specifies the name
5737 * of the data; often it uses the content: scheme, specifying data in a
5738 * content provider. Other schemes may be handled by specific activities,
5739 * such as http: by the web browser.
5740 *
5741 * @return The URI of the data this intent is targeting or null.
5742 *
5743 * @see #getScheme
5744 * @see #setData
5745 */
5746 public Uri getData() {
5747 return mData;
5748 }
5749
5750 /**
5751 * The same as {@link #getData()}, but returns the URI as an encoded
5752 * String.
5753 */
5754 public String getDataString() {
5755 return mData != null ? mData.toString() : null;
5756 }
5757
5758 /**
5759 * Return the scheme portion of the intent's data. If the data is null or
5760 * does not include a scheme, null is returned. Otherwise, the scheme
5761 * prefix without the final ':' is returned, i.e. "http".
5762 *
5763 * <p>This is the same as calling getData().getScheme() (and checking for
5764 * null data).
5765 *
5766 * @return The scheme of this intent.
5767 *
5768 * @see #getData
5769 */
5770 public String getScheme() {
5771 return mData != null ? mData.getScheme() : null;
5772 }
5773
5774 /**
5775 * Retrieve any explicit MIME type included in the intent. This is usually
5776 * null, as the type is determined by the intent data.
5777 *
5778 * @return If a type was manually set, it is returned; else null is
5779 * returned.
5780 *
5781 * @see #resolveType(ContentResolver)
5782 * @see #setType
5783 */
5784 public String getType() {
5785 return mType;
5786 }
5787
5788 /**
5789 * Return the MIME data type of this intent. If the type field is
5790 * explicitly set, that is simply returned. Otherwise, if the data is set,
5791 * the type of that data is returned. If neither fields are set, a null is
5792 * returned.
5793 *
5794 * @return The MIME type of this intent.
5795 *
5796 * @see #getType
5797 * @see #resolveType(ContentResolver)
5798 */
5799 public String resolveType(Context context) {
5800 return resolveType(context.getContentResolver());
5801 }
5802
5803 /**
5804 * Return the MIME data type of this intent. If the type field is
5805 * explicitly set, that is simply returned. Otherwise, if the data is set,
5806 * the type of that data is returned. If neither fields are set, a null is
5807 * returned.
5808 *
5809 * @param resolver A ContentResolver that can be used to determine the MIME
5810 * type of the intent's data.
5811 *
5812 * @return The MIME type of this intent.
5813 *
5814 * @see #getType
5815 * @see #resolveType(Context)
5816 */
5817 public String resolveType(ContentResolver resolver) {
5818 if (mType != null) {
5819 return mType;
5820 }
5821 if (mData != null) {
5822 if ("content".equals(mData.getScheme())) {
5823 return resolver.getType(mData);
5824 }
5825 }
5826 return null;
5827 }
5828
5829 /**
5830 * Return the MIME data type of this intent, only if it will be needed for
5831 * intent resolution. This is not generally useful for application code;
5832 * it is used by the frameworks for communicating with back-end system
5833 * services.
5834 *
5835 * @param resolver A ContentResolver that can be used to determine the MIME
5836 * type of the intent's data.
5837 *
5838 * @return The MIME type of this intent, or null if it is unknown or not
5839 * needed.
5840 */
5841 public String resolveTypeIfNeeded(ContentResolver resolver) {
5842 if (mComponent != null) {
5843 return mType;
5844 }
5845 return resolveType(resolver);
5846 }
5847
5848 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005849 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005850 *
5851 * @param category The category to check.
5852 *
5853 * @return boolean True if the intent contains the category, else false.
5854 *
5855 * @see #getCategories
5856 * @see #addCategory
5857 */
5858 public boolean hasCategory(String category) {
5859 return mCategories != null && mCategories.contains(category);
5860 }
5861
5862 /**
5863 * Return the set of all categories in the intent. If there are no categories,
5864 * returns NULL.
5865 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005866 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005867 *
5868 * @see #hasCategory
5869 * @see #addCategory
5870 */
5871 public Set<String> getCategories() {
5872 return mCategories;
5873 }
5874
5875 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005876 * Return the specific selector associated with this Intent. If there is
5877 * none, returns null. See {@link #setSelector} for more information.
5878 *
5879 * @see #setSelector
5880 */
5881 public Intent getSelector() {
5882 return mSelector;
5883 }
5884
5885 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005886 * Return the {@link ClipData} associated with this Intent. If there is
5887 * none, returns null. See {@link #setClipData} for more information.
5888 *
John Spurlock125d1332013-11-25 11:58:37 -05005889 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005890 */
5891 public ClipData getClipData() {
5892 return mClipData;
5893 }
5894
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005895 /** @hide */
5896 public int getContentUserHint() {
5897 return mContentUserHint;
5898 }
5899
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005900 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005901 * Sets the ClassLoader that will be used when unmarshalling
5902 * any Parcelable values from the extras of this Intent.
5903 *
5904 * @param loader a ClassLoader, or null to use the default loader
5905 * at the time of unmarshalling.
5906 */
5907 public void setExtrasClassLoader(ClassLoader loader) {
5908 if (mExtras != null) {
5909 mExtras.setClassLoader(loader);
5910 }
5911 }
5912
5913 /**
5914 * Returns true if an extra value is associated with the given name.
5915 * @param name the extra's name
5916 * @return true if the given extra is present.
5917 */
5918 public boolean hasExtra(String name) {
5919 return mExtras != null && mExtras.containsKey(name);
5920 }
5921
5922 /**
5923 * Returns true if the Intent's extras contain a parcelled file descriptor.
5924 * @return true if the Intent contains a parcelled file descriptor.
5925 */
5926 public boolean hasFileDescriptors() {
5927 return mExtras != null && mExtras.hasFileDescriptors();
5928 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005929
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04005930 /** @hide */
5931 public void setAllowFds(boolean allowFds) {
5932 if (mExtras != null) {
5933 mExtras.setAllowFds(allowFds);
5934 }
5935 }
5936
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005937 /**
5938 * Retrieve extended data from the intent.
5939 *
5940 * @param name The name of the desired item.
5941 *
5942 * @return the value of an item that previously added with putExtra()
5943 * or null if none was found.
5944 *
5945 * @deprecated
5946 * @hide
5947 */
5948 @Deprecated
5949 public Object getExtra(String name) {
5950 return getExtra(name, null);
5951 }
5952
5953 /**
5954 * Retrieve extended data from the intent.
5955 *
5956 * @param name The name of the desired item.
5957 * @param defaultValue the value to be returned if no value of the desired
5958 * type is stored with the given name.
5959 *
5960 * @return the value of an item that previously added with putExtra()
5961 * or the default value if none was found.
5962 *
5963 * @see #putExtra(String, boolean)
5964 */
5965 public boolean getBooleanExtra(String name, boolean defaultValue) {
5966 return mExtras == null ? defaultValue :
5967 mExtras.getBoolean(name, defaultValue);
5968 }
5969
5970 /**
5971 * Retrieve extended data from the intent.
5972 *
5973 * @param name The name of the desired item.
5974 * @param defaultValue the value to be returned if no value of the desired
5975 * type is stored with the given name.
5976 *
5977 * @return the value of an item that previously added with putExtra()
5978 * or the default value if none was found.
5979 *
5980 * @see #putExtra(String, byte)
5981 */
5982 public byte getByteExtra(String name, byte defaultValue) {
5983 return mExtras == null ? defaultValue :
5984 mExtras.getByte(name, defaultValue);
5985 }
5986
5987 /**
5988 * Retrieve extended data from the intent.
5989 *
5990 * @param name The name of the desired item.
5991 * @param defaultValue the value to be returned if no value of the desired
5992 * type is stored with the given name.
5993 *
5994 * @return the value of an item that previously added with putExtra()
5995 * or the default value if none was found.
5996 *
5997 * @see #putExtra(String, short)
5998 */
5999 public short getShortExtra(String name, short defaultValue) {
6000 return mExtras == null ? defaultValue :
6001 mExtras.getShort(name, defaultValue);
6002 }
6003
6004 /**
6005 * Retrieve extended data from the intent.
6006 *
6007 * @param name The name of the desired item.
6008 * @param defaultValue the value to be returned if no value of the desired
6009 * type is stored with the given name.
6010 *
6011 * @return the value of an item that previously added with putExtra()
6012 * or the default value if none was found.
6013 *
6014 * @see #putExtra(String, char)
6015 */
6016 public char getCharExtra(String name, char defaultValue) {
6017 return mExtras == null ? defaultValue :
6018 mExtras.getChar(name, defaultValue);
6019 }
6020
6021 /**
6022 * Retrieve extended data from the intent.
6023 *
6024 * @param name The name of the desired item.
6025 * @param defaultValue the value to be returned if no value of the desired
6026 * type is stored with the given name.
6027 *
6028 * @return the value of an item that previously added with putExtra()
6029 * or the default value if none was found.
6030 *
6031 * @see #putExtra(String, int)
6032 */
6033 public int getIntExtra(String name, int defaultValue) {
6034 return mExtras == null ? defaultValue :
6035 mExtras.getInt(name, defaultValue);
6036 }
6037
6038 /**
6039 * Retrieve extended data from the intent.
6040 *
6041 * @param name The name of the desired item.
6042 * @param defaultValue the value to be returned if no value of the desired
6043 * type is stored with the given name.
6044 *
6045 * @return the value of an item that previously added with putExtra()
6046 * or the default value if none was found.
6047 *
6048 * @see #putExtra(String, long)
6049 */
6050 public long getLongExtra(String name, long defaultValue) {
6051 return mExtras == null ? defaultValue :
6052 mExtras.getLong(name, defaultValue);
6053 }
6054
6055 /**
6056 * Retrieve extended data from the intent.
6057 *
6058 * @param name The name of the desired item.
6059 * @param defaultValue the value to be returned if no value of the desired
6060 * type is stored with the given name.
6061 *
6062 * @return the value of an item that previously added with putExtra(),
6063 * or the default value if no such item is present
6064 *
6065 * @see #putExtra(String, float)
6066 */
6067 public float getFloatExtra(String name, float defaultValue) {
6068 return mExtras == null ? defaultValue :
6069 mExtras.getFloat(name, defaultValue);
6070 }
6071
6072 /**
6073 * Retrieve extended data from the intent.
6074 *
6075 * @param name The name of the desired item.
6076 * @param defaultValue the value to be returned if no value of the desired
6077 * type is stored with the given name.
6078 *
6079 * @return the value of an item that previously added with putExtra()
6080 * or the default value if none was found.
6081 *
6082 * @see #putExtra(String, double)
6083 */
6084 public double getDoubleExtra(String name, double defaultValue) {
6085 return mExtras == null ? defaultValue :
6086 mExtras.getDouble(name, defaultValue);
6087 }
6088
6089 /**
6090 * Retrieve extended data from the intent.
6091 *
6092 * @param name The name of the desired item.
6093 *
6094 * @return the value of an item that previously added with putExtra()
6095 * or null if no String value was found.
6096 *
6097 * @see #putExtra(String, String)
6098 */
6099 public String getStringExtra(String name) {
6100 return mExtras == null ? null : mExtras.getString(name);
6101 }
6102
6103 /**
6104 * Retrieve extended data from the intent.
6105 *
6106 * @param name The name of the desired item.
6107 *
6108 * @return the value of an item that previously added with putExtra()
6109 * or null if no CharSequence value was found.
6110 *
6111 * @see #putExtra(String, CharSequence)
6112 */
6113 public CharSequence getCharSequenceExtra(String name) {
6114 return mExtras == null ? null : mExtras.getCharSequence(name);
6115 }
6116
6117 /**
6118 * Retrieve extended data from the intent.
6119 *
6120 * @param name The name of the desired item.
6121 *
6122 * @return the value of an item that previously added with putExtra()
6123 * or null if no Parcelable value was found.
6124 *
6125 * @see #putExtra(String, Parcelable)
6126 */
6127 public <T extends Parcelable> T getParcelableExtra(String name) {
6128 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6129 }
6130
6131 /**
6132 * Retrieve extended data from the intent.
6133 *
6134 * @param name The name of the desired item.
6135 *
6136 * @return the value of an item that previously added with putExtra()
6137 * or null if no Parcelable[] value was found.
6138 *
6139 * @see #putExtra(String, Parcelable[])
6140 */
6141 public Parcelable[] getParcelableArrayExtra(String name) {
6142 return mExtras == null ? null : mExtras.getParcelableArray(name);
6143 }
6144
6145 /**
6146 * Retrieve extended data from the intent.
6147 *
6148 * @param name The name of the desired item.
6149 *
6150 * @return the value of an item that previously added with putExtra()
6151 * or null if no ArrayList<Parcelable> value was found.
6152 *
6153 * @see #putParcelableArrayListExtra(String, ArrayList)
6154 */
6155 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6156 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6157 }
6158
6159 /**
6160 * Retrieve extended data from the intent.
6161 *
6162 * @param name The name of the desired item.
6163 *
6164 * @return the value of an item that previously added with putExtra()
6165 * or null if no Serializable value was found.
6166 *
6167 * @see #putExtra(String, Serializable)
6168 */
6169 public Serializable getSerializableExtra(String name) {
6170 return mExtras == null ? null : mExtras.getSerializable(name);
6171 }
6172
6173 /**
6174 * Retrieve extended data from the intent.
6175 *
6176 * @param name The name of the desired item.
6177 *
6178 * @return the value of an item that previously added with putExtra()
6179 * or null if no ArrayList<Integer> value was found.
6180 *
6181 * @see #putIntegerArrayListExtra(String, ArrayList)
6182 */
6183 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6184 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6185 }
6186
6187 /**
6188 * Retrieve extended data from the intent.
6189 *
6190 * @param name The name of the desired item.
6191 *
6192 * @return the value of an item that previously added with putExtra()
6193 * or null if no ArrayList<String> value was found.
6194 *
6195 * @see #putStringArrayListExtra(String, ArrayList)
6196 */
6197 public ArrayList<String> getStringArrayListExtra(String name) {
6198 return mExtras == null ? null : mExtras.getStringArrayList(name);
6199 }
6200
6201 /**
6202 * Retrieve extended data from the intent.
6203 *
6204 * @param name The name of the desired item.
6205 *
6206 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006207 * or null if no ArrayList<CharSequence> value was found.
6208 *
6209 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6210 */
6211 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6212 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6213 }
6214
6215 /**
6216 * Retrieve extended data from the intent.
6217 *
6218 * @param name The name of the desired item.
6219 *
6220 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006221 * or null if no boolean array value was found.
6222 *
6223 * @see #putExtra(String, boolean[])
6224 */
6225 public boolean[] getBooleanArrayExtra(String name) {
6226 return mExtras == null ? null : mExtras.getBooleanArray(name);
6227 }
6228
6229 /**
6230 * Retrieve extended data from the intent.
6231 *
6232 * @param name The name of the desired item.
6233 *
6234 * @return the value of an item that previously added with putExtra()
6235 * or null if no byte array value was found.
6236 *
6237 * @see #putExtra(String, byte[])
6238 */
6239 public byte[] getByteArrayExtra(String name) {
6240 return mExtras == null ? null : mExtras.getByteArray(name);
6241 }
6242
6243 /**
6244 * Retrieve extended data from the intent.
6245 *
6246 * @param name The name of the desired item.
6247 *
6248 * @return the value of an item that previously added with putExtra()
6249 * or null if no short array value was found.
6250 *
6251 * @see #putExtra(String, short[])
6252 */
6253 public short[] getShortArrayExtra(String name) {
6254 return mExtras == null ? null : mExtras.getShortArray(name);
6255 }
6256
6257 /**
6258 * Retrieve extended data from the intent.
6259 *
6260 * @param name The name of the desired item.
6261 *
6262 * @return the value of an item that previously added with putExtra()
6263 * or null if no char array value was found.
6264 *
6265 * @see #putExtra(String, char[])
6266 */
6267 public char[] getCharArrayExtra(String name) {
6268 return mExtras == null ? null : mExtras.getCharArray(name);
6269 }
6270
6271 /**
6272 * Retrieve extended data from the intent.
6273 *
6274 * @param name The name of the desired item.
6275 *
6276 * @return the value of an item that previously added with putExtra()
6277 * or null if no int array value was found.
6278 *
6279 * @see #putExtra(String, int[])
6280 */
6281 public int[] getIntArrayExtra(String name) {
6282 return mExtras == null ? null : mExtras.getIntArray(name);
6283 }
6284
6285 /**
6286 * Retrieve extended data from the intent.
6287 *
6288 * @param name The name of the desired item.
6289 *
6290 * @return the value of an item that previously added with putExtra()
6291 * or null if no long array value was found.
6292 *
6293 * @see #putExtra(String, long[])
6294 */
6295 public long[] getLongArrayExtra(String name) {
6296 return mExtras == null ? null : mExtras.getLongArray(name);
6297 }
6298
6299 /**
6300 * Retrieve extended data from the intent.
6301 *
6302 * @param name The name of the desired item.
6303 *
6304 * @return the value of an item that previously added with putExtra()
6305 * or null if no float array value was found.
6306 *
6307 * @see #putExtra(String, float[])
6308 */
6309 public float[] getFloatArrayExtra(String name) {
6310 return mExtras == null ? null : mExtras.getFloatArray(name);
6311 }
6312
6313 /**
6314 * Retrieve extended data from the intent.
6315 *
6316 * @param name The name of the desired item.
6317 *
6318 * @return the value of an item that previously added with putExtra()
6319 * or null if no double array value was found.
6320 *
6321 * @see #putExtra(String, double[])
6322 */
6323 public double[] getDoubleArrayExtra(String name) {
6324 return mExtras == null ? null : mExtras.getDoubleArray(name);
6325 }
6326
6327 /**
6328 * Retrieve extended data from the intent.
6329 *
6330 * @param name The name of the desired item.
6331 *
6332 * @return the value of an item that previously added with putExtra()
6333 * or null if no String array value was found.
6334 *
6335 * @see #putExtra(String, String[])
6336 */
6337 public String[] getStringArrayExtra(String name) {
6338 return mExtras == null ? null : mExtras.getStringArray(name);
6339 }
6340
6341 /**
6342 * Retrieve extended data from the intent.
6343 *
6344 * @param name The name of the desired item.
6345 *
6346 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006347 * or null if no CharSequence array value was found.
6348 *
6349 * @see #putExtra(String, CharSequence[])
6350 */
6351 public CharSequence[] getCharSequenceArrayExtra(String name) {
6352 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6353 }
6354
6355 /**
6356 * Retrieve extended data from the intent.
6357 *
6358 * @param name The name of the desired item.
6359 *
6360 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006361 * or null if no Bundle value was found.
6362 *
6363 * @see #putExtra(String, Bundle)
6364 */
6365 public Bundle getBundleExtra(String name) {
6366 return mExtras == null ? null : mExtras.getBundle(name);
6367 }
6368
6369 /**
6370 * Retrieve extended data from the intent.
6371 *
6372 * @param name The name of the desired item.
6373 *
6374 * @return the value of an item that previously added with putExtra()
6375 * or null if no IBinder value was found.
6376 *
6377 * @see #putExtra(String, IBinder)
6378 *
6379 * @deprecated
6380 * @hide
6381 */
6382 @Deprecated
6383 public IBinder getIBinderExtra(String name) {
6384 return mExtras == null ? null : mExtras.getIBinder(name);
6385 }
6386
6387 /**
6388 * Retrieve extended data from the intent.
6389 *
6390 * @param name The name of the desired item.
6391 * @param defaultValue The default value to return in case no item is
6392 * associated with the key 'name'
6393 *
6394 * @return the value of an item that previously added with putExtra()
6395 * or defaultValue if none was found.
6396 *
6397 * @see #putExtra
6398 *
6399 * @deprecated
6400 * @hide
6401 */
6402 @Deprecated
6403 public Object getExtra(String name, Object defaultValue) {
6404 Object result = defaultValue;
6405 if (mExtras != null) {
6406 Object result2 = mExtras.get(name);
6407 if (result2 != null) {
6408 result = result2;
6409 }
6410 }
6411
6412 return result;
6413 }
6414
6415 /**
6416 * Retrieves a map of extended data from the intent.
6417 *
6418 * @return the map of all extras previously added with putExtra(),
6419 * or null if none have been added.
6420 */
6421 public Bundle getExtras() {
6422 return (mExtras != null)
6423 ? new Bundle(mExtras)
6424 : null;
6425 }
6426
6427 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006428 * Filter extras to only basic types.
6429 * @hide
6430 */
6431 public void removeUnsafeExtras() {
6432 if (mExtras != null) {
6433 mExtras.filterValues();
6434 }
6435 }
6436
6437 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006438 * Retrieve any special flags associated with this intent. You will
6439 * normally just set them with {@link #setFlags} and let the system
6440 * take the appropriate action with them.
6441 *
6442 * @return int The currently set flags.
6443 *
6444 * @see #setFlags
6445 */
6446 public int getFlags() {
6447 return mFlags;
6448 }
6449
Dianne Hackborne7f97212011-02-24 14:40:20 -08006450 /** @hide */
6451 public boolean isExcludingStopped() {
6452 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6453 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6454 }
6455
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006456 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006457 * Retrieve the application package name this Intent is limited to. When
6458 * resolving an Intent, if non-null this limits the resolution to only
6459 * components in the given application package.
6460 *
6461 * @return The name of the application package for the Intent.
6462 *
6463 * @see #resolveActivity
6464 * @see #setPackage
6465 */
6466 public String getPackage() {
6467 return mPackage;
6468 }
6469
6470 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006471 * Retrieve the concrete component associated with the intent. When receiving
6472 * an intent, this is the component that was found to best handle it (that is,
6473 * yourself) and will always be non-null; in all other cases it will be
6474 * null unless explicitly set.
6475 *
6476 * @return The name of the application component to handle the intent.
6477 *
6478 * @see #resolveActivity
6479 * @see #setComponent
6480 */
6481 public ComponentName getComponent() {
6482 return mComponent;
6483 }
6484
6485 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006486 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6487 * used as a hint to the receiver for animations and the like. Null means that there
6488 * is no source bounds.
6489 */
6490 public Rect getSourceBounds() {
6491 return mSourceBounds;
6492 }
6493
6494 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006495 * Return the Activity component that should be used to handle this intent.
6496 * The appropriate component is determined based on the information in the
6497 * intent, evaluated as follows:
6498 *
6499 * <p>If {@link #getComponent} returns an explicit class, that is returned
6500 * without any further consideration.
6501 *
6502 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6503 * category to be considered.
6504 *
6505 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6506 * action.
6507 *
6508 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6509 * this type.
6510 *
6511 * <p>If {@link #addCategory} has added any categories, the activity must
6512 * handle ALL of the categories specified.
6513 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006514 * <p>If {@link #getPackage} is non-NULL, only activity components in
6515 * that application package will be considered.
6516 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006517 * <p>If there are no activities that satisfy all of these conditions, a
6518 * null string is returned.
6519 *
6520 * <p>If multiple activities are found to satisfy the intent, the one with
6521 * the highest priority will be used. If there are multiple activities
6522 * with the same priority, the system will either pick the best activity
6523 * based on user preference, or resolve to a system class that will allow
6524 * the user to pick an activity and forward from there.
6525 *
6526 * <p>This method is implemented simply by calling
6527 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6528 * true.</p>
6529 * <p> This API is called for you as part of starting an activity from an
6530 * intent. You do not normally need to call it yourself.</p>
6531 *
6532 * @param pm The package manager with which to resolve the Intent.
6533 *
6534 * @return Name of the component implementing an activity that can
6535 * display the intent.
6536 *
6537 * @see #setComponent
6538 * @see #getComponent
6539 * @see #resolveActivityInfo
6540 */
6541 public ComponentName resolveActivity(PackageManager pm) {
6542 if (mComponent != null) {
6543 return mComponent;
6544 }
6545
6546 ResolveInfo info = pm.resolveActivity(
6547 this, PackageManager.MATCH_DEFAULT_ONLY);
6548 if (info != null) {
6549 return new ComponentName(
6550 info.activityInfo.applicationInfo.packageName,
6551 info.activityInfo.name);
6552 }
6553
6554 return null;
6555 }
6556
6557 /**
6558 * Resolve the Intent into an {@link ActivityInfo}
6559 * describing the activity that should execute the intent. Resolution
6560 * follows the same rules as described for {@link #resolveActivity}, but
6561 * you get back the completely information about the resolved activity
6562 * instead of just its class name.
6563 *
6564 * @param pm The package manager with which to resolve the Intent.
6565 * @param flags Addition information to retrieve as per
6566 * {@link PackageManager#getActivityInfo(ComponentName, int)
6567 * PackageManager.getActivityInfo()}.
6568 *
6569 * @return PackageManager.ActivityInfo
6570 *
6571 * @see #resolveActivity
6572 */
6573 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6574 ActivityInfo ai = null;
6575 if (mComponent != null) {
6576 try {
6577 ai = pm.getActivityInfo(mComponent, flags);
6578 } catch (PackageManager.NameNotFoundException e) {
6579 // ignore
6580 }
6581 } else {
6582 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006583 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006584 if (info != null) {
6585 ai = info.activityInfo;
6586 }
6587 }
6588
6589 return ai;
6590 }
6591
6592 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006593 * Special function for use by the system to resolve service
6594 * intents to system apps. Throws an exception if there are
6595 * multiple potential matches to the Intent. Returns null if
6596 * there are no matches.
6597 * @hide
6598 */
6599 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6600 if (mComponent != null) {
6601 return mComponent;
6602 }
6603
6604 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6605 if (results == null) {
6606 return null;
6607 }
6608 ComponentName comp = null;
6609 for (int i=0; i<results.size(); i++) {
6610 ResolveInfo ri = results.get(i);
6611 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6612 continue;
6613 }
6614 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6615 ri.serviceInfo.name);
6616 if (comp != null) {
6617 throw new IllegalStateException("Multiple system services handle " + this
6618 + ": " + comp + ", " + foundComp);
6619 }
6620 comp = foundComp;
6621 }
6622 return comp;
6623 }
6624
6625 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006626 * Set the general action to be performed.
6627 *
6628 * @param action An action name, such as ACTION_VIEW. Application-specific
6629 * actions should be prefixed with the vendor's package name.
6630 *
6631 * @return Returns the same Intent object, for chaining multiple calls
6632 * into a single statement.
6633 *
6634 * @see #getAction
6635 */
6636 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006637 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006638 return this;
6639 }
6640
6641 /**
6642 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006643 * clears any type that was previously set by {@link #setType} or
6644 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006645 *
Nick Pellyccae4122012-01-09 14:12:58 -08006646 * <p><em>Note: scheme matching in the Android framework is
6647 * case-sensitive, unlike the formal RFC. As a result,
6648 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006649 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006650 * {@link #setDataAndNormalize}
6651 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006652 *
Nick Pellyccae4122012-01-09 14:12:58 -08006653 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006654 *
6655 * @return Returns the same Intent object, for chaining multiple calls
6656 * into a single statement.
6657 *
6658 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006659 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006660 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006661 */
6662 public Intent setData(Uri data) {
6663 mData = data;
6664 mType = null;
6665 return this;
6666 }
6667
6668 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006669 * Normalize and set the data this intent is operating on.
6670 *
6671 * <p>This method automatically clears any type that was
6672 * previously set (for example, by {@link #setType}).
6673 *
6674 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006675 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006676 * so really this is just a convenience method for
6677 * <pre>
6678 * setData(data.normalize())
6679 * </pre>
6680 *
6681 * @param data The Uri of the data this intent is now targeting.
6682 *
6683 * @return Returns the same Intent object, for chaining multiple calls
6684 * into a single statement.
6685 *
6686 * @see #getData
6687 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006688 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006689 */
6690 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006691 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006692 }
6693
6694 /**
6695 * Set an explicit MIME data type.
6696 *
6697 * <p>This is used to create intents that only specify a type and not data,
6698 * for example to indicate the type of data to return.
6699 *
6700 * <p>This method automatically clears any data that was
6701 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006702 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006703 * <p><em>Note: MIME type matching in the Android framework is
6704 * case-sensitive, unlike formal RFC MIME types. As a result,
6705 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006706 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6707 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006708 *
6709 * @param type The MIME type of the data being handled by this intent.
6710 *
6711 * @return Returns the same Intent object, for chaining multiple calls
6712 * into a single statement.
6713 *
6714 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006715 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006716 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006717 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006718 */
6719 public Intent setType(String type) {
6720 mData = null;
6721 mType = type;
6722 return this;
6723 }
6724
6725 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006726 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006727 *
Nick Pellyccae4122012-01-09 14:12:58 -08006728 * <p>This is used to create intents that only specify a type and not data,
6729 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006730 *
Nick Pellyccae4122012-01-09 14:12:58 -08006731 * <p>This method automatically clears any data that was
6732 * previously set (for example by {@link #setData}).
6733 *
6734 * <p>The MIME type is normalized using
6735 * {@link #normalizeMimeType} before it is set,
6736 * so really this is just a convenience method for
6737 * <pre>
6738 * setType(Intent.normalizeMimeType(type))
6739 * </pre>
6740 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006741 * @param type The MIME type of the data being handled by this intent.
6742 *
6743 * @return Returns the same Intent object, for chaining multiple calls
6744 * into a single statement.
6745 *
Nick Pellyccae4122012-01-09 14:12:58 -08006746 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006747 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006748 * @see #normalizeMimeType
6749 */
6750 public Intent setTypeAndNormalize(String type) {
6751 return setType(normalizeMimeType(type));
6752 }
6753
6754 /**
6755 * (Usually optional) Set the data for the intent along with an explicit
6756 * MIME data type. This method should very rarely be used -- it allows you
6757 * to override the MIME type that would ordinarily be inferred from the
6758 * data with your own type given here.
6759 *
6760 * <p><em>Note: MIME type and Uri scheme matching in the
6761 * Android framework is case-sensitive, unlike the formal RFC definitions.
6762 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006763 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006764 * {@link #setDataAndTypeAndNormalize}
6765 * to ensure that they are converted to lower case.</em>
6766 *
6767 * @param data The Uri of the data this intent is now targeting.
6768 * @param type The MIME type of the data being handled by this intent.
6769 *
6770 * @return Returns the same Intent object, for chaining multiple calls
6771 * into a single statement.
6772 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006773 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006774 * @see #setData
6775 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006776 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006777 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006778 */
6779 public Intent setDataAndType(Uri data, String type) {
6780 mData = data;
6781 mType = type;
6782 return this;
6783 }
6784
6785 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006786 * (Usually optional) Normalize and set both the data Uri and an explicit
6787 * MIME data type. This method should very rarely be used -- it allows you
6788 * to override the MIME type that would ordinarily be inferred from the
6789 * data with your own type given here.
6790 *
6791 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006792 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006793 * before they are set, so really this is just a convenience method for
6794 * <pre>
6795 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6796 * </pre>
6797 *
6798 * @param data The Uri of the data this intent is now targeting.
6799 * @param type The MIME type of the data being handled by this intent.
6800 *
6801 * @return Returns the same Intent object, for chaining multiple calls
6802 * into a single statement.
6803 *
6804 * @see #setType
6805 * @see #setData
6806 * @see #setDataAndType
6807 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006808 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006809 */
6810 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006811 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006812 }
6813
6814 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006815 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006816 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006817 * activities that provide <em>all</em> of the requested categories will be
6818 * used.
6819 *
6820 * @param category The desired category. This can be either one of the
6821 * predefined Intent categories, or a custom category in your own
6822 * namespace.
6823 *
6824 * @return Returns the same Intent object, for chaining multiple calls
6825 * into a single statement.
6826 *
6827 * @see #hasCategory
6828 * @see #removeCategory
6829 */
6830 public Intent addCategory(String category) {
6831 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006832 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006833 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006834 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006835 return this;
6836 }
6837
6838 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006839 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006840 *
6841 * @param category The category to remove.
6842 *
6843 * @see #addCategory
6844 */
6845 public void removeCategory(String category) {
6846 if (mCategories != null) {
6847 mCategories.remove(category);
6848 if (mCategories.size() == 0) {
6849 mCategories = null;
6850 }
6851 }
6852 }
6853
6854 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006855 * Set a selector for this Intent. This is a modification to the kinds of
6856 * things the Intent will match. If the selector is set, it will be used
6857 * when trying to find entities that can handle the Intent, instead of the
6858 * main contents of the Intent. This allows you build an Intent containing
6859 * a generic protocol while targeting it more specifically.
6860 *
6861 * <p>An example of where this may be used is with things like
6862 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6863 * Intent that will launch the Browser application. However, the correct
6864 * main entry point of an application is actually {@link #ACTION_MAIN}
6865 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
6866 * used to specify the actual Activity to launch. If you launch the browser
6867 * with something different, undesired behavior may happen if the user has
6868 * previously or later launches it the normal way, since they do not match.
6869 * Instead, you can build an Intent with the MAIN action (but no ComponentName
6870 * yet specified) and set a selector with {@link #ACTION_MAIN} and
6871 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
6872 *
6873 * <p>Setting a selector does not impact the behavior of
6874 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
6875 * desired behavior of a selector -- it does not impact the base meaning
6876 * of the Intent, just what kinds of things will be matched against it
6877 * when determining who can handle it.</p>
6878 *
6879 * <p>You can not use both a selector and {@link #setPackage(String)} on
6880 * the same base Intent.</p>
6881 *
6882 * @param selector The desired selector Intent; set to null to not use
6883 * a special selector.
6884 */
6885 public void setSelector(Intent selector) {
6886 if (selector == this) {
6887 throw new IllegalArgumentException(
6888 "Intent being set as a selector of itself");
6889 }
6890 if (selector != null && mPackage != null) {
6891 throw new IllegalArgumentException(
6892 "Can't set selector when package name is already set");
6893 }
6894 mSelector = selector;
6895 }
6896
6897 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006898 * Set a {@link ClipData} associated with this Intent. This replaces any
6899 * previously set ClipData.
6900 *
6901 * <p>The ClipData in an intent is not used for Intent matching or other
6902 * such operations. Semantically it is like extras, used to transmit
6903 * additional data with the Intent. The main feature of using this over
6904 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
6905 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
6906 * items included in the clip data. This is useful, in particular, if
6907 * you want to transmit an Intent containing multiple <code>content:</code>
6908 * URIs for which the recipient may not have global permission to access the
6909 * content provider.
6910 *
6911 * <p>If the ClipData contains items that are themselves Intents, any
6912 * grant flags in those Intents will be ignored. Only the top-level flags
6913 * of the main Intent are respected, and will be applied to all Uri or
6914 * Intent items in the clip (or sub-items of the clip).
6915 *
6916 * <p>The MIME type, label, and icon in the ClipData object are not
6917 * directly used by Intent. Applications should generally rely on the
6918 * MIME type of the Intent itself, not what it may find in the ClipData.
6919 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05006920 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006921 *
6922 * @param clip The new clip to set. May be null to clear the current clip.
6923 */
6924 public void setClipData(ClipData clip) {
6925 mClipData = clip;
6926 }
6927
6928 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006929 * This is NOT a secure mechanism to identify the user who sent the intent.
6930 * When the intent is sent to a different user, it is used to fix uris by adding the userId
6931 * who sent the intent.
6932 * @hide
6933 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01006934 public void prepareToLeaveUser(int userId) {
6935 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
6936 // We want mContentUserHint to refer to the original user, so don't do anything.
6937 if (mContentUserHint == UserHandle.USER_CURRENT) {
6938 mContentUserHint = userId;
6939 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006940 }
6941
6942 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006943 * Add extended data to the intent. The name must include a package
6944 * prefix, for example the app com.android.contacts would use names
6945 * like "com.android.contacts.ShowAll".
6946 *
6947 * @param name The name of the extra data, with package prefix.
6948 * @param value The boolean data value.
6949 *
6950 * @return Returns the same Intent object, for chaining multiple calls
6951 * into a single statement.
6952 *
6953 * @see #putExtras
6954 * @see #removeExtra
6955 * @see #getBooleanExtra(String, boolean)
6956 */
6957 public Intent putExtra(String name, boolean value) {
6958 if (mExtras == null) {
6959 mExtras = new Bundle();
6960 }
6961 mExtras.putBoolean(name, value);
6962 return this;
6963 }
6964
6965 /**
6966 * Add extended data to the intent. The name must include a package
6967 * prefix, for example the app com.android.contacts would use names
6968 * like "com.android.contacts.ShowAll".
6969 *
6970 * @param name The name of the extra data, with package prefix.
6971 * @param value The byte data value.
6972 *
6973 * @return Returns the same Intent object, for chaining multiple calls
6974 * into a single statement.
6975 *
6976 * @see #putExtras
6977 * @see #removeExtra
6978 * @see #getByteExtra(String, byte)
6979 */
6980 public Intent putExtra(String name, byte value) {
6981 if (mExtras == null) {
6982 mExtras = new Bundle();
6983 }
6984 mExtras.putByte(name, value);
6985 return this;
6986 }
6987
6988 /**
6989 * Add extended data to the intent. The name must include a package
6990 * prefix, for example the app com.android.contacts would use names
6991 * like "com.android.contacts.ShowAll".
6992 *
6993 * @param name The name of the extra data, with package prefix.
6994 * @param value The char data value.
6995 *
6996 * @return Returns the same Intent object, for chaining multiple calls
6997 * into a single statement.
6998 *
6999 * @see #putExtras
7000 * @see #removeExtra
7001 * @see #getCharExtra(String, char)
7002 */
7003 public Intent putExtra(String name, char value) {
7004 if (mExtras == null) {
7005 mExtras = new Bundle();
7006 }
7007 mExtras.putChar(name, value);
7008 return this;
7009 }
7010
7011 /**
7012 * Add extended data to the intent. The name must include a package
7013 * prefix, for example the app com.android.contacts would use names
7014 * like "com.android.contacts.ShowAll".
7015 *
7016 * @param name The name of the extra data, with package prefix.
7017 * @param value The short data value.
7018 *
7019 * @return Returns the same Intent object, for chaining multiple calls
7020 * into a single statement.
7021 *
7022 * @see #putExtras
7023 * @see #removeExtra
7024 * @see #getShortExtra(String, short)
7025 */
7026 public Intent putExtra(String name, short value) {
7027 if (mExtras == null) {
7028 mExtras = new Bundle();
7029 }
7030 mExtras.putShort(name, value);
7031 return this;
7032 }
7033
7034 /**
7035 * Add extended data to the intent. The name must include a package
7036 * prefix, for example the app com.android.contacts would use names
7037 * like "com.android.contacts.ShowAll".
7038 *
7039 * @param name The name of the extra data, with package prefix.
7040 * @param value The integer data value.
7041 *
7042 * @return Returns the same Intent object, for chaining multiple calls
7043 * into a single statement.
7044 *
7045 * @see #putExtras
7046 * @see #removeExtra
7047 * @see #getIntExtra(String, int)
7048 */
7049 public Intent putExtra(String name, int value) {
7050 if (mExtras == null) {
7051 mExtras = new Bundle();
7052 }
7053 mExtras.putInt(name, value);
7054 return this;
7055 }
7056
7057 /**
7058 * Add extended data to the intent. The name must include a package
7059 * prefix, for example the app com.android.contacts would use names
7060 * like "com.android.contacts.ShowAll".
7061 *
7062 * @param name The name of the extra data, with package prefix.
7063 * @param value The long data value.
7064 *
7065 * @return Returns the same Intent object, for chaining multiple calls
7066 * into a single statement.
7067 *
7068 * @see #putExtras
7069 * @see #removeExtra
7070 * @see #getLongExtra(String, long)
7071 */
7072 public Intent putExtra(String name, long value) {
7073 if (mExtras == null) {
7074 mExtras = new Bundle();
7075 }
7076 mExtras.putLong(name, value);
7077 return this;
7078 }
7079
7080 /**
7081 * Add extended data to the intent. The name must include a package
7082 * prefix, for example the app com.android.contacts would use names
7083 * like "com.android.contacts.ShowAll".
7084 *
7085 * @param name The name of the extra data, with package prefix.
7086 * @param value The float data value.
7087 *
7088 * @return Returns the same Intent object, for chaining multiple calls
7089 * into a single statement.
7090 *
7091 * @see #putExtras
7092 * @see #removeExtra
7093 * @see #getFloatExtra(String, float)
7094 */
7095 public Intent putExtra(String name, float value) {
7096 if (mExtras == null) {
7097 mExtras = new Bundle();
7098 }
7099 mExtras.putFloat(name, value);
7100 return this;
7101 }
7102
7103 /**
7104 * Add extended data to the intent. The name must include a package
7105 * prefix, for example the app com.android.contacts would use names
7106 * like "com.android.contacts.ShowAll".
7107 *
7108 * @param name The name of the extra data, with package prefix.
7109 * @param value The double data value.
7110 *
7111 * @return Returns the same Intent object, for chaining multiple calls
7112 * into a single statement.
7113 *
7114 * @see #putExtras
7115 * @see #removeExtra
7116 * @see #getDoubleExtra(String, double)
7117 */
7118 public Intent putExtra(String name, double value) {
7119 if (mExtras == null) {
7120 mExtras = new Bundle();
7121 }
7122 mExtras.putDouble(name, value);
7123 return this;
7124 }
7125
7126 /**
7127 * Add extended data to the intent. The name must include a package
7128 * prefix, for example the app com.android.contacts would use names
7129 * like "com.android.contacts.ShowAll".
7130 *
7131 * @param name The name of the extra data, with package prefix.
7132 * @param value The String data value.
7133 *
7134 * @return Returns the same Intent object, for chaining multiple calls
7135 * into a single statement.
7136 *
7137 * @see #putExtras
7138 * @see #removeExtra
7139 * @see #getStringExtra(String)
7140 */
7141 public Intent putExtra(String name, String value) {
7142 if (mExtras == null) {
7143 mExtras = new Bundle();
7144 }
7145 mExtras.putString(name, value);
7146 return this;
7147 }
7148
7149 /**
7150 * Add extended data to the intent. The name must include a package
7151 * prefix, for example the app com.android.contacts would use names
7152 * like "com.android.contacts.ShowAll".
7153 *
7154 * @param name The name of the extra data, with package prefix.
7155 * @param value The CharSequence data value.
7156 *
7157 * @return Returns the same Intent object, for chaining multiple calls
7158 * into a single statement.
7159 *
7160 * @see #putExtras
7161 * @see #removeExtra
7162 * @see #getCharSequenceExtra(String)
7163 */
7164 public Intent putExtra(String name, CharSequence value) {
7165 if (mExtras == null) {
7166 mExtras = new Bundle();
7167 }
7168 mExtras.putCharSequence(name, value);
7169 return this;
7170 }
7171
7172 /**
7173 * Add extended data to the intent. The name must include a package
7174 * prefix, for example the app com.android.contacts would use names
7175 * like "com.android.contacts.ShowAll".
7176 *
7177 * @param name The name of the extra data, with package prefix.
7178 * @param value The Parcelable data value.
7179 *
7180 * @return Returns the same Intent object, for chaining multiple calls
7181 * into a single statement.
7182 *
7183 * @see #putExtras
7184 * @see #removeExtra
7185 * @see #getParcelableExtra(String)
7186 */
7187 public Intent putExtra(String name, Parcelable value) {
7188 if (mExtras == null) {
7189 mExtras = new Bundle();
7190 }
7191 mExtras.putParcelable(name, value);
7192 return this;
7193 }
7194
7195 /**
7196 * Add extended data to the intent. The name must include a package
7197 * prefix, for example the app com.android.contacts would use names
7198 * like "com.android.contacts.ShowAll".
7199 *
7200 * @param name The name of the extra data, with package prefix.
7201 * @param value The Parcelable[] data value.
7202 *
7203 * @return Returns the same Intent object, for chaining multiple calls
7204 * into a single statement.
7205 *
7206 * @see #putExtras
7207 * @see #removeExtra
7208 * @see #getParcelableArrayExtra(String)
7209 */
7210 public Intent putExtra(String name, Parcelable[] value) {
7211 if (mExtras == null) {
7212 mExtras = new Bundle();
7213 }
7214 mExtras.putParcelableArray(name, value);
7215 return this;
7216 }
7217
7218 /**
7219 * Add extended data to the intent. The name must include a package
7220 * prefix, for example the app com.android.contacts would use names
7221 * like "com.android.contacts.ShowAll".
7222 *
7223 * @param name The name of the extra data, with package prefix.
7224 * @param value The ArrayList<Parcelable> data value.
7225 *
7226 * @return Returns the same Intent object, for chaining multiple calls
7227 * into a single statement.
7228 *
7229 * @see #putExtras
7230 * @see #removeExtra
7231 * @see #getParcelableArrayListExtra(String)
7232 */
7233 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7234 if (mExtras == null) {
7235 mExtras = new Bundle();
7236 }
7237 mExtras.putParcelableArrayList(name, value);
7238 return this;
7239 }
7240
7241 /**
7242 * Add extended data to the intent. The name must include a package
7243 * prefix, for example the app com.android.contacts would use names
7244 * like "com.android.contacts.ShowAll".
7245 *
7246 * @param name The name of the extra data, with package prefix.
7247 * @param value The ArrayList<Integer> data value.
7248 *
7249 * @return Returns the same Intent object, for chaining multiple calls
7250 * into a single statement.
7251 *
7252 * @see #putExtras
7253 * @see #removeExtra
7254 * @see #getIntegerArrayListExtra(String)
7255 */
7256 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7257 if (mExtras == null) {
7258 mExtras = new Bundle();
7259 }
7260 mExtras.putIntegerArrayList(name, value);
7261 return this;
7262 }
7263
7264 /**
7265 * Add extended data to the intent. The name must include a package
7266 * prefix, for example the app com.android.contacts would use names
7267 * like "com.android.contacts.ShowAll".
7268 *
7269 * @param name The name of the extra data, with package prefix.
7270 * @param value The ArrayList<String> data value.
7271 *
7272 * @return Returns the same Intent object, for chaining multiple calls
7273 * into a single statement.
7274 *
7275 * @see #putExtras
7276 * @see #removeExtra
7277 * @see #getStringArrayListExtra(String)
7278 */
7279 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7280 if (mExtras == null) {
7281 mExtras = new Bundle();
7282 }
7283 mExtras.putStringArrayList(name, value);
7284 return this;
7285 }
7286
7287 /**
7288 * Add extended data to the intent. The name must include a package
7289 * prefix, for example the app com.android.contacts would use names
7290 * like "com.android.contacts.ShowAll".
7291 *
7292 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007293 * @param value The ArrayList<CharSequence> data value.
7294 *
7295 * @return Returns the same Intent object, for chaining multiple calls
7296 * into a single statement.
7297 *
7298 * @see #putExtras
7299 * @see #removeExtra
7300 * @see #getCharSequenceArrayListExtra(String)
7301 */
7302 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7303 if (mExtras == null) {
7304 mExtras = new Bundle();
7305 }
7306 mExtras.putCharSequenceArrayList(name, value);
7307 return this;
7308 }
7309
7310 /**
7311 * Add extended data to the intent. The name must include a package
7312 * prefix, for example the app com.android.contacts would use names
7313 * like "com.android.contacts.ShowAll".
7314 *
7315 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007316 * @param value The Serializable data value.
7317 *
7318 * @return Returns the same Intent object, for chaining multiple calls
7319 * into a single statement.
7320 *
7321 * @see #putExtras
7322 * @see #removeExtra
7323 * @see #getSerializableExtra(String)
7324 */
7325 public Intent putExtra(String name, Serializable value) {
7326 if (mExtras == null) {
7327 mExtras = new Bundle();
7328 }
7329 mExtras.putSerializable(name, value);
7330 return this;
7331 }
7332
7333 /**
7334 * Add extended data to the intent. The name must include a package
7335 * prefix, for example the app com.android.contacts would use names
7336 * like "com.android.contacts.ShowAll".
7337 *
7338 * @param name The name of the extra data, with package prefix.
7339 * @param value The boolean array data value.
7340 *
7341 * @return Returns the same Intent object, for chaining multiple calls
7342 * into a single statement.
7343 *
7344 * @see #putExtras
7345 * @see #removeExtra
7346 * @see #getBooleanArrayExtra(String)
7347 */
7348 public Intent putExtra(String name, boolean[] value) {
7349 if (mExtras == null) {
7350 mExtras = new Bundle();
7351 }
7352 mExtras.putBooleanArray(name, value);
7353 return this;
7354 }
7355
7356 /**
7357 * Add extended data to the intent. The name must include a package
7358 * prefix, for example the app com.android.contacts would use names
7359 * like "com.android.contacts.ShowAll".
7360 *
7361 * @param name The name of the extra data, with package prefix.
7362 * @param value The byte array data value.
7363 *
7364 * @return Returns the same Intent object, for chaining multiple calls
7365 * into a single statement.
7366 *
7367 * @see #putExtras
7368 * @see #removeExtra
7369 * @see #getByteArrayExtra(String)
7370 */
7371 public Intent putExtra(String name, byte[] value) {
7372 if (mExtras == null) {
7373 mExtras = new Bundle();
7374 }
7375 mExtras.putByteArray(name, value);
7376 return this;
7377 }
7378
7379 /**
7380 * Add extended data to the intent. The name must include a package
7381 * prefix, for example the app com.android.contacts would use names
7382 * like "com.android.contacts.ShowAll".
7383 *
7384 * @param name The name of the extra data, with package prefix.
7385 * @param value The short array data value.
7386 *
7387 * @return Returns the same Intent object, for chaining multiple calls
7388 * into a single statement.
7389 *
7390 * @see #putExtras
7391 * @see #removeExtra
7392 * @see #getShortArrayExtra(String)
7393 */
7394 public Intent putExtra(String name, short[] value) {
7395 if (mExtras == null) {
7396 mExtras = new Bundle();
7397 }
7398 mExtras.putShortArray(name, value);
7399 return this;
7400 }
7401
7402 /**
7403 * Add extended data to the intent. The name must include a package
7404 * prefix, for example the app com.android.contacts would use names
7405 * like "com.android.contacts.ShowAll".
7406 *
7407 * @param name The name of the extra data, with package prefix.
7408 * @param value The char array data value.
7409 *
7410 * @return Returns the same Intent object, for chaining multiple calls
7411 * into a single statement.
7412 *
7413 * @see #putExtras
7414 * @see #removeExtra
7415 * @see #getCharArrayExtra(String)
7416 */
7417 public Intent putExtra(String name, char[] value) {
7418 if (mExtras == null) {
7419 mExtras = new Bundle();
7420 }
7421 mExtras.putCharArray(name, value);
7422 return this;
7423 }
7424
7425 /**
7426 * Add extended data to the intent. The name must include a package
7427 * prefix, for example the app com.android.contacts would use names
7428 * like "com.android.contacts.ShowAll".
7429 *
7430 * @param name The name of the extra data, with package prefix.
7431 * @param value The int array data value.
7432 *
7433 * @return Returns the same Intent object, for chaining multiple calls
7434 * into a single statement.
7435 *
7436 * @see #putExtras
7437 * @see #removeExtra
7438 * @see #getIntArrayExtra(String)
7439 */
7440 public Intent putExtra(String name, int[] value) {
7441 if (mExtras == null) {
7442 mExtras = new Bundle();
7443 }
7444 mExtras.putIntArray(name, value);
7445 return this;
7446 }
7447
7448 /**
7449 * Add extended data to the intent. The name must include a package
7450 * prefix, for example the app com.android.contacts would use names
7451 * like "com.android.contacts.ShowAll".
7452 *
7453 * @param name The name of the extra data, with package prefix.
7454 * @param value The byte array data value.
7455 *
7456 * @return Returns the same Intent object, for chaining multiple calls
7457 * into a single statement.
7458 *
7459 * @see #putExtras
7460 * @see #removeExtra
7461 * @see #getLongArrayExtra(String)
7462 */
7463 public Intent putExtra(String name, long[] value) {
7464 if (mExtras == null) {
7465 mExtras = new Bundle();
7466 }
7467 mExtras.putLongArray(name, value);
7468 return this;
7469 }
7470
7471 /**
7472 * Add extended data to the intent. The name must include a package
7473 * prefix, for example the app com.android.contacts would use names
7474 * like "com.android.contacts.ShowAll".
7475 *
7476 * @param name The name of the extra data, with package prefix.
7477 * @param value The float array data value.
7478 *
7479 * @return Returns the same Intent object, for chaining multiple calls
7480 * into a single statement.
7481 *
7482 * @see #putExtras
7483 * @see #removeExtra
7484 * @see #getFloatArrayExtra(String)
7485 */
7486 public Intent putExtra(String name, float[] value) {
7487 if (mExtras == null) {
7488 mExtras = new Bundle();
7489 }
7490 mExtras.putFloatArray(name, value);
7491 return this;
7492 }
7493
7494 /**
7495 * Add extended data to the intent. The name must include a package
7496 * prefix, for example the app com.android.contacts would use names
7497 * like "com.android.contacts.ShowAll".
7498 *
7499 * @param name The name of the extra data, with package prefix.
7500 * @param value The double array data value.
7501 *
7502 * @return Returns the same Intent object, for chaining multiple calls
7503 * into a single statement.
7504 *
7505 * @see #putExtras
7506 * @see #removeExtra
7507 * @see #getDoubleArrayExtra(String)
7508 */
7509 public Intent putExtra(String name, double[] value) {
7510 if (mExtras == null) {
7511 mExtras = new Bundle();
7512 }
7513 mExtras.putDoubleArray(name, value);
7514 return this;
7515 }
7516
7517 /**
7518 * Add extended data to the intent. The name must include a package
7519 * prefix, for example the app com.android.contacts would use names
7520 * like "com.android.contacts.ShowAll".
7521 *
7522 * @param name The name of the extra data, with package prefix.
7523 * @param value The String array data value.
7524 *
7525 * @return Returns the same Intent object, for chaining multiple calls
7526 * into a single statement.
7527 *
7528 * @see #putExtras
7529 * @see #removeExtra
7530 * @see #getStringArrayExtra(String)
7531 */
7532 public Intent putExtra(String name, String[] value) {
7533 if (mExtras == null) {
7534 mExtras = new Bundle();
7535 }
7536 mExtras.putStringArray(name, value);
7537 return this;
7538 }
7539
7540 /**
7541 * Add extended data to the intent. The name must include a package
7542 * prefix, for example the app com.android.contacts would use names
7543 * like "com.android.contacts.ShowAll".
7544 *
7545 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007546 * @param value The CharSequence array data value.
7547 *
7548 * @return Returns the same Intent object, for chaining multiple calls
7549 * into a single statement.
7550 *
7551 * @see #putExtras
7552 * @see #removeExtra
7553 * @see #getCharSequenceArrayExtra(String)
7554 */
7555 public Intent putExtra(String name, CharSequence[] value) {
7556 if (mExtras == null) {
7557 mExtras = new Bundle();
7558 }
7559 mExtras.putCharSequenceArray(name, value);
7560 return this;
7561 }
7562
7563 /**
7564 * Add extended data to the intent. The name must include a package
7565 * prefix, for example the app com.android.contacts would use names
7566 * like "com.android.contacts.ShowAll".
7567 *
7568 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007569 * @param value The Bundle data value.
7570 *
7571 * @return Returns the same Intent object, for chaining multiple calls
7572 * into a single statement.
7573 *
7574 * @see #putExtras
7575 * @see #removeExtra
7576 * @see #getBundleExtra(String)
7577 */
7578 public Intent putExtra(String name, Bundle value) {
7579 if (mExtras == null) {
7580 mExtras = new Bundle();
7581 }
7582 mExtras.putBundle(name, value);
7583 return this;
7584 }
7585
7586 /**
7587 * Add extended data to the intent. The name must include a package
7588 * prefix, for example the app com.android.contacts would use names
7589 * like "com.android.contacts.ShowAll".
7590 *
7591 * @param name The name of the extra data, with package prefix.
7592 * @param value The IBinder data value.
7593 *
7594 * @return Returns the same Intent object, for chaining multiple calls
7595 * into a single statement.
7596 *
7597 * @see #putExtras
7598 * @see #removeExtra
7599 * @see #getIBinderExtra(String)
7600 *
7601 * @deprecated
7602 * @hide
7603 */
7604 @Deprecated
7605 public Intent putExtra(String name, IBinder value) {
7606 if (mExtras == null) {
7607 mExtras = new Bundle();
7608 }
7609 mExtras.putIBinder(name, value);
7610 return this;
7611 }
7612
7613 /**
7614 * Copy all extras in 'src' in to this intent.
7615 *
7616 * @param src Contains the extras to copy.
7617 *
7618 * @see #putExtra
7619 */
7620 public Intent putExtras(Intent src) {
7621 if (src.mExtras != null) {
7622 if (mExtras == null) {
7623 mExtras = new Bundle(src.mExtras);
7624 } else {
7625 mExtras.putAll(src.mExtras);
7626 }
7627 }
7628 return this;
7629 }
7630
7631 /**
7632 * Add a set of extended data to the intent. The keys must include a package
7633 * prefix, for example the app com.android.contacts would use names
7634 * like "com.android.contacts.ShowAll".
7635 *
7636 * @param extras The Bundle of extras to add to this intent.
7637 *
7638 * @see #putExtra
7639 * @see #removeExtra
7640 */
7641 public Intent putExtras(Bundle extras) {
7642 if (mExtras == null) {
7643 mExtras = new Bundle();
7644 }
7645 mExtras.putAll(extras);
7646 return this;
7647 }
7648
7649 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007650 * Completely replace the extras in the Intent with the extras in the
7651 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007652 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007653 * @param src The exact extras contained in this Intent are copied
7654 * into the target intent, replacing any that were previously there.
7655 */
7656 public Intent replaceExtras(Intent src) {
7657 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7658 return this;
7659 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007660
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007661 /**
7662 * Completely replace the extras in the Intent with the given Bundle of
7663 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007664 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007665 * @param extras The new set of extras in the Intent, or null to erase
7666 * all extras.
7667 */
7668 public Intent replaceExtras(Bundle extras) {
7669 mExtras = extras != null ? new Bundle(extras) : null;
7670 return this;
7671 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007672
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007673 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007674 * Remove extended data from the intent.
7675 *
7676 * @see #putExtra
7677 */
7678 public void removeExtra(String name) {
7679 if (mExtras != null) {
7680 mExtras.remove(name);
7681 if (mExtras.size() == 0) {
7682 mExtras = null;
7683 }
7684 }
7685 }
7686
7687 /**
7688 * Set special flags controlling how this intent is handled. Most values
7689 * here depend on the type of component being executed by the Intent,
7690 * specifically the FLAG_ACTIVITY_* flags are all for use with
7691 * {@link Context#startActivity Context.startActivity()} and the
7692 * FLAG_RECEIVER_* flags are all for use with
7693 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7694 *
Scott Main7aee61f2011-02-08 11:25:01 -08007695 * <p>See the
7696 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7697 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007698 * the behavior of your application.
7699 *
7700 * @param flags The desired flags.
7701 *
7702 * @return Returns the same Intent object, for chaining multiple calls
7703 * into a single statement.
7704 *
7705 * @see #getFlags
7706 * @see #addFlags
7707 *
7708 * @see #FLAG_GRANT_READ_URI_PERMISSION
7709 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007710 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7711 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007712 * @see #FLAG_DEBUG_LOG_RESOLUTION
7713 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007714 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007715 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007716 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007717 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007718 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7719 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007720 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007721 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007722 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007723 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007724 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007725 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007726 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007727 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7728 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007729 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007730 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007731 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007732 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7733 */
7734 public Intent setFlags(int flags) {
7735 mFlags = flags;
7736 return this;
7737 }
7738
7739 /**
7740 * Add additional flags to the intent (or with existing flags
7741 * value).
7742 *
7743 * @param flags The new flags to set.
7744 *
7745 * @return Returns the same Intent object, for chaining multiple calls
7746 * into a single statement.
7747 *
7748 * @see #setFlags
7749 */
7750 public Intent addFlags(int flags) {
7751 mFlags |= flags;
7752 return this;
7753 }
7754
7755 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007756 * (Usually optional) Set an explicit application package name that limits
7757 * the components this Intent will resolve to. If left to the default
7758 * value of null, all components in all applications will considered.
7759 * If non-null, the Intent can only match the components in the given
7760 * application package.
7761 *
7762 * @param packageName The name of the application package to handle the
7763 * intent, or null to allow any application package.
7764 *
7765 * @return Returns the same Intent object, for chaining multiple calls
7766 * into a single statement.
7767 *
7768 * @see #getPackage
7769 * @see #resolveActivity
7770 */
7771 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007772 if (packageName != null && mSelector != null) {
7773 throw new IllegalArgumentException(
7774 "Can't set package name when selector is already set");
7775 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007776 mPackage = packageName;
7777 return this;
7778 }
7779
7780 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007781 * (Usually optional) Explicitly set the component to handle the intent.
7782 * If left with the default value of null, the system will determine the
7783 * appropriate class to use based on the other fields (action, data,
7784 * type, categories) in the Intent. If this class is defined, the
7785 * specified class will always be used regardless of the other fields. You
7786 * should only set this value when you know you absolutely want a specific
7787 * class to be used; otherwise it is better to let the system find the
7788 * appropriate class so that you will respect the installed applications
7789 * and user preferences.
7790 *
7791 * @param component The name of the application component to handle the
7792 * intent, or null to let the system find one for you.
7793 *
7794 * @return Returns the same Intent object, for chaining multiple calls
7795 * into a single statement.
7796 *
7797 * @see #setClass
7798 * @see #setClassName(Context, String)
7799 * @see #setClassName(String, String)
7800 * @see #getComponent
7801 * @see #resolveActivity
7802 */
7803 public Intent setComponent(ComponentName component) {
7804 mComponent = component;
7805 return this;
7806 }
7807
7808 /**
7809 * Convenience for calling {@link #setComponent} with an
7810 * explicit class name.
7811 *
7812 * @param packageContext A Context of the application package implementing
7813 * this class.
7814 * @param className The name of a class inside of the application package
7815 * that will be used as the component for this Intent.
7816 *
7817 * @return Returns the same Intent object, for chaining multiple calls
7818 * into a single statement.
7819 *
7820 * @see #setComponent
7821 * @see #setClass
7822 */
7823 public Intent setClassName(Context packageContext, String className) {
7824 mComponent = new ComponentName(packageContext, className);
7825 return this;
7826 }
7827
7828 /**
7829 * Convenience for calling {@link #setComponent} with an
7830 * explicit application package name and class name.
7831 *
7832 * @param packageName The name of the package implementing the desired
7833 * component.
7834 * @param className The name of a class inside of the application package
7835 * that will be used as the component for this Intent.
7836 *
7837 * @return Returns the same Intent object, for chaining multiple calls
7838 * into a single statement.
7839 *
7840 * @see #setComponent
7841 * @see #setClass
7842 */
7843 public Intent setClassName(String packageName, String className) {
7844 mComponent = new ComponentName(packageName, className);
7845 return this;
7846 }
7847
7848 /**
7849 * Convenience for calling {@link #setComponent(ComponentName)} with the
7850 * name returned by a {@link Class} object.
7851 *
7852 * @param packageContext A Context of the application package implementing
7853 * this class.
7854 * @param cls The class name to set, equivalent to
7855 * <code>setClassName(context, cls.getName())</code>.
7856 *
7857 * @return Returns the same Intent object, for chaining multiple calls
7858 * into a single statement.
7859 *
7860 * @see #setComponent
7861 */
7862 public Intent setClass(Context packageContext, Class<?> cls) {
7863 mComponent = new ComponentName(packageContext, cls);
7864 return this;
7865 }
7866
7867 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007868 * Set the bounds of the sender of this intent, in screen coordinates. This can be
7869 * used as a hint to the receiver for animations and the like. Null means that there
7870 * is no source bounds.
7871 */
7872 public void setSourceBounds(Rect r) {
7873 if (r != null) {
7874 mSourceBounds = new Rect(r);
7875 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07007876 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007877 }
7878 }
7879
Tor Norbyed9273d62013-05-30 15:59:53 -07007880 /** @hide */
7881 @IntDef(flag = true,
7882 value = {
7883 FILL_IN_ACTION,
7884 FILL_IN_DATA,
7885 FILL_IN_CATEGORIES,
7886 FILL_IN_COMPONENT,
7887 FILL_IN_PACKAGE,
7888 FILL_IN_SOURCE_BOUNDS,
7889 FILL_IN_SELECTOR,
7890 FILL_IN_CLIP_DATA
7891 })
7892 @Retention(RetentionPolicy.SOURCE)
7893 public @interface FillInFlags {}
7894
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007895 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007896 * Use with {@link #fillIn} to allow the current action value to be
7897 * overwritten, even if it is already set.
7898 */
7899 public static final int FILL_IN_ACTION = 1<<0;
7900
7901 /**
7902 * Use with {@link #fillIn} to allow the current data or type value
7903 * overwritten, even if it is already set.
7904 */
7905 public static final int FILL_IN_DATA = 1<<1;
7906
7907 /**
7908 * Use with {@link #fillIn} to allow the current categories to be
7909 * overwritten, even if they are already set.
7910 */
7911 public static final int FILL_IN_CATEGORIES = 1<<2;
7912
7913 /**
7914 * Use with {@link #fillIn} to allow the current component value to be
7915 * overwritten, even if it is already set.
7916 */
7917 public static final int FILL_IN_COMPONENT = 1<<3;
7918
7919 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007920 * Use with {@link #fillIn} to allow the current package value to be
7921 * overwritten, even if it is already set.
7922 */
7923 public static final int FILL_IN_PACKAGE = 1<<4;
7924
7925 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007926 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007927 * overwritten, even if it is already set.
7928 */
7929 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
7930
7931 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007932 * Use with {@link #fillIn} to allow the current selector to be
7933 * overwritten, even if it is already set.
7934 */
7935 public static final int FILL_IN_SELECTOR = 1<<6;
7936
7937 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007938 * Use with {@link #fillIn} to allow the current ClipData to be
7939 * overwritten, even if it is already set.
7940 */
7941 public static final int FILL_IN_CLIP_DATA = 1<<7;
7942
7943 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007944 * Copy the contents of <var>other</var> in to this object, but only
7945 * where fields are not defined by this object. For purposes of a field
7946 * being defined, the following pieces of data in the Intent are
7947 * considered to be separate fields:
7948 *
7949 * <ul>
7950 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08007951 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007952 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
7953 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007954 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007955 * <li> component, as set by {@link #setComponent(ComponentName)} or
7956 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007957 * <li> source bounds, as set by {@link #setSourceBounds}.
7958 * <li> selector, as set by {@link #setSelector(Intent)}.
7959 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007960 * <li> each top-level name in the associated extras.
7961 * </ul>
7962 *
7963 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007964 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007965 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7966 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
7967 * the restriction where the corresponding field will not be replaced if
7968 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007969 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007970 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
7971 * is explicitly specified. The selector will only be copied if
7972 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07007973 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007974 * <p>For example, consider Intent A with {data="foo", categories="bar"}
7975 * and Intent B with {action="gotit", data-type="some/thing",
7976 * categories="one","two"}.
7977 *
7978 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
7979 * containing: {action="gotit", data-type="some/thing",
7980 * categories="bar"}.
7981 *
7982 * @param other Another Intent whose values are to be used to fill in
7983 * the current one.
7984 * @param flags Options to control which fields can be filled in.
7985 *
7986 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007987 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07007988 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7989 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
7990 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007991 */
Tor Norbyed9273d62013-05-30 15:59:53 -07007992 @FillInFlags
7993 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007994 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007995 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007996 if (other.mAction != null
7997 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007998 mAction = other.mAction;
7999 changes |= FILL_IN_ACTION;
8000 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008001 if ((other.mData != null || other.mType != null)
8002 && ((mData == null && mType == null)
8003 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008004 mData = other.mData;
8005 mType = other.mType;
8006 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008007 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008008 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008009 if (other.mCategories != null
8010 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008011 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008012 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008013 }
8014 changes |= FILL_IN_CATEGORIES;
8015 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008016 if (other.mPackage != null
8017 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008018 // Only do this if mSelector is not set.
8019 if (mSelector == null) {
8020 mPackage = other.mPackage;
8021 changes |= FILL_IN_PACKAGE;
8022 }
8023 }
8024 // Selector is special: it can only be set if explicitly allowed,
8025 // for the same reason as the component name.
8026 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8027 if (mPackage == null) {
8028 mSelector = new Intent(other.mSelector);
8029 mPackage = null;
8030 changes |= FILL_IN_SELECTOR;
8031 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008032 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008033 if (other.mClipData != null
8034 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8035 mClipData = other.mClipData;
8036 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008037 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008038 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008039 // Component is special: it can -only- be set if explicitly allowed,
8040 // since otherwise the sender could force the intent somewhere the
8041 // originator didn't intend.
8042 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008043 mComponent = other.mComponent;
8044 changes |= FILL_IN_COMPONENT;
8045 }
8046 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008047 if (other.mSourceBounds != null
8048 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8049 mSourceBounds = new Rect(other.mSourceBounds);
8050 changes |= FILL_IN_SOURCE_BOUNDS;
8051 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008052 if (mExtras == null) {
8053 if (other.mExtras != null) {
8054 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008055 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008056 }
8057 } else if (other.mExtras != null) {
8058 try {
8059 Bundle newb = new Bundle(other.mExtras);
8060 newb.putAll(mExtras);
8061 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008062 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008063 } catch (RuntimeException e) {
8064 // Modifying the extras can cause us to unparcel the contents
8065 // of the bundle, and if we do this in the system process that
8066 // may fail. We really should handle this (i.e., the Bundle
8067 // impl shouldn't be on top of a plain map), but for now just
8068 // ignore it and keep the original contents. :(
8069 Log.w("Intent", "Failure filling in extras", e);
8070 }
8071 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008072 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8073 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8074 mContentUserHint = other.mContentUserHint;
8075 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008076 return changes;
8077 }
8078
8079 /**
8080 * Wrapper class holding an Intent and implementing comparisons on it for
8081 * the purpose of filtering. The class implements its
8082 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8083 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8084 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8085 * on the wrapped Intent.
8086 */
8087 public static final class FilterComparison {
8088 private final Intent mIntent;
8089 private final int mHashCode;
8090
8091 public FilterComparison(Intent intent) {
8092 mIntent = intent;
8093 mHashCode = intent.filterHashCode();
8094 }
8095
8096 /**
8097 * Return the Intent that this FilterComparison represents.
8098 * @return Returns the Intent held by the FilterComparison. Do
8099 * not modify!
8100 */
8101 public Intent getIntent() {
8102 return mIntent;
8103 }
8104
8105 @Override
8106 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008107 if (obj instanceof FilterComparison) {
8108 Intent other = ((FilterComparison)obj).mIntent;
8109 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008110 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008111 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008112 }
8113
8114 @Override
8115 public int hashCode() {
8116 return mHashCode;
8117 }
8118 }
8119
8120 /**
8121 * Determine if two intents are the same for the purposes of intent
8122 * resolution (filtering). That is, if their action, data, type,
8123 * class, and categories are the same. This does <em>not</em> compare
8124 * any extra data included in the intents.
8125 *
8126 * @param other The other Intent to compare against.
8127 *
8128 * @return Returns true if action, data, type, class, and categories
8129 * are the same.
8130 */
8131 public boolean filterEquals(Intent other) {
8132 if (other == null) {
8133 return false;
8134 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008135 if (!Objects.equals(this.mAction, other.mAction)) return false;
8136 if (!Objects.equals(this.mData, other.mData)) return false;
8137 if (!Objects.equals(this.mType, other.mType)) return false;
8138 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8139 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8140 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008141
8142 return true;
8143 }
8144
8145 /**
8146 * Generate hash code that matches semantics of filterEquals().
8147 *
8148 * @return Returns the hash value of the action, data, type, class, and
8149 * categories.
8150 *
8151 * @see #filterEquals
8152 */
8153 public int filterHashCode() {
8154 int code = 0;
8155 if (mAction != null) {
8156 code += mAction.hashCode();
8157 }
8158 if (mData != null) {
8159 code += mData.hashCode();
8160 }
8161 if (mType != null) {
8162 code += mType.hashCode();
8163 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008164 if (mPackage != null) {
8165 code += mPackage.hashCode();
8166 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008167 if (mComponent != null) {
8168 code += mComponent.hashCode();
8169 }
8170 if (mCategories != null) {
8171 code += mCategories.hashCode();
8172 }
8173 return code;
8174 }
8175
8176 @Override
8177 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008178 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008179
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008180 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008181 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008182 b.append(" }");
8183
8184 return b.toString();
8185 }
8186
8187 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008188 public String toInsecureString() {
8189 StringBuilder b = new StringBuilder(128);
8190
8191 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008192 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008193 b.append(" }");
8194
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008195 return b.toString();
8196 }
Romain Guy4969af72009-06-17 10:53:19 -07008197
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008198 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008199 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008200 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008201
8202 b.append("Intent { ");
8203 toShortString(b, false, true, true, true);
8204 b.append(" }");
8205
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008206 return b.toString();
8207 }
8208
8209 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008210 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8211 StringBuilder b = new StringBuilder(128);
8212 toShortString(b, secure, comp, extras, clip);
8213 return b.toString();
8214 }
8215
8216 /** @hide */
8217 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8218 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008219 boolean first = true;
8220 if (mAction != null) {
8221 b.append("act=").append(mAction);
8222 first = false;
8223 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008224 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008225 if (!first) {
8226 b.append(' ');
8227 }
8228 first = false;
8229 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008230 for (int i=0; i<mCategories.size(); i++) {
8231 if (i > 0) b.append(',');
8232 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008233 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008234 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008235 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008236 if (mData != null) {
8237 if (!first) {
8238 b.append(' ');
8239 }
8240 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008241 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008242 if (secure) {
8243 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008244 } else {
8245 b.append(mData);
8246 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008247 }
8248 if (mType != null) {
8249 if (!first) {
8250 b.append(' ');
8251 }
8252 first = false;
8253 b.append("typ=").append(mType);
8254 }
8255 if (mFlags != 0) {
8256 if (!first) {
8257 b.append(' ');
8258 }
8259 first = false;
8260 b.append("flg=0x").append(Integer.toHexString(mFlags));
8261 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008262 if (mPackage != null) {
8263 if (!first) {
8264 b.append(' ');
8265 }
8266 first = false;
8267 b.append("pkg=").append(mPackage);
8268 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008269 if (comp && mComponent != null) {
8270 if (!first) {
8271 b.append(' ');
8272 }
8273 first = false;
8274 b.append("cmp=").append(mComponent.flattenToShortString());
8275 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008276 if (mSourceBounds != null) {
8277 if (!first) {
8278 b.append(' ');
8279 }
8280 first = false;
8281 b.append("bnds=").append(mSourceBounds.toShortString());
8282 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008283 if (mClipData != null) {
8284 if (!first) {
8285 b.append(' ');
8286 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008287 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008288 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008289 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008290 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008291 if (mClipData.getDescription() != null) {
8292 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8293 } else {
8294 first = true;
8295 }
8296 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008297 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008298 first = false;
8299 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008300 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008301 if (extras && mExtras != null) {
8302 if (!first) {
8303 b.append(' ');
8304 }
8305 first = false;
8306 b.append("(has extras)");
8307 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008308 if (mContentUserHint != UserHandle.USER_CURRENT) {
8309 if (!first) {
8310 b.append(' ');
8311 }
8312 first = false;
8313 b.append("u=").append(mContentUserHint);
8314 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008315 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008316 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008317 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008318 b.append("}");
8319 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008320 }
8321
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008322 /**
8323 * Call {@link #toUri} with 0 flags.
8324 * @deprecated Use {@link #toUri} instead.
8325 */
8326 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008327 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008328 return toUri(0);
8329 }
8330
8331 /**
8332 * Convert this Intent into a String holding a URI representation of it.
8333 * The returned URI string has been properly URI encoded, so it can be
8334 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8335 * Intent's data as the base URI, with an additional fragment describing
8336 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008337 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008338 * <p>You can convert the returned string back to an Intent with
8339 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008340 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008341 * @param flags Additional operating flags. Either 0,
8342 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008343 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008344 * @return Returns a URI encoding URI string describing the entire contents
8345 * of the Intent.
8346 */
8347 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008348 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008349 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8350 if (mPackage == null) {
8351 throw new IllegalArgumentException(
8352 "Intent must include an explicit package name to build an android-app: "
8353 + this);
8354 }
8355 uri.append("android-app://");
8356 uri.append(mPackage);
8357 String scheme = null;
8358 if (mData != null) {
8359 scheme = mData.getScheme();
8360 if (scheme != null) {
8361 uri.append('/');
8362 uri.append(scheme);
8363 String authority = mData.getEncodedAuthority();
8364 if (authority != null) {
8365 uri.append('/');
8366 uri.append(authority);
8367 String path = mData.getEncodedPath();
8368 if (path != null) {
8369 uri.append(path);
8370 }
8371 String queryParams = mData.getEncodedQuery();
8372 if (queryParams != null) {
8373 uri.append('?');
8374 uri.append(queryParams);
8375 }
8376 String fragment = mData.getEncodedFragment();
8377 if (fragment != null) {
8378 uri.append('#');
8379 uri.append(fragment);
8380 }
8381 }
8382 }
8383 }
8384 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8385 mPackage, flags);
8386 return uri.toString();
8387 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008388 String scheme = null;
8389 if (mData != null) {
8390 String data = mData.toString();
8391 if ((flags&URI_INTENT_SCHEME) != 0) {
8392 final int N = data.length();
8393 for (int i=0; i<N; i++) {
8394 char c = data.charAt(i);
8395 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8396 || c == '.' || c == '-') {
8397 continue;
8398 }
8399 if (c == ':' && i > 0) {
8400 // Valid scheme.
8401 scheme = data.substring(0, i);
8402 uri.append("intent:");
8403 data = data.substring(i+1);
8404 break;
8405 }
Tom Taylord4a47292009-12-21 13:59:18 -08008406
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008407 // No scheme.
8408 break;
8409 }
8410 }
8411 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008412
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008413 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8414 uri.append("intent:");
8415 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008416
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008417 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008418
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008419 return uri.toString();
8420 }
8421
8422 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8423 String defPackage, int flags) {
8424 StringBuilder frag = new StringBuilder(128);
8425
8426 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008427 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008428 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008429 // Note that for now we are not going to try to handle the
8430 // data part; not clear how to represent this as a URI, and
8431 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008432 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8433 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008434 }
8435
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008436 if (frag.length() > 0) {
8437 uri.append("#Intent;");
8438 uri.append(frag);
8439 uri.append("end");
8440 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008441 }
8442
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008443 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8444 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008445 if (scheme != null) {
8446 uri.append("scheme=").append(scheme).append(';');
8447 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008448 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008449 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008450 }
8451 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008452 for (int i=0; i<mCategories.size(); i++) {
8453 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008454 }
8455 }
8456 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008457 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008458 }
8459 if (mFlags != 0) {
8460 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8461 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008462 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008463 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8464 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008465 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008466 uri.append("component=").append(Uri.encode(
8467 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008468 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008469 if (mSourceBounds != null) {
8470 uri.append("sourceBounds=")
8471 .append(Uri.encode(mSourceBounds.flattenToString()))
8472 .append(';');
8473 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008474 if (mExtras != null) {
8475 for (String key : mExtras.keySet()) {
8476 final Object value = mExtras.get(key);
8477 char entryType =
8478 value instanceof String ? 'S' :
8479 value instanceof Boolean ? 'B' :
8480 value instanceof Byte ? 'b' :
8481 value instanceof Character ? 'c' :
8482 value instanceof Double ? 'd' :
8483 value instanceof Float ? 'f' :
8484 value instanceof Integer ? 'i' :
8485 value instanceof Long ? 'l' :
8486 value instanceof Short ? 's' :
8487 '\0';
8488
8489 if (entryType != '\0') {
8490 uri.append(entryType);
8491 uri.append('.');
8492 uri.append(Uri.encode(key));
8493 uri.append('=');
8494 uri.append(Uri.encode(value.toString()));
8495 uri.append(';');
8496 }
8497 }
8498 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008499 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008500
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008501 public int describeContents() {
8502 return (mExtras != null) ? mExtras.describeContents() : 0;
8503 }
8504
8505 public void writeToParcel(Parcel out, int flags) {
8506 out.writeString(mAction);
8507 Uri.writeToParcel(out, mData);
8508 out.writeString(mType);
8509 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008510 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008511 ComponentName.writeToParcel(mComponent, out);
8512
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008513 if (mSourceBounds != null) {
8514 out.writeInt(1);
8515 mSourceBounds.writeToParcel(out, flags);
8516 } else {
8517 out.writeInt(0);
8518 }
8519
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008520 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008521 final int N = mCategories.size();
8522 out.writeInt(N);
8523 for (int i=0; i<N; i++) {
8524 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008525 }
8526 } else {
8527 out.writeInt(0);
8528 }
8529
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008530 if (mSelector != null) {
8531 out.writeInt(1);
8532 mSelector.writeToParcel(out, flags);
8533 } else {
8534 out.writeInt(0);
8535 }
8536
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008537 if (mClipData != null) {
8538 out.writeInt(1);
8539 mClipData.writeToParcel(out, flags);
8540 } else {
8541 out.writeInt(0);
8542 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008543 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008544 out.writeBundle(mExtras);
8545 }
8546
8547 public static final Parcelable.Creator<Intent> CREATOR
8548 = new Parcelable.Creator<Intent>() {
8549 public Intent createFromParcel(Parcel in) {
8550 return new Intent(in);
8551 }
8552 public Intent[] newArray(int size) {
8553 return new Intent[size];
8554 }
8555 };
8556
Dianne Hackborneb034652009-09-07 00:49:58 -07008557 /** @hide */
8558 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008559 readFromParcel(in);
8560 }
8561
8562 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008563 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008564 mData = Uri.CREATOR.createFromParcel(in);
8565 mType = in.readString();
8566 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008567 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008568 mComponent = ComponentName.readFromParcel(in);
8569
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008570 if (in.readInt() != 0) {
8571 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8572 }
8573
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008574 int N = in.readInt();
8575 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008576 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008577 int i;
8578 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008579 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008580 }
8581 } else {
8582 mCategories = null;
8583 }
8584
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008585 if (in.readInt() != 0) {
8586 mSelector = new Intent(in);
8587 }
8588
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008589 if (in.readInt() != 0) {
8590 mClipData = new ClipData(in);
8591 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008592 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008593 mExtras = in.readBundle();
8594 }
8595
8596 /**
8597 * Parses the "intent" element (and its children) from XML and instantiates
8598 * an Intent object. The given XML parser should be located at the tag
8599 * where parsing should start (often named "intent"), from which the
8600 * basic action, data, type, and package and class name will be
8601 * retrieved. The function will then parse in to any child elements,
8602 * looking for <category android:name="xxx"> tags to add categories and
8603 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8604 * to the intent.
8605 *
8606 * @param resources The Resources to use when inflating resources.
8607 * @param parser The XML parser pointing at an "intent" tag.
8608 * @param attrs The AttributeSet interface for retrieving extended
8609 * attribute data at the current <var>parser</var> location.
8610 * @return An Intent object matching the XML data.
8611 * @throws XmlPullParserException If there was an XML parsing error.
8612 * @throws IOException If there was an I/O error.
8613 */
8614 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8615 throws XmlPullParserException, IOException {
8616 Intent intent = new Intent();
8617
8618 TypedArray sa = resources.obtainAttributes(attrs,
8619 com.android.internal.R.styleable.Intent);
8620
8621 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8622
8623 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8624 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8625 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8626
8627 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8628 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8629 if (packageName != null && className != null) {
8630 intent.setComponent(new ComponentName(packageName, className));
8631 }
8632
8633 sa.recycle();
8634
8635 int outerDepth = parser.getDepth();
8636 int type;
8637 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8638 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8639 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8640 continue;
8641 }
8642
8643 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008644 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008645 sa = resources.obtainAttributes(attrs,
8646 com.android.internal.R.styleable.IntentCategory);
8647 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8648 sa.recycle();
8649
8650 if (cat != null) {
8651 intent.addCategory(cat);
8652 }
8653 XmlUtils.skipCurrentTag(parser);
8654
Craig Mautner21d24a22014-04-23 11:45:37 -07008655 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008656 if (intent.mExtras == null) {
8657 intent.mExtras = new Bundle();
8658 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008659 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008660 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008661
8662 } else {
8663 XmlUtils.skipCurrentTag(parser);
8664 }
8665 }
8666
8667 return intent;
8668 }
Nick Pellyccae4122012-01-09 14:12:58 -08008669
Craig Mautner21d24a22014-04-23 11:45:37 -07008670 /** @hide */
8671 public void saveToXml(XmlSerializer out) throws IOException {
8672 if (mAction != null) {
8673 out.attribute(null, ATTR_ACTION, mAction);
8674 }
8675 if (mData != null) {
8676 out.attribute(null, ATTR_DATA, mData.toString());
8677 }
8678 if (mType != null) {
8679 out.attribute(null, ATTR_TYPE, mType);
8680 }
8681 if (mComponent != null) {
8682 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8683 }
8684 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8685
8686 if (mCategories != null) {
8687 out.startTag(null, TAG_CATEGORIES);
8688 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8689 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8690 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008691 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008692 }
8693 }
8694
8695 /** @hide */
8696 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8697 XmlPullParserException {
8698 Intent intent = new Intent();
8699 final int outerDepth = in.getDepth();
8700
8701 int attrCount = in.getAttributeCount();
8702 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8703 final String attrName = in.getAttributeName(attrNdx);
8704 final String attrValue = in.getAttributeValue(attrNdx);
8705 if (ATTR_ACTION.equals(attrName)) {
8706 intent.setAction(attrValue);
8707 } else if (ATTR_DATA.equals(attrName)) {
8708 intent.setData(Uri.parse(attrValue));
8709 } else if (ATTR_TYPE.equals(attrName)) {
8710 intent.setType(attrValue);
8711 } else if (ATTR_COMPONENT.equals(attrName)) {
8712 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8713 } else if (ATTR_FLAGS.equals(attrName)) {
8714 intent.setFlags(Integer.valueOf(attrValue, 16));
8715 } else {
8716 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8717 }
8718 }
8719
8720 int event;
8721 String name;
8722 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8723 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8724 if (event == XmlPullParser.START_TAG) {
8725 name = in.getName();
8726 if (TAG_CATEGORIES.equals(name)) {
8727 attrCount = in.getAttributeCount();
8728 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8729 intent.addCategory(in.getAttributeValue(attrNdx));
8730 }
8731 } else {
8732 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8733 XmlUtils.skipCurrentTag(in);
8734 }
8735 }
8736 }
8737
8738 return intent;
8739 }
8740
Nick Pellyccae4122012-01-09 14:12:58 -08008741 /**
8742 * Normalize a MIME data type.
8743 *
8744 * <p>A normalized MIME type has white-space trimmed,
8745 * content-type parameters removed, and is lower-case.
8746 * This aligns the type with Android best practices for
8747 * intent filtering.
8748 *
8749 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8750 * "text/x-vCard" becomes "text/x-vcard".
8751 *
8752 * <p>All MIME types received from outside Android (such as user input,
8753 * or external sources like Bluetooth, NFC, or the Internet) should
8754 * be normalized before they are used to create an Intent.
8755 *
8756 * @param type MIME data type to normalize
8757 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008758 * @see #setType
8759 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008760 */
8761 public static String normalizeMimeType(String type) {
8762 if (type == null) {
8763 return null;
8764 }
8765
Elliott Hughescb64d432013-08-02 10:00:44 -07008766 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008767
8768 final int semicolonIndex = type.indexOf(';');
8769 if (semicolonIndex != -1) {
8770 type = type.substring(0, semicolonIndex);
8771 }
8772 return type;
8773 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008774
8775 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008776 * Prepare this {@link Intent} to leave an app process.
8777 *
8778 * @hide
8779 */
8780 public void prepareToLeaveProcess() {
8781 setAllowFds(false);
8782
8783 if (mSelector != null) {
8784 mSelector.prepareToLeaveProcess();
8785 }
8786 if (mClipData != null) {
8787 mClipData.prepareToLeaveProcess();
8788 }
8789
8790 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
8791 // There are several ACTION_MEDIA_* broadcasts that send file://
8792 // Uris, so only check common actions.
8793 if (ACTION_VIEW.equals(mAction) ||
8794 ACTION_EDIT.equals(mAction) ||
8795 ACTION_ATTACH_DATA.equals(mAction)) {
8796 mData.checkFileUriExposed("Intent.getData()");
8797 }
8798 }
8799 }
8800
8801 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008802 * @hide
8803 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008804 public void prepareToEnterProcess() {
8805 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008806 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8807 fixUris(mContentUserHint);
8808 mContentUserHint = UserHandle.USER_CURRENT;
8809 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008810 }
8811 }
8812
8813 /**
8814 * @hide
8815 */
8816 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008817 Uri data = getData();
8818 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008819 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008820 }
8821 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008822 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008823 }
8824 String action = getAction();
8825 if (ACTION_SEND.equals(action)) {
8826 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8827 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008828 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008829 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008830 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008831 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8832 if (streams != null) {
8833 ArrayList<Uri> newStreams = new ArrayList<Uri>();
8834 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008835 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008836 }
8837 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
8838 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008839 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8840 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8841 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8842 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8843 if (output != null) {
8844 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
8845 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008846 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008847 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008848
8849 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008850 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008851 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
8852 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008853 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008854 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008855 * @hide
8856 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008857 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008858 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008859 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008860
8861 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008862 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008863
8864 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008865 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008866 // Inspect contained intents to see if we need to migrate extras. We
8867 // don't promote ClipData to the parent, since ChooserActivity will
8868 // already start the picked item as the caller, and we can't combine
8869 // the flags in a safe way.
8870
8871 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07008872 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008873 final Intent intent = getParcelableExtra(EXTRA_INTENT);
8874 if (intent != null) {
8875 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07008876 }
8877 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008878 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008879 try {
8880 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
8881 if (intents != null) {
8882 for (int i = 0; i < intents.length; i++) {
8883 final Intent intent = (Intent) intents[i];
8884 if (intent != null) {
8885 migrated |= intent.migrateExtraStreamToClipData();
8886 }
8887 }
8888 }
8889 } catch (ClassCastException e) {
8890 }
8891 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008892
8893 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008894 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008895 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8896 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
8897 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
8898 if (stream != null || text != null || htmlText != null) {
8899 final ClipData clipData = new ClipData(
8900 null, new String[] { getType() },
8901 new ClipData.Item(text, htmlText, null, stream));
8902 setClipData(clipData);
8903 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008904 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008905 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008906 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008907 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008908
8909 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008910 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008911 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8912 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
8913 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
8914 int num = -1;
8915 if (streams != null) {
8916 num = streams.size();
8917 }
8918 if (texts != null) {
8919 if (num >= 0 && num != texts.size()) {
8920 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008921 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008922 }
8923 num = texts.size();
8924 }
8925 if (htmlTexts != null) {
8926 if (num >= 0 && num != htmlTexts.size()) {
8927 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008928 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008929 }
8930 num = htmlTexts.size();
8931 }
8932 if (num > 0) {
8933 final ClipData clipData = new ClipData(
8934 null, new String[] { getType() },
8935 makeClipItem(streams, texts, htmlTexts, 0));
8936
8937 for (int i = 1; i < num; i++) {
8938 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
8939 }
8940
8941 setClipData(clipData);
8942 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008943 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008944 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008945 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008946 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008947 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8948 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8949 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8950 final Uri output;
8951 try {
8952 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8953 } catch (ClassCastException e) {
8954 return false;
8955 }
8956 if (output != null) {
8957 setClipData(ClipData.newRawUri("", output));
8958 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
8959 return true;
8960 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008961 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008962
8963 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008964 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07008965
8966 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
8967 ArrayList<String> htmlTexts, int which) {
8968 Uri uri = streams != null ? streams.get(which) : null;
8969 CharSequence text = texts != null ? texts.get(which) : null;
8970 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
8971 return new ClipData.Item(text, htmlText, null, uri);
8972 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07008973
8974 /** @hide */
8975 public boolean isDocument() {
8976 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
8977 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008978}